< Back
Set-AzureRmApplicationGatewayFrontendIPConfig
Post
NAME Set-AzureRmApplicationGatewayFrontendIPConfig
SYNOPSIS
Modifies a front-end IP address configuration.
SYNTAX
Set-AzureRmApplicationGatewayFrontendIPConfig -ApplicationGateway <PSApplicationGateway> [-DefaultProfile <IAzureContextContainer>] -Name <String>
[-PrivateIPAddress <String>] [-PublicIPAddress <PSPublicIpAddress>] [-Subnet <PSSubnet>] [<CommonParameters>]
Set-AzureRmApplicationGatewayFrontendIPConfig -ApplicationGateway <PSApplicationGateway> [-DefaultProfile <IAzureContextContainer>] -Name <String>
[-PrivateIPAddress <String>] [-PublicIPAddressId <String>] [-SubnetId <String>] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmApplicationGatewayFrontendIPConfig 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.
PARAMETERS
-ApplicationGateway <PSApplicationGateway>
Specifies an application gateway object in which to modify the front-end IP configuration.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the front-end IP configuration that this cmdlet modifies.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PrivateIPAddress <String>
Specifies the private IP address. If specified, this IP is statically allocated from the subnet.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PublicIPAddress <PSPublicIpAddress>
Specifies the public IP address.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PublicIPAddressId <String>
Specifies the ID of the public IP address.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Subnet <PSSubnet>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SubnetId <String>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
OUTPUTS
Microsoft.Azure.Commands.Network.Models.PSApplicationGateway
NOTES
Example 1: Set a public IP as front-end IP of an application gateway
PS C:\\>$PublicIp = New-AzureRmPublicIpAddress -ResourceGroupName "ResourceGroup01" -Name "PublicIp01" -location "West US" -AllocationMethod Dynamic
PS C:\\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01"
PS C:\\> $AppGw = Set-AzureRmApplicationGatewayFrontendIPConfig -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
PS C:\\>$VNet = Get-AzureRmvirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01"
PS C:\\> $Subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $VNet
PS C:\\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01"
PS C:\\> $AppGw = Set-AzureRmApplicationGatewayFrontendIPConfig -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
PS C:\\>$VNet = Get-AzureRmvirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01"
PS C:\\> $Subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $VNet
PS C:\\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01"
PS C:\\> $AppGw = Set-AzureRmApplicationGatewayFrontendIPConfig -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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ndipconfig
Add-AzureRmApplicationGatewayFrontendIPConfig
Add-AzureRmApplicationGatewayFrontendIPConfig
Get-AzureRmApplicationGatewayFrontendIPConfig
New-AzureRmApplicationGatewayFrontendIPConfig
Remove-AzureRmApplicationGatewayFrontendIPConfig
SYNOPSIS
Modifies a front-end IP address configuration.
SYNTAX
Set-AzureRmApplicationGatewayFrontendIPConfig -ApplicationGateway <PSApplicationGateway> [-DefaultProfile <IAzureContextContainer>] -Name <String>
[-PrivateIPAddress <String>] [-PublicIPAddress <PSPublicIpAddress>] [-Subnet <PSSubnet>] [<CommonParameters>]
Set-AzureRmApplicationGatewayFrontendIPConfig -ApplicationGateway <PSApplicationGateway> [-DefaultProfile <IAzureContextContainer>] -Name <String>
[-PrivateIPAddress <String>] [-PublicIPAddressId <String>] [-SubnetId <String>] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmApplicationGatewayFrontendIPConfig 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.
PARAMETERS
-ApplicationGateway <PSApplicationGateway>
Specifies an application gateway object in which to modify the front-end IP configuration.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the front-end IP configuration that this cmdlet modifies.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PrivateIPAddress <String>
Specifies the private IP address. If specified, this IP is statically allocated from the subnet.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PublicIPAddress <PSPublicIpAddress>
Specifies the public IP address.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PublicIPAddressId <String>
Specifies the ID of the public IP address.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Subnet <PSSubnet>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SubnetId <String>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
OUTPUTS
Microsoft.Azure.Commands.Network.Models.PSApplicationGateway
NOTES
Example 1: Set a public IP as front-end IP of an application gateway
PS C:\\>$PublicIp = New-AzureRmPublicIpAddress -ResourceGroupName "ResourceGroup01" -Name "PublicIp01" -location "West US" -AllocationMethod Dynamic
PS C:\\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01"
PS C:\\> $AppGw = Set-AzureRmApplicationGatewayFrontendIPConfig -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
PS C:\\>$VNet = Get-AzureRmvirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01"
PS C:\\> $Subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $VNet
PS C:\\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01"
PS C:\\> $AppGw = Set-AzureRmApplicationGatewayFrontendIPConfig -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
PS C:\\>$VNet = Get-AzureRmvirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01"
PS C:\\> $Subnet = Get-AzureRmVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $VNet
PS C:\\> $AppGw = Get-AzureRmApplicationGateway -Name "ApplicationGateway01" -ResourceGroupName "ResourceGroup01"
PS C:\\> $AppGw = Set-AzureRmApplicationGatewayFrontendIPConfig -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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ndipconfig
Add-AzureRmApplicationGatewayFrontendIPConfig
Add-AzureRmApplicationGatewayFrontendIPConfig
Get-AzureRmApplicationGatewayFrontendIPConfig
New-AzureRmApplicationGatewayFrontendIPConfig
Remove-AzureRmApplicationGatewayFrontendIPConfig