Edit

Share via

Set-AzureLoadBalancedEndpoint

Module:
Azure Module

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

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.

The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.

Syntax

DefaultProbe (Default) 

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

TCPProbe 

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

HTTPProbe 

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

Parameters

-ACL

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

Parameter properties

Type:NetworkAclObject
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DirectServerReturn

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

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IdleTimeoutInMinutes

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

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InformationAction

Specifies how this cmdlet responds to an information event.

The acceptable values for this parameter are:

  • Continue
  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend

Parameter properties

Type:ActionPreference
Default value:None
Supports wildcards:False
DontShow:False
Aliases:infa

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InformationVariable

Specifies an information variable.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:iv

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InternalLoadBalancerName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LBSetName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ProbeIntervalInSeconds

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

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

TCPProbe
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
HTTPProbe
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ProbePath

Specifies the relative path of the HTTP Probe.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

HTTPProbe
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ProbePort

Specifies the port that the load balancer probe uses.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

TCPProbe
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
HTTPProbe
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ProbeProtocolHTTP

Specifies that the load balancer endpoints use an HTTP Probe.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

HTTPProbe
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ProbeProtocolTCP

Specifies that the load balancer endpoints use a TCP Probe.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

TCPProbe
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ProbeTimeoutInSeconds

Specifies the probe polling time-out in seconds.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

TCPProbe
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
HTTPProbe
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:AzureSMProfile
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Protocol

Specifies the protocol of the endpoints. Valid values are:

  • TCP
  • UDP

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PublicPort

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

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ServiceName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.