Set-AzureEndpoint
Set-AzureEndpoint
Parameter Set: LoadBalanced Set-AzureEndpoint [-Name] <String> [-Protocol] <String> [-LocalPort] <Int32> -LBSetName <String> -ProbePort <Int32> -ProbeProtocol <String> -VM <IPersistentVM> [-ProbePath <String> ] [-PublicPort <Int32> ] [ <CommonParameters>] Parameter Set: NoLB Set-AzureEndpoint [-Name] <String> [-Protocol] <String> [-LocalPort] <Int32> -VM <IPersistentVM> [-PublicPort <Int32> ] [ <CommonParameters>]
The Set-AzureInputEndpoint cmdlet updates an existing endpoint assigned to a virtual machine. You can specify updates to an endpoint that is not load balanced, which only a single virtual machine uses, or you can specify updates to a load-balanced endpoint, which other virtual machines running in the same cloud service can share to load-balance traffic.
When updating a load-balanced endpoint, you can also specify parameters for an endpoint probe. The probe will be used to check the health of endpoints and endpoint resources, probing for response every 15 seconds, and taking a resource out of rotation if no response is received within 31 seconds. You need to pass the updated virtual machine object to Update-AzureVM to complete the endpoint change.
-LBSetName<String>
Specifies the name of a load-balanced endpoint. Multiple virtual machines in the cloud service can use a load-balanced endpoint. Either LBSetName or Name must be specified for the endpoint, but not both.
Aliases | none |
Required? | true |
Position? | named |
Default Value | none |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
-LocalPort<Int32>
Specifies the local (private) port that will be used for the endpoint. Applications within the virtual machine listen to this port to service input requests over the endpoint.
Aliases | none |
Required? | true |
Position? | 3 |
Default Value | none |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
-Name<String>
Specifies the name of the endpoint.
Aliases | none |
Required? | true |
Position? | 1 |
Default Value | none |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
-ProbePath<String>
Required if ProbeProtocol is set to “http”. Omit otherwise. Specifies the URI whose health will be probed.
Aliases | none |
Required? | false |
Position? | named |
Default Value | none |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
-ProbePort<Int32>
Specifies the public port that the probe will use.
Aliases | none |
Required? | true |
Position? | named |
Default Value | none |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
-ProbeProtocol<String>
Specifies the protocol of the endpoint to be probed. Acceptable values are "http" or "tcp". If "tcp" is specified, a received ACK is required for the probe to be successful. If "http" is specified, a 200 OK response from the ProbePath URI is required.
Aliases | none |
Required? | true |
Position? | named |
Default Value | none |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
-Protocol<String>
Specifies the protocol of the endpoint. Acceptable values are "udp" or "tcp".
Aliases | none |
Required? | true |
Position? | 2 |
Default Value | none |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
-PublicPort<Int32>
Specifies the public port that the endpoint will use. If not specified, Windows Azure will assign an available free port.
Aliases | none |
Required? | false |
Position? | named |
Default Value | none |
Accept Pipeline Input? | false |
Accept Wildcard Characters? | false |
-VM<IPersistentVM>
Specifies the virtual machine object for which the endpoint will be created.
Aliases | InputObject |
Required? | true |
Position? | named |
Default Value | none |
Accept Pipeline Input? | True (ByValue) |
Accept Wildcard Characters? | false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
-------------- Example 1 --------------
This command updates the input endpoint named “Web” assigned to the virtual machine “MyVM” to listen on Port 443.
PS C:\> Get-AzureVM -ServiceName "MyService" -Name "MyVM" | Set-AzureEndpoint -Name "Web" -PublicPort 443 -LocalPort 443 -Protocol "tcp" | Update-AzureVM
Related topics