< Back
Set-AzureRmLoadBalancerRuleConfig
Post
NAME Set-AzureRmLoadBalancerRuleConfig
SYNOPSIS
Sets the goal state for a load balancer rule configuration.
SYNTAX
Set-AzureRmLoadBalancerRuleConfig [-BackendAddressPool <PSBackendAddressPool>] [-BackendPort <Int32>] [-DefaultProfile <IAzureContextContainer>]
[-DisableOutboundSNAT] [-EnableFloatingIP] [-FrontendIpConfiguration <PSFrontendIPConfiguration>] [-FrontendPort <Int32>] [-IdleTimeoutInMinutes
<Int32>] -LoadBalancer <PSLoadBalancer> [-LoadDistribution {Default | SourceIP | SourceIPProtocol}] -Name <String> [-Probe <PSProbe>] [-Protocol
{Tcp | Udp | All}] [<CommonParameters>]
Set-AzureRmLoadBalancerRuleConfig [-BackendAddressPoolId <String>] [-BackendPort <Int32>] [-DefaultProfile <IAzureContextContainer>]
[-DisableOutboundSNAT] [-EnableFloatingIP] [-FrontendIpConfigurationId <String>] [-FrontendPort <Int32>] [-IdleTimeoutInMinutes <Int32>]
-LoadBalancer <PSLoadBalancer> [-LoadDistribution {Default | SourceIP | SourceIPProtocol}] -Name <String> [-ProbeId <String>] [-Protocol {Tcp |
Udp | All}] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmLoadBalancerRuleConfig cmdlet sets the goal state for a load balancer rule configuration.
PARAMETERS
-BackendAddressPool <PSBackendAddressPool>
Specifies a BackendAddressPool object to associate with a load balancer rule.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-BackendAddressPoolId <String>
Specifies the ID of a BackendAddressPool object to associate with a load balancer rule configuration.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-BackendPort <Int32>
Specifies the backend port for traffic that is matched by this rule configuration.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DisableOutboundSNAT [<SwitchParameter>]
Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-EnableFloatingIP [<SwitchParameter>]
Indicates that this cmdlet enables a floating IP address for a rule configuration.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-FrontendIpConfiguration <PSFrontendIPConfiguration>
Specifies a list of front-end IP addresses to associate with a load balancer rule configuration.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-FrontendIpConfigurationId <String>
Specifies the ID for a front-end IP address configuration.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-FrontendPort <Int32>
Specifies the front-end port that is matched by a load balancer rule configuration.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-IdleTimeoutInMinutes <Int32>
Specifies the length of time, in minutes, for which the state of conversations is maintained in a load balancer.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-LoadBalancer <PSLoadBalancer>
Specifies a load balancer. This cmdlet sets the goal state rule configuration for the load balancer that this parameter specifies.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-LoadDistribution <String>
Specifies a load distribution. The acceptable values for this parameter are: SourceIP and SourceIPProtocol.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of a load balancer.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Probe <PSProbe>
Specifies a probe to associate with a load balancer rule configuration.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ProbeId <String>
Specifies the ID of the probe to associate with a load balancer rule configuration.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Protocol <String>
Specifies the protocol that is matched by a load balancer rule. The acceptable values for this parameter are: Tcp or Udp.
Required? false
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 (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
PSLoadBalancer
Parameter 'LoadBalancer' accepts value of type 'PSLoadBalancer' from the pipeline
OUTPUTS
Microsoft.Azure.Commands.Network.Models.PSLoadBalancer
NOTES
Example 1: Modify a load balancing rule configuration
PS C:\\>$slb = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup"
PS C:\\> $slb | Add-AzureRmLoadBalancerRuleConfig -Name "NewRule" -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol "Tcp"
-FrontendPort 3350 -BackendPort 3350 -EnableFloatingIP
PS C:\\> $slb | Set-AzureRmLoadBalancerRuleConfig -Name "NewRule" -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol "Tcp"
-FrontendPort 3350 -BackendPort 3350
The first command gets the load balancer named MyLoadBalancer, and then stores it in the $slb variable.
The second command uses the pipeline operator to pass the load balancer in $slb to Add-AzureRmLoadBalancerRuleConfig, which adds a rule named
NewRule to it.
The third command passes the load balancer to Set-AzureRmLoadBalancerRuleConfig , which sets the new rule configuration. Note that the
configuration does not enable a floating IP address, which had been enabled by the previous command.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ruleconfig
Add-AzureRmLoadBalancerRuleConfig
Add-AzureRmLoadBalancerRuleConfig
Get-AzureRmLoadBalancerRuleConfig
New-AzureRmLoadBalancerRuleConfig
Remove-AzureRmLoadBalancerRuleConfig
SYNOPSIS
Sets the goal state for a load balancer rule configuration.
SYNTAX
Set-AzureRmLoadBalancerRuleConfig [-BackendAddressPool <PSBackendAddressPool>] [-BackendPort <Int32>] [-DefaultProfile <IAzureContextContainer>]
[-DisableOutboundSNAT] [-EnableFloatingIP] [-FrontendIpConfiguration <PSFrontendIPConfiguration>] [-FrontendPort <Int32>] [-IdleTimeoutInMinutes
<Int32>] -LoadBalancer <PSLoadBalancer> [-LoadDistribution {Default | SourceIP | SourceIPProtocol}] -Name <String> [-Probe <PSProbe>] [-Protocol
{Tcp | Udp | All}] [<CommonParameters>]
Set-AzureRmLoadBalancerRuleConfig [-BackendAddressPoolId <String>] [-BackendPort <Int32>] [-DefaultProfile <IAzureContextContainer>]
[-DisableOutboundSNAT] [-EnableFloatingIP] [-FrontendIpConfigurationId <String>] [-FrontendPort <Int32>] [-IdleTimeoutInMinutes <Int32>]
-LoadBalancer <PSLoadBalancer> [-LoadDistribution {Default | SourceIP | SourceIPProtocol}] -Name <String> [-ProbeId <String>] [-Protocol {Tcp |
Udp | All}] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmLoadBalancerRuleConfig cmdlet sets the goal state for a load balancer rule configuration.
PARAMETERS
-BackendAddressPool <PSBackendAddressPool>
Specifies a BackendAddressPool object to associate with a load balancer rule.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-BackendAddressPoolId <String>
Specifies the ID of a BackendAddressPool object to associate with a load balancer rule configuration.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-BackendPort <Int32>
Specifies the backend port for traffic that is matched by this rule configuration.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DisableOutboundSNAT [<SwitchParameter>]
Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-EnableFloatingIP [<SwitchParameter>]
Indicates that this cmdlet enables a floating IP address for a rule configuration.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-FrontendIpConfiguration <PSFrontendIPConfiguration>
Specifies a list of front-end IP addresses to associate with a load balancer rule configuration.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-FrontendIpConfigurationId <String>
Specifies the ID for a front-end IP address configuration.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-FrontendPort <Int32>
Specifies the front-end port that is matched by a load balancer rule configuration.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-IdleTimeoutInMinutes <Int32>
Specifies the length of time, in minutes, for which the state of conversations is maintained in a load balancer.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-LoadBalancer <PSLoadBalancer>
Specifies a load balancer. This cmdlet sets the goal state rule configuration for the load balancer that this parameter specifies.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-LoadDistribution <String>
Specifies a load distribution. The acceptable values for this parameter are: SourceIP and SourceIPProtocol.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of a load balancer.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Probe <PSProbe>
Specifies a probe to associate with a load balancer rule configuration.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ProbeId <String>
Specifies the ID of the probe to associate with a load balancer rule configuration.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Protocol <String>
Specifies the protocol that is matched by a load balancer rule. The acceptable values for this parameter are: Tcp or Udp.
Required? false
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 (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
PSLoadBalancer
Parameter 'LoadBalancer' accepts value of type 'PSLoadBalancer' from the pipeline
OUTPUTS
Microsoft.Azure.Commands.Network.Models.PSLoadBalancer
NOTES
Example 1: Modify a load balancing rule configuration
PS C:\\>$slb = Get-AzureRmLoadBalancer -Name "MyLoadBalancer" -ResourceGroupName "MyResourceGroup"
PS C:\\> $slb | Add-AzureRmLoadBalancerRuleConfig -Name "NewRule" -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol "Tcp"
-FrontendPort 3350 -BackendPort 3350 -EnableFloatingIP
PS C:\\> $slb | Set-AzureRmLoadBalancerRuleConfig -Name "NewRule" -FrontendIPConfiguration $slb.FrontendIpConfigurations[0] -Protocol "Tcp"
-FrontendPort 3350 -BackendPort 3350
The first command gets the load balancer named MyLoadBalancer, and then stores it in the $slb variable.
The second command uses the pipeline operator to pass the load balancer in $slb to Add-AzureRmLoadBalancerRuleConfig, which adds a rule named
NewRule to it.
The third command passes the load balancer to Set-AzureRmLoadBalancerRuleConfig , which sets the new rule configuration. Note that the
configuration does not enable a floating IP address, which had been enabled by the previous command.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ruleconfig
Add-AzureRmLoadBalancerRuleConfig
Add-AzureRmLoadBalancerRuleConfig
Get-AzureRmLoadBalancerRuleConfig
New-AzureRmLoadBalancerRuleConfig
Remove-AzureRmLoadBalancerRuleConfig