Set-AzureLoadBalancedEndpoint
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Set-AzureLoadBalancedEndpoint
Updates all of the endpoints in a load-balanced set.
Syntax
Parameter Set: DefaultProbe
Set-AzureLoadBalancedEndpoint [-ServiceName] <String> -LBSetName <String> [-ACL <NetworkAclObject> ] [-DirectServerReturn <Boolean> ] [-IdleTimeoutInMinutes <Int32> ] [-InternalLoadBalancerName <String> ] [-LoadBalancerDistribution <String> ] [-LocalPort <Int32> ] [-Protocol <String> ] [-PublicPort <Int32> ] [ <CommonParameters>]
Parameter Set: HTTPProbe
Set-AzureLoadBalancedEndpoint [-ServiceName] <String> -LBSetName <String> -ProbePath <String> -ProbeProtocolHTTP [-ACL <NetworkAclObject> ] [-DirectServerReturn <Boolean> ] [-IdleTimeoutInMinutes <Int32> ] [-InternalLoadBalancerName <String> ] [-LoadBalancerDistribution <String> ] [-LocalPort <Int32> ] [-ProbeIntervalInSeconds <Int32> ] [-ProbePort <Int32> ] [-ProbeTimeoutInSeconds <Int32> ] [-Protocol <String> ] [-PublicPort <Int32> ] [ <CommonParameters>]
Parameter Set: TCPProbe
Set-AzureLoadBalancedEndpoint [-ServiceName] <String> -LBSetName <String> -ProbeProtocolTCP [-ACL <NetworkAclObject> ] [-DirectServerReturn <Boolean> ] [-IdleTimeoutInMinutes <Int32> ] [-InternalLoadBalancerName <String> ] [-LoadBalancerDistribution <String> ] [-LocalPort <Int32> ] [-ProbeIntervalInSeconds <Int32> ] [-ProbePort <Int32> ] [-ProbeTimeoutInSeconds <Int32> ] [-Protocol <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.
This cmdlet updates all of the endpoints in a given load-balanced set within an Azure Service.
Parameters
-ACL<NetworkAclObject>
Specifies an ACL to apply to the endpoint on update.
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.
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 |
-LBSetName<String>
Specifies the name of the load-balanced set to update.
Aliases |
none |
Required? |
true |
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 to be used for the endpoint. Applications running in the virtual machine listen to this port to service input requests over the endpoint.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ProbeIntervalInSeconds<Int32>
Specifies the probe polling interval in seconds.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ProbePath<String>
Specifies the relative path to the HTTP probe.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ProbePort<Int32>
Specifies the port for the load balancer probe to use. If not specified, Azure assigns the endpoint’s local port.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ProbeProtocolHTTP
Specifies that a HTTP probe should be used.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ProbeProtocolTCP
Specifies that a TCP probe should be used.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ProbeTimeoutInSeconds<Int32>
Specifies the probe polling timeout in seconds.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Protocol<String>
Specifies the protocol to be used on the endpoint, either “TCP” or “UDP”.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PublicPort<Int32>
Specifies the public port for the endpoint to use. If not specified, Azure assigns an available free port
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ServiceName<String>
Specifies the name of the service to which the load-balanced set applies.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (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
This example updates all endpoints in the load-balanced set "LBSet1" to use the TCP protocol and private port 80, and sets the load balancer probe to use the TCP protocol on port 8080.
PS C:\> Set-AzureLoadBalancedEndpoint -ServiceName "MyService" -LBSetName "LBSet1" -Protocol tcp -LocalPort 80 -ProbeProtocolTCP -ProbePort 8080