{ "swagger": "2.0", "info": { "title": "WebApplicationFirewallManagement", "version": "2026-03-01", "description": "APIs to manage Microsoft Azure network resources.", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "host": "management.azure.com", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow.", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } }, "tags": [ { "name": "ApplicationGateways" }, { "name": "ApplicationGatewayPrivateLinkResources" }, { "name": "ApplicationGatewayPrivateEndpointConnections" }, { "name": "WebApplicationFirewallPolicies" } ], "paths": { "/subscriptions/{subscriptionId}/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies": { "get": { "operationId": "WebApplicationFirewallPolicies_ListAll", "tags": [ "WebApplicationFirewallPolicies" ], "description": "Gets all the WAF policies in a subscription.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/WebApplicationFirewallPolicyListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Lists all WAF policies in a subscription": { "$ref": "./examples/WafListAllPolicies.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableRequestHeaders": { "get": { "operationId": "ApplicationGateways_ListAvailableRequestHeaders", "tags": [ "ApplicationGateways" ], "description": "Lists all available request headers.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "type": "array", "items": { "type": "string" } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/Error" } } }, "x-ms-examples": { "Get Available Request Headers": { "$ref": "./examples/ApplicationGatewayAvailableRequestHeadersGet.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableResponseHeaders": { "get": { "operationId": "ApplicationGateways_ListAvailableResponseHeaders", "tags": [ "ApplicationGateways" ], "description": "Lists all available response headers.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "type": "array", "items": { "type": "string" } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/Error" } } }, "x-ms-examples": { "Get Available Response Headers": { "$ref": "./examples/ApplicationGatewayAvailableResponseHeadersGet.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableServerVariables": { "get": { "operationId": "ApplicationGateways_ListAvailableServerVariables", "tags": [ "ApplicationGateways" ], "description": "Lists all available server variables.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "type": "array", "items": { "type": "string" } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/Error" } } }, "x-ms-examples": { "Get Available Server Variables": { "$ref": "./examples/ApplicationGatewayAvailableServerVariablesGet.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableSslOptions/default": { "get": { "operationId": "ApplicationGateways_ListAvailableSslOptions", "tags": [ "ApplicationGateways" ], "description": "Lists available Ssl options for configuring Ssl policy.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ApplicationGatewayAvailableSslOptions" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get Available Ssl Options": { "$ref": "./examples/ApplicationGatewayAvailableSslOptionsGet.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableSslOptions/default/predefinedPolicies": { "get": { "operationId": "ApplicationGateways_ListAvailableSslPredefinedPolicies", "tags": [ "ApplicationGateways" ], "description": "Lists all SSL predefined policies for configuring Ssl policy.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ApplicationGatewayAvailableSslPredefinedPolicies" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get Available Ssl Predefined Policies": { "$ref": "./examples/ApplicationGatewayAvailableSslOptionsPredefinedPoliciesGet.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableSslOptions/default/predefinedPolicies/{predefinedPolicyName}": { "get": { "operationId": "ApplicationGateways_GetSslPredefinedPolicy", "tags": [ "ApplicationGateways" ], "description": "Gets Ssl predefined policy with the specified policy name.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "name": "predefinedPolicyName", "in": "path", "description": "The name of the ssl predefined policy.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ApplicationGatewaySslPredefinedPolicy" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get Available Ssl Predefined Policy by name": { "$ref": "./examples/ApplicationGatewayAvailableSslOptionsPredefinedPolicyGet.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableWafRuleSets": { "get": { "operationId": "ApplicationGateways_ListAvailableWafRuleSets", "tags": [ "ApplicationGateways" ], "description": "Lists all available web application firewall rule sets.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ApplicationGatewayAvailableWafRuleSetsResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get Available Waf Rule Sets": { "$ref": "./examples/ApplicationGatewayAvailableWafRuleSetsGet.json" } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGateways": { "get": { "operationId": "ApplicationGateways_ListAll", "tags": [ "ApplicationGateways" ], "description": "Gets all the application gateways in a subscription.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ApplicationGatewayListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Lists all application gateways in a subscription": { "$ref": "./examples/ApplicationGatewayListAll.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/applicationGatewayWafDynamicManifests": { "get": { "operationId": "ApplicationGatewayWafDynamicManifests_Get", "description": "Gets the regional application gateway waf manifest.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "name": "location", "in": "path", "description": "The location for which the WAF dynamic manifest is requested.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ApplicationGatewayWafDynamicManifestResultList" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Gets WAF manifests": { "$ref": "./examples/GetApplicationGatewayWafDynamicManifests.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/applicationGatewayWafDynamicManifests/dafault": { "get": { "operationId": "ApplicationGatewayWafDynamicManifestsDefault_Get", "description": "Gets the regional application gateway waf manifest.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "name": "location", "in": "path", "description": "The location for which the WAF dynamic manifest is requested.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ApplicationGatewayWafDynamicManifestResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Gets WAF default manifest": { "$ref": "./examples/GetApplicationGatewayWafDynamicManifestsDefault.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies": { "get": { "operationId": "WebApplicationFirewallPolicies_List", "tags": [ "WebApplicationFirewallPolicies" ], "description": "Lists all of the protection policies within a resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/WebApplicationFirewallPolicyListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Lists all WAF policies in a resource group": { "$ref": "./examples/WafListPolicies.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/{policyName}": { "get": { "operationId": "WebApplicationFirewallPolicies_Get", "tags": [ "WebApplicationFirewallPolicies" ], "description": "Retrieve protection policy with specified name within a resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "policyName", "in": "path", "description": "The name of the policy.", "required": true, "type": "string", "maxLength": 128 } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/WebApplicationFirewallPolicy" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Gets a Basic tier WAF policy within a resource group": { "$ref": "./examples/WafPolicyGetBasic.json" }, "Gets a WAF policy within a resource group": { "$ref": "./examples/WafPolicyGet.json" } } }, "put": { "operationId": "WebApplicationFirewallPolicies_CreateOrUpdate", "tags": [ "WebApplicationFirewallPolicies" ], "description": "Creates or update policy with specified rule set name within a resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "policyName", "in": "path", "description": "The name of the policy.", "required": true, "type": "string", "maxLength": 128 }, { "name": "parameters", "in": "body", "description": "Policy to be created.", "required": true, "schema": { "$ref": "#/definitions/WebApplicationFirewallPolicy" } } ], "responses": { "200": { "description": "Resource 'WebApplicationFirewallPolicy' update operation succeeded", "schema": { "$ref": "#/definitions/WebApplicationFirewallPolicy" } }, "201": { "description": "Resource 'WebApplicationFirewallPolicy' create operation succeeded", "schema": { "$ref": "#/definitions/WebApplicationFirewallPolicy" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Creates or updates a Basic tier WAF policy within a resource group": { "$ref": "./examples/WafPolicyCreateOrUpdateBasic.json" }, "Creates or updates a WAF policy within a resource group": { "$ref": "./examples/WafPolicyCreateOrUpdate.json" } } }, "delete": { "operationId": "WebApplicationFirewallPolicies_Delete", "tags": [ "WebApplicationFirewallPolicies" ], "description": "Deletes Policy.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "policyName", "in": "path", "description": "The name of the policy.", "required": true, "type": "string", "maxLength": 128 } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Deletes a WAF policy within a resource group": { "$ref": "./examples/WafPolicyDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways": { "get": { "operationId": "ApplicationGateways_List", "tags": [ "ApplicationGateways" ], "description": "Lists all application gateways in a resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ApplicationGatewayListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Lists all application gateways in a resource group": { "$ref": "./examples/ApplicationGatewayList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}": { "get": { "operationId": "ApplicationGateways_Get", "tags": [ "ApplicationGateways" ], "description": "Gets the specified application gateway.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "applicationGatewayName", "in": "path", "description": "The name of the application gateway.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ApplicationGateway" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get ApplicationGateway": { "$ref": "./examples/ApplicationGatewayGet.json" }, "Get Basic_WAF_v2 Application Gateway": { "$ref": "./examples/ApplicationGatewayGetBasicWafV2.json" }, "Get Basic_v2 Application Gateway": { "$ref": "./examples/ApplicationGatewayGetBasicV2.json" } } }, "put": { "operationId": "ApplicationGateways_CreateOrUpdate", "tags": [ "ApplicationGateways" ], "description": "Creates or updates the specified application gateway.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "applicationGatewayName", "in": "path", "description": "The name of the application gateway.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Parameters supplied to the create or update application gateway operation.", "required": true, "schema": { "$ref": "#/definitions/ApplicationGateway" } } ], "responses": { "200": { "description": "Resource 'ApplicationGateway' update operation succeeded", "schema": { "$ref": "#/definitions/ApplicationGateway" } }, "201": { "description": "Resource 'ApplicationGateway' create operation succeeded", "schema": { "$ref": "#/definitions/ApplicationGateway" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Create Application Gateway": { "$ref": "./examples/ApplicationGatewayCreate.json" }, "Create Basic_WAF_v2 Application Gateway": { "$ref": "./examples/ApplicationGatewayCreateBasicWafV2.json" }, "Create Basic_v2 Application Gateway": { "$ref": "./examples/ApplicationGatewayCreateBasicV2.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/ApplicationGateway" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "ApplicationGateways_UpdateTags", "tags": [ "ApplicationGateways" ], "description": "Updates the specified application gateway tags.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "applicationGatewayName", "in": "path", "description": "The name of the application gateway.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Parameters supplied to update application gateway tags.", "required": true, "schema": { "$ref": "./common.json#/definitions/TagsObject" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ApplicationGateway" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Update Application Gateway tags": { "$ref": "./examples/ApplicationGatewayUpdateTags.json" } } }, "delete": { "operationId": "ApplicationGateways_Delete", "tags": [ "ApplicationGateways" ], "description": "Deletes the specified application gateway.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "applicationGatewayName", "in": "path", "description": "The name of the application gateway.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Delete ApplicationGateway": { "$ref": "./examples/ApplicationGatewayDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendhealth": { "post": { "operationId": "ApplicationGateways_BackendHealth", "tags": [ "ApplicationGateways" ], "description": "Gets the backend health of the specified application gateway in a resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "applicationGatewayName", "in": "path", "description": "The name of the application gateway.", "required": true, "type": "string" }, { "name": "$expand", "in": "query", "description": "Expands BackendAddressPool and BackendHttpSettings referenced in backend health.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ApplicationGatewayBackendHealth" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get Backend Health": { "$ref": "./examples/ApplicationGatewayBackendHealthGet.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ApplicationGatewayBackendHealth" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/getBackendHealthOnDemand": { "post": { "operationId": "ApplicationGateways_BackendHealthOnDemand", "tags": [ "ApplicationGateways" ], "description": "Gets the backend health for given combination of backend pool and http setting of the specified application gateway in a resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "applicationGatewayName", "in": "path", "description": "The name of the application gateway.", "required": true, "type": "string" }, { "name": "$expand", "in": "query", "description": "Expands BackendAddressPool and BackendHttpSettings referenced in backend health.", "required": false, "type": "string" }, { "name": "probeRequest", "in": "body", "description": "Request body for on-demand test probe operation.", "required": true, "schema": { "$ref": "#/definitions/ApplicationGatewayOnDemandProbe" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ApplicationGatewayBackendHealthOnDemand" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Test Backend Health": { "$ref": "./examples/ApplicationGatewayBackendHealthTest.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ApplicationGatewayBackendHealthOnDemand" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/privateEndpointConnections": { "get": { "operationId": "ApplicationGatewayPrivateEndpointConnections_List", "tags": [ "ApplicationGatewayPrivateEndpointConnections" ], "description": "Lists all private endpoint connections on an application gateway.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "applicationGatewayName", "in": "path", "description": "The name of the application gateway.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ApplicationGatewayPrivateEndpointConnectionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Lists all private endpoint connections on application gateway": { "$ref": "./examples/ApplicationGatewayPrivateEndpointConnectionList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/privateEndpointConnections/{connectionName}": { "get": { "operationId": "ApplicationGatewayPrivateEndpointConnections_Get", "tags": [ "ApplicationGatewayPrivateEndpointConnections" ], "description": "Gets the specified private endpoint connection on application gateway.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "applicationGatewayName", "in": "path", "description": "The name of the application gateway.", "required": true, "type": "string" }, { "name": "connectionName", "in": "path", "description": "Name of the private endpoint connection on an application gateway.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ApplicationGatewayPrivateEndpointConnection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Get Application Gateway Private Endpoint Connection": { "$ref": "./examples/ApplicationGatewayPrivateEndpointConnectionGet.json" } } }, "put": { "operationId": "ApplicationGatewayPrivateEndpointConnections_Update", "tags": [ "ApplicationGatewayPrivateEndpointConnections" ], "description": "Updates the specified private endpoint connection on application gateway.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "applicationGatewayName", "in": "path", "description": "The name of the application gateway.", "required": true, "type": "string" }, { "name": "connectionName", "in": "path", "description": "Name of the private endpoint connection on an application gateway.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "Parameters supplied to update application gateway private endpoint connection operation.", "required": true, "schema": { "$ref": "#/definitions/ApplicationGatewayPrivateEndpointConnection" } } ], "responses": { "200": { "description": "Resource 'ApplicationGatewayPrivateEndpointConnection' update operation succeeded", "schema": { "$ref": "#/definitions/ApplicationGatewayPrivateEndpointConnection" } }, "202": { "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Update Application Gateway Private Endpoint Connection": { "$ref": "./examples/ApplicationGatewayPrivateEndpointConnectionUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/ApplicationGatewayPrivateEndpointConnection" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "ApplicationGatewayPrivateEndpointConnections_Delete", "tags": [ "ApplicationGatewayPrivateEndpointConnections" ], "description": "Deletes the specified private endpoint connection on application gateway.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "applicationGatewayName", "in": "path", "description": "The name of the application gateway.", "required": true, "type": "string" }, { "name": "connectionName", "in": "path", "description": "Name of the private endpoint connection on an application gateway.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Delete Application Gateway Private Endpoint Connection": { "$ref": "./examples/ApplicationGatewayPrivateEndpointConnectionDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/privateLinkResources": { "get": { "operationId": "ApplicationGatewayPrivateLinkResources_List", "tags": [ "ApplicationGatewayPrivateLinkResources" ], "description": "Lists all private link resources on an application gateway.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "applicationGatewayName", "in": "path", "description": "The name of the application gateway.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ApplicationGatewayPrivateLinkResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Lists all private link resources on application gateway": { "$ref": "./examples/ApplicationGatewayPrivateLinkResourceList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/start": { "post": { "operationId": "ApplicationGateways_Start", "tags": [ "ApplicationGateways" ], "description": "Starts the specified application gateway.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "applicationGatewayName", "in": "path", "description": "The name of the application gateway.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully." }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Start Application Gateway": { "$ref": "./examples/ApplicationGatewayStart.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/stop": { "post": { "operationId": "ApplicationGateways_Stop", "tags": [ "ApplicationGateways" ], "description": "Stops the specified application gateway in a resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "applicationGatewayName", "in": "path", "description": "The name of the application gateway.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully." }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "./common.json#/definitions/CloudError" } } }, "x-ms-examples": { "Stop Application Gateway": { "$ref": "./examples/ApplicationGatewayStop.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } } }, "definitions": { "ApplicationGateway": { "type": "object", "description": "Application gateway resource.", "properties": { "properties": { "$ref": "#/definitions/ApplicationGatewayPropertiesFormat", "description": "Properties of the application gateway.", "x-ms-client-flatten": true }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true }, "zones": { "type": "array", "description": "A list of availability zones denoting where the resource needs to come from.", "items": { "type": "string" } }, "identity": { "$ref": "./common.json#/definitions/ManagedServiceIdentity", "description": "The identity of the application gateway, if configured." } }, "allOf": [ { "$ref": "./common.json#/definitions/Resource" } ] }, "ApplicationGatewayAdvancedRoutingCondition": { "type": "object", "description": "A condition evaluated as part of an advanced routing condition set.", "properties": { "conditionType": { "$ref": "./common.json#/definitions/ApplicationGatewayAdvancedRoutingConditionType", "description": "The type of request property the condition is evaluated against." }, "propertyName": { "type": "string", "description": "Name of the request property the condition is evaluated against. Required when conditionType is Header or QueryString, and not applicable when conditionType is Path, ClientIP or Method." }, "propertyValues": { "type": "array", "description": "Values the request property is matched against. Exactly one of propertyValues or propertyValueMatcher must be specified.", "items": { "type": "string" } }, "propertyValueMatcher": { "$ref": "#/definitions/ApplicationGatewayAdvancedRoutingPropertyValueMatcher", "description": "Pattern the request property is matched against. Exactly one of propertyValues or propertyValueMatcher must be specified. Not applicable when conditionType is ClientIP or Method." } }, "required": [ "conditionType" ] }, "ApplicationGatewayAdvancedRoutingConditionSet": { "type": "object", "description": "Advanced routing condition set of an application gateway. Referenced by advanced routing rules to determine whether a request matches.", "properties": { "properties": { "$ref": "#/definitions/ApplicationGatewayAdvancedRoutingConditionSetPropertiesFormat", "description": "Properties of the application gateway advanced routing condition set." }, "name": { "type": "string", "description": "Name of the advanced routing condition set that is unique within an Application Gateway." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true }, "type": { "type": "string", "description": "Type of the resource.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "ApplicationGatewayAdvancedRoutingConditionSetPropertiesFormat": { "type": "object", "description": "Properties of advanced routing condition set of the application gateway.", "properties": { "routingConditions": { "type": "array", "description": "Routing conditions of the condition set. All conditions must be satisfied for the referencing advanced routing rule to match.", "items": { "$ref": "#/definitions/ApplicationGatewayAdvancedRoutingCondition" }, "x-ms-identifiers": [] }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the advanced routing condition set resource.", "readOnly": true } }, "required": [ "routingConditions" ] }, "ApplicationGatewayAdvancedRoutingMap": { "type": "object", "description": "Advanced routing map of an application gateway. Holds the advanced routing rules evaluated for requests handled by an AdvancedRouting request routing rule, along with the configuration applied when no rule matches.", "properties": { "properties": { "$ref": "#/definitions/ApplicationGatewayAdvancedRoutingMapPropertiesFormat", "description": "Properties of the application gateway advanced routing map." }, "name": { "type": "string", "description": "Name of the advanced routing map that is unique within an Application Gateway." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true }, "type": { "type": "string", "description": "Type of the resource.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "ApplicationGatewayAdvancedRoutingMapPropertiesFormat": { "type": "object", "description": "Properties of advanced routing map of the application gateway.", "properties": { "defaultBackendAddressPool": { "$ref": "./common.json#/definitions/SubResource", "description": "Default backend address pool resource of the advanced routing map. Required unless defaultRedirectConfiguration is specified." }, "defaultBackendHttpSettings": { "$ref": "./common.json#/definitions/SubResource", "description": "Default backend http settings resource of the advanced routing map. Required unless defaultRedirectConfiguration is specified." }, "defaultRedirectConfiguration": { "$ref": "./common.json#/definitions/SubResource", "description": "Default redirect configuration resource of the advanced routing map. Cannot be combined with defaultBackendAddressPool or defaultBackendHttpSettings." }, "defaultRewriteRuleSet": { "$ref": "./common.json#/definitions/SubResource", "description": "Default rewrite rule set resource of the advanced routing map." }, "defaultAuthConfigs": { "type": "array", "description": "Default authentication configuration bindings of the advanced routing map. Only one authentication configuration is supported. Authentication configuration names must be unique across the Application Gateway, and an Application Gateway can reference at most 100 distinct authentication policies. Authentication policies can only be bound to Application Gateways using the Standard_v2 or WAF_v2 SKU.", "maxItems": 1, "items": { "$ref": "#/definitions/ApplicationGatewayAuthConfig" }, "x-ms-identifiers": [ "name" ] }, "advancedRoutingRules": { "type": "array", "description": "Advanced routing rules of the advanced routing map. Each rule must specify a priority that is unique within the map.", "items": { "$ref": "#/definitions/ApplicationGatewayAdvancedRoutingRule" } }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the advanced routing map resource.", "readOnly": true } }, "required": [ "advancedRoutingRules" ] }, "ApplicationGatewayAdvancedRoutingPropertyValueMatcher": { "type": "object", "description": "Matches the value of a request property against a fixed string or regular expression.", "properties": { "pattern": { "type": "string", "description": "The pattern, either fixed string or regular expression, that the request property value is evaluated against." }, "ignoreCase": { "type": "boolean", "description": "Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison.", "default": true }, "negate": { "type": "boolean", "description": "Setting this value as truth will force to check the negation of the condition given by the user in the pattern field." } }, "required": [ "pattern" ] }, "ApplicationGatewayAdvancedRoutingRule": { "type": "object", "description": "Advanced routing rule of an application gateway.", "properties": { "properties": { "$ref": "#/definitions/ApplicationGatewayAdvancedRoutingRulePropertiesFormat", "description": "Properties of the application gateway advanced routing rule." }, "name": { "type": "string", "description": "Name of the advanced routing rule that is unique within an advanced routing map." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true }, "type": { "type": "string", "description": "Type of the resource.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "ApplicationGatewayAdvancedRoutingRulePropertiesFormat": { "type": "object", "description": "Properties of advanced routing rule of the application gateway.", "properties": { "priority": { "type": "integer", "format": "int32", "description": "Priority of the advanced routing rule. Must be unique within the containing advanced routing map. Rules are evaluated in ascending priority order.", "minimum": 1, "maximum": 1000 }, "advancedRoutingConditionSet": { "$ref": "./common.json#/definitions/SubResource", "description": "Advanced routing condition set resource evaluated by this rule." }, "backendAddressPool": { "$ref": "./common.json#/definitions/SubResource", "description": "Backend address pool resource of the advanced routing rule. Required unless redirectConfiguration is specified." }, "backendHttpSettings": { "$ref": "./common.json#/definitions/SubResource", "description": "Backend http settings resource of the advanced routing rule. Required unless redirectConfiguration is specified." }, "redirectConfiguration": { "$ref": "./common.json#/definitions/SubResource", "description": "Redirect configuration resource of the advanced routing rule. Cannot be combined with backendAddressPool or backendHttpSettings." }, "rewriteRuleSet": { "$ref": "./common.json#/definitions/SubResource", "description": "Rewrite rule set resource of the advanced routing rule." }, "authConfigs": { "type": "array", "description": "Authentication configuration bindings of the advanced routing rule. Only one authentication configuration is supported. Authentication configuration names must be unique across the Application Gateway, and an Application Gateway can reference at most 100 distinct authentication policies. Authentication policies can only be bound to Application Gateways using the Standard_v2 or WAF_v2 SKU.", "maxItems": 1, "items": { "$ref": "#/definitions/ApplicationGatewayAuthConfig" }, "x-ms-identifiers": [ "name" ] }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the advanced routing rule resource.", "readOnly": true } }, "required": [ "priority" ] }, "ApplicationGatewayAuthConfig": { "type": "object", "description": "An authentication configuration binding for an Application Gateway routing rule or routing map.", "properties": { "name": { "type": "string", "description": "The name of the auth configuration." }, "authenticationPolicy": { "$ref": "./common.json#/definitions/SubResource", "description": "Reference to the authentication policy (Microsoft.Network/authenticationPolicies) resource." } }, "required": [ "name", "authenticationPolicy" ] }, "ApplicationGatewayAuthenticationCertificate": { "type": "object", "description": "Authentication certificates of an application gateway.", "properties": { "properties": { "$ref": "#/definitions/ApplicationGatewayAuthenticationCertificatePropertiesFormat", "description": "Properties of the application gateway authentication certificate.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Name of the authentication certificate that is unique within an Application Gateway." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true }, "type": { "type": "string", "description": "Type of the resource.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "ApplicationGatewayAuthenticationCertificatePropertiesFormat": { "type": "object", "description": "Authentication certificates properties of an application gateway.", "properties": { "data": { "type": "string", "description": "Certificate public data." }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the authentication certificate resource.", "readOnly": true } } }, "ApplicationGatewayAutoscaleConfiguration": { "type": "object", "description": "Application Gateway autoscale configuration.", "properties": { "minCapacity": { "type": "integer", "format": "int32", "description": "Lower bound on number of Application Gateway capacity.", "minimum": 0 }, "maxCapacity": { "type": "integer", "format": "int32", "description": "Upper bound on number of Application Gateway capacity.", "minimum": 2 } }, "required": [ "minCapacity" ] }, "ApplicationGatewayAvailableSslOptions": { "type": "object", "description": "Response for ApplicationGatewayAvailableSslOptions API service call.", "properties": { "properties": { "$ref": "#/definitions/ApplicationGatewayAvailableSslOptionsPropertiesFormat", "description": "Properties of the application gateway available SSL options.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "./common.json#/definitions/Resource" } ] }, "ApplicationGatewayAvailableSslOptionsPropertiesFormat": { "type": "object", "description": "Properties of ApplicationGatewayAvailableSslOptions.", "properties": { "predefinedPolicies": { "type": "array", "description": "List of available Ssl predefined policy.", "items": { "$ref": "./common.json#/definitions/SubResource" } }, "defaultPolicy": { "$ref": "./common.json#/definitions/ApplicationGatewaySslPolicyName", "description": "Name of the Ssl predefined policy applied by default to application gateway." }, "availableCipherSuites": { "type": "array", "description": "List of available Ssl cipher suites.", "items": { "$ref": "./common.json#/definitions/ApplicationGatewaySslCipherSuite" } }, "availableProtocols": { "type": "array", "description": "List of available Ssl protocols.", "items": { "$ref": "./common.json#/definitions/ApplicationGatewaySslProtocol" } } } }, "ApplicationGatewayAvailableSslPredefinedPolicies": { "type": "object", "description": "Response for ApplicationGatewayAvailableSslOptions API service call.", "properties": { "value": { "type": "array", "description": "The ApplicationGatewaySslPredefinedPolicy items on this page", "items": { "$ref": "#/definitions/ApplicationGatewaySslPredefinedPolicy" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ApplicationGatewayAvailableWafRuleSetsResult": { "type": "object", "description": "Response for ApplicationGatewayAvailableWafRuleSets API service call.", "properties": { "value": { "type": "array", "description": "The list of application gateway rule sets.", "items": { "$ref": "#/definitions/ApplicationGatewayFirewallRuleSet" } } } }, "ApplicationGatewayBackendAddress": { "type": "object", "description": "Backend address of an application gateway.", "properties": { "fqdn": { "type": "string", "description": "Fully qualified domain name (FQDN)." }, "ipAddress": { "type": "string", "description": "IP address." } } }, "ApplicationGatewayBackendAddressPool": { "type": "object", "description": "Backend Address Pool of an application gateway.", "properties": { "properties": { "$ref": "#/definitions/ApplicationGatewayBackendAddressPoolPropertiesFormat", "description": "Properties of the application gateway backend address pool.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Name of the backend address pool that is unique within an Application Gateway." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true }, "type": { "type": "string", "description": "Type of the resource.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "ApplicationGatewayBackendAddressPoolPropertiesFormat": { "type": "object", "description": "Properties of Backend Address Pool of an application gateway.", "properties": { "backendIPConfigurations": { "type": "array", "description": "Collection of references to IPs defined in network interfaces.", "items": { "$ref": "./virtualNetwork.json#/definitions/NetworkInterfaceIPConfiguration" }, "readOnly": true }, "backendAddresses": { "type": "array", "description": "Backend addresses.", "items": { "$ref": "#/definitions/ApplicationGatewayBackendAddress" } }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the backend address pool resource.", "readOnly": true } } }, "ApplicationGatewayBackendHealth": { "type": "object", "description": "Response for ApplicationGatewayBackendHealth API service call.", "properties": { "backendAddressPools": { "type": "array", "description": "A list of ApplicationGatewayBackendHealthPool resources.", "items": { "$ref": "#/definitions/ApplicationGatewayBackendHealthPool" } } } }, "ApplicationGatewayBackendHealthHttpSettings": { "type": "object", "description": "Application gateway BackendHealthHttp settings.", "properties": { "backendHttpSettings": { "$ref": "#/definitions/ApplicationGatewayBackendHttpSettings", "description": "Reference to an ApplicationGatewayBackendHttpSettings resource." }, "servers": { "type": "array", "description": "List of ApplicationGatewayBackendHealthServer resources.", "items": { "$ref": "#/definitions/ApplicationGatewayBackendHealthServer" } } } }, "ApplicationGatewayBackendHealthOnDemand": { "type": "object", "description": "Result of on demand test probe.", "properties": { "backendAddressPool": { "$ref": "#/definitions/ApplicationGatewayBackendAddressPool", "description": "Reference to an ApplicationGatewayBackendAddressPool resource." }, "backendHealthHttpSettings": { "$ref": "#/definitions/ApplicationGatewayBackendHealthHttpSettings", "description": "Application gateway BackendHealthHttp settings." } } }, "ApplicationGatewayBackendHealthPool": { "type": "object", "description": "Application gateway BackendHealth pool.", "properties": { "backendAddressPool": { "$ref": "#/definitions/ApplicationGatewayBackendAddressPool", "description": "Reference to an ApplicationGatewayBackendAddressPool resource." }, "backendHttpSettingsCollection": { "type": "array", "description": "List of ApplicationGatewayBackendHealthHttpSettings resources.", "items": { "$ref": "#/definitions/ApplicationGatewayBackendHealthHttpSettings" } } } }, "ApplicationGatewayBackendHealthServer": { "type": "object", "description": "Application gateway backendhealth http settings.", "properties": { "address": { "type": "string", "description": "IP address or FQDN of backend server." }, "ipConfiguration": { "$ref": "./virtualNetwork.json#/definitions/NetworkInterfaceIPConfiguration", "description": "Reference to IP configuration of backend server." }, "health": { "$ref": "./common.json#/definitions/ApplicationGatewayBackendHealthServerHealth", "description": "Health of backend server." }, "healthProbeLog": { "type": "string", "description": "Health Probe Log." } } }, "ApplicationGatewayBackendHttpSettings": { "type": "object", "description": "Backend address pool settings of an application gateway.", "properties": { "properties": { "$ref": "#/definitions/ApplicationGatewayBackendHttpSettingsPropertiesFormat", "description": "Properties of the application gateway backend HTTP settings.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Name of the backend http settings that is unique within an Application Gateway." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true }, "type": { "type": "string", "description": "Type of the resource.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "ApplicationGatewayBackendHttpSettingsPropertiesFormat": { "type": "object", "description": "Properties of Backend address pool settings of an application gateway.", "properties": { "port": { "type": "integer", "format": "int32", "description": "The destination port on the backend." }, "protocol": { "$ref": "./common.json#/definitions/ApplicationGatewayProtocol", "description": "The protocol used to communicate with the backend." }, "cookieBasedAffinity": { "$ref": "./common.json#/definitions/ApplicationGatewayCookieBasedAffinity", "description": "Cookie based affinity." }, "requestTimeout": { "type": "integer", "format": "int32", "description": "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." }, "probe": { "$ref": "./common.json#/definitions/SubResource", "description": "Probe resource of an application gateway." }, "authenticationCertificates": { "type": "array", "description": "Array of references to application gateway authentication certificates.", "items": { "$ref": "./common.json#/definitions/SubResource" } }, "trustedRootCertificates": { "type": "array", "description": "Array of references to application gateway trusted root certificates.", "items": { "$ref": "./common.json#/definitions/SubResource" } }, "connectionDraining": { "$ref": "#/definitions/ApplicationGatewayConnectionDraining", "description": "Connection draining of the backend http settings resource." }, "hostName": { "type": "string", "description": "Host header to be sent to the backend servers." }, "pickHostNameFromBackendAddress": { "type": "boolean", "description": "Whether to pick host header should be picked from the host name of the backend server. Default value is false." }, "affinityCookieName": { "type": "string", "description": "Cookie name to use for the affinity cookie." }, "probeEnabled": { "type": "boolean", "description": "Whether the probe is enabled. Default value is false." }, "path": { "type": "string", "description": "Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null." }, "dedicatedBackendConnection": { "type": "boolean", "description": "Enable or disable dedicated connection per backend server. Default is set to false." }, "validateCertChainAndExpiry": { "type": "boolean", "description": "Verify or skip both chain and expiry validations of the certificate on the backend server. Default is set to true.", "default": true }, "validateSNI": { "type": "boolean", "description": "When enabled, verifies if the Common Name of the certificate provided by the backend server matches the Server Name Indication (SNI) value. Default value is true.", "default": true }, "sniName": { "type": "string", "description": "Specify an SNI value to match the common name of the certificate on the backend. By default, the application gateway uses the incoming request’s host header as the SNI. Default value is null." }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the backend HTTP settings resource.", "readOnly": true } } }, "ApplicationGatewayBackendSettings": { "type": "object", "description": "Backend address pool settings of an application gateway.", "properties": { "properties": { "$ref": "#/definitions/ApplicationGatewayBackendSettingsPropertiesFormat", "description": "Properties of the application gateway backend settings.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Name of the backend settings that is unique within an Application Gateway." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true }, "type": { "type": "string", "description": "Type of the resource.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "ApplicationGatewayBackendSettingsPropertiesFormat": { "type": "object", "description": "Properties of Backend address pool settings of an application gateway.", "properties": { "port": { "type": "integer", "format": "int32", "description": "The destination port on the backend." }, "protocol": { "$ref": "./common.json#/definitions/ApplicationGatewayProtocol", "description": "The protocol used to communicate with the backend." }, "timeout": { "type": "integer", "format": "int32", "description": "Connection timeout in seconds. Application Gateway will fail the request if response is not received within ConnectionTimeout. Acceptable values are from 1 second to 86400 seconds." }, "probe": { "$ref": "./common.json#/definitions/SubResource", "description": "Probe resource of an application gateway." }, "trustedRootCertificates": { "type": "array", "description": "Array of references to application gateway trusted root certificates.", "items": { "$ref": "./common.json#/definitions/SubResource" } }, "hostName": { "type": "string", "description": "Server name indication to be sent to the backend servers for Tls protocol." }, "pickHostNameFromBackendAddress": { "type": "boolean", "description": "Whether to pick server name indication from the host name of the backend server for Tls protocol. Default value is false." }, "enableL4ClientIpPreservation": { "type": "boolean", "description": "Whether to send Proxy Protocol header to backend servers over TCP or TLS protocols. Default value is false." }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the backend HTTP settings resource.", "readOnly": true } } }, "ApplicationGatewayClientAuthConfiguration": { "type": "object", "description": "Application gateway client authentication configuration.", "properties": { "verifyClientCertIssuerDN": { "type": "boolean", "description": "Verify client certificate issuer name on the application gateway." }, "verifyClientRevocation": { "$ref": "./common.json#/definitions/ApplicationGatewayClientRevocationOptions", "description": "Verify client certificate revocation status." }, "verifyClientAuthMode": { "$ref": "./common.json#/definitions/ApplicationGatewayClientAuthVerificationModes", "description": "Verify client Authentication mode." } } }, "ApplicationGatewayConnectionDraining": { "type": "object", "description": "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.", "properties": { "enabled": { "type": "boolean", "description": "Whether connection draining is enabled or not." }, "drainTimeoutInSec": { "type": "integer", "format": "int32", "description": "The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.", "minimum": 1, "maximum": 3600 } }, "required": [ "enabled", "drainTimeoutInSec" ] }, "ApplicationGatewayCustomError": { "type": "object", "description": "Custom error of an application gateway.", "properties": { "statusCode": { "$ref": "./common.json#/definitions/ApplicationGatewayCustomErrorStatusCode", "description": "Status code of the application gateway custom error." }, "customErrorPageUrl": { "type": "string", "description": "Error page URL of the application gateway custom error." } } }, "ApplicationGatewayEntraJWTValidationConfig": { "type": "object", "description": "Entra JWT Validation Configuration of an application gateway.", "properties": { "properties": { "$ref": "#/definitions/ApplicationGatewayEntraJWTValidationConfigPropertiesFormat", "description": "Properties of the application gateway entra jwt validation configuration.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Name of the entra jwt validation configuration that is unique within an application gateway." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "ApplicationGatewayEntraJWTValidationConfigPropertiesFormat": { "type": "object", "description": "Properties of entra jwt validation configuration of the application gateway.", "properties": { "unAuthorizedRequestAction": { "$ref": "./common.json#/definitions/ApplicationGatewayUnAuthorizedRequestAction", "description": "Unauthorized request action." }, "tenantId": { "type": "string", "description": "The Tenant ID of the Microsoft Entra ID application." }, "clientId": { "type": "string", "description": "The Client ID of the Microsoft Entra ID application." }, "audiences": { "type": "array", "description": "List of acceptable audience claims that can be present in the token (aud claim). A maximum of 5 audiences are permitted.", "items": { "type": "string" } }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the entra jwt validation configuration resource.", "readOnly": true } } }, "ApplicationGatewayFirewallDisabledRuleGroup": { "type": "object", "description": "Allows to disable rules within a rule group or an entire rule group.", "properties": { "ruleGroupName": { "type": "string", "description": "The name of the rule group that will be disabled." }, "rules": { "type": "array", "description": "The list of rules that will be disabled. If null, all rules of the rule group will be disabled.", "items": { "type": "integer", "format": "int32" } } }, "required": [ "ruleGroupName" ] }, "ApplicationGatewayFirewallExclusion": { "type": "object", "description": "Allow to exclude some variable satisfy the condition for the WAF check.", "properties": { "matchVariable": { "type": "string", "description": "The variable to be excluded." }, "selectorMatchOperator": { "type": "string", "description": "When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to." }, "selector": { "type": "string", "description": "When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to." } }, "required": [ "matchVariable", "selectorMatchOperator", "selector" ] }, "ApplicationGatewayFirewallManifestRuleSet": { "type": "object", "description": "Properties of the web application firewall rule set.", "properties": { "ruleSetType": { "type": "string", "description": "The type of the web application firewall rule set." }, "ruleSetVersion": { "type": "string", "description": "The version of the web application firewall rule set type." }, "status": { "$ref": "./common.json#/definitions/ApplicationGatewayRuleSetStatusOptions", "description": "The rule set status" }, "displayName": { "type": "string", "description": "Human-readable display name for the managed rule set version (e.g., 'Default Ruleset 2.2 (Latest, Recommended)')." }, "tiers": { "type": "array", "description": "Tier of an application gateway that support the rule set.", "items": { "$ref": "./common.json#/definitions/ApplicationGatewayTierTypes" } }, "ruleGroups": { "type": "array", "description": "The rule groups of the web application firewall rule set.", "items": { "$ref": "#/definitions/ApplicationGatewayFirewallRuleGroup" }, "x-ms-identifiers": [] } }, "required": [ "ruleSetType", "ruleSetVersion", "ruleGroups" ] }, "ApplicationGatewayFirewallRule": { "type": "object", "description": "A web application firewall rule.", "properties": { "ruleId": { "type": "integer", "format": "int32", "description": "The identifier of the web application firewall rule." }, "ruleIdString": { "type": "string", "description": "The string representation of the web application firewall rule identifier." }, "state": { "$ref": "./common.json#/definitions/ApplicationGatewayWafRuleStateTypes", "description": "The string representation of the web application firewall rule state." }, "action": { "$ref": "./common.json#/definitions/ApplicationGatewayWafRuleActionTypes", "description": "The string representation of the web application firewall rule action." }, "sensitivity": { "$ref": "./common.json#/definitions/ApplicationGatewayWafRuleSensitivityTypes", "description": "The string representation of the web application firewall rule sensitivity." }, "paranoiaLevel": { "$ref": "./common.json#/definitions/ApplicationGatewayWafRuleParanoiaLevel", "description": "OWASP CRS paranoia level of a managed rule. Applicable only for DRS and OWASP rules." }, "description": { "type": "string", "description": "The description of the web application firewall rule." } }, "required": [ "ruleId" ] }, "ApplicationGatewayFirewallRuleGroup": { "type": "object", "description": "A web application firewall rule group.", "properties": { "ruleGroupName": { "type": "string", "description": "The name of the web application firewall rule group." }, "description": { "type": "string", "description": "The description of the web application firewall rule group." }, "rules": { "type": "array", "description": "The rules of the web application firewall rule group.", "items": { "$ref": "#/definitions/ApplicationGatewayFirewallRule" } } }, "required": [ "ruleGroupName", "rules" ] }, "ApplicationGatewayFirewallRuleSet": { "type": "object", "description": "A web application firewall rule set.", "properties": { "properties": { "$ref": "#/definitions/ApplicationGatewayFirewallRuleSetPropertiesFormat", "description": "Properties of the application gateway firewall rule set.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "./common.json#/definitions/Resource" } ] }, "ApplicationGatewayFirewallRuleSetPropertiesFormat": { "type": "object", "description": "Properties of the web application firewall rule set.", "properties": { "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the web application firewall rule set.", "readOnly": true }, "ruleSetType": { "type": "string", "description": "The type of the web application firewall rule set." }, "ruleSetVersion": { "type": "string", "description": "The version of the web application firewall rule set type." }, "displayName": { "type": "string", "description": "Human-readable display name for the managed rule set version (e.g., 'Default Ruleset 2.2 (Latest, Recommended)')." }, "ruleGroups": { "type": "array", "description": "The rule groups of the web application firewall rule set.", "items": { "$ref": "#/definitions/ApplicationGatewayFirewallRuleGroup" } }, "tiers": { "type": "array", "description": "Tier of an application gateway that support the rule set.", "items": { "$ref": "./common.json#/definitions/ApplicationGatewayTierTypes" } } }, "required": [ "ruleSetType", "ruleSetVersion", "ruleGroups" ] }, "ApplicationGatewayForContainersReferenceDefinition": { "type": "object", "description": "Defines an application gateway for containers reference.", "properties": { "id": { "type": "string", "format": "arm-id", "description": "Resource Id of the application gateway for containers.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.ServiceNetworking/trafficControllers" } ] } } }, "required": [ "id" ] }, "ApplicationGatewayFrontendIPConfiguration": { "type": "object", "description": "Frontend IP configuration of an application gateway.", "properties": { "properties": { "$ref": "#/definitions/ApplicationGatewayFrontendIPConfigurationPropertiesFormat", "description": "Properties of the application gateway frontend IP configuration.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Name of the frontend IP configuration that is unique within an Application Gateway." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true }, "type": { "type": "string", "description": "Type of the resource.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "ApplicationGatewayFrontendIPConfigurationPropertiesFormat": { "type": "object", "description": "Properties of Frontend IP configuration of an application gateway.", "properties": { "privateIPAddress": { "type": "string", "description": "PrivateIPAddress of the network interface IP Configuration." }, "privateIPAllocationMethod": { "$ref": "./common.json#/definitions/IPAllocationMethod", "description": "The private IP address allocation method." }, "subnet": { "$ref": "./common.json#/definitions/SubResource", "description": "Reference to the subnet resource." }, "publicIPAddress": { "$ref": "./common.json#/definitions/SubResource", "description": "Reference to the PublicIP resource." }, "privateLinkConfiguration": { "$ref": "./common.json#/definitions/SubResource", "description": "Reference to the application gateway private link configuration." }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the frontend IP configuration resource.", "readOnly": true } } }, "ApplicationGatewayFrontendPort": { "type": "object", "description": "Frontend port of an application gateway.", "properties": { "properties": { "$ref": "#/definitions/ApplicationGatewayFrontendPortPropertiesFormat", "description": "Properties of the application gateway frontend port.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Name of the frontend port that is unique within an Application Gateway." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true }, "type": { "type": "string", "description": "Type of the resource.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "ApplicationGatewayFrontendPortPropertiesFormat": { "type": "object", "description": "Properties of Frontend port of an application gateway.", "properties": { "port": { "type": "integer", "format": "int32", "description": "Frontend port." }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the frontend port resource.", "readOnly": true } } }, "ApplicationGatewayGlobalConfiguration": { "type": "object", "description": "Application Gateway global configuration.", "properties": { "enableRequestBuffering": { "type": "boolean", "description": "Enable request buffering." }, "enableResponseBuffering": { "type": "boolean", "description": "Enable response buffering." }, "disableDefaultServerHeaderInResponse": { "type": "boolean", "description": "Disable default server header in response." } } }, "ApplicationGatewayHeaderConfiguration": { "type": "object", "description": "Header configuration of the Actions set in Application Gateway.", "properties": { "headerName": { "type": "string", "description": "Header name of the header configuration." }, "headerValueMatcher": { "$ref": "#/definitions/HeaderValueMatcher", "description": "An optional field under \"Rewrite Action\". It lets you capture and modify the value(s) of a specific header when multiple headers with the same name exist. Currently supported for Set-Cookie Response header only. For more details, visit https://aka.ms/appgwheadercrud" }, "headerValue": { "type": "string", "description": "Header value of the header configuration." } } }, "ApplicationGatewayHttpListener": { "type": "object", "description": "Http listener of an application gateway.", "properties": { "properties": { "$ref": "#/definitions/ApplicationGatewayHttpListenerPropertiesFormat", "description": "Properties of the application gateway HTTP listener.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Name of the HTTP listener that is unique within an Application Gateway." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true }, "type": { "type": "string", "description": "Type of the resource.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "ApplicationGatewayHttpListenerPropertiesFormat": { "type": "object", "description": "Properties of HTTP listener of an application gateway.", "properties": { "frontendIPConfiguration": { "$ref": "./common.json#/definitions/SubResource", "description": "Frontend IP configuration resource of an application gateway." }, "frontendPort": { "$ref": "./common.json#/definitions/SubResource", "description": "Frontend port resource of an application gateway." }, "protocol": { "$ref": "./common.json#/definitions/ApplicationGatewayProtocol", "description": "Protocol of the HTTP listener." }, "hostName": { "type": "string", "description": "Host name of HTTP listener." }, "sslCertificate": { "$ref": "./common.json#/definitions/SubResource", "description": "SSL certificate resource of an application gateway." }, "sslProfile": { "$ref": "./common.json#/definitions/SubResource", "description": "SSL profile resource of the application gateway." }, "requireServerNameIndication": { "type": "boolean", "description": "Applicable only if protocol is https. Enables SNI for multi-hosting." }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the HTTP listener resource.", "readOnly": true }, "customErrorConfigurations": { "type": "array", "description": "Custom error configurations of the HTTP listener.", "items": { "$ref": "#/definitions/ApplicationGatewayCustomError" } }, "firewallPolicy": { "$ref": "./common.json#/definitions/SubResource", "description": "Reference to the FirewallPolicy resource." }, "hostNames": { "type": "array", "description": "List of Host names for HTTP Listener that allows special wildcard characters as well.", "items": { "type": "string" } } } }, "ApplicationGatewayIPConfiguration": { "type": "object", "description": "IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed.", "properties": { "properties": { "$ref": "#/definitions/ApplicationGatewayIPConfigurationPropertiesFormat", "description": "Properties of the application gateway IP configuration.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Name of the IP configuration that is unique within an Application Gateway." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true }, "type": { "type": "string", "description": "Type of the resource.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "ApplicationGatewayIPConfigurationPropertiesFormat": { "type": "object", "description": "Properties of IP configuration of an application gateway.", "properties": { "subnet": { "$ref": "./common.json#/definitions/SubResource", "description": "Reference to the subnet resource. A subnet from where application gateway gets its private address." }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the application gateway IP configuration resource.", "readOnly": true } } }, "ApplicationGatewayListResult": { "type": "object", "description": "The response of a ApplicationGateway list operation.", "properties": { "value": { "type": "array", "description": "The ApplicationGateway items on this page", "items": { "$ref": "#/definitions/ApplicationGateway" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ApplicationGatewayListener": { "type": "object", "description": "Listener of an application gateway.", "properties": { "properties": { "$ref": "#/definitions/ApplicationGatewayListenerPropertiesFormat", "description": "Properties of the application gateway listener.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Name of the listener that is unique within an Application Gateway." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true }, "type": { "type": "string", "description": "Type of the resource.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "ApplicationGatewayListenerPropertiesFormat": { "type": "object", "description": "Properties of listener of an application gateway.", "properties": { "frontendIPConfiguration": { "$ref": "./common.json#/definitions/SubResource", "description": "Frontend IP configuration resource of an application gateway." }, "frontendPort": { "$ref": "./common.json#/definitions/SubResource", "description": "Frontend port resource of an application gateway." }, "protocol": { "$ref": "./common.json#/definitions/ApplicationGatewayProtocol", "description": "Protocol of the listener." }, "sslCertificate": { "$ref": "./common.json#/definitions/SubResource", "description": "SSL certificate resource of an application gateway." }, "sslProfile": { "$ref": "./common.json#/definitions/SubResource", "description": "SSL profile resource of the application gateway." }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the listener resource.", "readOnly": true }, "hostNames": { "type": "array", "description": "List of Server Name Indications(SNI) for TLS Multi-site Listener that allows special wildcard characters as well.", "items": { "type": "string" } } } }, "ApplicationGatewayLoadDistributionPolicy": { "type": "object", "description": "Load Distribution Policy of an application gateway.", "properties": { "properties": { "$ref": "#/definitions/ApplicationGatewayLoadDistributionPolicyPropertiesFormat", "description": "Properties of the application gateway load distribution policy.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Name of the load distribution policy that is unique within an Application Gateway." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true }, "type": { "type": "string", "description": "Type of the resource.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "ApplicationGatewayLoadDistributionPolicyPropertiesFormat": { "type": "object", "description": "Properties of Load Distribution Policy of an application gateway.", "properties": { "loadDistributionTargets": { "type": "array", "description": "Load Distribution Targets resource of an application gateway.", "items": { "$ref": "#/definitions/ApplicationGatewayLoadDistributionTarget" } }, "loadDistributionAlgorithm": { "$ref": "./common.json#/definitions/ApplicationGatewayLoadDistributionAlgorithm", "description": "Load Distribution Targets resource of an application gateway." }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the Load Distribution Policy resource.", "readOnly": true } } }, "ApplicationGatewayLoadDistributionTarget": { "type": "object", "description": "Load Distribution Target of an application gateway.", "properties": { "properties": { "$ref": "#/definitions/ApplicationGatewayLoadDistributionTargetPropertiesFormat", "description": "Properties of the application gateway load distribution target.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Name of the load distribution policy that is unique within an Application Gateway." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true }, "type": { "type": "string", "description": "Type of the resource.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "ApplicationGatewayLoadDistributionTargetPropertiesFormat": { "type": "object", "properties": { "weightPerServer": { "type": "integer", "format": "int32", "description": "Weight per server. Range between 1 and 100.", "minimum": 1, "maximum": 100 }, "backendAddressPool": { "$ref": "./common.json#/definitions/SubResource", "description": "Backend address pool resource of the application gateway." } } }, "ApplicationGatewayManagedHsm": { "type": "object", "description": "Managed HSM properties of an application gateway.", "properties": { "keyId": { "type": "string", "format": "uri", "description": "Key identifier of a key stored in Managed HSM." }, "publicCertData": { "type": "string", "description": "Base-64 encoded value of a base-64 public certificate." } } }, "ApplicationGatewayOnDemandProbe": { "type": "object", "description": "Details of on demand test probe request.", "properties": { "protocol": { "$ref": "./common.json#/definitions/ApplicationGatewayProtocol", "description": "The protocol used for the probe." }, "host": { "type": "string", "description": "Host name to send the probe to." }, "path": { "type": "string", "description": "Relative path of probe. Valid path starts from '/'. Probe is sent to ://:." }, "timeout": { "type": "integer", "format": "int32", "description": "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." }, "pickHostNameFromBackendHttpSettings": { "type": "boolean", "description": "Whether the host header should be picked from the backend http settings. Default value is false." }, "enableProbeProxyProtocolHeader": { "type": "boolean", "description": "Whether to send Proxy Protocol header along with the Health Probe over TCP or TLS protocol. Default value is false." }, "match": { "$ref": "#/definitions/ApplicationGatewayProbeHealthResponseMatch", "description": "Criterion for classifying a healthy probe response." }, "backendAddressPool": { "$ref": "./common.json#/definitions/SubResource", "description": "Reference to backend pool of application gateway to which probe request will be sent." }, "backendHttpSettings": { "$ref": "./common.json#/definitions/SubResource", "description": "Reference to backend http setting of application gateway to be used for test probe." } } }, "ApplicationGatewayPathRule": { "type": "object", "description": "Path rule of URL path map of an application gateway.", "properties": { "properties": { "$ref": "#/definitions/ApplicationGatewayPathRulePropertiesFormat", "description": "Properties of the application gateway path rule.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Name of the path rule that is unique within an Application Gateway." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true }, "type": { "type": "string", "description": "Type of the resource.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "ApplicationGatewayPathRulePropertiesFormat": { "type": "object", "description": "Properties of path rule of an application gateway.", "properties": { "paths": { "type": "array", "description": "Path rules of URL path map.", "items": { "type": "string" } }, "backendAddressPool": { "$ref": "./common.json#/definitions/SubResource", "description": "Backend address pool resource of URL path map path rule." }, "backendHttpSettings": { "$ref": "./common.json#/definitions/SubResource", "description": "Backend http settings resource of URL path map path rule." }, "redirectConfiguration": { "$ref": "./common.json#/definitions/SubResource", "description": "Redirect configuration resource of URL path map path rule." }, "rewriteRuleSet": { "$ref": "./common.json#/definitions/SubResource", "description": "Rewrite rule set resource of URL path map path rule." }, "loadDistributionPolicy": { "$ref": "./common.json#/definitions/SubResource", "description": "Load Distribution Policy resource of URL path map path rule." }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the path rule resource.", "readOnly": true }, "firewallPolicy": { "$ref": "./common.json#/definitions/SubResource", "description": "Reference to the FirewallPolicy resource." } } }, "ApplicationGatewayPrivateEndpointConnection": { "type": "object", "description": "Private Endpoint connection on an application gateway.", "properties": { "properties": { "$ref": "#/definitions/ApplicationGatewayPrivateEndpointConnectionProperties", "description": "Properties of the application gateway private endpoint connection.", "x-ms-client-flatten": true }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResourceModel" } ] }, "ApplicationGatewayPrivateEndpointConnectionListResult": { "type": "object", "description": "The response of a ApplicationGatewayPrivateEndpointConnection list operation.", "properties": { "value": { "type": "array", "description": "The ApplicationGatewayPrivateEndpointConnection items on this page", "items": { "$ref": "#/definitions/ApplicationGatewayPrivateEndpointConnection" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ApplicationGatewayPrivateEndpointConnectionProperties": { "type": "object", "description": "Properties of Private Link Resource of an application gateway.", "properties": { "privateEndpoint": { "$ref": "./virtualNetwork.json#/definitions/PrivateEndpoint", "description": "The resource of private end point.", "readOnly": true }, "privateLinkServiceConnectionState": { "$ref": "./virtualNetwork.json#/definitions/PrivateLinkServiceConnectionState", "description": "A collection of information about the state of the connection between service consumer and provider." }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the application gateway private endpoint connection resource.", "readOnly": true }, "linkIdentifier": { "type": "string", "description": "The consumer link id.", "readOnly": true } } }, "ApplicationGatewayPrivateLinkConfiguration": { "type": "object", "description": "Private Link Configuration on an application gateway.", "properties": { "properties": { "$ref": "#/definitions/ApplicationGatewayPrivateLinkConfigurationProperties", "description": "Properties of the application gateway private link configuration.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Name of the private link configuration that is unique within an Application Gateway." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true }, "type": { "type": "string", "description": "Type of the resource.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "ApplicationGatewayPrivateLinkConfigurationProperties": { "type": "object", "description": "Properties of private link configuration on an application gateway.", "properties": { "ipConfigurations": { "type": "array", "description": "An array of application gateway private link ip configurations.", "items": { "$ref": "#/definitions/ApplicationGatewayPrivateLinkIpConfiguration" } }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the application gateway private link configuration.", "readOnly": true } } }, "ApplicationGatewayPrivateLinkIpConfiguration": { "type": "object", "description": "The application gateway private link ip configuration.", "properties": { "properties": { "$ref": "#/definitions/ApplicationGatewayPrivateLinkIpConfigurationProperties", "description": "Properties of an application gateway private link ip configuration.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "The name of application gateway private link ip configuration." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true }, "type": { "type": "string", "description": "The resource type.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "ApplicationGatewayPrivateLinkIpConfigurationProperties": { "type": "object", "description": "Properties of an application gateway private link IP configuration.", "properties": { "privateIPAddress": { "type": "string", "description": "The private IP address of the IP configuration." }, "privateIPAllocationMethod": { "$ref": "./common.json#/definitions/IPAllocationMethod", "description": "The private IP address allocation method." }, "subnet": { "$ref": "./common.json#/definitions/SubResource", "description": "Reference to the subnet resource." }, "primary": { "type": "boolean", "description": "Whether the ip configuration is primary or not." }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the application gateway private link IP configuration.", "readOnly": true } } }, "ApplicationGatewayPrivateLinkResource": { "type": "object", "description": "PrivateLink Resource of an application gateway.", "properties": { "properties": { "$ref": "#/definitions/ApplicationGatewayPrivateLinkResourceProperties", "description": "Properties of the application gateway private link resource.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Name of the private link resource that is unique within an Application Gateway." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true }, "type": { "type": "string", "description": "Type of the resource.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "ApplicationGatewayPrivateLinkResourceListResult": { "type": "object", "description": "The response of a ApplicationGatewayPrivateLinkResource list operation.", "properties": { "value": { "type": "array", "description": "The ApplicationGatewayPrivateLinkResource items on this page", "items": { "$ref": "#/definitions/ApplicationGatewayPrivateLinkResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ApplicationGatewayPrivateLinkResourceProperties": { "type": "object", "description": "Properties of a private link resource.", "properties": { "groupId": { "type": "string", "description": "Group identifier of private link resource.", "readOnly": true }, "requiredMembers": { "type": "array", "description": "Required member names of private link resource.", "items": { "type": "string" }, "readOnly": true }, "requiredZoneNames": { "type": "array", "description": "Required DNS zone names of the the private link resource.", "items": { "type": "string" } } } }, "ApplicationGatewayProbe": { "type": "object", "description": "Probe of the application gateway.", "properties": { "properties": { "$ref": "#/definitions/ApplicationGatewayProbePropertiesFormat", "description": "Properties of the application gateway probe.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Name of the probe that is unique within an Application Gateway." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true }, "type": { "type": "string", "description": "Type of the resource.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "ApplicationGatewayProbeHealthResponseMatch": { "type": "object", "description": "Application gateway probe health response match.", "properties": { "body": { "type": "string", "description": "Body that must be contained in the health response. Default value is empty." }, "statusCodes": { "type": "array", "description": "Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399.", "items": { "type": "string" } } } }, "ApplicationGatewayProbePropertiesFormat": { "type": "object", "description": "Properties of probe of an application gateway.", "properties": { "protocol": { "$ref": "./common.json#/definitions/ApplicationGatewayProtocol", "description": "The protocol used for the probe." }, "host": { "type": "string", "description": "Host name to send the probe to." }, "path": { "type": "string", "description": "Relative path of probe. Valid path starts from '/'. Probe is sent to ://:." }, "interval": { "type": "integer", "format": "int32", "description": "The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds." }, "timeout": { "type": "integer", "format": "int32", "description": "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." }, "unhealthyThreshold": { "type": "integer", "format": "int32", "description": "The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20." }, "pickHostNameFromBackendHttpSettings": { "type": "boolean", "description": "Whether the host header should be picked from the backend http settings. Default value is false." }, "pickHostNameFromBackendSettings": { "type": "boolean", "description": "Whether the server name indication should be picked from the backend settings for Tls protocol. Default value is false." }, "minServers": { "type": "integer", "format": "int32", "description": "Minimum number of servers that are always marked healthy. Default value is 0." }, "match": { "$ref": "#/definitions/ApplicationGatewayProbeHealthResponseMatch", "description": "Criterion for classifying a healthy probe response." }, "enableProbeProxyProtocolHeader": { "type": "boolean", "description": "Whether to send Proxy Protocol header along with the Health Probe over TCP or TLS protocol. Default value is false." }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the probe resource.", "readOnly": true }, "port": { "type": "integer", "format": "int32", "description": "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 Basic, Standard_v2 and WAF_v2 only.", "minimum": 1, "maximum": 65535 } } }, "ApplicationGatewayPropertiesFormat": { "type": "object", "description": "Properties of the application gateway.", "properties": { "sku": { "$ref": "#/definitions/ApplicationGatewaySku", "description": "SKU of the application gateway resource." }, "sslPolicy": { "$ref": "#/definitions/ApplicationGatewaySslPolicy", "description": "SSL policy of the application gateway resource." }, "operationalState": { "$ref": "./common.json#/definitions/ApplicationGatewayOperationalState", "description": "Operational state of the application gateway resource.", "readOnly": true }, "gatewayIPConfigurations": { "type": "array", "description": "Subnets of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).", "items": { "$ref": "#/definitions/ApplicationGatewayIPConfiguration" } }, "authenticationCertificates": { "type": "array", "description": "Authentication certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).", "items": { "$ref": "#/definitions/ApplicationGatewayAuthenticationCertificate" } }, "trustedRootCertificates": { "type": "array", "description": "Trusted Root certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).", "items": { "$ref": "#/definitions/ApplicationGatewayTrustedRootCertificate" } }, "trustedClientCertificates": { "type": "array", "description": "Trusted client certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).", "items": { "$ref": "#/definitions/ApplicationGatewayTrustedClientCertificate" } }, "sslCertificates": { "type": "array", "description": "SSL certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).", "items": { "$ref": "#/definitions/ApplicationGatewaySslCertificate" } }, "frontendIPConfigurations": { "type": "array", "description": "Frontend IP addresses of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).", "items": { "$ref": "#/definitions/ApplicationGatewayFrontendIPConfiguration" } }, "frontendPorts": { "type": "array", "description": "Frontend ports of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).", "items": { "$ref": "#/definitions/ApplicationGatewayFrontendPort" } }, "probes": { "type": "array", "description": "Probes of the application gateway resource.", "items": { "$ref": "#/definitions/ApplicationGatewayProbe" } }, "backendAddressPools": { "type": "array", "description": "Backend address pool of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).", "items": { "$ref": "#/definitions/ApplicationGatewayBackendAddressPool" } }, "backendHttpSettingsCollection": { "type": "array", "description": "Backend http settings of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).", "items": { "$ref": "#/definitions/ApplicationGatewayBackendHttpSettings" } }, "backendSettingsCollection": { "type": "array", "description": "Backend settings of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).", "items": { "$ref": "#/definitions/ApplicationGatewayBackendSettings" } }, "httpListeners": { "type": "array", "description": "Http listeners of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).", "items": { "$ref": "#/definitions/ApplicationGatewayHttpListener" } }, "listeners": { "type": "array", "description": "Listeners of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).", "items": { "$ref": "#/definitions/ApplicationGatewayListener" } }, "sslProfiles": { "type": "array", "description": "SSL profiles of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).", "items": { "$ref": "#/definitions/ApplicationGatewaySslProfile" } }, "urlPathMaps": { "type": "array", "description": "URL path map of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).", "items": { "$ref": "#/definitions/ApplicationGatewayUrlPathMap" } }, "advancedRoutingMaps": { "type": "array", "description": "Advanced routing maps of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).", "items": { "$ref": "#/definitions/ApplicationGatewayAdvancedRoutingMap" } }, "requestRoutingRules": { "type": "array", "description": "Request routing rules of the application gateway resource.", "items": { "$ref": "#/definitions/ApplicationGatewayRequestRoutingRule" } }, "routingRules": { "type": "array", "description": "Routing rules of the application gateway resource.", "items": { "$ref": "#/definitions/ApplicationGatewayRoutingRule" } }, "rewriteRuleSets": { "type": "array", "description": "Rewrite rules for the application gateway resource.", "items": { "$ref": "#/definitions/ApplicationGatewayRewriteRuleSet" } }, "advancedRoutingConditionSets": { "type": "array", "description": "Advanced routing condition sets of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).", "items": { "$ref": "#/definitions/ApplicationGatewayAdvancedRoutingConditionSet" } }, "redirectConfigurations": { "type": "array", "description": "Redirect configurations of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).", "items": { "$ref": "#/definitions/ApplicationGatewayRedirectConfiguration" } }, "webApplicationFirewallConfiguration": { "$ref": "#/definitions/ApplicationGatewayWebApplicationFirewallConfiguration", "description": "Web application firewall configuration." }, "firewallPolicy": { "$ref": "./common.json#/definitions/SubResource", "description": "Reference to the FirewallPolicy resource." }, "enableHttp2": { "type": "boolean", "description": "Whether HTTP2 is enabled on the application gateway resource." }, "enableFips": { "type": "boolean", "description": "Whether FIPS is enabled on the application gateway resource." }, "autoscaleConfiguration": { "$ref": "#/definitions/ApplicationGatewayAutoscaleConfiguration", "description": "Autoscale Configuration." }, "reservedCapacity": { "type": "integer", "format": "int32", "description": "The reserved capacity of the application gateway resource. Applicable to the Basic_v2 and Basic_WAF_v2 SKU tiers." }, "privateLinkConfigurations": { "type": "array", "description": "PrivateLink configurations on application gateway.", "items": { "$ref": "#/definitions/ApplicationGatewayPrivateLinkConfiguration" } }, "privateEndpointConnections": { "type": "array", "description": "Private Endpoint connections on application gateway.", "items": { "$ref": "#/definitions/ApplicationGatewayPrivateEndpointConnection" }, "readOnly": true }, "resourceGuid": { "type": "string", "description": "The resource GUID property of the application gateway resource.", "readOnly": true }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the application gateway resource.", "readOnly": true }, "customErrorConfigurations": { "type": "array", "description": "Custom error configurations of the application gateway resource.", "items": { "$ref": "#/definitions/ApplicationGatewayCustomError" } }, "forceFirewallPolicyAssociation": { "type": "boolean", "description": "If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config." }, "loadDistributionPolicies": { "type": "array", "description": "Load distribution policies of the application gateway resource.", "items": { "$ref": "#/definitions/ApplicationGatewayLoadDistributionPolicy" } }, "entraJWTValidationConfigs": { "type": "array", "description": "Entra JWT validation configurations for the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits).", "items": { "$ref": "#/definitions/ApplicationGatewayEntraJWTValidationConfig" } }, "globalConfiguration": { "$ref": "#/definitions/ApplicationGatewayGlobalConfiguration", "description": "Global Configuration." }, "defaultPredefinedSslPolicy": { "$ref": "./common.json#/definitions/ApplicationGatewaySslPolicyName", "description": "The default predefined SSL Policy applied on the application gateway resource.", "readOnly": true } } }, "ApplicationGatewayRedirectConfiguration": { "type": "object", "description": "Redirect configuration of an application gateway.", "properties": { "properties": { "$ref": "#/definitions/ApplicationGatewayRedirectConfigurationPropertiesFormat", "description": "Properties of the application gateway redirect configuration.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Name of the redirect configuration that is unique within an Application Gateway." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true }, "type": { "type": "string", "description": "Type of the resource.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "ApplicationGatewayRedirectConfigurationPropertiesFormat": { "type": "object", "description": "Properties of redirect configuration of the application gateway.", "properties": { "redirectType": { "$ref": "./common.json#/definitions/ApplicationGatewayRedirectType", "description": "HTTP redirection type." }, "targetListener": { "$ref": "./common.json#/definitions/SubResource", "description": "Reference to a listener to redirect the request to." }, "targetUrl": { "type": "string", "description": "Url to redirect the request to." }, "includePath": { "type": "boolean", "description": "Include path in the redirected url." }, "includeQueryString": { "type": "boolean", "description": "Include query string in the redirected url." }, "requestRoutingRules": { "type": "array", "description": "Request routing specifying redirect configuration.", "items": { "$ref": "./common.json#/definitions/SubResource" } }, "urlPathMaps": { "type": "array", "description": "Url path maps specifying default redirect configuration.", "items": { "$ref": "./common.json#/definitions/SubResource" } }, "pathRules": { "type": "array", "description": "Path rules specifying redirect configuration.", "items": { "$ref": "./common.json#/definitions/SubResource" } } } }, "ApplicationGatewayRequestRoutingRule": { "type": "object", "description": "Request routing rule of an application gateway.", "properties": { "properties": { "$ref": "#/definitions/ApplicationGatewayRequestRoutingRulePropertiesFormat", "description": "Properties of the application gateway request routing rule.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Name of the request routing rule that is unique within an Application Gateway." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true }, "type": { "type": "string", "description": "Type of the resource.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "ApplicationGatewayRequestRoutingRulePropertiesFormat": { "type": "object", "description": "Properties of request routing rule of the application gateway.", "properties": { "ruleType": { "$ref": "./common.json#/definitions/ApplicationGatewayRequestRoutingRuleType", "description": "Rule type." }, "priority": { "type": "integer", "format": "int32", "description": "Priority of the request routing rule.", "minimum": 1, "maximum": 20000 }, "backendAddressPool": { "$ref": "./common.json#/definitions/SubResource", "description": "Backend address pool resource of the application gateway." }, "backendHttpSettings": { "$ref": "./common.json#/definitions/SubResource", "description": "Backend http settings resource of the application gateway." }, "httpListener": { "$ref": "./common.json#/definitions/SubResource", "description": "Http listener resource of the application gateway." }, "urlPathMap": { "$ref": "./common.json#/definitions/SubResource", "description": "URL path map resource of the application gateway." }, "advancedRoutingMap": { "$ref": "./common.json#/definitions/SubResource", "description": "Advanced routing map resource of the application gateway." }, "rewriteRuleSet": { "$ref": "./common.json#/definitions/SubResource", "description": "Rewrite Rule Set resource in Basic rule of the application gateway." }, "redirectConfiguration": { "$ref": "./common.json#/definitions/SubResource", "description": "Redirect configuration resource of the application gateway." }, "loadDistributionPolicy": { "$ref": "./common.json#/definitions/SubResource", "description": "Load Distribution Policy resource of the application gateway." }, "entraJWTValidationConfig": { "$ref": "./common.json#/definitions/SubResource", "description": "Entra JWT validation configuration resource of the application gateway." }, "authConfigs": { "type": "array", "description": "Authentication configuration bindings of the request routing rule. Only one authentication configuration is supported. Authentication configuration names must be unique across the Application Gateway, and an Application Gateway can reference at most 100 distinct authentication policies. Authentication policies can only be bound to Application Gateways using the Standard_v2 or WAF_v2 SKU.", "maxItems": 1, "items": { "$ref": "#/definitions/ApplicationGatewayAuthConfig" }, "x-ms-identifiers": [ "name" ] }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the request routing rule resource.", "readOnly": true } } }, "ApplicationGatewayRewriteRule": { "type": "object", "description": "Rewrite rule of an application gateway.", "properties": { "name": { "type": "string", "description": "Name of the rewrite rule that is unique within an Application Gateway." }, "ruleSequence": { "type": "integer", "format": "int32", "description": "Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet." }, "conditions": { "type": "array", "description": "Conditions based on which the action set execution will be evaluated.", "items": { "$ref": "#/definitions/ApplicationGatewayRewriteRuleCondition" } }, "actionSet": { "$ref": "#/definitions/ApplicationGatewayRewriteRuleActionSet", "description": "Set of actions to be done as part of the rewrite Rule." } } }, "ApplicationGatewayRewriteRuleActionSet": { "type": "object", "description": "Set of actions in the Rewrite Rule in Application Gateway.", "properties": { "requestHeaderConfigurations": { "type": "array", "description": "Request Header Actions in the Action Set.", "items": { "$ref": "#/definitions/ApplicationGatewayHeaderConfiguration" } }, "responseHeaderConfigurations": { "type": "array", "description": "Response Header Actions in the Action Set.", "items": { "$ref": "#/definitions/ApplicationGatewayHeaderConfiguration" } }, "urlConfiguration": { "$ref": "#/definitions/ApplicationGatewayUrlConfiguration", "description": "Url Configuration Action in the Action Set." } } }, "ApplicationGatewayRewriteRuleCondition": { "type": "object", "description": "Set of conditions in the Rewrite Rule in Application Gateway.", "properties": { "variable": { "type": "string", "description": "The condition parameter of the RewriteRuleCondition." }, "pattern": { "type": "string", "description": "The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition." }, "ignoreCase": { "type": "boolean", "description": "Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison." }, "negate": { "type": "boolean", "description": "Setting this value as truth will force to check the negation of the condition given by the user." } } }, "ApplicationGatewayRewriteRuleSet": { "type": "object", "description": "Rewrite rule set of an application gateway.", "properties": { "properties": { "$ref": "#/definitions/ApplicationGatewayRewriteRuleSetPropertiesFormat", "description": "Properties of the application gateway rewrite rule set.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Name of the rewrite rule set that is unique within an Application Gateway." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "ApplicationGatewayRewriteRuleSetPropertiesFormat": { "type": "object", "description": "Properties of rewrite rule set of the application gateway.", "properties": { "rewriteRules": { "type": "array", "description": "Rewrite rules in the rewrite rule set.", "items": { "$ref": "#/definitions/ApplicationGatewayRewriteRule" } }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the rewrite rule set resource.", "readOnly": true } } }, "ApplicationGatewayRoutingRule": { "type": "object", "description": "Routing rule of an application gateway.", "properties": { "properties": { "$ref": "#/definitions/ApplicationGatewayRoutingRulePropertiesFormat", "description": "Properties of the application gateway routing rule.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Name of the routing rule that is unique within an Application Gateway." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true }, "type": { "type": "string", "description": "Type of the resource.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "ApplicationGatewayRoutingRulePropertiesFormat": { "type": "object", "description": "Properties of routing rule of the application gateway.", "properties": { "ruleType": { "$ref": "./common.json#/definitions/ApplicationGatewayRequestRoutingRuleType", "description": "Rule type." }, "priority": { "type": "integer", "format": "int32", "description": "Priority of the routing rule.", "minimum": 1, "maximum": 20000 }, "backendAddressPool": { "$ref": "./common.json#/definitions/SubResource", "description": "Backend address pool resource of the application gateway." }, "backendSettings": { "$ref": "./common.json#/definitions/SubResource", "description": "Backend settings resource of the application gateway." }, "listener": { "$ref": "./common.json#/definitions/SubResource", "description": "Listener resource of the application gateway." }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the request routing rule resource.", "readOnly": true } }, "required": [ "priority" ] }, "ApplicationGatewaySku": { "type": "object", "description": "SKU of an application gateway.", "properties": { "name": { "$ref": "./common.json#/definitions/ApplicationGatewaySkuName", "description": "Name of an application gateway SKU." }, "tier": { "$ref": "./common.json#/definitions/ApplicationGatewayTier", "description": "Tier of an application gateway." }, "capacity": { "type": "integer", "format": "int32", "description": "Capacity (instance count) of an application gateway." }, "family": { "$ref": "./common.json#/definitions/ApplicationGatewaySkuFamily", "description": "Family of an application gateway SKU." } } }, "ApplicationGatewaySslCertificate": { "type": "object", "description": "SSL certificates of an application gateway.", "properties": { "properties": { "$ref": "#/definitions/ApplicationGatewaySslCertificatePropertiesFormat", "description": "Properties of the application gateway SSL certificate.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Name of the SSL certificate that is unique within an Application Gateway." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true }, "type": { "type": "string", "description": "Type of the resource.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "ApplicationGatewaySslCertificatePropertiesFormat": { "type": "object", "description": "Properties of SSL certificates of an application gateway.", "properties": { "data": { "type": "string", "description": "Base-64 encoded pfx certificate. Only applicable in PUT Request." }, "password": { "type": "string", "description": "Password for the pfx file specified in data. Only applicable in PUT request." }, "publicCertData": { "type": "string", "description": "Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request.", "readOnly": true }, "keyVaultSecretId": { "type": "string", "description": "Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault." }, "hsm": { "$ref": "#/definitions/ApplicationGatewayManagedHsm", "description": "Managed HSM properties of the Application Gateway resource." }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the SSL certificate resource.", "readOnly": true } } }, "ApplicationGatewaySslPolicy": { "type": "object", "description": "Application Gateway Ssl policy.", "properties": { "disabledSslProtocols": { "type": "array", "description": "Ssl protocols to be disabled on application gateway.", "items": { "$ref": "./common.json#/definitions/ApplicationGatewaySslProtocol" } }, "policyType": { "$ref": "./common.json#/definitions/ApplicationGatewaySslPolicyType", "description": "Type of Ssl Policy." }, "policyName": { "$ref": "./common.json#/definitions/ApplicationGatewaySslPolicyName", "description": "Name of Ssl predefined policy." }, "cipherSuites": { "type": "array", "description": "Ssl cipher suites to be enabled in the specified order to application gateway.", "items": { "$ref": "./common.json#/definitions/ApplicationGatewaySslCipherSuite" } }, "minProtocolVersion": { "$ref": "./common.json#/definitions/ApplicationGatewaySslProtocol", "description": "Minimum version of Ssl protocol to be supported on application gateway." } } }, "ApplicationGatewaySslPredefinedPolicy": { "type": "object", "description": "An Ssl predefined policy.", "properties": { "name": { "type": "string", "description": "Name of the Ssl predefined policy." }, "properties": { "$ref": "#/definitions/ApplicationGatewaySslPredefinedPolicyPropertiesFormat", "description": "Properties of the application gateway SSL predefined policy.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "ApplicationGatewaySslPredefinedPolicyPropertiesFormat": { "type": "object", "description": "Properties of ApplicationGatewaySslPredefinedPolicy.", "properties": { "cipherSuites": { "type": "array", "description": "Ssl cipher suites to be enabled in the specified order for application gateway.", "items": { "$ref": "./common.json#/definitions/ApplicationGatewaySslCipherSuite" } }, "minProtocolVersion": { "$ref": "./common.json#/definitions/ApplicationGatewaySslProtocol", "description": "Minimum version of Ssl protocol to be supported on application gateway." } } }, "ApplicationGatewaySslProfile": { "type": "object", "description": "SSL profile of an application gateway.", "properties": { "properties": { "$ref": "#/definitions/ApplicationGatewaySslProfilePropertiesFormat", "description": "Properties of the application gateway SSL profile.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Name of the SSL profile that is unique within an Application Gateway." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true }, "type": { "type": "string", "description": "Type of the resource.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "ApplicationGatewaySslProfilePropertiesFormat": { "type": "object", "description": "Properties of SSL profile of an application gateway.", "properties": { "trustedClientCertificates": { "type": "array", "description": "Array of references to application gateway trusted client certificates.", "items": { "$ref": "./common.json#/definitions/SubResource" } }, "sslPolicy": { "$ref": "#/definitions/ApplicationGatewaySslPolicy", "description": "SSL policy of the application gateway resource." }, "clientAuthConfiguration": { "$ref": "#/definitions/ApplicationGatewayClientAuthConfiguration", "description": "Client authentication configuration of the application gateway resource." }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the HTTP listener resource.", "readOnly": true } } }, "ApplicationGatewayTrustedClientCertificate": { "type": "object", "description": "Trusted client certificates of an application gateway.", "properties": { "properties": { "$ref": "#/definitions/ApplicationGatewayTrustedClientCertificatePropertiesFormat", "description": "Properties of the application gateway trusted client certificate.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Name of the trusted client certificate that is unique within an Application Gateway." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true }, "type": { "type": "string", "description": "Type of the resource.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "ApplicationGatewayTrustedClientCertificatePropertiesFormat": { "type": "object", "description": "Trusted client certificates properties of an application gateway.", "properties": { "data": { "type": "string", "description": "Certificate public data." }, "validatedCertData": { "type": "string", "description": "Validated certificate data.", "readOnly": true }, "clientCertIssuerDN": { "type": "string", "description": "Distinguished name of client certificate issuer.", "readOnly": true }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the trusted client certificate resource.", "readOnly": true } } }, "ApplicationGatewayTrustedRootCertificate": { "type": "object", "description": "Trusted Root certificates of an application gateway.", "properties": { "properties": { "$ref": "#/definitions/ApplicationGatewayTrustedRootCertificatePropertiesFormat", "description": "Properties of the application gateway trusted root certificate.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Name of the trusted root certificate that is unique within an Application Gateway." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true }, "type": { "type": "string", "description": "Type of the resource.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "ApplicationGatewayTrustedRootCertificatePropertiesFormat": { "type": "object", "description": "Trusted Root certificates properties of an application gateway.", "properties": { "data": { "type": "string", "description": "Certificate public data." }, "keyVaultSecretId": { "type": "string", "description": "Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault." }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the trusted root certificate resource.", "readOnly": true } } }, "ApplicationGatewayUrlConfiguration": { "type": "object", "description": "Url configuration of the Actions set in Application Gateway.", "properties": { "modifiedPath": { "type": "string", "description": "Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null." }, "modifiedQueryString": { "type": "string", "description": "Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null." }, "reroute": { "type": "boolean", "description": "If set as true, it will re-evaluate the url path map provided in path based request routing rules using modified path. Default value is false." } } }, "ApplicationGatewayUrlPathMap": { "type": "object", "description": "UrlPathMaps give a url path to the backend mapping information for PathBasedRouting.", "properties": { "properties": { "$ref": "#/definitions/ApplicationGatewayUrlPathMapPropertiesFormat", "description": "Properties of the application gateway URL path map.", "x-ms-client-flatten": true }, "name": { "type": "string", "description": "Name of the URL path map that is unique within an Application Gateway." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true }, "type": { "type": "string", "description": "Type of the resource.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/SubResource" } ] }, "ApplicationGatewayUrlPathMapPropertiesFormat": { "type": "object", "description": "Properties of UrlPathMap of the application gateway.", "properties": { "defaultBackendAddressPool": { "$ref": "./common.json#/definitions/SubResource", "description": "Default backend address pool resource of URL path map." }, "defaultBackendHttpSettings": { "$ref": "./common.json#/definitions/SubResource", "description": "Default backend http settings resource of URL path map." }, "defaultRewriteRuleSet": { "$ref": "./common.json#/definitions/SubResource", "description": "Default Rewrite rule set resource of URL path map." }, "defaultRedirectConfiguration": { "$ref": "./common.json#/definitions/SubResource", "description": "Default redirect configuration resource of URL path map." }, "defaultLoadDistributionPolicy": { "$ref": "./common.json#/definitions/SubResource", "description": "Default Load Distribution Policy resource of URL path map." }, "pathRules": { "type": "array", "description": "Path rule of URL path map resource.", "items": { "$ref": "#/definitions/ApplicationGatewayPathRule" } }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the URL path map resource.", "readOnly": true } } }, "ApplicationGatewayWafDynamicManifestPropertiesResult": { "type": "object", "description": "Properties of ApplicationGatewayWafDynamicManifest.", "properties": { "defaultRuleSet": { "$ref": "#/definitions/DefaultRuleSetPropertyFormat", "description": "The default ruleset.", "x-ms-client-flatten": true }, "availableRuleSets": { "type": "array", "description": "The available rulesets.", "items": { "$ref": "#/definitions/ApplicationGatewayFirewallManifestRuleSet" }, "x-ms-client-flatten": true, "x-ms-identifiers": [] } } }, "ApplicationGatewayWafDynamicManifestResult": { "type": "object", "description": "Response for ApplicationGatewayWafDynamicManifest API service call.", "properties": { "properties": { "$ref": "#/definitions/ApplicationGatewayWafDynamicManifestPropertiesResult", "description": "Properties of the ApplicationGatewayWafDynamicManifest .", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "./common.json#/definitions/ProxyResourceWithSettableId" } ] }, "ApplicationGatewayWafDynamicManifestResultList": { "type": "object", "description": "Response for ApplicationGatewayWafDynamicManifests API service call.", "properties": { "value": { "type": "array", "description": "The ApplicationGatewayWafDynamicManifestResult items on this page", "items": { "$ref": "#/definitions/ApplicationGatewayWafDynamicManifestResult" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "ApplicationGatewayWebApplicationFirewallConfiguration": { "type": "object", "description": "Application gateway web application firewall configuration.", "properties": { "enabled": { "type": "boolean", "description": "Whether the web application firewall is enabled or not." }, "firewallMode": { "$ref": "./common.json#/definitions/ApplicationGatewayFirewallMode", "description": "Web application firewall mode." }, "ruleSetType": { "type": "string", "description": "The type of the web application firewall rule set. Possible values are: 'OWASP'." }, "ruleSetVersion": { "type": "string", "description": "The version of the rule set type." }, "disabledRuleGroups": { "type": "array", "description": "The disabled rule groups.", "items": { "$ref": "#/definitions/ApplicationGatewayFirewallDisabledRuleGroup" } }, "requestBodyCheck": { "type": "boolean", "description": "Whether allow WAF to check request Body." }, "maxRequestBodySize": { "type": "integer", "format": "int32", "description": "Maximum request body size for WAF.", "minimum": 8, "maximum": 128 }, "maxRequestBodySizeInKb": { "type": "integer", "format": "int32", "description": "Maximum request body size in Kb for WAF.", "minimum": 8, "maximum": 128 }, "fileUploadLimitInMb": { "type": "integer", "format": "int32", "description": "Maximum file upload size in Mb for WAF.", "minimum": 0 }, "exclusions": { "type": "array", "description": "The exclusion list.", "items": { "$ref": "#/definitions/ApplicationGatewayFirewallExclusion" } } }, "required": [ "enabled", "firewallMode", "ruleSetType", "ruleSetVersion" ] }, "DefaultRuleSetPropertyFormat": { "type": "object", "description": "the default web application firewall rule set.", "properties": { "ruleSetType": { "type": "string", "description": "The type of the web application firewall rule set." }, "ruleSetVersion": { "type": "string", "description": "The version of the web application firewall rule set type." }, "displayName": { "type": "string", "description": "Human-readable display name for the managed rule set version (e.g., 'Default Ruleset 2.2 (Latest, Recommended)')." } } }, "ExceptionEntry": { "type": "object", "description": "Adds exception to allow a request when the condition is satisfied.", "properties": { "matchVariable": { "$ref": "./common.json#/definitions/ExceptionEntryMatchVariable", "description": "The variable on which we evaluate the exception condition" }, "values": { "type": "array", "description": "Allowed values for the matchVariable", "items": { "type": "string" } }, "valueMatchOperator": { "$ref": "./common.json#/definitions/ExceptionEntryValueMatchOperator", "description": "Operates on the allowed values for the matchVariable" }, "selectorMatchOperator": { "$ref": "./common.json#/definitions/ExceptionEntrySelectorMatchOperator", "description": "When the matchVariable points to a key-value pair (e.g, RequestHeader), this operates on the selector" }, "selector": { "type": "string", "description": "When the matchVariable points to a key-value pair (e.g, RequestHeader), this identifies the key." }, "exceptionManagedRuleSets": { "type": "array", "description": "The managed rule sets that are associated with the exception.", "items": { "$ref": "#/definitions/ExclusionManagedRuleSet" } } }, "required": [ "matchVariable", "valueMatchOperator" ] }, "ExclusionManagedRule": { "type": "object", "description": "Defines a managed rule to use for exclusion.", "properties": { "ruleId": { "type": "string", "description": "Identifier for the managed rule." } }, "required": [ "ruleId" ] }, "ExclusionManagedRuleGroup": { "type": "object", "description": "Defines a managed rule group to use for exclusion.", "properties": { "ruleGroupName": { "type": "string", "description": "The managed rule group for exclusion." }, "rules": { "type": "array", "description": "List of rules that will be excluded. If none specified, all rules in the group will be excluded.", "items": { "$ref": "#/definitions/ExclusionManagedRule" } } }, "required": [ "ruleGroupName" ] }, "ExclusionManagedRuleSet": { "type": "object", "description": "Defines a managed rule set for Exclusions.", "properties": { "ruleSetType": { "type": "string", "description": "Defines the rule set type to use." }, "ruleSetVersion": { "type": "string", "description": "Defines the version of the rule set to use." }, "ruleGroups": { "type": "array", "description": "Defines the rule groups to apply to the rule set.", "items": { "$ref": "#/definitions/ExclusionManagedRuleGroup" } } }, "required": [ "ruleSetType", "ruleSetVersion" ] }, "GroupByUserSession": { "type": "object", "description": "Define user session identifier group by clauses.", "properties": { "groupByVariables": { "type": "array", "description": "List of group by clause variables.", "items": { "$ref": "#/definitions/GroupByVariable" }, "x-ms-identifiers": [] } }, "required": [ "groupByVariables" ] }, "GroupByVariable": { "type": "object", "description": "Define user session group by clause variables.", "properties": { "variableName": { "$ref": "./common.json#/definitions/ApplicationGatewayFirewallUserSessionVariable", "description": "User Session clause variable." } }, "required": [ "variableName" ] }, "HeaderValueMatcher": { "type": "object", "description": "An optional field under \"Rewrite Action\". It lets you capture and modify the value(s) of a specific header when multiple headers with the same name exist. Currently supported for Set-Cookie Response header only. For more details, visit https://aka.ms/appgwheadercrud", "properties": { "pattern": { "type": "string", "description": "The pattern, either fixed string or regular expression, that evaluates if a header value should be selected for rewrite." }, "ignoreCase": { "type": "boolean", "description": "Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison." }, "negate": { "type": "boolean", "description": "Setting this value as truth will force to check the negation of the condition given by the user in the pattern field." } } }, "ManagedRuleGroupOverride": { "type": "object", "description": "Defines a managed rule group override setting.", "properties": { "ruleGroupName": { "type": "string", "description": "The managed rule group to override." }, "rules": { "type": "array", "description": "List of rules that will be disabled. If none specified, all rules in the group will be disabled.", "items": { "$ref": "#/definitions/ManagedRuleOverride" } } }, "required": [ "ruleGroupName" ] }, "ManagedRuleOverride": { "type": "object", "description": "Defines a managed rule group override setting.", "properties": { "ruleId": { "type": "string", "description": "Identifier for the managed rule." }, "state": { "$ref": "./common.json#/definitions/ManagedRuleEnabledState", "description": "The state of the managed rule. Defaults to Disabled if not specified." }, "action": { "$ref": "./common.json#/definitions/ActionType", "description": "Describes the override action to be applied when rule matches." }, "sensitivity": { "$ref": "./common.json#/definitions/SensitivityType", "description": "Describes the override sensitivity to be applied when rule matches." } }, "required": [ "ruleId" ] }, "ManagedRuleSet": { "type": "object", "description": "Defines a managed rule set.", "properties": { "ruleSetType": { "type": "string", "description": "Defines the rule set type to use." }, "ruleSetVersion": { "type": "string", "description": "Defines the version of the rule set to use." }, "ruleGroupOverrides": { "type": "array", "description": "Defines the rule group overrides to apply to the rule set.", "items": { "$ref": "#/definitions/ManagedRuleGroupOverride" } }, "computedDisabledRules": { "type": "array", "description": "Stores the final list of disabled rule groups", "items": { "$ref": "#/definitions/ManagedRuleSetRuleGroup" }, "readOnly": true } }, "required": [ "ruleSetType", "ruleSetVersion" ] }, "ManagedRuleSetRuleGroup": { "type": "object", "description": "Defines a managed rule set rule group", "properties": { "ruleGroupName": { "type": "string", "description": "Name of the rule group" }, "rules": { "type": "array", "description": "List of rules within the rule group", "items": { "type": "integer", "format": "int32" } } }, "required": [ "ruleGroupName" ] }, "ManagedRulesDefinition": { "type": "object", "description": "Allow to exclude some variable satisfy the condition for the WAF check.", "properties": { "exceptions": { "type": "array", "description": "The exceptions that are applied on the policy.", "items": { "$ref": "#/definitions/ExceptionEntry" } }, "exclusions": { "type": "array", "description": "The Exclusions that are applied on the policy.", "items": { "$ref": "#/definitions/OwaspCrsExclusionEntry" } }, "managedRuleSets": { "type": "array", "description": "The managed rule sets that are associated with the policy.", "items": { "$ref": "#/definitions/ManagedRuleSet" } } }, "required": [ "managedRuleSets" ] }, "MatchCondition": { "type": "object", "description": "Define match conditions.", "properties": { "matchVariables": { "type": "array", "description": "List of match variables.", "items": { "$ref": "#/definitions/MatchVariable" } }, "operator": { "$ref": "./common.json#/definitions/WebApplicationFirewallOperator", "description": "The operator to be matched." }, "negationConditon": { "type": "boolean", "description": "Whether this is negate condition or not." }, "matchValues": { "type": "array", "description": "Match value.", "items": { "type": "string" } }, "transforms": { "type": "array", "description": "List of transforms.", "items": { "$ref": "./common.json#/definitions/WebApplicationFirewallTransform" } } }, "required": [ "matchVariables", "operator", "matchValues" ] }, "MatchVariable": { "type": "object", "description": "Define match variables.", "properties": { "variableName": { "$ref": "./common.json#/definitions/WebApplicationFirewallMatchVariable", "description": "Match Variable." }, "selector": { "type": "string", "description": "The selector of match variable." } }, "required": [ "variableName" ] }, "OwaspCrsExclusionEntry": { "type": "object", "description": "Allow to exclude some variable satisfy the condition for the WAF check.", "properties": { "matchVariable": { "$ref": "./common.json#/definitions/OwaspCrsExclusionEntryMatchVariable", "description": "The variable to be excluded." }, "selectorMatchOperator": { "$ref": "./common.json#/definitions/OwaspCrsExclusionEntrySelectorMatchOperator", "description": "When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to." }, "selector": { "type": "string", "description": "When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to." }, "exclusionManagedRuleSets": { "type": "array", "description": "The managed rule sets that are associated with the exclusion.", "items": { "$ref": "#/definitions/ExclusionManagedRuleSet" } } }, "required": [ "matchVariable", "selectorMatchOperator", "selector" ] }, "PolicySettings": { "type": "object", "description": "Defines contents of a web application firewall global configuration.", "properties": { "state": { "$ref": "./common.json#/definitions/WebApplicationFirewallEnabledState", "description": "The state of the policy." }, "mode": { "$ref": "./common.json#/definitions/WebApplicationFirewallMode", "description": "The mode of the policy." }, "requestBodyCheck": { "type": "boolean", "description": "Whether to allow WAF to check request Body." }, "requestBodyInspectLimitInKB": { "type": "integer", "format": "int32", "description": "Max inspection limit in KB for request body inspection for WAF." }, "requestBodyEnforcement": { "type": "boolean", "description": "Whether allow WAF to enforce request body limits.", "default": true }, "maxRequestBodySizeInKb": { "type": "integer", "format": "int32", "description": "Maximum request body size in Kb for WAF.", "minimum": 8 }, "fileUploadEnforcement": { "type": "boolean", "description": "Whether allow WAF to enforce file upload limits.", "default": true }, "fileUploadLimitInMb": { "type": "integer", "format": "int32", "description": "Maximum file upload size in Mb for WAF.", "minimum": 0 }, "customBlockResponseStatusCode": { "type": "integer", "format": "int32", "description": "If the action type is block, customer can override the response status code.", "minimum": 0 }, "customBlockResponseBody": { "type": "string", "description": "If the action type is block, customer can override the response body. The body must be specified in base64 encoding.", "maxLength": 32768, "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "logScrubbing": { "$ref": "#/definitions/PolicySettingsLogScrubbing", "description": "To scrub sensitive log fields" }, "jsChallengeCookieExpirationInMins": { "type": "integer", "format": "int32", "description": "Web Application Firewall JavaScript Challenge Cookie Expiration time in minutes.", "minimum": 5, "maximum": 1440 }, "captchaExpirationInMins": { "type": "integer", "format": "int32", "description": "Web Application Firewall CAPTCHA Cookie Expiration time in minutes.", "minimum": 5, "maximum": 1440 } } }, "PolicySettingsLogScrubbing": { "type": "object", "description": "To scrub sensitive log fields", "properties": { "state": { "$ref": "./common.json#/definitions/WebApplicationFirewallScrubbingState", "description": "State of the log scrubbing config. Default value is Enabled." }, "scrubbingRules": { "type": "array", "description": "The rules that are applied to the logs for scrubbing.", "items": { "$ref": "#/definitions/WebApplicationFirewallScrubbingRules" }, "x-ms-identifiers": [] } } }, "WebApplicationFirewallCustomRule": { "type": "object", "description": "Defines contents of a web application rule.", "properties": { "name": { "type": "string", "description": "The name of the resource that is unique within a policy. This name can be used to access the resource.", "maxLength": 128 }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true }, "priority": { "type": "integer", "format": "int32", "description": "Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value." }, "state": { "$ref": "./common.json#/definitions/WebApplicationFirewallState", "description": "Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified." }, "rateLimitDuration": { "$ref": "./common.json#/definitions/ApplicationGatewayFirewallRateLimitDuration", "description": "Duration over which Rate Limit policy will be applied. Applies only when ruleType is RateLimitRule." }, "rateLimitThreshold": { "type": "integer", "format": "int32", "description": "Rate Limit threshold to apply in case ruleType is RateLimitRule. Must be greater than or equal to 1" }, "ruleType": { "$ref": "./common.json#/definitions/WebApplicationFirewallRuleType", "description": "The rule type." }, "matchConditions": { "type": "array", "description": "List of match conditions.", "items": { "$ref": "#/definitions/MatchCondition" } }, "groupByUserSession": { "type": "array", "description": "List of user session identifier group by clauses.", "items": { "$ref": "#/definitions/GroupByUserSession" }, "x-ms-identifiers": [] }, "action": { "$ref": "./common.json#/definitions/WebApplicationFirewallAction", "description": "Type of Actions." } }, "required": [ "priority", "ruleType", "matchConditions", "action" ] }, "WebApplicationFirewallPolicy": { "type": "object", "description": "Defines web application firewall policy.", "properties": { "properties": { "$ref": "#/definitions/WebApplicationFirewallPolicyPropertiesFormat", "description": "Properties of the web application firewall policy.", "x-ms-client-flatten": true }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated.", "readOnly": true } }, "allOf": [ { "$ref": "./common.json#/definitions/Resource" } ] }, "WebApplicationFirewallPolicyListResult": { "type": "object", "description": "Paged collection of WebApplicationFirewallPolicy items", "properties": { "value": { "type": "array", "description": "The WebApplicationFirewallPolicy items on this page", "items": { "$ref": "#/definitions/WebApplicationFirewallPolicy" }, "readOnly": true }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "WebApplicationFirewallPolicyPropertiesFormat": { "type": "object", "description": "Defines web application firewall policy properties.", "properties": { "policySettings": { "$ref": "#/definitions/PolicySettings", "description": "The PolicySettings for policy." }, "customRules": { "type": "array", "description": "The custom rules inside the policy.", "items": { "$ref": "#/definitions/WebApplicationFirewallCustomRule" } }, "applicationGateways": { "type": "array", "description": "A collection of references to application gateways.", "items": { "$ref": "#/definitions/ApplicationGateway" }, "readOnly": true }, "provisioningState": { "$ref": "./common.json#/definitions/ProvisioningState", "description": "The provisioning state of the web application firewall policy resource.", "readOnly": true }, "resourceState": { "$ref": "./common.json#/definitions/WebApplicationFirewallPolicyResourceState", "title": "Resource status of the policy.", "description": "Resource status of the policy.", "readOnly": true }, "managedRules": { "$ref": "#/definitions/ManagedRulesDefinition", "description": "Describes the managedRules structure." }, "httpListeners": { "type": "array", "description": "A collection of references to application gateway http listeners.", "items": { "$ref": "./common.json#/definitions/SubResource" }, "readOnly": true }, "pathBasedRules": { "type": "array", "description": "A collection of references to application gateway path rules.", "items": { "$ref": "./common.json#/definitions/SubResource" }, "readOnly": true }, "applicationGatewayForContainers": { "type": "array", "description": "A collection of references to application gateway for containers.", "items": { "$ref": "#/definitions/ApplicationGatewayForContainersReferenceDefinition" }, "readOnly": true }, "tier": { "$ref": "./common.json#/definitions/WebApplicationFirewallPolicyTier", "description": "Tier of a web application firewall policy." } }, "required": [ "managedRules" ] }, "WebApplicationFirewallScrubbingRules": { "type": "object", "description": "Allow certain variables to be scrubbed on WAF logs", "properties": { "matchVariable": { "$ref": "./common.json#/definitions/ScrubbingRuleEntryMatchVariable", "description": "The variable to be scrubbed from the logs." }, "selectorMatchOperator": { "$ref": "./common.json#/definitions/scrubbingRuleEntryMatchOperator", "description": "When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to." }, "selector": { "type": "string", "description": "When matchVariable is a collection, operator used to specify which elements in the collection this rule applies to." }, "state": { "$ref": "./common.json#/definitions/scrubbingRuleEntryState", "description": "Defines the state of log scrubbing rule. Default value is Enabled." } }, "required": [ "matchVariable", "selectorMatchOperator" ] } }, "parameters": {} }