Microsoft.Network applicationGateways 2015-05-01-preview
- Latest
- 2024-03-01
- 2024-01-01
- 2023-11-01
- 2023-09-01
- 2023-06-01
- 2023-05-01
- 2023-04-01
- 2023-02-01
- 2022-11-01
- 2022-09-01
- 2022-07-01
- 2022-05-01
- 2022-01-01
- 2021-08-01
- 2021-05-01
- 2021-03-01
- 2021-02-01
- 2020-11-01
- 2020-08-01
- 2020-07-01
- 2020-06-01
- 2020-05-01
- 2020-04-01
- 2020-03-01
- 2019-12-01
- 2019-11-01
- 2019-09-01
- 2019-08-01
- 2019-07-01
- 2019-06-01
- 2019-04-01
- 2019-02-01
- 2018-12-01
- 2018-11-01
- 2018-10-01
- 2018-08-01
- 2018-07-01
- 2018-06-01
- 2018-04-01
- 2018-02-01
- 2018-01-01
- 2017-11-01
- 2017-10-01
- 2017-09-01
- 2017-08-01
- 2017-06-01
- 2017-03-30
- 2017-03-01
- 2016-12-01
- 2016-09-01
- 2016-06-01
- 2016-03-30
- 2015-06-15
- 2015-05-01-preview
Bicep resource definition
The applicationGateways resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Network/applicationGateways resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Network/applicationGateways@2015-05-01-preview' = {
etag: 'string'
location: 'string'
name: 'string'
properties: {
backendAddressPools: [
{
etag: 'string'
id: 'string'
name: 'string'
properties: {
backendAddresses: [
{
fqdn: 'string'
ipAddress: 'string'
}
]
backendIPConfigurations: [
{
id: 'string'
}
]
provisioningState: 'string'
}
}
]
backendHttpSettingsCollection: [
{
etag: 'string'
id: 'string'
name: 'string'
properties: {
cookieBasedAffinity: 'string'
port: int
protocol: 'string'
provisioningState: 'string'
}
}
]
frontendIPConfigurations: [
{
etag: 'string'
id: 'string'
name: 'string'
properties: {
privateIPAddress: 'string'
privateIPAllocationMethod: 'string'
provisioningState: 'string'
publicIPAddress: {
id: 'string'
}
subnet: {
id: 'string'
}
}
}
]
frontendPorts: [
{
etag: 'string'
id: 'string'
name: 'string'
properties: {
port: int
provisioningState: 'string'
}
}
]
gatewayIPConfigurations: [
{
etag: 'string'
id: 'string'
name: 'string'
properties: {
provisioningState: 'string'
subnet: {
id: 'string'
}
}
}
]
httpListeners: [
{
etag: 'string'
id: 'string'
name: 'string'
properties: {
frontendIPConfiguration: {
id: 'string'
}
frontendPort: {
id: 'string'
}
protocol: 'string'
provisioningState: 'string'
sslCertificate: {
id: 'string'
}
}
}
]
provisioningState: 'string'
requestRoutingRules: [
{
etag: 'string'
id: 'string'
name: 'string'
properties: {
backendAddressPool: {
id: 'string'
}
backendHttpSettings: {
id: 'string'
}
httpListener: {
id: 'string'
}
provisioningState: 'string'
ruleType: 'string'
}
}
]
resourceGuid: 'string'
sku: {
capacity: int
name: 'string'
tier: 'string'
}
sslCertificates: [
{
etag: 'string'
id: 'string'
name: 'string'
properties: {
data: 'string'
password: 'string'
provisioningState: 'string'
publicCertData: 'string'
}
}
]
}
tags: {
{customized property}: 'string'
}
}
Property values
ApplicationGatewayBackendAddress
| Name | Description | Value |
|---|---|---|
| fqdn | Gets or sets the dns name | string |
| ipAddress | Gets or sets the ip address | string |
ApplicationGatewayBackendAddressPool
| Name | Description | Value |
|---|---|---|
| etag | A unique read-only string that changes whenever the resource is updated | string |
| id | Resource Id | string |
| name | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | string |
| properties | Properties of Backend Address Pool of application gateway | ApplicationGatewayBackendAddressPoolPropertiesFormat |
ApplicationGatewayBackendAddressPoolPropertiesFormat
| Name | Description | Value |
|---|---|---|
| backendAddresses | Gets or sets the backend addresses | ApplicationGatewayBackendAddress[] |
| backendIPConfigurations | Gets or sets backendIPConfiguration of application gateway | SubResource[] |
| provisioningState | Gets or sets Provisioning state of the backend address pool resource Updating/Deleting/Failed | string |
ApplicationGatewayBackendHttpSettings
| Name | Description | Value |
|---|---|---|
| etag | A unique read-only string that changes whenever the resource is updated | string |
| id | Resource Id | string |
| name | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | string |
| properties | Properties of Backend address pool settings of application gateway | ApplicationGatewayBackendHttpSettingsPropertiesFormat |
ApplicationGatewayBackendHttpSettingsPropertiesFormat
| Name | Description | Value |
|---|---|---|
| cookieBasedAffinity | Gets or sets the cookie affinity | 'Disabled' 'Enabled' |
| port | Gets or sets the port | int |
| protocol | Gets or sets the protocol | 'Http' 'Https' |
| provisioningState | Gets or sets Provisioning state of the backend http settings resource Updating/Deleting/Failed | string |
ApplicationGatewayFrontendIPConfiguration
| Name | Description | Value |
|---|---|---|
| etag | A unique read-only string that changes whenever the resource is updated | string |
| id | Resource Id | string |
| name | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | string |
| properties | Properties of Frontend IP configuration of application gateway | ApplicationGatewayFrontendIPConfigurationPropertiesFormat |
ApplicationGatewayFrontendIPConfigurationPropertiesFormat
| Name | Description | Value |
|---|---|---|
| privateIPAddress | Gets or sets the privateIPAddress of the Network Interface IP Configuration | string |
| privateIPAllocationMethod | Gets or sets PrivateIP allocation method (Static/Dynamic) | 'Dynamic' 'Static' |
| provisioningState | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | string |
| publicIPAddress | Gets or sets the reference of the PublicIP resource | SubResource |
| subnet | Gets or sets the reference of the subnet resource | SubResource |
ApplicationGatewayFrontendPort
| Name | Description | Value |
|---|---|---|
| etag | A unique read-only string that changes whenever the resource is updated | string |
| id | Resource Id | string |
| name | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | string |
| properties | Properties of Frontend Port of application gateway | ApplicationGatewayFrontendPortPropertiesFormat |
ApplicationGatewayFrontendPortPropertiesFormat
| Name | Description | Value |
|---|---|---|
| port | Gets or sets the frontend port | int |
| provisioningState | Gets or sets Provisioning state of the frontend port resource Updating/Deleting/Failed | string |
ApplicationGatewayHttpListener
| Name | Description | Value |
|---|---|---|
| etag | A unique read-only string that changes whenever the resource is updated | string |
| id | Resource Id | string |
| name | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | string |
| properties | Properties of Http listener of application gateway | ApplicationGatewayHttpListenerPropertiesFormat |
ApplicationGatewayHttpListenerPropertiesFormat
| Name | Description | Value |
|---|---|---|
| frontendIPConfiguration | Gets or sets frontend IP configuration resource of application gateway | SubResource |
| frontendPort | Gets or sets frontend port resource of application gateway | SubResource |
| protocol | Gets or sets the protocol | 'Http' 'Https' |
| provisioningState | Gets or sets Provisioning state of the http listener resource Updating/Deleting/Failed | string |
| sslCertificate | Gets or sets ssl certificate resource of application gateway | SubResource |
ApplicationGatewayIPConfiguration
| Name | Description | Value |
|---|---|---|
| etag | A unique read-only string that changes whenever the resource is updated | string |
| id | Resource Id | string |
| name | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | string |
| properties | Properties of IP configuration of application gateway | ApplicationGatewayIPConfigurationPropertiesFormat |
ApplicationGatewayIPConfigurationPropertiesFormat
| Name | Description | Value |
|---|---|---|
| provisioningState | Gets or sets Provisioning state of the application gateway subnet resource Updating/Deleting/Failed | string |
| subnet | Gets or sets the reference of the subnet resource.A subnet from where application gateway gets its private address | SubResource |
ApplicationGatewayPropertiesFormat
| Name | Description | Value |
|---|---|---|
| backendAddressPools | Gets or sets backend address pool of application gateway resource | ApplicationGatewayBackendAddressPool[] |
| backendHttpSettingsCollection | Gets or sets backend http settings of application gateway resource | ApplicationGatewayBackendHttpSettings[] |
| frontendIPConfigurations | Gets or sets frontend IP addresses of application gateway resource | ApplicationGatewayFrontendIPConfiguration[] |
| frontendPorts | Gets or sets frontend ports of application gateway resource | ApplicationGatewayFrontendPort[] |
| gatewayIPConfigurations | Gets or sets subnets of application gateway resource | ApplicationGatewayIPConfiguration[] |
| httpListeners | Gets or sets HTTP listeners of application gateway resource | ApplicationGatewayHttpListener[] |
| provisioningState | Gets or sets Provisioning state of the ApplicationGateway resource Updating/Deleting/Failed | string |
| requestRoutingRules | Gets or sets request routing rules of application gateway resource | ApplicationGatewayRequestRoutingRule[] |
| resourceGuid | Gets or sets resource guid property of the ApplicationGateway resource | string |
| sku | Gets or sets sku of application gateway resource | ApplicationGatewaySku |
| sslCertificates | Gets or sets ssl certificates of application gateway resource | ApplicationGatewaySslCertificate[] |
ApplicationGatewayRequestRoutingRule
| Name | Description | Value |
|---|---|---|
| etag | A unique read-only string that changes whenever the resource is updated | string |
| id | Resource Id | string |
| name | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | string |
| properties | Properties of Request routing rule of application gateway | ApplicationGatewayRequestRoutingRulePropertiesFormat |
ApplicationGatewayRequestRoutingRulePropertiesFormat
| Name | Description | Value |
|---|---|---|
| backendAddressPool | Gets or sets backend address pool resource of application gateway | SubResource |
| backendHttpSettings | Gets or sets frontend port resource of application gateway | SubResource |
| httpListener | Gets or sets http listener resource of application gateway | SubResource |
| provisioningState | Gets or sets Provisioning state of the request routing rule resource Updating/Deleting/Failed | string |
| ruleType | Gets or sets the rule type | 'Basic' |
ApplicationGatewaySku
| Name | Description | Value |
|---|---|---|
| capacity | Gets or sets capacity (instance count) of application gateway | int |
| name | Gets or sets name of application gateway SKU | 'Standard_Large' 'Standard_Medium' 'Standard_Small' |
| tier | Gets or sets tier of application gateway | 'Standard' |
ApplicationGatewaySslCertificate
| Name | Description | Value |
|---|---|---|
| etag | A unique read-only string that changes whenever the resource is updated | string |
| id | Resource Id | string |
| name | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | string |
| properties | Properties of SSL certificates of application gateway | ApplicationGatewaySslCertificatePropertiesFormat |
ApplicationGatewaySslCertificatePropertiesFormat
| Name | Description | Value |
|---|---|---|
| data | Gets or sets the certificate data | string |
| password | Gets or sets the certificate password | string |
| provisioningState | Gets or sets Provisioning state of the ssl certificate resource Updating/Deleting/Failed | string |
| publicCertData | Gets or sets the certificate public data | string |
Microsoft.Network/applicationGateways
| Name | Description | Value |
|---|---|---|
| etag | Gets a unique read-only string that changes whenever the resource is updated | string |
| location | Resource location | string (required) |
| name | The resource name | string (required) |
| properties | Properties of Application Gateway | ApplicationGatewayPropertiesFormat |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
ResourceTags
| Name | Description | Value |
|---|
SubResource
| Name | Description | Value |
|---|---|---|
| id | Resource Id | string |
Quickstart samples
The following quickstart samples deploy this resource type.
| Bicep File | Description |
|---|---|
| AKS Cluster with a NAT Gateway and an Application Gateway | This sample shows how to a deploy an AKS cluster with NAT Gateway for outbound connections and an Application Gateway for inbound connections. |
| AKS cluster with the Application Gateway Ingress Controller | This sample shows how to deploy an AKS cluster with Application Gateway, Application Gateway Ingress Controller, Azure Container Registry, Log Analytics and Key Vault |
| Application Gateway with internal API Management and Web App | Application Gateway routing Internet traffic to a virtual network (internal mode) API Management instance which services a web API hosted in an Azure Web App. |
| Application Gateway with WAF and firewall policy | This template creates an Application Gateway with WAF configured along with a firewall policy |
| Create a Web App, PE and Application Gateway v2 | This template creates an Azure Web App with Private endpoint in Azure Virtual Network Subnet , an Application Gateway v2. The Application Gateway is deployed in a vNet (subnet). The Web App restricts access to traffic from the subnet using private endpoint |
| Create an Application Gateway v2 | This template creates an application gateway v2 in a virtual network and sets up auto scaling properties and an HTTP load-balancing rule with public frontend |
| Create an Azure Application Gateway v2 | This template creates an Azure Application Gateway with two Windows Server 2016 servers in the backend pool |
| Create an Azure WAF v2 on Azure Application Gateway | This template creates an Azure Web Application Firewall v2 on Azure Application Gateway with two Windows Server 2016 servers in the backend pool |
| Create API Management in Internal VNet with App Gateway | This template demonstrates how to Create a instance of Azure API Management on a private network protected by Azure Application Gateway. |
| Create Application Gateway with Certificates | This template shows how to generate Key Vault self-signed certificates, then reference from Application Gateway. |
| Deploy a Windows VM scale set with Azure Application Gateway | This template allows you to deploy a simple Windows VM Scale Set integrated with Azure Application Gateway, and supports up to 1000 VMs |
| Front Door Standard/Premium with Application Gateway origin | This template creates a Front Door Standard/Premium and an Application Gateway instance, and uses an NSG and WAF policy to validate that traffic has come through the Front Door origin. |
| Front Door with Container Instances and Application Gateway | This template creates a Front Door Standard/Premium with a container group and Application Gateway. |
ARM template resource definition
The applicationGateways resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Network/applicationGateways resource, add the following JSON to your template.
{
"type": "Microsoft.Network/applicationGateways",
"apiVersion": "2015-05-01-preview",
"name": "string",
"etag": "string",
"location": "string",
"properties": {
"backendAddressPools": [
{
"etag": "string",
"id": "string",
"name": "string",
"properties": {
"backendAddresses": [
{
"fqdn": "string",
"ipAddress": "string"
}
],
"backendIPConfigurations": [
{
"id": "string"
}
],
"provisioningState": "string"
}
}
],
"backendHttpSettingsCollection": [
{
"etag": "string",
"id": "string",
"name": "string",
"properties": {
"cookieBasedAffinity": "string",
"port": "int",
"protocol": "string",
"provisioningState": "string"
}
}
],
"frontendIPConfigurations": [
{
"etag": "string",
"id": "string",
"name": "string",
"properties": {
"privateIPAddress": "string",
"privateIPAllocationMethod": "string",
"provisioningState": "string",
"publicIPAddress": {
"id": "string"
},
"subnet": {
"id": "string"
}
}
}
],
"frontendPorts": [
{
"etag": "string",
"id": "string",
"name": "string",
"properties": {
"port": "int",
"provisioningState": "string"
}
}
],
"gatewayIPConfigurations": [
{
"etag": "string",
"id": "string",
"name": "string",
"properties": {
"provisioningState": "string",
"subnet": {
"id": "string"
}
}
}
],
"httpListeners": [
{
"etag": "string",
"id": "string",
"name": "string",
"properties": {
"frontendIPConfiguration": {
"id": "string"
},
"frontendPort": {
"id": "string"
},
"protocol": "string",
"provisioningState": "string",
"sslCertificate": {
"id": "string"
}
}
}
],
"provisioningState": "string",
"requestRoutingRules": [
{
"etag": "string",
"id": "string",
"name": "string",
"properties": {
"backendAddressPool": {
"id": "string"
},
"backendHttpSettings": {
"id": "string"
},
"httpListener": {
"id": "string"
},
"provisioningState": "string",
"ruleType": "string"
}
}
],
"resourceGuid": "string",
"sku": {
"capacity": "int",
"name": "string",
"tier": "string"
},
"sslCertificates": [
{
"etag": "string",
"id": "string",
"name": "string",
"properties": {
"data": "string",
"password": "string",
"provisioningState": "string",
"publicCertData": "string"
}
}
]
},
"tags": {
"{customized property}": "string"
}
}
Property values
ApplicationGatewayBackendAddress
| Name | Description | Value |
|---|---|---|
| fqdn | Gets or sets the dns name | string |
| ipAddress | Gets or sets the ip address | string |
ApplicationGatewayBackendAddressPool
| Name | Description | Value |
|---|---|---|
| etag | A unique read-only string that changes whenever the resource is updated | string |
| id | Resource Id | string |
| name | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | string |
| properties | Properties of Backend Address Pool of application gateway | ApplicationGatewayBackendAddressPoolPropertiesFormat |
ApplicationGatewayBackendAddressPoolPropertiesFormat
| Name | Description | Value |
|---|---|---|
| backendAddresses | Gets or sets the backend addresses | ApplicationGatewayBackendAddress[] |
| backendIPConfigurations | Gets or sets backendIPConfiguration of application gateway | SubResource[] |
| provisioningState | Gets or sets Provisioning state of the backend address pool resource Updating/Deleting/Failed | string |
ApplicationGatewayBackendHttpSettings
| Name | Description | Value |
|---|---|---|
| etag | A unique read-only string that changes whenever the resource is updated | string |
| id | Resource Id | string |
| name | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | string |
| properties | Properties of Backend address pool settings of application gateway | ApplicationGatewayBackendHttpSettingsPropertiesFormat |
ApplicationGatewayBackendHttpSettingsPropertiesFormat
| Name | Description | Value |
|---|---|---|
| cookieBasedAffinity | Gets or sets the cookie affinity | 'Disabled' 'Enabled' |
| port | Gets or sets the port | int |
| protocol | Gets or sets the protocol | 'Http' 'Https' |
| provisioningState | Gets or sets Provisioning state of the backend http settings resource Updating/Deleting/Failed | string |
ApplicationGatewayFrontendIPConfiguration
| Name | Description | Value |
|---|---|---|
| etag | A unique read-only string that changes whenever the resource is updated | string |
| id | Resource Id | string |
| name | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | string |
| properties | Properties of Frontend IP configuration of application gateway | ApplicationGatewayFrontendIPConfigurationPropertiesFormat |
ApplicationGatewayFrontendIPConfigurationPropertiesFormat
| Name | Description | Value |
|---|---|---|
| privateIPAddress | Gets or sets the privateIPAddress of the Network Interface IP Configuration | string |
| privateIPAllocationMethod | Gets or sets PrivateIP allocation method (Static/Dynamic) | 'Dynamic' 'Static' |
| provisioningState | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | string |
| publicIPAddress | Gets or sets the reference of the PublicIP resource | SubResource |
| subnet | Gets or sets the reference of the subnet resource | SubResource |
ApplicationGatewayFrontendPort
| Name | Description | Value |
|---|---|---|
| etag | A unique read-only string that changes whenever the resource is updated | string |
| id | Resource Id | string |
| name | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | string |
| properties | Properties of Frontend Port of application gateway | ApplicationGatewayFrontendPortPropertiesFormat |
ApplicationGatewayFrontendPortPropertiesFormat
| Name | Description | Value |
|---|---|---|
| port | Gets or sets the frontend port | int |
| provisioningState | Gets or sets Provisioning state of the frontend port resource Updating/Deleting/Failed | string |
ApplicationGatewayHttpListener
| Name | Description | Value |
|---|---|---|
| etag | A unique read-only string that changes whenever the resource is updated | string |
| id | Resource Id | string |
| name | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | string |
| properties | Properties of Http listener of application gateway | ApplicationGatewayHttpListenerPropertiesFormat |
ApplicationGatewayHttpListenerPropertiesFormat
| Name | Description | Value |
|---|---|---|
| frontendIPConfiguration | Gets or sets frontend IP configuration resource of application gateway | SubResource |
| frontendPort | Gets or sets frontend port resource of application gateway | SubResource |
| protocol | Gets or sets the protocol | 'Http' 'Https' |
| provisioningState | Gets or sets Provisioning state of the http listener resource Updating/Deleting/Failed | string |
| sslCertificate | Gets or sets ssl certificate resource of application gateway | SubResource |
ApplicationGatewayIPConfiguration
| Name | Description | Value |
|---|---|---|
| etag | A unique read-only string that changes whenever the resource is updated | string |
| id | Resource Id | string |
| name | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | string |
| properties | Properties of IP configuration of application gateway | ApplicationGatewayIPConfigurationPropertiesFormat |
ApplicationGatewayIPConfigurationPropertiesFormat
| Name | Description | Value |
|---|---|---|
| provisioningState | Gets or sets Provisioning state of the application gateway subnet resource Updating/Deleting/Failed | string |
| subnet | Gets or sets the reference of the subnet resource.A subnet from where application gateway gets its private address | SubResource |
ApplicationGatewayPropertiesFormat
| Name | Description | Value |
|---|---|---|
| backendAddressPools | Gets or sets backend address pool of application gateway resource | ApplicationGatewayBackendAddressPool[] |
| backendHttpSettingsCollection | Gets or sets backend http settings of application gateway resource | ApplicationGatewayBackendHttpSettings[] |
| frontendIPConfigurations | Gets or sets frontend IP addresses of application gateway resource | ApplicationGatewayFrontendIPConfiguration[] |
| frontendPorts | Gets or sets frontend ports of application gateway resource | ApplicationGatewayFrontendPort[] |
| gatewayIPConfigurations | Gets or sets subnets of application gateway resource | ApplicationGatewayIPConfiguration[] |
| httpListeners | Gets or sets HTTP listeners of application gateway resource | ApplicationGatewayHttpListener[] |
| provisioningState | Gets or sets Provisioning state of the ApplicationGateway resource Updating/Deleting/Failed | string |
| requestRoutingRules | Gets or sets request routing rules of application gateway resource | ApplicationGatewayRequestRoutingRule[] |
| resourceGuid | Gets or sets resource guid property of the ApplicationGateway resource | string |
| sku | Gets or sets sku of application gateway resource | ApplicationGatewaySku |
| sslCertificates | Gets or sets ssl certificates of application gateway resource | ApplicationGatewaySslCertificate[] |
ApplicationGatewayRequestRoutingRule
| Name | Description | Value |
|---|---|---|
| etag | A unique read-only string that changes whenever the resource is updated | string |
| id | Resource Id | string |
| name | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | string |
| properties | Properties of Request routing rule of application gateway | ApplicationGatewayRequestRoutingRulePropertiesFormat |
ApplicationGatewayRequestRoutingRulePropertiesFormat
| Name | Description | Value |
|---|---|---|
| backendAddressPool | Gets or sets backend address pool resource of application gateway | SubResource |
| backendHttpSettings | Gets or sets frontend port resource of application gateway | SubResource |
| httpListener | Gets or sets http listener resource of application gateway | SubResource |
| provisioningState | Gets or sets Provisioning state of the request routing rule resource Updating/Deleting/Failed | string |
| ruleType | Gets or sets the rule type | 'Basic' |
ApplicationGatewaySku
| Name | Description | Value |
|---|---|---|
| capacity | Gets or sets capacity (instance count) of application gateway | int |
| name | Gets or sets name of application gateway SKU | 'Standard_Large' 'Standard_Medium' 'Standard_Small' |
| tier | Gets or sets tier of application gateway | 'Standard' |
ApplicationGatewaySslCertificate
| Name | Description | Value |
|---|---|---|
| etag | A unique read-only string that changes whenever the resource is updated | string |
| id | Resource Id | string |
| name | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | string |
| properties | Properties of SSL certificates of application gateway | ApplicationGatewaySslCertificatePropertiesFormat |
ApplicationGatewaySslCertificatePropertiesFormat
| Name | Description | Value |
|---|---|---|
| data | Gets or sets the certificate data | string |
| password | Gets or sets the certificate password | string |
| provisioningState | Gets or sets Provisioning state of the ssl certificate resource Updating/Deleting/Failed | string |
| publicCertData | Gets or sets the certificate public data | string |
Microsoft.Network/applicationGateways
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2015-05-01-preview' |
| etag | Gets a unique read-only string that changes whenever the resource is updated | string |
| location | Resource location | string (required) |
| name | The resource name | string (required) |
| properties | Properties of Application Gateway | ApplicationGatewayPropertiesFormat |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Network/applicationGateways' |
ResourceTags
| Name | Description | Value |
|---|
SubResource
| Name | Description | Value |
|---|---|---|
| id | Resource Id | string |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
AKS Cluster with a NAT Gateway and an Application Gateway |
This sample shows how to a deploy an AKS cluster with NAT Gateway for outbound connections and an Application Gateway for inbound connections. |
| AKS cluster with the Application Gateway Ingress Controller |
This sample shows how to deploy an AKS cluster with Application Gateway, Application Gateway Ingress Controller, Azure Container Registry, Log Analytics and Key Vault |
| App Gateway with WAF, SSL, IIS and HTTPS redirection |
This template deploys an Application Gateway with WAF, end to end SSL and HTTP to HTTPS redirect on the IIS servers. |
| Application Gateway for a Web App with IP Restriction |
This template creates an application gateway in front of an Azure Web App with IP restriction enabled on the Web App. |
| Application Gateway for Multi Hosting |
This template creates an Application Gateway and configures it for Multi Hosting on port 443. |
| Application Gateway for Url Path Based Routing |
This template creates an Application Gateway and configures it for URL Path Based Routing. |
| Application Gateway with internal API Management and Web App |
Application Gateway routing Internet traffic to a virtual network (internal mode) API Management instance which services a web API hosted in an Azure Web App. |
| Application Gateway with WAF and firewall policy |
This template creates an Application Gateway with WAF configured along with a firewall policy |
| Autoscale LANSA Windows VM ScaleSet with Azure SQL Database |
The template deploys a Windows VMSS with a desired count of VMs in the scale set and a LANSA MSI to install into each VM. Once the VM Scale Set is deployed a custom script extension is used to install the LANSA MSI) |
| Azure Application Gateway Demo Setup |
This template allows you to quickly deploy Azure Application Gateway demo to test load-balancing with or without cookie-based affinity. |
| Create a Web App protected by Application Gateway v2 |
This template creates an Azure Web App with Access Restriction for an Application Gateway v2. The Application Gateway is deployed in a vNet (subnet) which has a 'Microsoft.Web' Service Endpoint enabled. The Web App restricts access to traffic from the subnet. |
| Create a Web App, PE and Application Gateway v2 |
This template creates an Azure Web App with Private endpoint in Azure Virtual Network Subnet , an Application Gateway v2. The Application Gateway is deployed in a vNet (subnet). The Web App restricts access to traffic from the subnet using private endpoint |
| Create a WordPress site in a virtual network |
This template creates a WordPress site on Container Instance in a virtual network. And output a public site FQDN which could access WordPress site. |
| Create an Application Gateway |
This template creates an application gateway in a virtual network and sets up load balancing rules for any number of virtual machines |
| Create an Application Gateway (Custom SSL) |
This template deploys an Application Gateway configured with a custom ssl policy. |
| Create an Application Gateway (SSL Policy) |
This template deploys an Application Gateway configured with a predefined ssl policy. |
| Create an Application Gateway (WAF) |
This template creates an application gateway with Web Application Firewall functionality in a virtual network and sets up load balancing rules for any number of virtual machines |
| Create an Application Gateway for WebApps |
This template creates an application gateway in front of two Azure Web Apps with a custom probe enabled. |
| Create an Application Gateway v2 |
This template creates an application gateway v2 in a virtual network and sets up auto scaling properties and an HTTP load-balancing rule with public frontend |
| Create an Application Gateway V2 with Key Vault |
This template deploys an Application Gateway V2 in a Virtual Network, a user defined identity, Key Vault, a secret (cert data), and access policy on Key Vault and Application Gateway. |
| Create an Application Gateway with Path Override |
This template deploys an Application Gateway and shows usage of the path override feature for a backend address pool. |
| Create an Application Gateway with Probe |
This template deploys an Application Gateway with enhanced probe functionality. |
| Create an Application Gateway with Public IP |
This template creates an Application Gateway, Public IP address for the Application Gateway, and the Virtual Network in which Application Gateway is deployed. Also configures Application Gateway for Http Load balancing with Two backend servers. Note that you have to specify valid IPs for backend servers. |
| Create an Application Gateway with Public IP (Offload) |
This template creates an Application Gateway, Public IP address for the Application Gateway, and the Virtual Network in which Application Gateway is deployed. Also configures Application Gateway for Ssl Offload and Load balancing with Two backend servers. Note that you have to specify valid IPs for backend servers. |
| Create an Application Gateway with Redirect |
This template creates an application gateway with Redirect functionalities in a virtual network and sets up load balancing and redirect rules (basic and pathbased) |
| Create an Application Gateway with Rewrite |
This template creates an application gateway with Rewrite functionalities in a virtual network and sets up load balancing, rewrite rules |
| Create an Azure Application Gateway v2 |
This template creates an Azure Application Gateway with two Windows Server 2016 servers in the backend pool |
| Create an Azure WAF v2 on Azure Application Gateway |
This template creates an Azure Web Application Firewall v2 on Azure Application Gateway with two Windows Server 2016 servers in the backend pool |
| Create an IPv6 Application Gateway |
This template creates an application gateway with an IPv6 frontend in a dual-stack virtual network. |
| Create API Management in Internal VNet with App Gateway |
This template demonstrates how to Create a instance of Azure API Management on a private network protected by Azure Application Gateway. |
| Create Application Gateway with Certificates |
This template shows how to generate Key Vault self-signed certificates, then reference from Application Gateway. |
| Deploy a Windows VM scale set with Azure Application Gateway |
This template allows you to deploy a simple Windows VM Scale Set integrated with Azure Application Gateway, and supports up to 1000 VMs |
| Deploy an Ubuntu VM scale set with Azure Application Gateway |
This template allows you to deploy a simple Ubuntu VM Scale Set integrated with Azure Application Gateway, and supports up to 1000 VMs |
| eShop Website with ILB ASE |
An App Service Environment is a Premium service plan option of Azure App Service that provides a fully isolated and dedicated environment for securely running Azure App Service apps at high scale, including Web Apps, Mobile Apps, and API Apps. |
| Front Door Standard/Premium with Application Gateway origin |
This template creates a Front Door Standard/Premium and an Application Gateway instance, and uses an NSG and WAF policy to validate that traffic has come through the Front Door origin. |
| Front Door with Container Instances and Application Gateway |
This template creates a Front Door Standard/Premium with a container group and Application Gateway. |
| Multi tier App with NSG, ILB, AppGateway |
This template deploys a Virtual Network, segregates the network through subnets, deploys VMs and configures load balancing |
| Multi tier traffic manager, L4 ILB, L7 AppGateway |
This template deploys a Virtual Network, segregates the network through subnets, deploys VMs and configures load balancing |
Terraform (AzAPI provider) resource definition
The applicationGateways resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Network/applicationGateways resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Network/applicationGateways@2015-05-01-preview"
name = "string"
etag = "string"
location = "string"
body = jsonencode({
properties = {
backendAddressPools = [
{
etag = "string"
id = "string"
name = "string"
properties = {
backendAddresses = [
{
fqdn = "string"
ipAddress = "string"
}
]
backendIPConfigurations = [
{
id = "string"
}
]
provisioningState = "string"
}
}
]
backendHttpSettingsCollection = [
{
etag = "string"
id = "string"
name = "string"
properties = {
cookieBasedAffinity = "string"
port = int
protocol = "string"
provisioningState = "string"
}
}
]
frontendIPConfigurations = [
{
etag = "string"
id = "string"
name = "string"
properties = {
privateIPAddress = "string"
privateIPAllocationMethod = "string"
provisioningState = "string"
publicIPAddress = {
id = "string"
}
subnet = {
id = "string"
}
}
}
]
frontendPorts = [
{
etag = "string"
id = "string"
name = "string"
properties = {
port = int
provisioningState = "string"
}
}
]
gatewayIPConfigurations = [
{
etag = "string"
id = "string"
name = "string"
properties = {
provisioningState = "string"
subnet = {
id = "string"
}
}
}
]
httpListeners = [
{
etag = "string"
id = "string"
name = "string"
properties = {
frontendIPConfiguration = {
id = "string"
}
frontendPort = {
id = "string"
}
protocol = "string"
provisioningState = "string"
sslCertificate = {
id = "string"
}
}
}
]
provisioningState = "string"
requestRoutingRules = [
{
etag = "string"
id = "string"
name = "string"
properties = {
backendAddressPool = {
id = "string"
}
backendHttpSettings = {
id = "string"
}
httpListener = {
id = "string"
}
provisioningState = "string"
ruleType = "string"
}
}
]
resourceGuid = "string"
sku = {
capacity = int
name = "string"
tier = "string"
}
sslCertificates = [
{
etag = "string"
id = "string"
name = "string"
properties = {
data = "string"
password = "string"
provisioningState = "string"
publicCertData = "string"
}
}
]
}
})
tags = {
{customized property} = "string"
}
}
Property values
ApplicationGatewayBackendAddress
| Name | Description | Value |
|---|---|---|
| fqdn | Gets or sets the dns name | string |
| ipAddress | Gets or sets the ip address | string |
ApplicationGatewayBackendAddressPool
| Name | Description | Value |
|---|---|---|
| etag | A unique read-only string that changes whenever the resource is updated | string |
| id | Resource Id | string |
| name | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | string |
| properties | Properties of Backend Address Pool of application gateway | ApplicationGatewayBackendAddressPoolPropertiesFormat |
ApplicationGatewayBackendAddressPoolPropertiesFormat
| Name | Description | Value |
|---|---|---|
| backendAddresses | Gets or sets the backend addresses | ApplicationGatewayBackendAddress[] |
| backendIPConfigurations | Gets or sets backendIPConfiguration of application gateway | SubResource[] |
| provisioningState | Gets or sets Provisioning state of the backend address pool resource Updating/Deleting/Failed | string |
ApplicationGatewayBackendHttpSettings
| Name | Description | Value |
|---|---|---|
| etag | A unique read-only string that changes whenever the resource is updated | string |
| id | Resource Id | string |
| name | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | string |
| properties | Properties of Backend address pool settings of application gateway | ApplicationGatewayBackendHttpSettingsPropertiesFormat |
ApplicationGatewayBackendHttpSettingsPropertiesFormat
| Name | Description | Value |
|---|---|---|
| cookieBasedAffinity | Gets or sets the cookie affinity | 'Disabled' 'Enabled' |
| port | Gets or sets the port | int |
| protocol | Gets or sets the protocol | 'Http' 'Https' |
| provisioningState | Gets or sets Provisioning state of the backend http settings resource Updating/Deleting/Failed | string |
ApplicationGatewayFrontendIPConfiguration
| Name | Description | Value |
|---|---|---|
| etag | A unique read-only string that changes whenever the resource is updated | string |
| id | Resource Id | string |
| name | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | string |
| properties | Properties of Frontend IP configuration of application gateway | ApplicationGatewayFrontendIPConfigurationPropertiesFormat |
ApplicationGatewayFrontendIPConfigurationPropertiesFormat
| Name | Description | Value |
|---|---|---|
| privateIPAddress | Gets or sets the privateIPAddress of the Network Interface IP Configuration | string |
| privateIPAllocationMethod | Gets or sets PrivateIP allocation method (Static/Dynamic) | 'Dynamic' 'Static' |
| provisioningState | Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed | string |
| publicIPAddress | Gets or sets the reference of the PublicIP resource | SubResource |
| subnet | Gets or sets the reference of the subnet resource | SubResource |
ApplicationGatewayFrontendPort
| Name | Description | Value |
|---|---|---|
| etag | A unique read-only string that changes whenever the resource is updated | string |
| id | Resource Id | string |
| name | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | string |
| properties | Properties of Frontend Port of application gateway | ApplicationGatewayFrontendPortPropertiesFormat |
ApplicationGatewayFrontendPortPropertiesFormat
| Name | Description | Value |
|---|---|---|
| port | Gets or sets the frontend port | int |
| provisioningState | Gets or sets Provisioning state of the frontend port resource Updating/Deleting/Failed | string |
ApplicationGatewayHttpListener
| Name | Description | Value |
|---|---|---|
| etag | A unique read-only string that changes whenever the resource is updated | string |
| id | Resource Id | string |
| name | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | string |
| properties | Properties of Http listener of application gateway | ApplicationGatewayHttpListenerPropertiesFormat |
ApplicationGatewayHttpListenerPropertiesFormat
| Name | Description | Value |
|---|---|---|
| frontendIPConfiguration | Gets or sets frontend IP configuration resource of application gateway | SubResource |
| frontendPort | Gets or sets frontend port resource of application gateway | SubResource |
| protocol | Gets or sets the protocol | 'Http' 'Https' |
| provisioningState | Gets or sets Provisioning state of the http listener resource Updating/Deleting/Failed | string |
| sslCertificate | Gets or sets ssl certificate resource of application gateway | SubResource |
ApplicationGatewayIPConfiguration
| Name | Description | Value |
|---|---|---|
| etag | A unique read-only string that changes whenever the resource is updated | string |
| id | Resource Id | string |
| name | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | string |
| properties | Properties of IP configuration of application gateway | ApplicationGatewayIPConfigurationPropertiesFormat |
ApplicationGatewayIPConfigurationPropertiesFormat
| Name | Description | Value |
|---|---|---|
| provisioningState | Gets or sets Provisioning state of the application gateway subnet resource Updating/Deleting/Failed | string |
| subnet | Gets or sets the reference of the subnet resource.A subnet from where application gateway gets its private address | SubResource |
ApplicationGatewayPropertiesFormat
| Name | Description | Value |
|---|---|---|
| backendAddressPools | Gets or sets backend address pool of application gateway resource | ApplicationGatewayBackendAddressPool[] |
| backendHttpSettingsCollection | Gets or sets backend http settings of application gateway resource | ApplicationGatewayBackendHttpSettings[] |
| frontendIPConfigurations | Gets or sets frontend IP addresses of application gateway resource | ApplicationGatewayFrontendIPConfiguration[] |
| frontendPorts | Gets or sets frontend ports of application gateway resource | ApplicationGatewayFrontendPort[] |
| gatewayIPConfigurations | Gets or sets subnets of application gateway resource | ApplicationGatewayIPConfiguration[] |
| httpListeners | Gets or sets HTTP listeners of application gateway resource | ApplicationGatewayHttpListener[] |
| provisioningState | Gets or sets Provisioning state of the ApplicationGateway resource Updating/Deleting/Failed | string |
| requestRoutingRules | Gets or sets request routing rules of application gateway resource | ApplicationGatewayRequestRoutingRule[] |
| resourceGuid | Gets or sets resource guid property of the ApplicationGateway resource | string |
| sku | Gets or sets sku of application gateway resource | ApplicationGatewaySku |
| sslCertificates | Gets or sets ssl certificates of application gateway resource | ApplicationGatewaySslCertificate[] |
ApplicationGatewayRequestRoutingRule
| Name | Description | Value |
|---|---|---|
| etag | A unique read-only string that changes whenever the resource is updated | string |
| id | Resource Id | string |
| name | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | string |
| properties | Properties of Request routing rule of application gateway | ApplicationGatewayRequestRoutingRulePropertiesFormat |
ApplicationGatewayRequestRoutingRulePropertiesFormat
| Name | Description | Value |
|---|---|---|
| backendAddressPool | Gets or sets backend address pool resource of application gateway | SubResource |
| backendHttpSettings | Gets or sets frontend port resource of application gateway | SubResource |
| httpListener | Gets or sets http listener resource of application gateway | SubResource |
| provisioningState | Gets or sets Provisioning state of the request routing rule resource Updating/Deleting/Failed | string |
| ruleType | Gets or sets the rule type | 'Basic' |
ApplicationGatewaySku
| Name | Description | Value |
|---|---|---|
| capacity | Gets or sets capacity (instance count) of application gateway | int |
| name | Gets or sets name of application gateway SKU | 'Standard_Large' 'Standard_Medium' 'Standard_Small' |
| tier | Gets or sets tier of application gateway | 'Standard' |
ApplicationGatewaySslCertificate
| Name | Description | Value |
|---|---|---|
| etag | A unique read-only string that changes whenever the resource is updated | string |
| id | Resource Id | string |
| name | Gets name of the resource that is unique within a resource group. This name can be used to access the resource | string |
| properties | Properties of SSL certificates of application gateway | ApplicationGatewaySslCertificatePropertiesFormat |
ApplicationGatewaySslCertificatePropertiesFormat
| Name | Description | Value |
|---|---|---|
| data | Gets or sets the certificate data | string |
| password | Gets or sets the certificate password | string |
| provisioningState | Gets or sets Provisioning state of the ssl certificate resource Updating/Deleting/Failed | string |
| publicCertData | Gets or sets the certificate public data | string |
Microsoft.Network/applicationGateways
| Name | Description | Value |
|---|---|---|
| etag | Gets a unique read-only string that changes whenever the resource is updated | string |
| location | Resource location | string (required) |
| name | The resource name | string (required) |
| properties | Properties of Application Gateway | ApplicationGatewayPropertiesFormat |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Network/applicationGateways@2015-05-01-preview" |
ResourceTags
| Name | Description | Value |
|---|
SubResource
| Name | Description | Value |
|---|---|---|
| id | Resource Id | string |