Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Add-AzureLoadBalancerRuleConfig

Add-AzureLoadBalancerRuleConfig

microsoft.azure.commands.network.dll

Synopsis

Add a new Load Balancer Rule to an Azure Load Balancer

Syntax

Add-AzureLoadBalancerRuleConfig [-Name] [-LoadBalancer] [-FrontendIpConfigurationId] [-BackendAddressPoolId] [-ProbeId] [-Protocol] [-FrontendPort] [-BackendPort] [-IdleTimeoutInMinutes] [-LoadDistribution] [-EnableFloatingIP] [-Profile] [<CommonParameters>]

Add-AzureLoadBalancerRuleConfig [-Name] [-LoadBalancer] [-FrontendIpConfiguration] [-BackendAddressPool] [-Probe] [-Protocol] [-FrontendPort] [-BackendPort] [-IdleTimeoutInMinutes] [-LoadDistribution] [-EnableFloatingIP] [-Profile] [<CommonParameters>]

Detailed Description

Add a new Load Balancer Rule to an Azure Load Balancer

Parameters

-Name <String>

The name of the Load Balancer Rule.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-LoadBalancer <PSLoadBalancer>

The Load Balancer in which this Load Balancer Rule will be created.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByValue)

Accept wildcard characters?

false

-FrontendIpConfigurationId <String>

A list of Frontend Ip Id to associate with this Load Balancer Rule.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-BackendAddressPoolId <String>

The Id of a Backend Address Pool to associate with this Load Balancer Rule.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ProbeId <String>

The Id of the probe to associate with this Load Balancer Rule.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Protocol <String>

The protocol matched by this Load Balancer Rule.

Options: Tcp or Udp.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-FrontendPort <Int32>

The frontend port matched by this Load Balancer Rule.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-BackendPort <Int32>

The backend port for traffic matched by this Load Balancer Rule.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-IdleTimeoutInMinutes <Int32>

The length of time in minutes for which state of conversations is maintained within the Load Balancer.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-LoadDistribution <String>

Specifies the load balancing distribution type to be used by the Load Balancer. Possible values are Default – The load balancer is configured to use a 5 tuple hash to map traffic to available servers SourceIP – The load balancer is configured to use a 2 tuple hash to map traffic to available servers SourceIPProtocol– The load balancer is configured to use a 3 tuple hash to map traffic to available servers

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-EnableFloatingIP <SwitchParameter>

Floating IP is pertinent to failover scenarios: a “floating” IP is reassigned to a secondary server in case the primary server fails. Floating IP is required for SQL AlwaysOn.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Profile <AzureProfile>

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-FrontendIpConfiguration <PSFrontendIPConfiguration>

A list of Frontend Ips to associate with this Load Balancer Rule.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-BackendAddressPool <PSBackendAddressPool>

The Backend Address Pool to associate with this Load Balancer Rule.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Probe <PSProbe>

The probe object to be used for this Load Balancer Rule.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type


Notes

Examples

-------------------------- Example 1 --------------------------

PS C:\> $lb = Get-AzureLoadBalancer -Name "myLb" -ResourceGroupName "myRg"

          $lb | Add-AzureLoadBalancerRuleConfig -Name "lbruleName" -FrontendIPConfiguration $lb.FrontendIPConfigurations[0] -BackendAddressPool $lb.BackendAddressPools[0] -Probe $lb.Probes[0] -Protocol Tcp -FrontendPort 80 -BackendPort 80 -IdleTimeoutInSeconds 15 -EnableFloatingIP | Set-AzureLoadBalancer