Edit

Share via

New-AzureRmLoadBalancerFrontendIpConfig

  • Reference
Module:
AzureRM.Network

Creates a front-end IP configuration for a load balancer.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

New-AzureRmLoadBalancerFrontendIpConfig
   -Name <String>
   [-PrivateIpAddress <String>]
   [-Zone <System.Collections.Generic.List`1[System.String]>]
   -Subnet <PSSubnet>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzureRmLoadBalancerFrontendIpConfig
   -Name <String>
   [-PrivateIpAddress <String>]
   [-Zone <System.Collections.Generic.List`1[System.String]>]
   -SubnetId <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzureRmLoadBalancerFrontendIpConfig
   -Name <String>
   [-Zone <System.Collections.Generic.List`1[System.String]>]
   -PublicIpAddressId <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzureRmLoadBalancerFrontendIpConfig
   -Name <String>
   [-Zone <System.Collections.Generic.List`1[System.String]>]
   -PublicIpAddress <PSPublicIpAddress>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-AzureRmLoadBalancerFrontendIpConfig 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

PS C:\>$publicip = New-AzureRmPublicIpAddress -ResourceGroupName "MyResourceGroup" -Name "MyPublicIP" -Location "West US" -AllocationMethod "Dynamic"
PS C:\> New-AzureRmLoadBalancerFrontendIpConfig -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.

Parameters

-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:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies the front-end IP configuration that this cmdlet creates.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-PrivateIpAddress

Specifies the private IP address of the load balancer. Specify this parameter only if you also specify the Subnet parameter.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-PublicIpAddress

Specifies the PublicIpAddress object to associate with a front-end IP configuration.

Type:PSPublicIpAddress
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PublicIpAddressId

Specifies the ID of the PublicIpAddress object to associate with a front-end IP configuration.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Subnet

Specifies the Subnet object in which to create a front-end IP configuration.

Type:PSSubnet
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-SubnetId

Specifies the ID of the subnet in which to create a front-end IP configuration.

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

-Zone

A list of availability zones denoting the IP allocated for the resource needs to come from.

Type:List<T>[String]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

Inputs

System.Collections.Generic.List\`1[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

Outputs

PSFrontendIPConfiguration