Set-AzApplicationGatewayFrontendIPConfig

Module:

Az.Network Module

Modifies a front-end IP address configuration.

Syntax

SetByResourceId

Set-AzApplicationGatewayFrontendIPConfig
    -ApplicationGateway <PSApplicationGateway>
    -Name <String>
    [-PrivateIPAddress <String>]
    [-SubnetId <String>]
    [-PublicIPAddressId <String>]
    [-PrivateLinkConfigurationId <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

SetByResource

Set-AzApplicationGatewayFrontendIPConfig
    -ApplicationGateway <PSApplicationGateway>
    -Name <String>
    [-PrivateIPAddress <String>]
    [-Subnet <PSSubnet>]
    [-PublicIPAddress <PSPublicIpAddress>]
    [-PrivateLinkConfiguration <PSApplicationGatewayPrivateLinkConfiguration>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Set-AzApplicationGatewayFrontendIPConfig cmdlet updates a front-end IP configuration. An application gateway supports two types of front-end IP addresses:

• Public IP addresses
• Private IP addresses for which the configuration uses Internal Load Balancing (ILB) An application gateway can have at most one public IP address and one private IP address. A public IP address and a private IP address should be added separately as front-end IP addresses.

Examples

Example 1: Set a public IP as front-end IP of an application gateway

$PublicIp = New-AzPublicIpAddress -ResourceGroupName "ResourceGroup01" -Name "PublicIp01" -location "West US" -AllocationMethod Dynamic
$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01"
$AppGw = Set-AzApplicationGatewayFrontendIPConfig -ApplicationGateway $AppGw -Name "FrontEndIp01" -PublicIPAddress $PublicIp

The first command creates a public IP address object and stores it in the $PublicIp variable. The second command gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01, and stores it in the $AppGw variable. The third command updates the front-end IP configuration named FrontEndIp01, for the gateway in $AppGw, using the address stored in $PublicIp.

Example 2: Set a static private IP as the front-end IP of an application gateway

$VNet = Get-AzVirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01"
$Subnet = Get-AzVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $VNet
$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01"
$AppGw = Set-AzApplicationGatewayFrontendIPConfig -ApplicationGateway $AppGw -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 gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01, and stores it in the $AppGw variable. The fourth command adds a front-end IP configuration named FrontendIP02 using $Subnet from the second command and the private IP address 10.0.1.1.

Example 3: Set a dynamic private IP as the front-end IP of an application gateway

$VNet = Get-AzVirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01"
$Subnet = Get-AzVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $VNet
$AppGw = Get-AzApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01"
$AppGw = Set-AzApplicationGatewayFrontendIPConfig -ApplicationGateway $AppGw -Name "FrontendIP02" -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 gets the application gateway named ApplicationGateway01 that belongs to the resource group named ResourceGroup01, and stores it in the $AppGw variable. The fourth command adds a front-end IP configuration named FrontendIP02 using $Subnet from the second command.

Parameters

-ApplicationGateway

Specifies an application gateway object in which to modify the front-end IP configuration.

Parameter properties

Type:	PSApplicationGateway
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
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

-Name

Specifies the name of the front-end IP configuration that this cmdlet modifies.

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. If specified, this IP is statically allocated from the subnet.

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

-PrivateLinkConfiguration

PrivateLinkConfiguration

Parameter properties

Type:	PSApplicationGatewayPrivateLinkConfiguration
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SetByResource

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-PrivateLinkConfigurationId

PrivateLinkConfigurationId

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SetByResourceId

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-PublicIPAddress

Specifies the public IP address.

Parameter properties

Type:	PSPublicIpAddress
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SetByResource

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-PublicIPAddressId

Specifies the ID of the public IP address.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SetByResourceId

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Subnet

Specifies the subnet that the application gateway uses. Specify this parameter if the gateway uses a private IP address. If the PrivateIPAddress address is specified, it should belong to this 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.

Parameter properties

Type:	PSSubnet
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SetByResource

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-SubnetId

Specifies the subnet ID. Specify this parameter if the gateway uses a private IP address. If the PrivateIPAddress parameter is specified, it should belong to this 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.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SetByResourceId

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
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.

Inputs

PSApplicationGateway

Outputs

PSApplicationGateway

Related Links

• Add-AzApplicationGatewayFrontendIPConfig
• Add-AzApplicationGatewayFrontendIPConfig
• Get-AzApplicationGatewayFrontendIPConfig
• New-AzApplicationGatewayFrontendIPConfig
• Remove-AzApplicationGatewayFrontendIPConfig