Edit

Share via

New-AzApplicationGatewayFrontendIPConfig

  • Reference
Module:
Az.Network

Creates a front-end IP configuration for an application gateway.

Syntax

PowerShell 
New-AzApplicationGatewayFrontendIPConfig
   -Name <String>
   [-PrivateIPAddress <String>]
   [-SubnetId <String>]
   [-PublicIPAddressId <String>]
   [-PrivateLinkConfigurationId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
PowerShell 
New-AzApplicationGatewayFrontendIPConfig
   -Name <String>
   [-PrivateIPAddress <String>]
   [-Subnet <PSSubnet>]
   [-PublicIPAddress <PSPublicIpAddress>]
   [-PrivateLinkConfiguration <PSApplicationGatewayPrivateLinkConfiguration>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The New-AzApplicationGatewayFrontendIPConfig cmdlet creates a front-end IP configuration for an Azure application gateway. An application gateway supports two types of front-end IP configuration:

  • Public IP addresses -- Private IP addresses using internal load balancing (ILB). An application gateway can have at most one public IP address and one private IP address. The public IP address and private IP address should be added separately as front-end IP addresses.

Examples

Example 1: Create a front-end IP configuration using a public IP resource object

PowerShell 
$PublicIP = New-AzPublicIpAddress -ResourceGroupName "ResourceGroup01" -Name "PublicIP01" -location "West US" -AllocationMethod Dynamic
$FrontEnd = New-AzApplicationGatewayFrontendIPConfig -Name "FrontEndIP01" -PublicIPAddress $PublicIP

The first command creates a public IP resource object and stores it in the $PublicIP variable. The second command uses $PublicIP to create a new front-end IP configuration named FrontEndIP01 and stores it in the $FrontEnd variable.

Example 2: Create a static private IP as the front-end IP address

PowerShell 
$VNet = Get-AzVirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01"
$Subnet = Get-AzVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $VNet
$FrontEnd = New-AzApplicationGatewayFrontendIPConfig -Name "FrontendIP02" -Subnet $Subnet -PrivateIPAddress 10.0.1.1

The first command gets a virtual network named VNet01 that belongs to the resource group named ResourceGroup01, and stores it in the $VNet variable. The second command gets a subnet configuration named Subnet01 using $VNet from the first command and stores it in the $Subnet variable. The third command creates a front-end IP configuration named FrontEndIP02 using $Subnet from the second command and the private IP address 10.0.1.1, and then stores it in the $FrontEnd variable.

Example 3: Create a dynamic private IP as the front-end IP address

PowerShell 
$VNet = Get-AzVirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01"
$Subnet = Get-AzVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $VNet
$FrontEnd = New-AzApplicationGatewayFrontendIPConfig -Name "FrontendIP03" -Subnet $Subnet

The first command gets a virtual network named VNet01 that belongs to the resource group named ResourceGroup01, and stores it in the $VNet variable. The second command gets a subnet configuration named Subnet01 using $VNet from the first command and stores it in the $Subnet variable. The third command creates a front-end IP configuration named FrontEndIP03 using $Subnet from the second command, and stores it in the $FrontEnd variable.

Parameters

-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

-Name

Specifies the name of 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 which this cmdlet associates with the front-end IP address of the application gateway. This can be specified only if a subnet is specified. This IP is statically allocated from the subnet.

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

-PrivateLinkConfiguration

PrivateLinkConfiguration

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

-PrivateLinkConfigurationId

PrivateLinkConfigurationId

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

-PublicIPAddress

Specifies the public IP address object which this cmdlet associates with the front-end IP address of the application gateway.

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

-PublicIPAddressId

Specifies the public IP address ID which this cmdlet associates with the front-end IP of the application gateway.

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

-Subnet

Specifies the subnet object which this cmdlet associates with the front-end IP address of the application gateway. If you specify this parameter, it implies that the gateway uses a private IP address. If the PrivateIPAddress parameter is specified, it should belong to the subnet specified by this parameter. If PrivateIPAddress is not specified, one of the IP addresses from this subnet is dynamically picked up as the front-end IP address of the application gateway.

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

-SubnetId

Specifies the subnet ID which this cmdlet associates with the front-end IP configuration of the application gateway. If you specify the Subnet parameter, it implies that the gateway uses a private IP address. If the PrivateIPAddress parameter is specified, it should belong to the subnet specified by Subnet. If PrivateIPAddress is not specified, one of the IP addresses from this subnet is dynamically picked up as the front-end IP address of the application gateway.

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

Inputs

None

Outputs