< Back

Set-AzureLoadBalancedEndpoint

Wed Jan 30, 2019 5:53 pm

NAME Set-AzureLoadBalancedEndpoint



SYNOPSIS

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





SYNTAX

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>] -ProbeProtocolTCP [-ProbePort <Int32>] [-ProbeIntervalInSeconds <Int32>] [-ProbeTimeoutInSeconds <Int32>] [<CommonParameters>]



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>] [-ProbePort <Int32>] [-ProbeIntervalInSeconds <Int32>] [-ProbeTimeoutInSeconds <Int32>] -ProbeProtocolHTTP -ProbePath <String>

[<CommonParameters>]





DESCRIPTION

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





PARAMETERS

-LBSetName <String>

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



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Protocol <String>

Specifies the protocol of the endpoints. Valid values are:



-- TCP



-- UDP



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-LocalPort <Int32>

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.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-PublicPort <Int32>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-DirectServerReturn <Boolean>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ACL <NetworkAclObject>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InternalLoadBalancerName <String>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-IdleTimeoutInMinutes <Int32>

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



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. 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.





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-VirtualIPName <String>

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.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ServiceName <String>

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



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Profile <AzureSMProfile>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InformationAction <ActionPreference>





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-InformationVariable <String>





Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ProbeProtocolTCP [<SwitchParameter>]

Specifies that the load balancer endpoints use a TCP Probe.



Required? true

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-ProbePort <Int32>

Specifies the port that the load balancer probe uses.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ProbeIntervalInSeconds <Int32>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ProbeTimeoutInSeconds <Int32>

Specifies the probe polling time-out in seconds.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ProbeProtocolHTTP [<SwitchParameter>]

Specifies that the load balancer endpoints use an HTTP Probe.



Required? true

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-ProbePath <String>

Specifies the relative path of the HTTP Probe.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES









-------------------------- 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.



RELATED LINKS

Add-AzureVirtualIP

Set-AzureInternalLoadBalancer