Set-AzureEndpoint
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Set-AzureEndpoint
Updates an existing endpoint assigned to an Azure virtual machine.
Syntax
Parameter Set: Default
Set-AzureEndpoint [-Name] <String> [[-Protocol] <String> ] [[-LocalPort] <Int32> ] -VM <IPersistentVM> [-ACL <NetworkAclObject> ] [-DirectServerReturn <Boolean> ] [-IdleTimeoutInMinutes <Int32> ] [-InternalLoadBalancerName <String> ] [-LoadBalancerDistribution <String> ] [-PublicPort <Int32> ] [ <CommonParameters>]
Detailed Description
This topic describes the cmdlet in the 0.8.10 version of the Microsoft Azure PowerShell module. To get the version of the module you're using, in the Azure PowerShell console, type (Get-Module -Name Azure).Version.
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 is 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. To complete the reconfiguration of an endpoint, pass the updated virtual machine object to the Update-AzureVM cmdlet.
Parameters
-ACL<NetworkAclObject>
Updates the endpoint with an access control list (ACL).
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-DirectServerReturn<Boolean>
Enables or disables Direct Server Return on the endpoint.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-IdleTimeoutInMinutes<Int32>
Specifies the TCP Idle timeout period, in minutes.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-InternalLoadBalancerName<String>
Specifies name of the internal load balancer.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-LoadBalancerDistribution<String>
Specifies the load balancer distribution algorithm. Valid values are:
-- sourceIP: 2 tuple affinity (Source IP, Destination IP)
-- sourceIPProtocol: 3 tuple affinity (Source IP, Destination IP, Protocol)
-- none: 5 tuple affinity (Source IP, Source Port, Destination IP, Destination Port, Protocol)
The default value is none.
Aliases |
none |
Required? |
false |
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? |
false |
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 |
-Protocol<String>
Specifies the protocol of the endpoint. Acceptable values are "UDP" or "TCP".
Aliases |
none |
Required? |
false |
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 a port is not specified, an available free port is assigned.
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, ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://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.
Examples
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