Edit

Share via

New-AzApplicationGateway

Module:
Az.Network Module

Creates an application gateway.

Syntax

IdentityByUserAssignedIdentityId (Default) 

New-AzApplicationGateway
    -Name <String>
    -ResourceGroupName <String>
    -Location <String>
    -Sku <PSApplicationGatewaySku>
    -GatewayIPConfigurations <PSApplicationGatewayIPConfiguration[]>
    -FrontendPorts <PSApplicationGatewayFrontendPort[]>
    -BackendAddressPools <PSApplicationGatewayBackendAddressPool[]>
    [-SslPolicy <PSApplicationGatewaySslPolicy>]
    [-SslCertificates <PSApplicationGatewaySslCertificate[]>]
    [-AuthenticationCertificates <PSApplicationGatewayAuthenticationCertificate[]>]
    [-TrustedRootCertificate <PSApplicationGatewayTrustedRootCertificate[]>]
    [-TrustedClientCertificates <PSApplicationGatewayTrustedClientCertificate[]>]
    [-FrontendIPConfigurations <PSApplicationGatewayFrontendIPConfiguration[]>]
    [-Probes <PSApplicationGatewayProbe[]>]
    [-BackendHttpSettingsCollection <PSApplicationGatewayBackendHttpSettings[]>]
    [-BackendSettingsCollection <PSApplicationGatewayBackendSettings[]>]
    [-SslProfiles <PSApplicationGatewaySslProfile[]>]
    [-HttpListeners <PSApplicationGatewayHttpListener[]>]
    [-Listeners <PSApplicationGatewayListener[]>]
    [-UrlPathMaps <PSApplicationGatewayUrlPathMap[]>]
    [-RequestRoutingRules <PSApplicationGatewayRequestRoutingRule[]>]
    [-RoutingRules <PSApplicationGatewayRoutingRule[]>]
    [-RewriteRuleSet <PSApplicationGatewayRewriteRuleSet[]>]
    [-RedirectConfigurations <PSApplicationGatewayRedirectConfiguration[]>]
    [-WebApplicationFirewallConfiguration <PSApplicationGatewayWebApplicationFirewallConfiguration>]
    [-AutoscaleConfiguration <PSApplicationGatewayAutoscaleConfiguration>]
    [-EnableHttp2]
    [-EnableFIPS]
    [-EnableRequestBuffering <Boolean>]
    [-EnableResponseBuffering <Boolean>]
    [-ForceFirewallPolicyAssociation]
    [-Zone <String[]>]
    [-Tag <Hashtable>]
    [-UserAssignedIdentityId <String>]
    [-Force]
    [-AsJob]
    [-CustomErrorConfiguration <PSApplicationGatewayCustomError[]>]
    [-PrivateLinkConfiguration <PSApplicationGatewayPrivateLinkConfiguration[]>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetByResourceId 

New-AzApplicationGateway
    -Name <String>
    -ResourceGroupName <String>
    -Location <String>
    -Sku <PSApplicationGatewaySku>
    -GatewayIPConfigurations <PSApplicationGatewayIPConfiguration[]>
    -FrontendPorts <PSApplicationGatewayFrontendPort[]>
    -BackendAddressPools <PSApplicationGatewayBackendAddressPool[]>
    [-SslPolicy <PSApplicationGatewaySslPolicy>]
    [-SslCertificates <PSApplicationGatewaySslCertificate[]>]
    [-AuthenticationCertificates <PSApplicationGatewayAuthenticationCertificate[]>]
    [-TrustedRootCertificate <PSApplicationGatewayTrustedRootCertificate[]>]
    [-TrustedClientCertificates <PSApplicationGatewayTrustedClientCertificate[]>]
    [-FrontendIPConfigurations <PSApplicationGatewayFrontendIPConfiguration[]>]
    [-Probes <PSApplicationGatewayProbe[]>]
    [-BackendHttpSettingsCollection <PSApplicationGatewayBackendHttpSettings[]>]
    [-BackendSettingsCollection <PSApplicationGatewayBackendSettings[]>]
    [-SslProfiles <PSApplicationGatewaySslProfile[]>]
    [-HttpListeners <PSApplicationGatewayHttpListener[]>]
    [-Listeners <PSApplicationGatewayListener[]>]
    [-UrlPathMaps <PSApplicationGatewayUrlPathMap[]>]
    [-RequestRoutingRules <PSApplicationGatewayRequestRoutingRule[]>]
    [-RoutingRules <PSApplicationGatewayRoutingRule[]>]
    [-RewriteRuleSet <PSApplicationGatewayRewriteRuleSet[]>]
    [-RedirectConfigurations <PSApplicationGatewayRedirectConfiguration[]>]
    [-WebApplicationFirewallConfiguration <PSApplicationGatewayWebApplicationFirewallConfiguration>]
    [-FirewallPolicyId <String>]
    [-AutoscaleConfiguration <PSApplicationGatewayAutoscaleConfiguration>]
    [-EnableHttp2]
    [-EnableFIPS]
    [-EnableRequestBuffering <Boolean>]
    [-EnableResponseBuffering <Boolean>]
    [-ForceFirewallPolicyAssociation]
    [-Zone <String[]>]
    [-Tag <Hashtable>]
    [-Force]
    [-AsJob]
    [-CustomErrorConfiguration <PSApplicationGatewayCustomError[]>]
    [-PrivateLinkConfiguration <PSApplicationGatewayPrivateLinkConfiguration[]>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetByResource 

New-AzApplicationGateway
    -Name <String>
    -ResourceGroupName <String>
    -Location <String>
    -Sku <PSApplicationGatewaySku>
    -GatewayIPConfigurations <PSApplicationGatewayIPConfiguration[]>
    -FrontendPorts <PSApplicationGatewayFrontendPort[]>
    -BackendAddressPools <PSApplicationGatewayBackendAddressPool[]>
    [-SslPolicy <PSApplicationGatewaySslPolicy>]
    [-SslCertificates <PSApplicationGatewaySslCertificate[]>]
    [-AuthenticationCertificates <PSApplicationGatewayAuthenticationCertificate[]>]
    [-TrustedRootCertificate <PSApplicationGatewayTrustedRootCertificate[]>]
    [-TrustedClientCertificates <PSApplicationGatewayTrustedClientCertificate[]>]
    [-FrontendIPConfigurations <PSApplicationGatewayFrontendIPConfiguration[]>]
    [-Probes <PSApplicationGatewayProbe[]>]
    [-BackendHttpSettingsCollection <PSApplicationGatewayBackendHttpSettings[]>]
    [-BackendSettingsCollection <PSApplicationGatewayBackendSettings[]>]
    [-SslProfiles <PSApplicationGatewaySslProfile[]>]
    [-HttpListeners <PSApplicationGatewayHttpListener[]>]
    [-Listeners <PSApplicationGatewayListener[]>]
    [-UrlPathMaps <PSApplicationGatewayUrlPathMap[]>]
    [-RequestRoutingRules <PSApplicationGatewayRequestRoutingRule[]>]
    [-RoutingRules <PSApplicationGatewayRoutingRule[]>]
    [-RewriteRuleSet <PSApplicationGatewayRewriteRuleSet[]>]
    [-RedirectConfigurations <PSApplicationGatewayRedirectConfiguration[]>]
    [-WebApplicationFirewallConfiguration <PSApplicationGatewayWebApplicationFirewallConfiguration>]
    [-FirewallPolicy <PSApplicationGatewayWebApplicationFirewallPolicy>]
    [-AutoscaleConfiguration <PSApplicationGatewayAutoscaleConfiguration>]
    [-EnableHttp2]
    [-EnableFIPS]
    [-EnableRequestBuffering <Boolean>]
    [-EnableResponseBuffering <Boolean>]
    [-ForceFirewallPolicyAssociation]
    [-Zone <String[]>]
    [-Tag <Hashtable>]
    [-Force]
    [-AsJob]
    [-CustomErrorConfiguration <PSApplicationGatewayCustomError[]>]
    [-PrivateLinkConfiguration <PSApplicationGatewayPrivateLinkConfiguration[]>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

IdentityByIdentityObject 

New-AzApplicationGateway
    -Name <String>
    -ResourceGroupName <String>
    -Location <String>
    -Sku <PSApplicationGatewaySku>
    -GatewayIPConfigurations <PSApplicationGatewayIPConfiguration[]>
    -FrontendPorts <PSApplicationGatewayFrontendPort[]>
    -BackendAddressPools <PSApplicationGatewayBackendAddressPool[]>
    -Identity <PSManagedServiceIdentity>
    [-SslPolicy <PSApplicationGatewaySslPolicy>]
    [-SslCertificates <PSApplicationGatewaySslCertificate[]>]
    [-AuthenticationCertificates <PSApplicationGatewayAuthenticationCertificate[]>]
    [-TrustedRootCertificate <PSApplicationGatewayTrustedRootCertificate[]>]
    [-TrustedClientCertificates <PSApplicationGatewayTrustedClientCertificate[]>]
    [-FrontendIPConfigurations <PSApplicationGatewayFrontendIPConfiguration[]>]
    [-Probes <PSApplicationGatewayProbe[]>]
    [-BackendHttpSettingsCollection <PSApplicationGatewayBackendHttpSettings[]>]
    [-BackendSettingsCollection <PSApplicationGatewayBackendSettings[]>]
    [-SslProfiles <PSApplicationGatewaySslProfile[]>]
    [-HttpListeners <PSApplicationGatewayHttpListener[]>]
    [-Listeners <PSApplicationGatewayListener[]>]
    [-UrlPathMaps <PSApplicationGatewayUrlPathMap[]>]
    [-RequestRoutingRules <PSApplicationGatewayRequestRoutingRule[]>]
    [-RoutingRules <PSApplicationGatewayRoutingRule[]>]
    [-RewriteRuleSet <PSApplicationGatewayRewriteRuleSet[]>]
    [-RedirectConfigurations <PSApplicationGatewayRedirectConfiguration[]>]
    [-WebApplicationFirewallConfiguration <PSApplicationGatewayWebApplicationFirewallConfiguration>]
    [-AutoscaleConfiguration <PSApplicationGatewayAutoscaleConfiguration>]
    [-EnableHttp2]
    [-EnableFIPS]
    [-EnableRequestBuffering <Boolean>]
    [-EnableResponseBuffering <Boolean>]
    [-ForceFirewallPolicyAssociation]
    [-Zone <String[]>]
    [-Tag <Hashtable>]
    [-Force]
    [-AsJob]
    [-CustomErrorConfiguration <PSApplicationGatewayCustomError[]>]
    [-PrivateLinkConfiguration <PSApplicationGatewayPrivateLinkConfiguration[]>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The New-AzApplicationGateway cmdlet creates an Azure application gateway. An application gateway requires the following:

  • A resource group.
  • A virtual network.
  • A back-end server pool, containing the IP addresses of the back-end servers.
  • Back-end server pool settings. Each pool has settings such as port, protocol and cookie-based affinity, that are applied to all servers within the pool.
  • Front-end IP addresses, which are the IP addresses opened on the application gateway. A front-end IP address can be a public IP address or an internal IP address.
  • Front-end ports, which are the public ports opened on the application gateway. Traffic that hits these ports is redirected to the back-end servers.
  • A request routing rule that binds the listener and the back-end server pool. The rule defines which back-end server pool the traffic should be directed to when it hits a particular listener. A listener has a front-end port, front-end IP address, protocol (HTTP or HTTPS) and Secure Sockets Layer (SSL) certificate name (if configuring SSL offload).

Note

There is a limitation that does not allow users to deploy a V2 application gateway that utilizes customer key vault for certificate storage and has a WAF policy associated to it. In the four parameter sets provided by the New-AzApplicationGateway cmdlet, the -Identity switch never coincides with the -FirewallPolicy or -FirewallPolicyID switch. Therefore, this cannot be done in one operation. The workaround is to have this done in multiple operations. Users must deploy a standard V2 Application Gateway with the managed identity, then change the sku to WAF_v2 and add the WAF policy.

Examples

Example 1: Create an application gateway

$ResourceGroup = New-AzResourceGroup -Name "ResourceGroup01" -Location "West US" -Tag @{Name = "Department"; Value = "Marketing"}
$Subnet = New-AzVirtualNetworkSubnetConfig -Name "Subnet01" -AddressPrefix 10.0.0.0/24
$VNet = New-AzVirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01" -Location "West US" -AddressPrefix 10.0.0.0/16 -Subnet $Subnet
$VNet = Get-AzVirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01"
$Subnet = Get-AzVirtualNetworkSubnetConfig -Name "Subnet01" -VirtualNetwork $VNet
$GatewayIPconfig = New-AzApplicationGatewayIPConfiguration -Name "GatewayIp01" -Subnet $Subnet
$Pool = New-AzApplicationGatewayBackendAddressPool -Name "Pool01" -BackendIPAddresses 10.10.10.1, 10.10.10.2, 10.10.10.3
$PoolSetting = New-AzApplicationGatewayBackendHttpSetting -Name "PoolSetting01"  -Port 80 -Protocol "Http" -CookieBasedAffinity "Disabled"
$FrontEndPort = New-AzApplicationGatewayFrontendPort -Name "FrontEndPort01"  -Port 80
# Create a public IP address
$PublicIp = New-AzPublicIpAddress -ResourceGroupName "ResourceGroup01" -Name "PublicIpName01" -Location "West US" -AllocationMethod "Dynamic"
$FrontEndIpConfig = New-AzApplicationGatewayFrontendIPConfig -Name "FrontEndConfig01" -PublicIPAddress $PublicIp
$Listener = New-AzApplicationGatewayHttpListener -Name "ListenerName01"  -Protocol "Http" -FrontendIpConfiguration $FrontEndIpConfig -FrontendPort $FrontEndPort
$Rule = New-AzApplicationGatewayRequestRoutingRule -Name "Rule01" -RuleType basic -BackendHttpSettings $PoolSetting -HttpListener $Listener -BackendAddressPool $Pool
$Sku = New-AzApplicationGatewaySku -Name "Standard_Small" -Tier Standard -Capacity 2
$Gateway = New-AzApplicationGateway -Name "AppGateway01" -ResourceGroupName "ResourceGroup01" -Location "West US" -BackendAddressPools $Pool -BackendHttpSettingsCollection $PoolSetting -FrontendIpConfigurations $FrontEndIpConfig  -GatewayIpConfigurations $GatewayIpConfig -FrontendPorts $FrontEndPort -HttpListeners $Listener -RequestRoutingRules $Rule -Sku $Sku

The following example creates an application gateway by first creating a resource group and a virtual network, as well as the following:

  • A back-end server pool
  • Back-end server pool settings
  • Front-end ports
  • Front-end IP addresses
  • A request routing rule These four commands create a virtual network. The first command creates a subnet configuration. The second command creates a virtual network. The third command verifies the subnet configuration and the fourth command verifies that the virtual network is created successfully. The following commands create the application gateway. The first command creates an IP configuration named GatewayIp01 for the subnet created previously. The second command creates a back-end server pool named Pool01 with a list of back-end IP addresses and stores the pool in the $Pool variable. The third command creates the settings for the back-end server pool and stores the settings in the $PoolSetting variable. The forth command creates a front-end port on port 80, names it FrontEndPort01, and stores the port in the $FrontEndPort variable. The fifth command creates a public IP address by using New-AzPublicIpAddress. The sixth command creates a front-end IP configuration using $PublicIp, names it FrontEndPortConfig01, and stores it in the $FrontEndIpConfig variable. The seventh command creates a listener using the previously created $FrontEndIpConfig $FrontEndPort. The eighth command creates a rule for the listener. The ninth command sets the SKU. The tenth command creates the gateway using the objects set by the previous commands.

Example 2: Create an application gateway with UserAssigned Identity

$ResourceGroup = New-AzResourceGroup -Name "ResourceGroup01" -Location "West US" -Tag @{Name = "Department"; Value = "Marketing"}
$Subnet = New-AzVirtualNetworkSubnetConfig -Name "Subnet01" -AddressPrefix 10.0.0.0/24
$VNet = New-AzVirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01" -Location "West US" -AddressPrefix 10.0.0.0/16 -Subnet $Subnet
$VNet = Get-AzVirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01"
$Subnet = Get-AzVirtualNetworkSubnetConfig -Name $Subnet01 -VirtualNetwork $VNet
$GatewayIPconfig = New-AzApplicationGatewayIPConfiguration -Name "GatewayIp01" -Subnet $Subnet
$Pool = New-AzApplicationGatewayBackendAddressPool -Name "Pool01" -BackendIPAddresses 10.10.10.1, 10.10.10.2, 10.10.10.3
$PoolSetting = New-AzApplicationGatewayBackendHttpSetting -Name "PoolSetting01"  -Port 80 -Protocol "Http" -CookieBasedAffinity "Disabled"
$FrontEndPort = New-AzApplicationGatewayFrontendPort -Name "FrontEndPort01"  -Port 80
# Create a public IP address
$PublicIp = New-AzPublicIpAddress -ResourceGroupName "ResourceGroup01" -Name "PublicIpName01" -Location "West US" -AllocationMethod "Dynamic"
$FrontEndIpConfig = New-AzApplicationGatewayFrontendIPConfig -Name "FrontEndConfig01" -PublicIPAddress $PublicIp
$Listener = New-AzApplicationGatewayHttpListener -Name "ListenerName01"  -Protocol "Http" -FrontendIpConfiguration $FrontEndIpConfig -FrontendPort $FrontEndPort
$Rule = New-AzApplicationGatewayRequestRoutingRule -Name "Rule01" -RuleType basic -BackendHttpSettings $PoolSetting -HttpListener $Listener -BackendAddressPool $Pool
$Sku = New-AzApplicationGatewaySku -Name "Standard_Small" -Tier Standard -Capacity 2
$Identity = New-AzUserAssignedIdentity -Name "Identity01" -ResourceGroupName "ResourceGroup01" -Location "West US"
$AppgwIdentity = New-AzApplicationGatewayIdentity -UserAssignedIdentity $Identity.Id
$Gateway = New-AzApplicationGateway -Name "AppGateway01" -ResourceGroupName "ResourceGroup01" -Location "West US" -Identity $AppgwIdentity -BackendAddressPools $Pool -BackendHttpSettingsCollection $PoolSetting -FrontendIpConfigurations $FrontEndIpConfig  -GatewayIpConfigurations $GatewayIpConfig -FrontendPorts $FrontEndPort -HttpListeners $Listener -RequestRoutingRules $Rule -Sku $Sku

Parameters

-AsJob

Run cmdlet in the background

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

-AuthenticationCertificates

Specifies authentication certificates for the application gateway.

Parameter properties

Type:

PSApplicationGatewayAuthenticationCertificate[]

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

-AutoscaleConfiguration

Autoscale Configuration

Parameter properties

Type:PSApplicationGatewayAutoscaleConfiguration
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

-BackendAddressPools

Specifies the list of back-end address pools for the application gateway.

Parameter properties

Type:

PSApplicationGatewayBackendAddressPool[]

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:True
Value from remaining arguments:False

-BackendHttpSettingsCollection

Specifies the list of back-end HTTP settings for the application gateway.

Parameter properties

Type:

PSApplicationGatewayBackendHttpSettings[]

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

-BackendSettingsCollection

The list of backend settings

Parameter properties

Type:

PSApplicationGatewayBackendSettings[]

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
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

-CustomErrorConfiguration

Customer error of an application gateway

Parameter properties

Type:

PSApplicationGatewayCustomError[]

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

-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

-EnableFIPS

Whether FIPS is enabled.

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

-EnableHttp2

Whether HTTP2 is enabled.

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

-EnableRequestBuffering

Whether Request Buffering is enabled.

Parameter properties

Type:

Nullable<T>[Boolean]

Default value:True
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

-EnableResponseBuffering

Whether Response Buffering is enabled.

Parameter properties

Type:

Nullable<T>[Boolean]

Default value:True
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

-FirewallPolicy

Firewall configuration

Parameter properties

Type:PSApplicationGatewayWebApplicationFirewallPolicy
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

-FirewallPolicyId

FirewallPolicyId

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

-Force

Forces the command to run without asking for user confirmation.

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

-ForceFirewallPolicyAssociation

Whether Force firewallPolicy association is enabled.

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

-FrontendIPConfigurations

Specifies a list of front-end IP configurations for the application gateway.

Parameter properties

Type:

PSApplicationGatewayFrontendIPConfiguration[]

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

-FrontendPorts

Specifies a list of front-end ports for the application gateway.

Parameter properties

Type:

PSApplicationGatewayFrontendPort[]

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:True
Value from remaining arguments:False

-GatewayIPConfigurations

Specifies a list of IP configurations for the application gateway.

Parameter properties

Type:

PSApplicationGatewayIPConfiguration[]

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:True
Value from remaining arguments:False

-HttpListeners

Specifies a list of HTTP listeners for the application gateway.

Parameter properties

Type:

PSApplicationGatewayHttpListener[]

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

-Identity

Application Gateway Identity to be assigned to Application Gateway.

Parameter properties

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

Parameter sets

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

-Listeners

The list of listener

Parameter properties

Type:

PSApplicationGatewayListener[]

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

-Location

Specifies the region in which to create the application gateway.

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:True
Value from remaining arguments:False

-Name

Specifies the name of application gateway.

Parameter properties

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

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-PrivateLinkConfiguration

The list of privateLink Configuration

Parameter properties

Type:

PSApplicationGatewayPrivateLinkConfiguration[]

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

-Probes

Specifies probes for the application gateway.

Parameter properties

Type:

PSApplicationGatewayProbe[]

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

-RedirectConfigurations

The list of redirect configuration

Parameter properties

Type:

PSApplicationGatewayRedirectConfiguration[]

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

-RequestRoutingRules

Specifies a list of request routing rules for the application gateway.

Parameter properties

Type:

PSApplicationGatewayRequestRoutingRule[]

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

-ResourceGroupName

Specifies the name of the resource group in which to create the application gateway.

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:True
Value from remaining arguments:False

-RewriteRuleSet

The list of RewriteRuleSet

Parameter properties

Type:

PSApplicationGatewayRewriteRuleSet[]

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

-RoutingRules

The list of routing rule

Parameter properties

Type:

PSApplicationGatewayRoutingRule[]

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

-Sku

Specifies the stock keeping unit (SKU) of the application gateway.

Parameter properties

Type:PSApplicationGatewaySku
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:True
Value from remaining arguments:False

-SslCertificates

Specifies the list of Secure Sockets Layer (SSL) certificates for the application gateway.

Parameter properties

Type:

PSApplicationGatewaySslCertificate[]

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

-SslPolicy

Specifies an SSL policy for the application gateway.

Parameter properties

Type:PSApplicationGatewaySslPolicy
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

-SslProfiles

The list of ssl profiles

Parameter properties

Type:

PSApplicationGatewaySslProfile[]

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

-Tag

Key-value pairs in the form of a hash table. For example: @{key0="value0";key1=$null;key2="value2"}

Parameter properties

Type:Hashtable
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

-TrustedClientCertificates

The list of trusted client CA certificate chains

Parameter properties

Type:

PSApplicationGatewayTrustedClientCertificate[]

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

-TrustedRootCertificate

The list of trusted root certificates

Parameter properties

Type:

PSApplicationGatewayTrustedRootCertificate[]

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

-UrlPathMaps

Specifies URL path maps for the application gateway.

Parameter properties

Type:

PSApplicationGatewayUrlPathMap[]

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

-UserAssignedIdentityId

ResourceId of the user assigned identity to be assigned to Application Gateway.

Parameter properties

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

Parameter sets

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

-WebApplicationFirewallConfiguration

Specifies a web application firewall (WAF) configuration. You can use the Get-AzApplicationGatewayWebApplicationFirewallConfiguration cmdlet to get a WAF.

Parameter properties

Type:PSApplicationGatewayWebApplicationFirewallConfiguration
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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:False
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 where the application gateway 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: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

String

PSApplicationGatewaySku

PSApplicationGatewaySslPolicy

PSApplicationGatewayIPConfiguration

PSApplicationGatewaySslCertificate

PSApplicationGatewayAuthenticationCertificate

PSApplicationGatewayTrustedRootCertificate

PSApplicationGatewayFrontendIPConfiguration

PSApplicationGatewayFrontendPort

PSApplicationGatewayProbe

PSApplicationGatewayBackendAddressPool

PSApplicationGatewayBackendHttpSettings

PSApplicationGatewayHttpListener

PSApplicationGatewayUrlPathMap

PSApplicationGatewayRequestRoutingRule

PSApplicationGatewayRewriteRuleSet

PSApplicationGatewayRedirectConfiguration

PSApplicationGatewayWebApplicationFirewallConfiguration

PSApplicationGatewayAutoscaleConfiguration

Hashtable

PSManagedServiceIdentity

Outputs

PSApplicationGateway