Application Gateways - Create Or Update

Creates or updates the specified application gateway.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}?api-version=2019-07-01

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

resourceGroupName
path True
  • string

The name of the resource group.

applicationGatewayName
path True
  • string

The name of the application gateway.

api-version
query True
  • string

Client API version.

Request Body

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

identity

The identity of the application gateway, if configured.

location
  • string

Resource location.

properties.authenticationCertificates

Authentication certificates of the application gateway resource. For default limits, see Application Gateway limits.

properties.autoscaleConfiguration

Autoscale Configuration.

properties.backendAddressPools

Backend address pool of the application gateway resource. For default limits, see Application Gateway limits.

properties.backendHttpSettingsCollection

Backend http settings of the application gateway resource. For default limits, see Application Gateway limits.

properties.customErrorConfigurations

Custom error configurations of the application gateway resource.

properties.enableFips
  • boolean

Whether FIPS is enabled on the application gateway resource.

properties.enableHttp2
  • boolean

Whether HTTP2 is enabled on the application gateway resource.

properties.firewallPolicy

Reference of the FirewallPolicy resource.

properties.frontendIPConfigurations

Frontend IP addresses of the application gateway resource. For default limits, see Application Gateway limits.

properties.frontendPorts

Frontend ports of the application gateway resource. For default limits, see Application Gateway limits.

properties.gatewayIPConfigurations

Subnets of the application gateway resource. For default limits, see Application Gateway limits.

properties.httpListeners

Http listeners of the application gateway resource. For default limits, see Application Gateway limits.

properties.probes

Probes of the application gateway resource.

properties.redirectConfigurations

Redirect configurations of the application gateway resource. For default limits, see Application Gateway limits.

properties.requestRoutingRules

Request routing rules of the application gateway resource.

properties.resourceGuid
  • string

The resource GUID property of the application gateway resource.

properties.rewriteRuleSets

Rewrite rules for the application gateway resource.

properties.sku

SKU of the application gateway resource.

properties.sslCertificates

SSL certificates of the application gateway resource. For default limits, see Application Gateway limits.

properties.sslPolicy

SSL policy of the application gateway resource.

properties.trustedRootCertificates

Trusted Root certificates of the application gateway resource. For default limits, see Application Gateway limits.

properties.urlPathMaps

URL path map of the application gateway resource. For default limits, see Application Gateway limits.

properties.webApplicationFirewallConfiguration

Web application firewall configuration.

tags
  • object

Resource tags.

zones
  • string[]

A list of availability zones denoting where the resource needs to come from.

Responses

Name Type Description
200 OK

Update successful. The operation returns the resulting ApplicationGateway resource.

201 Created

Create successful. The operation returns the resulting ApplicationGateway resource.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Create Application Gateway

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw?api-version=2019-07-01
{
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {}
    }
  },
  "location": "eastus",
  "properties": {
    "sku": {
      "name": "Standard_v2",
      "tier": "Standard_v2",
      "capacity": 3
    },
    "gatewayIPConfigurations": [
      {
        "name": "appgwipc",
        "properties": {
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/appgwsubnet"
          }
        }
      }
    ],
    "sslCertificates": [
      {
        "name": "sslcert",
        "properties": {
          "data": "****",
          "password": "****"
        }
      },
      {
        "name": "sslcert2",
        "properties": {
          "keyVaultSecretId": "https://kv/secret"
        }
      }
    ],
    "trustedRootCertificates": [
      {
        "name": "rootcert",
        "properties": {
          "data": "****"
        }
      },
      {
        "name": "rootcert1",
        "properties": {
          "keyVaultSecretId": "https://kv/secret"
        }
      }
    ],
    "frontendIPConfigurations": [
      {
        "name": "appgwfip",
        "properties": {
          "publicIPAddress": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip"
          }
        }
      }
    ],
    "frontendPorts": [
      {
        "name": "appgwfp",
        "properties": {
          "port": 443
        }
      },
      {
        "name": "appgwfp80",
        "properties": {
          "port": 80
        }
      }
    ],
    "backendAddressPools": [
      {
        "name": "appgwpool",
        "properties": {
          "backendAddresses": [
            {
              "ipAddress": "10.0.1.1"
            },
            {
              "ipAddress": "10.0.1.2"
            }
          ]
        }
      }
    ],
    "backendHttpSettingsCollection": [
      {
        "name": "appgwbhs",
        "properties": {
          "port": 80,
          "protocol": "Http",
          "cookieBasedAffinity": "Disabled",
          "requestTimeout": 30
        }
      }
    ],
    "httpListeners": [
      {
        "name": "appgwhl",
        "properties": {
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip"
          },
          "frontendPort": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp"
          },
          "protocol": "Https",
          "sslCertificate": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert"
          },
          "requireServerNameIndication": false
        }
      },
      {
        "name": "appgwhttplistener",
        "properties": {
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip"
          },
          "frontendPort": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80"
          },
          "protocol": "Http"
        }
      }
    ],
    "urlPathMaps": [
      {
        "name": "pathMap1",
        "properties": {
          "defaultBackendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool"
          },
          "defaultBackendHttpSettings": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs"
          },
          "defaultRewriteRuleSet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1"
          },
          "pathRules": [
            {
              "name": "apiPaths",
              "properties": {
                "paths": [
                  "/api",
                  "/v1/api"
                ],
                "backendAddressPool": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool"
                },
                "backendHttpSettings": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs"
                },
                "rewriteRuleSet": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1"
                }
              }
            }
          ]
        }
      }
    ],
    "requestRoutingRules": [
      {
        "name": "appgwrule",
        "properties": {
          "ruleType": "Basic",
          "priority": 10,
          "httpListener": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl"
          },
          "backendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool"
          },
          "backendHttpSettings": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs"
          },
          "rewriteRuleSet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1"
          }
        }
      },
      {
        "name": "appgwPathBasedRule",
        "properties": {
          "ruleType": "PathBasedRouting",
          "priority": 20,
          "httpListener": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener"
          },
          "urlPathMap": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1"
          }
        }
      }
    ],
    "rewriteRuleSets": [
      {
        "name": "rewriteRuleSet1",
        "properties": {
          "rewriteRules": [
            {
              "name": "Set X-Forwarded-For",
              "ruleSequence": 102,
              "conditions": [
                {
                  "variable": "http_req_Authorization",
                  "pattern": "^Bearer",
                  "ignoreCase": true,
                  "negate": false
                }
              ],
              "actionSet": {
                "requestHeaderConfigurations": [
                  {
                    "headerName": "X-Forwarded-For",
                    "headerValue": "{var_add_x_forwarded_for_proxy}"
                  }
                ],
                "responseHeaderConfigurations": [
                  {
                    "headerName": "Strict-Transport-Security",
                    "headerValue": "max-age=31536000"
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

Sample Response

{
  "name": "appgw",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw",
  "type": "Microsoft.Network/applicationGateways",
  "location": "southcentralus",
  "properties": {
    "provisioningState": "Succeeded",
    "sku": {
      "name": "Standard_Medium",
      "tier": "Standard",
      "capacity": 3
    },
    "operationalState": "Running",
    "gatewayIPConfigurations": [
      {
        "name": "appgwipc",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/gatewayIPConfigurations/appgwipc",
        "properties": {
          "provisioningState": "Succeeded",
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet"
          }
        }
      }
    ],
    "sslCertificates": [
      {
        "name": "sslcert",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert",
        "properties": {
          "provisioningState": "Succeeded",
          "publicCertData": "*****"
        }
      }
    ],
    "authenticationCertificates": [],
    "frontendIPConfigurations": [
      {
        "name": "appgwfip",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip",
        "properties": {
          "provisioningState": "Succeeded",
          "privateIPAllocationMethod": "Dynamic",
          "publicIPAddress": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip"
          }
        }
      }
    ],
    "frontendPorts": [
      {
        "name": "appgwfp",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp",
        "properties": {
          "provisioningState": "Succeeded",
          "port": 443
        }
      },
      {
        "name": "appgwfp80",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80",
        "properties": {
          "provisioningState": "Succeeded",
          "port": 80
        }
      }
    ],
    "backendAddressPools": [
      {
        "name": "appgwpool",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool",
        "properties": {
          "provisioningState": "Succeeded",
          "backendAddresses": []
        }
      }
    ],
    "backendHttpSettingsCollection": [
      {
        "name": "appgwbhs",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs",
        "properties": {
          "provisioningState": "Succeeded",
          "port": 80,
          "protocol": "Http",
          "cookieBasedAffinity": "Disabled",
          "requestTimeout": 30
        }
      }
    ],
    "httpListeners": [
      {
        "name": "appgwhl",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip"
          },
          "frontendPort": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp"
          },
          "protocol": "Https",
          "sslCertificate": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert"
          },
          "requireServerNameIndication": false
        }
      },
      {
        "name": "appgwhttplistener",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip"
          },
          "frontendPort": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80"
          },
          "protocol": "Http"
        }
      }
    ],
    "urlPathMaps": [
      {
        "name": "pathMap1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1",
        "properties": {
          "provisioningState": "Succeeded",
          "defaultBackendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool"
          },
          "defaultBackendHttpSettings": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs"
          },
          "defaultRewriteRuleSet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1"
          },
          "pathRules": [
            {
              "name": "apiPaths",
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1/pathRules/apiPaths",
              "properties": {
                "provisioningState": "Succeeded",
                "paths": [
                  "/api",
                  "/v1/api"
                ],
                "backendAddressPool": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool"
                },
                "backendHttpSettings": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs"
                },
                "rewriteRuleSet": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1"
                }
              }
            }
          ]
        }
      }
    ],
    "requestRoutingRules": [
      {
        "name": "appgwrule",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwrule",
        "properties": {
          "provisioningState": "Succeeded",
          "ruleType": "Basic",
          "httpListener": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl"
          },
          "backendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool"
          },
          "backendHttpSettings": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs"
          },
          "rewriteRuleSet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1"
          }
        }
      },
      {
        "name": "appgwPathBasedRule",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwPathBasedRule",
        "properties": {
          "provisioningState": "Succeeded",
          "ruleType": "PathBasedRouting",
          "httpListener": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener"
          },
          "urlPathMap": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1"
          }
        }
      }
    ],
    "rewriteRuleSets": [
      {
        "name": "rewriteRuleSet1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1",
        "properties": {
          "provisioningState": "Succeeded",
          "rewriteRules": [
            {
              "name": "Set X-Forwarded-For",
              "ruleSequence": 102,
              "conditions": [
                {
                  "variable": "http_req_Authorization",
                  "pattern": "^Bearer",
                  "ignoreCase": true,
                  "negate": false
                }
              ],
              "actionSet": {
                "requestHeaderConfigurations": [
                  {
                    "headerName": "X-Forwarded-For",
                    "headerValue": "{var_remote-addr}"
                  }
                ],
                "responseHeaderConfigurations": [
                  {
                    "headerName": "Strict-Transport-Security",
                    "headerValue": "max-age=31536000"
                  }
                ]
              }
            }
          ]
        }
      }
    ],
    "probes": []
  }
}
{
  "name": "appgw",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw",
  "type": "Microsoft.Network/applicationGateways",
  "location": "southcentralus",
  "properties": {
    "provisioningState": "Succeeded",
    "sku": {
      "name": "Standard_Medium",
      "tier": "Standard",
      "capacity": 3
    },
    "operationalState": "Running",
    "gatewayIPConfigurations": [
      {
        "name": "appgwipc",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/gatewayIPConfigurations/appgwipc",
        "properties": {
          "provisioningState": "Succeeded",
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet"
          }
        }
      }
    ],
    "sslCertificates": [
      {
        "name": "sslcert",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert",
        "properties": {
          "provisioningState": "Succeeded",
          "publicCertData": "*****"
        }
      }
    ],
    "authenticationCertificates": [],
    "frontendIPConfigurations": [
      {
        "name": "appgwfip",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip",
        "properties": {
          "provisioningState": "Succeeded",
          "privateIPAllocationMethod": "Dynamic",
          "publicIPAddress": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip"
          }
        }
      }
    ],
    "frontendPorts": [
      {
        "name": "appgwfp",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp",
        "properties": {
          "provisioningState": "Succeeded",
          "port": 443
        }
      },
      {
        "name": "appgwfp80",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80",
        "properties": {
          "provisioningState": "Succeeded",
          "port": 80
        }
      }
    ],
    "backendAddressPools": [
      {
        "name": "appgwpool",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool",
        "properties": {
          "provisioningState": "Succeeded",
          "backendAddresses": []
        }
      }
    ],
    "backendHttpSettingsCollection": [
      {
        "name": "appgwbhs",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs",
        "properties": {
          "provisioningState": "Succeeded",
          "port": 80,
          "protocol": "Http",
          "cookieBasedAffinity": "Disabled",
          "requestTimeout": 30
        }
      }
    ],
    "httpListeners": [
      {
        "name": "appgwhl",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip"
          },
          "frontendPort": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp"
          },
          "protocol": "Https",
          "sslCertificate": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert"
          },
          "requireServerNameIndication": false
        }
      },
      {
        "name": "appgwhttplistener",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip"
          },
          "frontendPort": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80"
          },
          "protocol": "Http"
        }
      }
    ],
    "urlPathMaps": [
      {
        "name": "pathMap1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1",
        "properties": {
          "provisioningState": "Succeeded",
          "defaultBackendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool"
          },
          "defaultBackendHttpSettings": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs"
          },
          "defaultRewriteRuleSet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1"
          },
          "pathRules": [
            {
              "name": "apiPaths",
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1/pathRules/apiPaths",
              "properties": {
                "provisioningState": "Succeeded",
                "paths": [
                  "/api",
                  "/v1/api"
                ],
                "backendAddressPool": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool"
                },
                "backendHttpSettings": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs"
                },
                "rewriteRuleSet": {
                  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1"
                }
              }
            }
          ]
        }
      }
    ],
    "requestRoutingRules": [
      {
        "name": "appgwrule",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwrule",
        "properties": {
          "provisioningState": "Succeeded",
          "ruleType": "Basic",
          "httpListener": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl"
          },
          "backendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool"
          },
          "backendHttpSettings": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs"
          },
          "rewriteRuleSet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1"
          }
        }
      },
      {
        "name": "appgwPathBasedRule",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwPathBasedRule",
        "properties": {
          "provisioningState": "Succeeded",
          "ruleType": "PathBasedRouting",
          "httpListener": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener"
          },
          "urlPathMap": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1"
          }
        }
      }
    ],
    "rewriteRuleSets": [
      {
        "name": "rewriteRuleSet1",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1",
        "properties": {
          "provisioningState": "Succeeded",
          "rewriteRules": [
            {
              "name": "Set X-Forwarded-For",
              "ruleSequence": 102,
              "conditions": [
                {
                  "variable": "http_req_Authorization",
                  "pattern": "^Bearer",
                  "ignoreCase": true,
                  "negate": false
                }
              ],
              "actionSet": {
                "requestHeaderConfigurations": [
                  {
                    "headerName": "X-Forwarded-For",
                    "headerValue": "{var_remote-addr}"
                  }
                ],
                "responseHeaderConfigurations": [
                  {
                    "headerName": "Strict-Transport-Security",
                    "headerValue": "max-age=31536000"
                  }
                ]
              }
            }
          ]
        }
      }
    ],
    "probes": []
  }
}

Definitions

ApplicationGateway

Application gateway resource.

ApplicationGatewayAuthenticationCertificate

Authentication certificates of an application gateway.

ApplicationGatewayAutoscaleConfiguration

Application Gateway autoscale configuration.

ApplicationGatewayBackendAddress

Backend address of an application gateway.

ApplicationGatewayBackendAddressPool

Backend Address Pool of an application gateway.

ApplicationGatewayBackendHttpSettings

Backend address pool settings of an application gateway.

ApplicationGatewayConnectionDraining

Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.

ApplicationGatewayCookieBasedAffinity

Cookie based affinity.

ApplicationGatewayCustomError

Customer error of an application gateway.

ApplicationGatewayCustomErrorStatusCode

Status code of the application gateway customer error.

ApplicationGatewayFirewallDisabledRuleGroup

Allows to disable rules within a rule group or an entire rule group.

ApplicationGatewayFirewallExclusion

Allow to exclude some variable satisfy the condition for the WAF check.

ApplicationGatewayFirewallMode

Web application firewall mode.

ApplicationGatewayFrontendIPConfiguration

Frontend IP configuration of an application gateway.

ApplicationGatewayFrontendPort

Frontend port of an application gateway.

ApplicationGatewayHeaderConfiguration

Header configuration of the Actions set in Application Gateway.

ApplicationGatewayHttpListener

Http listener of an application gateway.

ApplicationGatewayIPConfiguration

IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.

ApplicationGatewayOperationalState

Operational state of the application gateway resource.

ApplicationGatewayPathRule

Path rule of URL path map of an application gateway.

ApplicationGatewayProbe

Probe of the application gateway.

ApplicationGatewayProbeHealthResponseMatch

Application gateway probe health response match.

ApplicationGatewayProtocol

Application Gateway protocol.

ApplicationGatewayRedirectConfiguration

Redirect configuration of an application gateway.

ApplicationGatewayRedirectType

HTTP redirection type.

ApplicationGatewayRequestRoutingRule

Request routing rule of an application gateway.

ApplicationGatewayRequestRoutingRuleType

Rule type.

ApplicationGatewayRewriteRule

Rewrite rule of an application gateway.

ApplicationGatewayRewriteRuleActionSet

Set of actions in the Rewrite Rule in Application Gateway.

ApplicationGatewayRewriteRuleCondition

Set of conditions in the Rewrite Rule in Application Gateway.

ApplicationGatewayRewriteRuleSet

Rewrite rule set of an application gateway.

ApplicationGatewaySku

SKU of an application gateway.

ApplicationGatewaySkuName

Name of an application gateway SKU.

ApplicationGatewaySslCertificate

SSL certificates of an application gateway.

ApplicationGatewaySslPolicy

Application Gateway Ssl policy.

ApplicationGatewaySslPolicyName

Name of Ssl predefined policy.

ApplicationGatewaySslPolicyType

Type of Ssl Policy.

ApplicationGatewaySslProtocol

Minimum version of Ssl protocol to be supported on application gateway.

ApplicationGatewayTier

Tier of an application gateway.

ApplicationGatewayTrustedRootCertificate

Trusted Root certificates of an application gateway.

ApplicationGatewayUrlPathMap

UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.

ApplicationGatewayWebApplicationFirewallConfiguration

Application gateway web application firewall configuration.

ApplicationSecurityGroup

An application security group in a resource group.

BackendAddressPool

Pool of backend IP addresses.

DdosSettings

Contains the DDoS protection settings of the public IP.

DdosSettingsProtectionCoverage

The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized.

Delegation

Details the service to which the subnet is delegated.

FrontendIPConfiguration

Frontend IP address of the load balancer.

InboundNatRule

Inbound NAT rule of the load balancer.

IPAllocationMethod

IP address allocation method.

IPConfiguration

IP configuration.

IPConfigurationProfile

IP configuration profile child resource.

IpTag

Contains the IpTag associated with the object.

IPVersion

IP address version.

ManagedServiceIdentity

Identity for the resource.

NetworkInterface

A network interface in a resource group.

NetworkInterfaceDnsSettings

DNS settings of a network interface.

NetworkInterfaceIPConfiguration

IPConfiguration in a network interface.

NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties

PrivateLinkConnection properties for the network interface.

NetworkInterfaceTapConfiguration

Tap configuration in a Network Interface.

NetworkSecurityGroup

NetworkSecurityGroup resource.

PrivateEndpoint

Private endpoint resource.

PrivateLinkServiceConnection

PrivateLinkServiceConnection resource.

PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

ProvisioningState

The current provisioning state.

PublicIPAddress

Public IP address resource.

PublicIPAddressDnsSettings

Contains FQDN of the DNS record associated with the public IP address.

PublicIPAddressSku

SKU of a public IP address.

PublicIPAddressSkuName

Name of a public IP address SKU.

ResourceIdentityType

The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.

ResourceNavigationLink

ResourceNavigationLink resource.

Route

Route resource.

RouteNextHopType

The type of Azure hop the packet should be sent to.

RouteTable

Route table resource.

SecurityRule

Network security rule.

SecurityRuleAccess

Whether network traffic is allowed or denied.

SecurityRuleDirection

The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.

SecurityRuleProtocol

Network protocol this rule applies to.

ServiceAssociationLink

ServiceAssociationLink resource.

ServiceEndpointPolicy

Service End point policy resource.

ServiceEndpointPolicyDefinition

Service Endpoint policy definitions.

ServiceEndpointPropertiesFormat

The service endpoint properties.

Subnet

Subnet in a virtual network resource.

SubResource

Reference to another subresource.

TransportProtocol

The transport protocol for the endpoint.

UserAssignedIdentities

The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

VirtualNetworkTap

Virtual Network Tap resource.

ApplicationGateway

Application gateway resource.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

identity

The identity of the application gateway, if configured.

location
  • string

Resource location.

name
  • string

Resource name.

properties.authenticationCertificates

Authentication certificates of the application gateway resource. For default limits, see Application Gateway limits.

properties.autoscaleConfiguration

Autoscale Configuration.

properties.backendAddressPools

Backend address pool of the application gateway resource. For default limits, see Application Gateway limits.

properties.backendHttpSettingsCollection

Backend http settings of the application gateway resource. For default limits, see Application Gateway limits.

properties.customErrorConfigurations

Custom error configurations of the application gateway resource.

properties.enableFips
  • boolean

Whether FIPS is enabled on the application gateway resource.

properties.enableHttp2
  • boolean

Whether HTTP2 is enabled on the application gateway resource.

properties.firewallPolicy

Reference of the FirewallPolicy resource.

properties.frontendIPConfigurations

Frontend IP addresses of the application gateway resource. For default limits, see Application Gateway limits.

properties.frontendPorts

Frontend ports of the application gateway resource. For default limits, see Application Gateway limits.

properties.gatewayIPConfigurations

Subnets of the application gateway resource. For default limits, see Application Gateway limits.

properties.httpListeners

Http listeners of the application gateway resource. For default limits, see Application Gateway limits.

properties.operationalState

Operational state of the application gateway resource.

properties.probes

Probes of the application gateway resource.

properties.provisioningState

The provisioning state of the application gateway resource.

properties.redirectConfigurations

Redirect configurations of the application gateway resource. For default limits, see Application Gateway limits.

properties.requestRoutingRules

Request routing rules of the application gateway resource.

properties.resourceGuid
  • string

The resource GUID property of the application gateway resource.

properties.rewriteRuleSets

Rewrite rules for the application gateway resource.

properties.sku

SKU of the application gateway resource.

properties.sslCertificates

SSL certificates of the application gateway resource. For default limits, see Application Gateway limits.

properties.sslPolicy

SSL policy of the application gateway resource.

properties.trustedRootCertificates

Trusted Root certificates of the application gateway resource. For default limits, see Application Gateway limits.

properties.urlPathMaps

URL path map of the application gateway resource. For default limits, see Application Gateway limits.

properties.webApplicationFirewallConfiguration

Web application firewall configuration.

tags
  • object

Resource tags.

type
  • string

Resource type.

zones
  • string[]

A list of availability zones denoting where the resource needs to come from.

ApplicationGatewayAuthenticationCertificate

Authentication certificates of an application gateway.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

Name of the authentication certificate that is unique within an Application Gateway.

properties.data
  • string

Certificate public data.

properties.provisioningState

The provisioning state of the authentication certificate resource.

type
  • string

Type of the resource.

ApplicationGatewayAutoscaleConfiguration

Application Gateway autoscale configuration.

Name Type Description
maxCapacity
  • integer

Upper bound on number of Application Gateway capacity.

minCapacity
  • integer

Lower bound on number of Application Gateway capacity.

ApplicationGatewayBackendAddress

Backend address of an application gateway.

Name Type Description
fqdn
  • string

Fully qualified domain name (FQDN).

ipAddress
  • string

IP address.

ApplicationGatewayBackendAddressPool

Backend Address Pool of an application gateway.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

Name of the backend address pool that is unique within an Application Gateway.

properties.backendAddresses

Backend addresses.

properties.backendIPConfigurations

Collection of references to IPs defined in network interfaces.

properties.provisioningState

The provisioning state of the backend address pool resource.

type
  • string

Type of the resource.

ApplicationGatewayBackendHttpSettings

Backend address pool settings of an application gateway.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

Name of the backend http settings that is unique within an Application Gateway.

properties.affinityCookieName
  • string

Cookie name to use for the affinity cookie.

properties.authenticationCertificates

Array of references to application gateway authentication certificates.

properties.connectionDraining

Connection draining of the backend http settings resource.

properties.cookieBasedAffinity

Cookie based affinity.

properties.hostName
  • string

Host header to be sent to the backend servers.

properties.path
  • string

Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null.

properties.pickHostNameFromBackendAddress
  • boolean

Whether to pick host header should be picked from the host name of the backend server. Default value is false.

properties.port
  • integer

The destination port on the backend.

properties.probe

Probe resource of an application gateway.

properties.probeEnabled
  • boolean

Whether the probe is enabled. Default value is false.

properties.protocol

The protocol used to communicate with the backend.

properties.provisioningState

The provisioning state of the backend HTTP settings resource.

properties.requestTimeout
  • integer

Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds.

properties.trustedRootCertificates

Array of references to application gateway trusted root certificates.

type
  • string

Type of the resource.

ApplicationGatewayConnectionDraining

Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration.

Name Type Description
drainTimeoutInSec
  • integer

The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.

enabled
  • boolean

Whether connection draining is enabled or not.

ApplicationGatewayCookieBasedAffinity

Cookie based affinity.

Name Type Description
Disabled
  • string
Enabled
  • string

ApplicationGatewayCustomError

Customer error of an application gateway.

Name Type Description
customErrorPageUrl
  • string

Error page URL of the application gateway customer error.

statusCode

Status code of the application gateway customer error.

ApplicationGatewayCustomErrorStatusCode

Status code of the application gateway customer error.

Name Type Description
HttpStatus403
  • string
HttpStatus502
  • string

ApplicationGatewayFirewallDisabledRuleGroup

Allows to disable rules within a rule group or an entire rule group.

Name Type Description
ruleGroupName
  • string

The name of the rule group that will be disabled.

rules
  • integer[]

The list of rules that will be disabled. If null, all rules of the rule group will be disabled.

ApplicationGatewayFirewallExclusion

Allow to exclude some variable satisfy the condition for the WAF check.

Name Type Description
matchVariable
  • string

The variable to be excluded.

selector
  • string

When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to.

selectorMatchOperator
  • string

When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to.

ApplicationGatewayFirewallMode

Web application firewall mode.

Name Type Description
Detection
  • string
Prevention
  • string

ApplicationGatewayFrontendIPConfiguration

Frontend IP configuration of an application gateway.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

Name of the frontend IP configuration that is unique within an Application Gateway.

properties.privateIPAddress
  • string

PrivateIPAddress of the network interface IP Configuration.

properties.privateIPAllocationMethod

The private IP address allocation method.

properties.provisioningState

The provisioning state of the frontend IP configuration resource.

properties.publicIPAddress

Reference of the PublicIP resource.

properties.subnet

Reference of the subnet resource.

type
  • string

Type of the resource.

ApplicationGatewayFrontendPort

Frontend port of an application gateway.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

Name of the frontend port that is unique within an Application Gateway.

properties.port
  • integer

Frontend port.

properties.provisioningState

The provisioning state of the frontend port resource.

type
  • string

Type of the resource.

ApplicationGatewayHeaderConfiguration

Header configuration of the Actions set in Application Gateway.

Name Type Description
headerName
  • string

Header name of the header configuration.

headerValue
  • string

Header value of the header configuration.

ApplicationGatewayHttpListener

Http listener of an application gateway.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

Name of the HTTP listener that is unique within an Application Gateway.

properties.customErrorConfigurations

Custom error configurations of the HTTP listener.

properties.frontendIPConfiguration

Frontend IP configuration resource of an application gateway.

properties.frontendPort

Frontend port resource of an application gateway.

properties.hostName
  • string

Host name of HTTP listener.

properties.protocol

Protocol of the HTTP listener.

properties.provisioningState

The provisioning state of the HTTP listener resource.

properties.requireServerNameIndication
  • boolean

Applicable only if protocol is https. Enables SNI for multi-hosting.

properties.sslCertificate

SSL certificate resource of an application gateway.

type
  • string

Type of the resource.

ApplicationGatewayIPConfiguration

IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

Name of the IP configuration that is unique within an Application Gateway.

properties.provisioningState

The provisioning state of the application gateway IP configuration resource.

properties.subnet

Reference of the subnet resource. A subnet from where application gateway gets its private address.

type
  • string

Type of the resource.

ApplicationGatewayOperationalState

Operational state of the application gateway resource.

Name Type Description
Running
  • string
Starting
  • string
Stopped
  • string
Stopping
  • string

ApplicationGatewayPathRule

Path rule of URL path map of an application gateway.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

Name of the path rule that is unique within an Application Gateway.

properties.backendAddressPool

Backend address pool resource of URL path map path rule.

properties.backendHttpSettings

Backend http settings resource of URL path map path rule.

properties.paths
  • string[]

Path rules of URL path map.

properties.provisioningState

The provisioning state of the path rule resource.

properties.redirectConfiguration

Redirect configuration resource of URL path map path rule.

properties.rewriteRuleSet

Rewrite rule set resource of URL path map path rule.

type
  • string

Type of the resource.

ApplicationGatewayProbe

Probe of the application gateway.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

Name of the probe that is unique within an Application Gateway.

properties.host
  • string

Host name to send the probe to.

properties.interval
  • integer

The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds.

properties.match

Criterion for classifying a healthy probe response.

properties.minServers
  • integer

Minimum number of servers that are always marked healthy. Default value is 0.

properties.path
  • string

Relative path of probe. Valid path starts from '/'. Probe is sent to ://:.

properties.pickHostNameFromBackendHttpSettings
  • boolean

Whether the host header should be picked from the backend http settings. Default value is false.

properties.port
  • integer

Custom port which will be used for probing the backend servers. The valid value ranges from 1 to 65535. In case not set, port from http settings will be used. This property is valid for Standard_v2 and WAF_v2 only.

properties.protocol

The protocol used for the probe.

properties.provisioningState

The provisioning state of the probe resource.

properties.timeout
  • integer

The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds.

properties.unhealthyThreshold
  • integer

The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20.

type
  • string

Type of the resource.

ApplicationGatewayProbeHealthResponseMatch

Application gateway probe health response match.

Name Type Description
body
  • string

Body that must be contained in the health response. Default value is empty.

statusCodes
  • string[]

Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399.

ApplicationGatewayProtocol

Application Gateway protocol.

Name Type Description
Http
  • string
Https
  • string

ApplicationGatewayRedirectConfiguration

Redirect configuration of an application gateway.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

Name of the redirect configuration that is unique within an Application Gateway.

properties.includePath
  • boolean

Include path in the redirected url.

properties.includeQueryString
  • boolean

Include query string in the redirected url.

properties.pathRules

Path rules specifying redirect configuration.

properties.redirectType

HTTP redirection type.

properties.requestRoutingRules

Request routing specifying redirect configuration.

properties.targetListener

Reference to a listener to redirect the request to.

properties.targetUrl
  • string

Url to redirect the request to.

properties.urlPathMaps

Url path maps specifying default redirect configuration.

type
  • string

Type of the resource.

ApplicationGatewayRedirectType

HTTP redirection type.

Name Type Description
Found
  • string
Permanent
  • string
SeeOther
  • string
Temporary
  • string

ApplicationGatewayRequestRoutingRule

Request routing rule of an application gateway.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

Name of the request routing rule that is unique within an Application Gateway.

properties.backendAddressPool

Backend address pool resource of the application gateway.

properties.backendHttpSettings

Backend http settings resource of the application gateway.

properties.httpListener

Http listener resource of the application gateway.

properties.priority
  • integer

Priority of the request routing rule.

properties.provisioningState

The provisioning state of the request routing rule resource.

properties.redirectConfiguration

Redirect configuration resource of the application gateway.

properties.rewriteRuleSet

Rewrite Rule Set resource in Basic rule of the application gateway.

properties.ruleType

Rule type.

properties.urlPathMap

URL path map resource of the application gateway.

type
  • string

Type of the resource.

ApplicationGatewayRequestRoutingRuleType

Rule type.

Name Type Description
Basic
  • string
PathBasedRouting
  • string

ApplicationGatewayRewriteRule

Rewrite rule of an application gateway.

Name Type Description
actionSet

Set of actions to be done as part of the rewrite Rule.

conditions

Conditions based on which the action set execution will be evaluated.

name
  • string

Name of the rewrite rule that is unique within an Application Gateway.

ruleSequence
  • integer

Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet.

ApplicationGatewayRewriteRuleActionSet

Set of actions in the Rewrite Rule in Application Gateway.

Name Type Description
requestHeaderConfigurations

Request Header Actions in the Action Set.

responseHeaderConfigurations

Response Header Actions in the Action Set.

ApplicationGatewayRewriteRuleCondition

Set of conditions in the Rewrite Rule in Application Gateway.

Name Type Description
ignoreCase
  • boolean

Setting this paramter to truth value with force the pattern to do a case in-sensitive comparison.

negate
  • boolean

Setting this value as truth will force to check the negation of the condition given by the user.

pattern
  • string

The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition.

variable
  • string

The condition parameter of the RewriteRuleCondition.

ApplicationGatewayRewriteRuleSet

Rewrite rule set of an application gateway.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

Name of the rewrite rule set that is unique within an Application Gateway.

properties.provisioningState

The provisioning state of the rewrite rule set resource.

properties.rewriteRules

Rewrite rules in the rewrite rule set.

ApplicationGatewaySku

SKU of an application gateway.

Name Type Description
capacity
  • integer

Capacity (instance count) of an application gateway.

name

Name of an application gateway SKU.

tier

Tier of an application gateway.

ApplicationGatewaySkuName

Name of an application gateway SKU.

Name Type Description
Standard_Large
  • string
Standard_Medium
  • string
Standard_Small
  • string
Standard_v2
  • string
WAF_Large
  • string
WAF_Medium
  • string
WAF_v2
  • string

ApplicationGatewaySslCertificate

SSL certificates of an application gateway.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

Name of the SSL certificate that is unique within an Application Gateway.

properties.data
  • string

Base-64 encoded pfx certificate. Only applicable in PUT Request.

properties.keyVaultSecretId
  • string

Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.

properties.password
  • string

Password for the pfx file specified in data. Only applicable in PUT request.

properties.provisioningState

The provisioning state of the SSL certificate resource.

properties.publicCertData
  • string

Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request.

type
  • string

Type of the resource.

ApplicationGatewaySslPolicy

Application Gateway Ssl policy.

Name Type Description
cipherSuites
  • string[]

Ssl cipher suites to be enabled in the specified order to application gateway.

disabledSslProtocols
  • string[]

Ssl protocols to be disabled on application gateway.

minProtocolVersion

Minimum version of Ssl protocol to be supported on application gateway.

policyName

Name of Ssl predefined policy.

policyType

Type of Ssl Policy.

ApplicationGatewaySslPolicyName

Name of Ssl predefined policy.

Name Type Description
AppGwSslPolicy20150501
  • string
AppGwSslPolicy20170401
  • string
AppGwSslPolicy20170401S
  • string

ApplicationGatewaySslPolicyType

Type of Ssl Policy.

Name Type Description
Custom
  • string
Predefined
  • string

ApplicationGatewaySslProtocol

Minimum version of Ssl protocol to be supported on application gateway.

Name Type Description
TLSv1_0
  • string
TLSv1_1
  • string
TLSv1_2
  • string

ApplicationGatewayTier

Tier of an application gateway.

Name Type Description
Standard
  • string
Standard_v2
  • string
WAF
  • string
WAF_v2
  • string

ApplicationGatewayTrustedRootCertificate

Trusted Root certificates of an application gateway.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

Name of the trusted root certificate that is unique within an Application Gateway.

properties.data
  • string

Certificate public data.

properties.keyVaultSecretId
  • string

Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault.

properties.provisioningState

The provisioning state of the trusted root certificate resource.

type
  • string

Type of the resource.

ApplicationGatewayUrlPathMap

UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

Name of the URL path map that is unique within an Application Gateway.

properties.defaultBackendAddressPool

Default backend address pool resource of URL path map.

properties.defaultBackendHttpSettings

Default backend http settings resource of URL path map.

properties.defaultRedirectConfiguration

Default redirect configuration resource of URL path map.

properties.defaultRewriteRuleSet

Default Rewrite rule set resource of URL path map.

properties.pathRules

Path rule of URL path map resource.

properties.provisioningState

The provisioning state of the URL path map resource.

type
  • string

Type of the resource.

ApplicationGatewayWebApplicationFirewallConfiguration

Application gateway web application firewall configuration.

Name Type Description
disabledRuleGroups

The disabled rule groups.

enabled
  • boolean

Whether the web application firewall is enabled or not.

exclusions

The exclusion list.

fileUploadLimitInMb
  • integer

Maximum file upload size in Mb for WAF.

firewallMode

Web application firewall mode.

maxRequestBodySize
  • integer

Maximum request body size for WAF.

maxRequestBodySizeInKb
  • integer

Maximum request body size in Kb for WAF.

requestBodyCheck
  • boolean

Whether allow WAF to check request Body.

ruleSetType
  • string

The type of the web application firewall rule set. Possible values are: 'OWASP'.

ruleSetVersion
  • string

The version of the rule set type.

ApplicationSecurityGroup

An application security group in a resource group.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

location
  • string

Resource location.

name
  • string

Resource name.

properties.provisioningState

The provisioning state of the application security group resource.

properties.resourceGuid
  • string

The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups.

tags
  • object

Resource tags.

type
  • string

Resource type.

BackendAddressPool

Pool of backend IP addresses.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

The name of the resource that is unique within the set of backend address pools used by the load balancer. This name can be used to access the resource.

properties.backendIPConfigurations

An array of references to IP addresses defined in network interfaces.

properties.loadBalancingRules

An array of references to load balancing rules that use this backend address pool.

properties.outboundRule

A reference to an outbound rule that uses this backend address pool.

properties.outboundRules

An array of references to outbound rules that use this backend address pool.

properties.provisioningState

The provisioning state of the backend address pool resource.

type
  • string

Type of the resource.

DdosSettings

Contains the DDoS protection settings of the public IP.

Name Type Description
ddosCustomPolicy

The DDoS custom policy associated with the public IP.

protectionCoverage

The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized.

DdosSettingsProtectionCoverage

The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized.

Name Type Description
Basic
  • string
Standard
  • string

Delegation

Details the service to which the subnet is delegated.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

The name of the resource that is unique within a subnet. This name can be used to access the resource.

properties.actions
  • string[]

Describes the actions permitted to the service upon delegation.

properties.provisioningState

The provisioning state of the service delegation resource.

properties.serviceName
  • string

The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers).

FrontendIPConfiguration

Frontend IP address of the load balancer.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource.

properties.inboundNatPools

An array of references to inbound pools that use this frontend IP.

properties.inboundNatRules

An array of references to inbound rules that use this frontend IP.

properties.loadBalancingRules

An array of references to load balancing rules that use this frontend IP.

properties.outboundRules

An array of references to outbound rules that use this frontend IP.

properties.privateIPAddress
  • string

The private IP address of the IP configuration.

properties.privateIPAddressVersion

Whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4.

properties.privateIPAllocationMethod

The Private IP allocation method.

properties.provisioningState

The provisioning state of the frontend IP configuration resource.

properties.publicIPAddress

The reference of the Public IP resource.

properties.publicIPPrefix

The reference of the Public IP Prefix resource.

properties.subnet

The reference of the subnet resource.

type
  • string

Type of the resource.

zones
  • string[]

A list of availability zones denoting the IP allocated for the resource needs to come from.

InboundNatRule

Inbound NAT rule of the load balancer.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

The name of the resource that is unique within the set of inbound NAT rules used by the load balancer. This name can be used to access the resource.

properties.backendIPConfiguration

A reference to a private IP address defined on a network interface of a VM. Traffic sent to the frontend port of each of the frontend IP configurations is forwarded to the backend IP.

properties.backendPort
  • integer

The port used for the internal endpoint. Acceptable values range from 1 to 65535.

properties.enableFloatingIP
  • boolean

Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.

properties.enableTcpReset
  • boolean

Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.

properties.frontendIPConfiguration

A reference to frontend IP addresses.

properties.frontendPort
  • integer

The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.

properties.idleTimeoutInMinutes
  • integer

The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.

properties.protocol

The reference to the transport protocol used by the load balancing rule.

properties.provisioningState

The provisioning state of the inbound NAT rule resource.

type
  • string

Type of the resource.

IPAllocationMethod

IP address allocation method.

Name Type Description
Dynamic
  • string
Static
  • string

IPConfiguration

IP configuration.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

properties.privateIPAddress
  • string

The private IP address of the IP configuration.

properties.privateIPAllocationMethod

The private IP address allocation method.

properties.provisioningState

The provisioning state of the IP configuration resource.

properties.publicIPAddress

The reference of the public IP resource.

properties.subnet

The reference of the subnet resource.

IPConfigurationProfile

IP configuration profile child resource.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

The name of the resource. This name can be used to access the resource.

properties.provisioningState

The provisioning state of the IP configuration profile resource.

properties.subnet

The reference of the subnet resource to create a container network interface ip configuration.

type
  • string

Sub Resource type.

IpTag

Contains the IpTag associated with the object.

Name Type Description
ipTagType
  • string

The IP tag type. Example: FirstPartyUsage.

tag
  • string

The value of the IP tag associated with the public IP. Example: SQL.

IPVersion

IP address version.

Name Type Description
IPv4
  • string
IPv6
  • string

ManagedServiceIdentity

Identity for the resource.

Name Type Description
principalId
  • string

The principal id of the system assigned identity. This property will only be provided for a system assigned identity.

tenantId
  • string

The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.

type

The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.

userAssignedIdentities

The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

NetworkInterface

A network interface in a resource group.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

location
  • string

Resource location.

name
  • string

Resource name.

properties.dnsSettings

The DNS settings in network interface.

properties.enableAcceleratedNetworking
  • boolean

If the network interface is accelerated networking enabled.

properties.enableIPForwarding
  • boolean

Indicates whether IP forwarding is enabled on this network interface.

properties.hostedWorkloads
  • string[]

A list of references to linked BareMetal resources.

properties.ipConfigurations

A list of IPConfigurations of the network interface.

properties.macAddress
  • string

The MAC address of the network interface.

properties.networkSecurityGroup

The reference of the NetworkSecurityGroup resource.

properties.primary
  • boolean

Whether this is a primary network interface on a virtual machine.

properties.privateEndpoint

A reference to the private endpoint to which the network interface is linked.

properties.provisioningState

The provisioning state of the network interface resource.

properties.resourceGuid
  • string

The resource GUID property of the network interface resource.

properties.tapConfigurations

A list of TapConfigurations of the network interface.

properties.virtualMachine

The reference of a virtual machine.

tags
  • object

Resource tags.

type
  • string

Resource type.

NetworkInterfaceDnsSettings

DNS settings of a network interface.

Name Type Description
appliedDnsServers
  • string[]

If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs.

dnsServers
  • string[]

List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection.

internalDnsNameLabel
  • string

Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.

internalDomainNameSuffix
  • string

Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix.

internalFqdn
  • string

Fully qualified DNS name supporting internal communications between VMs in the same virtual network.

NetworkInterfaceIPConfiguration

IPConfiguration in a network interface.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

properties.applicationGatewayBackendAddressPools

The reference of ApplicationGatewayBackendAddressPool resource.

properties.applicationSecurityGroups

Application security groups in which the IP configuration is included.

properties.loadBalancerBackendAddressPools

The reference of LoadBalancerBackendAddressPool resource.

properties.loadBalancerInboundNatRules

A list of references of LoadBalancerInboundNatRules.

properties.primary
  • boolean

Whether this is a primary customer address on the network interface.

properties.privateIPAddress
  • string

Private IP address of the IP configuration.

properties.privateIPAddressVersion

Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4.

properties.privateIPAllocationMethod

The private IP address allocation method.

properties.privateLinkConnectionProperties

PrivateLinkConnection properties for the network interface.

properties.provisioningState

The provisioning state of the network interface IP configuration.

properties.publicIPAddress

Public IP address bound to the IP configuration.

properties.subnet

Subnet bound to the IP configuration.

properties.virtualNetworkTaps

The reference to Virtual Network Taps.

NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties

PrivateLinkConnection properties for the network interface.

Name Type Description
fqdns
  • string[]

List of FQDNs for current private link connection.

groupId
  • string

The group ID for current private link connection.

requiredMemberName
  • string

The required member name for current private link connection.

NetworkInterfaceTapConfiguration

Tap configuration in a Network Interface.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

properties.provisioningState

The provisioning state of the network interface tap configuration resource.

properties.virtualNetworkTap

The reference of the Virtual Network Tap resource.

type
  • string

Sub Resource type.

NetworkSecurityGroup

NetworkSecurityGroup resource.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

location
  • string

Resource location.

name
  • string

Resource name.

properties.defaultSecurityRules

The default security rules of network security group.

properties.networkInterfaces

A collection of references to network interfaces.

properties.provisioningState

The provisioning state of the network security group resource.

properties.resourceGuid
  • string

The resource GUID property of the network security group resource.

properties.securityRules

A collection of security rules of the network security group.

properties.subnets

A collection of references to subnets.

tags
  • object

Resource tags.

type
  • string

Resource type.

PrivateEndpoint

Private endpoint resource.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

location
  • string

Resource location.

name
  • string

Resource name.

properties.manualPrivateLinkServiceConnections

A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource.

properties.networkInterfaces

An array of references to the network interfaces created for this private endpoint.

properties.privateLinkServiceConnections

A grouping of information about the connection to the remote resource.

properties.provisioningState

The provisioning state of the private endpoint resource.

properties.subnet

The ID of the subnet from which the private IP will be allocated.

tags
  • object

Resource tags.

type
  • string

Resource type.

PrivateLinkServiceConnection

PrivateLinkServiceConnection resource.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

properties.groupIds
  • string[]

The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to.

properties.privateLinkServiceConnectionState

A collection of read-only information about the state of the connection to the remote resource.

properties.privateLinkServiceId
  • string

The resource id of private link service.

properties.provisioningState

The provisioning state of the private link service connection resource.

properties.requestMessage
  • string

A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars.

type
  • string

The resource type.

PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

Name Type Description
actionRequired
  • string

A message indicating if changes on the service provider require any updates on the consumer.

description
  • string

The reason for approval/rejection of the connection.

status
  • string

Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

ProvisioningState

The current provisioning state.

Name Type Description
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

PublicIPAddress

Public IP address resource.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

location
  • string

Resource location.

name
  • string

Resource name.

properties.ddosSettings

The DDoS protection custom policy associated with the public IP address.

properties.dnsSettings

The FQDN of the DNS record associated with the public IP address.

properties.idleTimeoutInMinutes
  • integer

The idle timeout of the public IP address.

properties.ipAddress
  • string

The IP address associated with the public IP address resource.

properties.ipConfiguration

The IP configuration associated with the public IP address.

properties.ipTags

The list of tags associated with the public IP address.

properties.provisioningState

The provisioning state of the public IP address resource.

properties.publicIPAddressVersion

The public IP address version.

properties.publicIPAllocationMethod

The public IP address allocation method.

properties.publicIPPrefix

The Public IP Prefix this Public IP Address should be allocated from.

properties.resourceGuid
  • string

The resource GUID property of the public IP address resource.

sku

The public IP address SKU.

tags
  • object

Resource tags.

type
  • string

Resource type.

zones
  • string[]

A list of availability zones denoting the IP allocated for the resource needs to come from.

PublicIPAddressDnsSettings

Contains FQDN of the DNS record associated with the public IP address.

Name Type Description
domainNameLabel
  • string

The domain name label. The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system.

fqdn
  • string

The Fully Qualified Domain Name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone.

reverseFqdn
  • string

The reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN.

PublicIPAddressSku

SKU of a public IP address.

Name Type Description
name

Name of a public IP address SKU.

PublicIPAddressSkuName

Name of a public IP address SKU.

Name Type Description
Basic
  • string
Standard
  • string

ResourceIdentityType

The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned, UserAssigned
  • string
UserAssigned
  • string

ResourceNavigationLink resource.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource navigation link identifier.

name
  • string

Name of the resource that is unique within a resource group. This name can be used to access the resource.

properties.link
  • string

Link to the external resource.

properties.linkedResourceType
  • string

Resource type of the linked resource.

properties.provisioningState

The provisioning state of the resource navigation link resource.

type
  • string

Resource type.

Route

Route resource.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

properties.addressPrefix
  • string

The destination CIDR to which the route applies.

properties.nextHopIpAddress
  • string

The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.

properties.nextHopType

The type of Azure hop the packet should be sent to.

properties.provisioningState

The provisioning state of the route resource.

RouteNextHopType

The type of Azure hop the packet should be sent to.

Name Type Description
Internet
  • string
None
  • string
VirtualAppliance
  • string
VirtualNetworkGateway
  • string
VnetLocal
  • string

RouteTable

Route table resource.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

location
  • string

Resource location.

name
  • string

Resource name.

properties.disableBgpRoutePropagation
  • boolean

Whether to disable the routes learned by BGP on that route table. True means disable.

properties.provisioningState

The provisioning state of the route table resource.

properties.routes

Collection of routes contained within a route table.

properties.subnets

A collection of references to subnets.

tags
  • object

Resource tags.

type
  • string

Resource type.

SecurityRule

Network security rule.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

properties.access

The network traffic is allowed or denied.

properties.description
  • string

A description for this rule. Restricted to 140 chars.

properties.destinationAddressPrefix
  • string

The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used.

properties.destinationAddressPrefixes
  • string[]

The destination address prefixes. CIDR or destination IP ranges.

properties.destinationApplicationSecurityGroups

The application security group specified as destination.

properties.destinationPortRange
  • string

The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.

properties.destinationPortRanges
  • string[]

The destination port ranges.

properties.direction

The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.

properties.priority
  • integer

The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.

properties.protocol

Network protocol this rule applies to.

properties.provisioningState

The provisioning state of the security rule resource.

properties.sourceAddressPrefix
  • string

The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from.

properties.sourceAddressPrefixes
  • string[]

The CIDR or source IP ranges.

properties.sourceApplicationSecurityGroups

The application security group specified as source.

properties.sourcePortRange
  • string

The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.

properties.sourcePortRanges
  • string[]

The source port ranges.

SecurityRuleAccess

Whether network traffic is allowed or denied.

Name Type Description
Allow
  • string
Deny
  • string

SecurityRuleDirection

The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.

Name Type Description
Inbound
  • string
Outbound
  • string

SecurityRuleProtocol

Network protocol this rule applies to.

Name Type Description
*
  • string
Esp
  • string
Icmp
  • string
Tcp
  • string
Udp
  • string

ServiceAssociationLink resource.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

Name of the resource that is unique within a resource group. This name can be used to access the resource.

properties.allowDelete
  • boolean

If true, the resource can be deleted.

properties.link
  • string

Link to the external resource.

properties.linkedResourceType
  • string

Resource type of the linked resource.

properties.locations
  • string[]

A list of locations.

properties.provisioningState

The provisioning state of the service association link resource.

type
  • string

Resource type.

ServiceEndpointPolicy

Service End point policy resource.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

location
  • string

Resource location.

name
  • string

Resource name.

properties.provisioningState

The provisioning state of the service endpoint policy resource.

properties.resourceGuid
  • string

The resource GUID property of the service endpoint policy resource.

properties.serviceEndpointPolicyDefinitions

A collection of service endpoint policy definitions of the service endpoint policy.

properties.subnets

A collection of references to subnets.

tags
  • object

Resource tags.

type
  • string

Resource type.

ServiceEndpointPolicyDefinition

Service Endpoint policy definitions.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

properties.description
  • string

A description for this rule. Restricted to 140 chars.

properties.provisioningState

The provisioning state of the service endpoint policy definition resource.

properties.service
  • string

Service endpoint name.

properties.serviceResources
  • string[]

A list of service resources.

ServiceEndpointPropertiesFormat

The service endpoint properties.

Name Type Description
locations
  • string[]

A list of locations.

provisioningState

The provisioning state of the service endpoint resource.

service
  • string

The type of the endpoint service.

Subnet

Subnet in a virtual network resource.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

name
  • string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

properties.addressPrefix
  • string

The address prefix for the subnet.

properties.addressPrefixes
  • string[]

List of address prefixes for the subnet.

properties.delegations

An array of references to the delegations on the subnet.

properties.ipConfigurationProfiles

Array of IP configuration profiles which reference this subnet.

properties.ipConfigurations

An array of references to the network interface IP configurations using subnet.

properties.natGateway

Nat gateway associated with this subnet.

properties.networkSecurityGroup

The reference of the NetworkSecurityGroup resource.

properties.privateEndpointNetworkPolicies
  • string

Enable or Disable apply network policies on private end point in the subnet.

properties.privateEndpoints

An array of references to private endpoints.

properties.privateLinkServiceNetworkPolicies
  • string

Enable or Disable apply network policies on private link service in the subnet.

properties.provisioningState

The provisioning state of the subnet resource.

properties.purpose
  • string

A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties.

properties.resourceNavigationLinks

An array of references to the external resources using subnet.

properties.routeTable

The reference of the RouteTable resource.

properties.serviceAssociationLinks

An array of references to services injecting into this subnet.

properties.serviceEndpointPolicies

An array of service endpoint policies.

properties.serviceEndpoints

An array of service endpoints.

SubResource

Reference to another subresource.

Name Type Description
id
  • string

Resource ID.

TransportProtocol

The transport protocol for the endpoint.

Name Type Description
All
  • string
Tcp
  • string
Udp
  • string

UserAssignedIdentities

The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Name Type Description

VirtualNetworkTap

Virtual Network Tap resource.

Name Type Description
etag
  • string

A unique read-only string that changes whenever the resource is updated.

id
  • string

Resource ID.

location
  • string

Resource location.

name
  • string

Resource name.

properties.destinationLoadBalancerFrontEndIPConfiguration

The reference to the private IP address on the internal Load Balancer that will receive the tap.

properties.destinationNetworkInterfaceIPConfiguration

The reference to the private IP Address of the collector nic that will receive the tap.

properties.destinationPort
  • integer

The VXLAN destination port that will receive the tapped traffic.

properties.networkInterfaceTapConfigurations

Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped.

properties.provisioningState

The provisioning state of the virtual network tap resource.

properties.resourceGuid
  • string

The resource GUID property of the virtual network tap resource.

tags
  • object

Resource tags.

type
  • string

Resource type.