New-AzLoadBalancerOutboundRuleConfig
Creates an outbound rule configuration for a load balancer.
Syntax
New-AzLoadBalancerOutboundRuleConfig
-Name <String>
[-AllocatedOutboundPort <Int32>]
-Protocol <String>
[-EnableTcpReset]
[-IdleTimeoutInMinutes <Int32>]
-FrontendIpConfiguration <PSResourceId[]>
-BackendAddressPool <PSBackendAddressPool>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-AzLoadBalancerOutboundRuleConfig
-Name <String>
[-AllocatedOutboundPort <Int32>]
-Protocol <String>
[-EnableTcpReset]
[-IdleTimeoutInMinutes <Int32>]
-FrontendIpConfiguration <PSResourceId[]>
-BackendAddressPoolId <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The New-AzLoadBalancerOutboundRuleConfig cmdlet creates an outbound rule configuration for an Azure load balancer.
Examples
Example 1: Create an outbound rule configuration for a load balancer
$publicip = New-AzPublicIpAddress -ResourceGroupName "MyResourceGroup" -Name "MyPublicIP" -Location "West US" -AllocationMethod "Dynamic" -Sku "Standard"
$frontend = New-AzLoadBalancerFrontendIpConfig -Name "FrontendIpConfig01" -PublicIpAddress $publicip
$backend = New-AzLoadBalancerBackendAddressPoolConfig -Name "BackendAddressPool01"
New-AzLoadBalancerOutboundRuleConfig -Name "MyOutboundRule" -Protocol "Tcp" -FrontendIPConfiguration $frontend -BackendAddressPool $backendThe first command creates a public IP address named MyPublicIP in the resource group named MyResourceGroup, and then stores it in the $publicip variable. The second command creates a front-end IP configuration named FrontendIpConfig01 using the public IP address in $publicip, and then stores it in the $frontend variable. The third command creates a back-end address pool configuration named BackendAddressPool01, and then stores it in the $backend variable. The fourth command creates an outbound rule configuration named MyOutboundRule using the front-end and back-end objects in $frontend and $backend. The Protocol, FrontendIPConfiguration, and BackendAddressPool parameters are all required to create an outbound rule configuration.
Example 2
Creates an outbound rule configuration for a load balancer. (autogenerated)
New-AzLoadBalancerOutboundRuleConfig -BackendAddressPool <PSBackendAddressPool> -EnableTcpReset -FrontendIpConfiguration <PSResourceId[]> -Name 'MyOutboundRule' -Protocol 'Tcp'Parameters
-AllocatedOutboundPort
The number of outbound ports to be used for NAT.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-BackendAddressPool
A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs.
| Type: | PSBackendAddressPool |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-BackendAddressPoolId
A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EnableTcpReset
Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FrontendIpConfiguration
The Frontend IP addresses of the load balancer.
| Type: | PSResourceId[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-IdleTimeoutInMinutes
The timeout for the TCP idle connection
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Name of the outbound rule.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Protocol
Protocol - TCP, UDP or All
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |