Set-​Azure​Load​Balanced​Endpoint

Modifies all of the endpoints in a load balancer set within an Azure service.

Syntax

Set-AzureLoadBalancedEndpoint
   [-ServiceName] <String>
   [-ACL <NetworkAclObject>]
   [-DirectServerReturn <Boolean>]
   [-IdleTimeoutInMinutes <Int32>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-InternalLoadBalancerName <String>]
   -LBSetName <String>
   [-LoadBalancerDistribution <String>]
   [-LocalPort <Int32>]
   [-ProbeIntervalInSeconds <Int32>]
   [-ProbePort <Int32>]
   [-ProbeProtocolTCP]
   [-ProbeTimeoutInSeconds <Int32>]
   [-Profile <AzureSMProfile>]
   [-Protocol <String>]
   [-PublicPort <Int32>]
   [-VirtualIPName <String>]
   [<CommonParameters>]
Set-AzureLoadBalancedEndpoint
   [-ServiceName] <String>
   [-ACL <NetworkAclObject>]
   [-DirectServerReturn <Boolean>]
   [-IdleTimeoutInMinutes <Int32>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-InternalLoadBalancerName <String>]
   -LBSetName <String>
   [-LoadBalancerDistribution <String>]
   [-LocalPort <Int32>]
   [-ProbeIntervalInSeconds <Int32>]
   -ProbePath <String>
   [-ProbePort <Int32>]
   [-ProbeProtocolHTTP]
   [-ProbeTimeoutInSeconds <Int32>]
   [-Profile <AzureSMProfile>]
   [-Protocol <String>]
   [-PublicPort <Int32>]
   [-VirtualIPName <String>]
   [<CommonParameters>]

Description

The Set-AzureLoadBalancedEndpoint cmdlet modifies all of the endpoints in a load balancer set in an Azure service.

Examples

Example 1: Modify the endpoints in a load balancer set

PS C:\> Set-AzureLoadBalancedEndpoint -ServiceName "ContosoService" -LBSetName "LBSet01" -Protocol "TCP" -LocalPort 80 -ProbeProtocolTCP -ProbePort 8080

This command modifies all endpoints in the load balancer set named LBSet01 to use the TCP protocol and private port 80. The command sets the load balancer probe to use the TCP protocol on port 8080.

Example 2: Specify a different virtual IP

PS C:\> Set-AzureLoadBalancedEndpoint -ServiceName "ContosoService" -LBSetName "LBSet02" -VirtualIPName "Vip01"

This command modifies the load balancer that has the load balancer set name to use a virtual IP named Vip01.

Required Parameters

-LBSetName

Specifies the name of the load balancer set that this cmdlet updates.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ProbePath

Specifies the relative path of the HTTP Probe.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ProbeProtocolHTTP

Specifies that the load balancer endpoints use an HTTP Probe.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ProbeProtocolTCP

Specifies that the load balancer endpoints use a TCP Probe.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ServiceName

Specifies the name of the Azure service that contains the endpoints that this cmdlet modifies.

Type:String
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-ACL

Specifies an access control list (ACL) configuration object that this cmdlet applies to the endpoints.

Type:NetworkAclObject
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DirectServerReturn

Specifies whether this cmdlet enables direct server return. Specify $True to enable, or $False to disable.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-IdleTimeoutInMinutes

Specifies the TCP idle time-out period, in minutes, for the endpoints.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationAction

Specifies how this cmdlet responds to an information event.The acceptable values for this parameter are:- Continue

  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationVariable

Specifies an information variable.

Type:String
Aliases:iv
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InternalLoadBalancerName

Specifies the name of the internal load balancer that this cmdlet includes in the configuration.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-LoadBalancerDistribution

Specifies the load balancer distribution algorithm. Valid values are: - sourceIP. A two tuple affinity: Source IP, Destination IP

  • sourceIPProtocol. A three tuple affinity: Source IP, Destination IP, Protocol
  • none. A five tuple affinity: Source IP, Source Port, Destination IP, Destination Port, Protocol

    The default value is none.
Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-LocalPort

Specifies the local, private, port that these endpoints use. Applications in the virtual machine listen on this port for service input requests for this endpoint.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ProbeIntervalInSeconds

Specifies the probe polling interval, in seconds, for the endpoints.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ProbePort

Specifies the port that the load balancer probe uses.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ProbeTimeoutInSeconds

Specifies the probe polling time-out in seconds.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

Type:AzureSMProfile
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Protocol

Specifies the protocol of the endpoints. Valid values are: - TCP

  • UDP
Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PublicPort

Specifies the public port that the endpoint uses. If you do not specify a value, Azure assigns an available port.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-VirtualIPName

Specifies the name of a virtual IP address that Azure associates to the endpoints. To add virtual IPs to your service, use the Add-AzureVirtualIP cmdlet.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False