New-AzLoadBalancerFrontendIpConfig
Creates a front-end IP configuration for a load balancer.
Syntax
SetByResourceSubnet (Default)
New-AzLoadBalancerFrontendIpConfig
-Name <String>
-Subnet <PSSubnet>
[-PrivateIpAddress <String>]
[-PrivateIpAddressVersion <String>]
[-Zone <String[]>]
[-DdosCustomPolicyId <String>]
[-EnableConnectionTracking]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-AcquirePolicyToken]
[-ChangeReference <String>]
[<CommonParameters>]
SetByResourceIdSubnet
New-AzLoadBalancerFrontendIpConfig
-Name <String>
-SubnetId <String>
[-PrivateIpAddress <String>]
[-PrivateIpAddressVersion <String>]
[-Zone <String[]>]
[-DdosCustomPolicyId <String>]
[-EnableConnectionTracking]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-AcquirePolicyToken]
[-ChangeReference <String>]
[<CommonParameters>]
SetByResourceIdPublicIpAddress
New-AzLoadBalancerFrontendIpConfig
-Name <String>
-PublicIpAddressId <String>
[-Zone <String[]>]
[-DdosCustomPolicyId <String>]
[-EnableConnectionTracking]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-AcquirePolicyToken]
[-ChangeReference <String>]
[<CommonParameters>]
SetByResourcePublicIpAddress
New-AzLoadBalancerFrontendIpConfig
-Name <String>
-PublicIpAddress <PSPublicIpAddress>
[-Zone <String[]>]
[-DdosCustomPolicyId <String>]
[-EnableConnectionTracking]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-AcquirePolicyToken]
[-ChangeReference <String>]
[<CommonParameters>]
SetByResourceIdPublicIpAddressPrefix
New-AzLoadBalancerFrontendIpConfig
-Name <String>
-PublicIpAddressPrefixId <String>
[-Zone <String[]>]
[-DdosCustomPolicyId <String>]
[-EnableConnectionTracking]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-AcquirePolicyToken]
[-ChangeReference <String>]
[<CommonParameters>]
SetByResourcePublicIpAddressPrefix
New-AzLoadBalancerFrontendIpConfig
-Name <String>
-PublicIpAddressPrefix <PSPublicIpPrefix>
[-Zone <String[]>]
[-DdosCustomPolicyId <String>]
[-EnableConnectionTracking]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-AcquirePolicyToken]
[-ChangeReference <String>]
[<CommonParameters>]
Description
The New-AzLoadBalancerFrontendIpConfig cmdlet creates a front-end IP configuration for an Azure load balancer.
Examples
Example 1: Create a front-end IP configuration for a load balancer
$publicip = New-AzPublicIpAddress -ResourceGroupName "MyResourceGroup" -Name "MyPublicIP" -Location "West US" -AllocationMethod "Dynamic"
New-AzLoadBalancerFrontendIpConfig -Name "FrontendIpConfig01" -PublicIpAddress $publicip
The first command creates a dynamic 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.
Example 2: Create a front-end IP configuration for a load balancer using ip prefix
$publicipprefix = New-AzPublicIpPrefix -ResourceGroupName "MyResourceGroup" -name "MyPublicIPPrefix" -location "West US" -Sku Standard -PrefixLength 28
$frontend = New-AzLoadBalancerFrontendIpConfig -Name "FrontendIpConfig01" -PublicIpAddressPrefix $publicipprefix
The first command creates a public ip prefix named MyPublicIP of length 28 in the resource group named MyResourceGroup, and then stores it in the $publicipprefix variable.
The second command creates a front-end IP configuration named FrontendIpConfig01 using the public IP prefix in $publicipprefix.
Parameters
-AcquirePolicyToken
Acquire an Azure Policy token automatically for this resource operation.
Parameter properties
Type: SwitchParameter
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
-ChangeReference
The change reference resource ID for this resource operation.
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
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None
Supports wildcards: False
DontShow: False
Aliases: cf
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-DdosCustomPolicyId
The DDoS custom policy resource ID to associate with the frontend IP 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: True
Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
Parameter properties
Type: IAzureContextContainer
Default value: None
Supports wildcards: False
DontShow: False
Aliases: AzContext, AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-EnableConnectionTracking
Enables UDP flow tracking for traffic associated with the frontend IP configuration. When enabled, packets belonging to the same UDP flow are consistently directed to the same backend instance. This setting applies to all associated load balancing rules and takes precedence over rule-level connection tracking settings.
Parameter properties
Type: SwitchParameter
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: True
Value from remaining arguments: False
-Name
Specifies the front-end IP configuration that this cmdlet creates.
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
-PrivateIpAddress
Specifies the private IP address of the load balancer.
Specify this parameter only if you also specify the Subnet parameter.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
SetByResourceSubnet
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
SetByResourceIdSubnet
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
-PrivateIpAddressVersion
The private IP address version of the IP configuration.
Parameter properties
Type: String
Default value: None
Accepted values: IPv4, IPv6
Supports wildcards: False
DontShow: False
Parameter sets
SetByResourceSubnet
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
SetByResourceIdSubnet
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
-PublicIpAddress
Specifies the PublicIpAddress object to associate with a front-end IP configuration.
Parameter properties
Parameter sets
SetByResourcePublicIpAddress
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
-PublicIpAddressId
Specifies the ID of the PublicIpAddress object to associate with a front-end IP configuration.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
SetByResourceIdPublicIpAddress
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
-PublicIpAddressPrefix
Specifies the PublicIpAddressPrefix object to associate with a front-end IP configuration.
Parameter properties
Type: PSPublicIpPrefix
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
SetByResourcePublicIpAddressPrefix
Position: Named
Mandatory: True
Value from pipeline: True
Value from pipeline by property name: True
Value from remaining arguments: False
-PublicIpAddressPrefixId
Specifies the ID of the PublicIpAddressPrefix object to associate with a front-end IP configuration.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
SetByResourceIdPublicIpAddressPrefix
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
-Subnet
Specifies the Subnet object in which to create a front-end IP configuration.
Parameter properties
Type: PSSubnet
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
SetByResourceSubnet
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
-SubnetId
Specifies the ID of the subnet in which to create a front-end IP configuration.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
SetByResourceIdSubnet
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: True
Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None
Supports wildcards: False
DontShow: False
Aliases: wi
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-Zone
A list of availability zones denoting the IP allocated for the resource needs to come from.
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: True
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 .
Outputs