application_gateways

Creates, updates, deletes, gets or lists an application_gateways resource.

Overview

Name	application_gateways
Type	Resource
Id	azure.network.application_gateways

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
authenticationCertificates	array	Authentication certificates of the application gateway resource. For default limits, see Application Gateway limits _.
autoscaleConfiguration	object	Autoscale Configuration.
backendAddressPools	array	Backend address pool of the application gateway resource. For default limits, see Application Gateway limits _.
backendHttpSettingsCollection	array	Backend http settings of the application gateway resource. For default limits, see Application Gateway limits _.
backendSettingsCollection	array	Backend settings of the application gateway resource. For default limits, see Application Gateway limits _.
customErrorConfigurations	array	Custom error configurations of the application gateway resource.
defaultPredefinedSslPolicy	string	The default predefined SSL Policy applied on the application gateway resource. Known values are: "AppGwSslPolicy20150501", "AppGwSslPolicy20170401", "AppGwSslPolicy20170401S", "AppGwSslPolicy20220101", and "AppGwSslPolicy20220101S". (AppGwSslPolicy20150501, AppGwSslPolicy20170401, AppGwSslPolicy20170401S, AppGwSslPolicy20220101, AppGwSslPolicy20220101S)
enableFips	boolean	Whether FIPS is enabled on the application gateway resource.
enableHttp2	boolean	Whether HTTP2 is enabled on the application gateway resource.
entraJWTValidationConfigs	array	Entra JWT validation configurations for the application gateway resource. For default limits, see Application Gateway limits _.
etag	string	A unique read-only string that changes whenever the resource is updated.
firewallPolicy	object	Reference to another subresource.
forceFirewallPolicyAssociation	boolean	If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config.
frontendIPConfigurations	array	Frontend IP addresses of the application gateway resource. For default limits, see Application Gateway limits _.
frontendPorts	array	Frontend ports of the application gateway resource. For default limits, see Application Gateway limits _.
gatewayIPConfigurations	array	Subnets of the application gateway resource. For default limits, see Application Gateway limits _.
globalConfiguration	object	Global Configuration.
httpListeners	array	Http listeners of the application gateway resource. For default limits, see Application Gateway limits _.
identity	object	The identity of the application gateway, if configured.
listeners	array	Listeners of the application gateway resource. For default limits, see Application Gateway limits _.
loadDistributionPolicies	array	Load distribution policies of the application gateway resource.
location	string	Resource location.
operationalState	string	Operational state of the application gateway resource. Known values are: "Stopped", "Starting", "Running", and "Stopping". (Stopped, Starting, Running, Stopping)
privateEndpointConnections	array	Private Endpoint connections on application gateway.
privateLinkConfigurations	array	PrivateLink configurations on application gateway.
probes	array	Probes of the application gateway resource.
provisioningState	string	The provisioning state of the application gateway resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
redirectConfigurations	array	Redirect configurations of the application gateway resource. For default limits, see Application Gateway limits _.
requestRoutingRules	array	Request routing rules of the application gateway resource.
resourceGuid	string	The resource GUID property of the application gateway resource.
rewriteRuleSets	array	Rewrite rules for the application gateway resource.
routingRules	array	Routing rules of the application gateway resource.
sku	object	SKU of the application gateway resource.
sslCertificates	array	SSL certificates of the application gateway resource. For default limits, see Application Gateway limits _.
sslPolicy	object	SSL policy of the application gateway resource.
sslProfiles	array	SSL profiles of the application gateway resource. For default limits, see Application Gateway limits _.
tags	object	Resource tags.
trustedClientCertificates	array	Trusted client certificates of the application gateway resource. For default limits, see Application Gateway limits _.
trustedRootCertificates	array	Trusted Root certificates of the application gateway resource. For default limits, see Application Gateway limits _.
type	string	Resource type.
urlPathMaps	array	URL path map of the application gateway resource. For default limits, see Application Gateway limits _.
webApplicationFirewallConfiguration	object	Web application firewall configuration.
zones	array	A list of availability zones denoting where the resource needs to come from.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
authenticationCertificates	array	Authentication certificates of the application gateway resource. For default limits, see Application Gateway limits _.
autoscaleConfiguration	object	Autoscale Configuration.
backendAddressPools	array	Backend address pool of the application gateway resource. For default limits, see Application Gateway limits _.
backendHttpSettingsCollection	array	Backend http settings of the application gateway resource. For default limits, see Application Gateway limits _.
backendSettingsCollection	array	Backend settings of the application gateway resource. For default limits, see Application Gateway limits _.
customErrorConfigurations	array	Custom error configurations of the application gateway resource.
defaultPredefinedSslPolicy	string	The default predefined SSL Policy applied on the application gateway resource. Known values are: "AppGwSslPolicy20150501", "AppGwSslPolicy20170401", "AppGwSslPolicy20170401S", "AppGwSslPolicy20220101", and "AppGwSslPolicy20220101S". (AppGwSslPolicy20150501, AppGwSslPolicy20170401, AppGwSslPolicy20170401S, AppGwSslPolicy20220101, AppGwSslPolicy20220101S)
enableFips	boolean	Whether FIPS is enabled on the application gateway resource.
enableHttp2	boolean	Whether HTTP2 is enabled on the application gateway resource.
entraJWTValidationConfigs	array	Entra JWT validation configurations for the application gateway resource. For default limits, see Application Gateway limits _.
etag	string	A unique read-only string that changes whenever the resource is updated.
firewallPolicy	object	Reference to another subresource.
forceFirewallPolicyAssociation	boolean	If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config.
frontendIPConfigurations	array	Frontend IP addresses of the application gateway resource. For default limits, see Application Gateway limits _.
frontendPorts	array	Frontend ports of the application gateway resource. For default limits, see Application Gateway limits _.
gatewayIPConfigurations	array	Subnets of the application gateway resource. For default limits, see Application Gateway limits _.
globalConfiguration	object	Global Configuration.
httpListeners	array	Http listeners of the application gateway resource. For default limits, see Application Gateway limits _.
identity	object	The identity of the application gateway, if configured.
listeners	array	Listeners of the application gateway resource. For default limits, see Application Gateway limits _.
loadDistributionPolicies	array	Load distribution policies of the application gateway resource.
location	string	Resource location.
operationalState	string	Operational state of the application gateway resource. Known values are: "Stopped", "Starting", "Running", and "Stopping". (Stopped, Starting, Running, Stopping)
privateEndpointConnections	array	Private Endpoint connections on application gateway.
privateLinkConfigurations	array	PrivateLink configurations on application gateway.
probes	array	Probes of the application gateway resource.
provisioningState	string	The provisioning state of the application gateway resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
redirectConfigurations	array	Redirect configurations of the application gateway resource. For default limits, see Application Gateway limits _.
requestRoutingRules	array	Request routing rules of the application gateway resource.
resourceGuid	string	The resource GUID property of the application gateway resource.
rewriteRuleSets	array	Rewrite rules for the application gateway resource.
routingRules	array	Routing rules of the application gateway resource.
sku	object	SKU of the application gateway resource.
sslCertificates	array	SSL certificates of the application gateway resource. For default limits, see Application Gateway limits _.
sslPolicy	object	SSL policy of the application gateway resource.
sslProfiles	array	SSL profiles of the application gateway resource. For default limits, see Application Gateway limits _.
tags	object	Resource tags.
trustedClientCertificates	array	Trusted client certificates of the application gateway resource. For default limits, see Application Gateway limits _.
trustedRootCertificates	array	Trusted Root certificates of the application gateway resource. For default limits, see Application Gateway limits _.
type	string	Resource type.
urlPathMaps	array	URL path map of the application gateway resource. For default limits, see Application Gateway limits _.
webApplicationFirewallConfiguration	object	Web application firewall configuration.
zones	array	A list of availability zones denoting where the resource needs to come from.

get_ssl_predefined_policy

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the Ssl predefined policy.
cipherSuites	array	Ssl cipher suites to be enabled in the specified order for application gateway.
minProtocolVersion	string	Minimum version of Ssl protocol to be supported on application gateway. Known values are: "TLSv1_0", "TLSv1_1", "TLSv1_2", and "TLSv1_3". (TLSv1_0, TLSv1_1, TLSv1_2, TLSv1_3)

list_all

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
authenticationCertificates	array	Authentication certificates of the application gateway resource. For default limits, see Application Gateway limits _.
autoscaleConfiguration	object	Autoscale Configuration.
backendAddressPools	array	Backend address pool of the application gateway resource. For default limits, see Application Gateway limits _.
backendHttpSettingsCollection	array	Backend http settings of the application gateway resource. For default limits, see Application Gateway limits _.
backendSettingsCollection	array	Backend settings of the application gateway resource. For default limits, see Application Gateway limits _.
customErrorConfigurations	array	Custom error configurations of the application gateway resource.
defaultPredefinedSslPolicy	string	The default predefined SSL Policy applied on the application gateway resource. Known values are: "AppGwSslPolicy20150501", "AppGwSslPolicy20170401", "AppGwSslPolicy20170401S", "AppGwSslPolicy20220101", and "AppGwSslPolicy20220101S". (AppGwSslPolicy20150501, AppGwSslPolicy20170401, AppGwSslPolicy20170401S, AppGwSslPolicy20220101, AppGwSslPolicy20220101S)
enableFips	boolean	Whether FIPS is enabled on the application gateway resource.
enableHttp2	boolean	Whether HTTP2 is enabled on the application gateway resource.
entraJWTValidationConfigs	array	Entra JWT validation configurations for the application gateway resource. For default limits, see Application Gateway limits _.
etag	string	A unique read-only string that changes whenever the resource is updated.
firewallPolicy	object	Reference to another subresource.
forceFirewallPolicyAssociation	boolean	If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config.
frontendIPConfigurations	array	Frontend IP addresses of the application gateway resource. For default limits, see Application Gateway limits _.
frontendPorts	array	Frontend ports of the application gateway resource. For default limits, see Application Gateway limits _.
gatewayIPConfigurations	array	Subnets of the application gateway resource. For default limits, see Application Gateway limits _.
globalConfiguration	object	Global Configuration.
httpListeners	array	Http listeners of the application gateway resource. For default limits, see Application Gateway limits _.
identity	object	The identity of the application gateway, if configured.
listeners	array	Listeners of the application gateway resource. For default limits, see Application Gateway limits _.
loadDistributionPolicies	array	Load distribution policies of the application gateway resource.
location	string	Resource location.
operationalState	string	Operational state of the application gateway resource. Known values are: "Stopped", "Starting", "Running", and "Stopping". (Stopped, Starting, Running, Stopping)
privateEndpointConnections	array	Private Endpoint connections on application gateway.
privateLinkConfigurations	array	PrivateLink configurations on application gateway.
probes	array	Probes of the application gateway resource.
provisioningState	string	The provisioning state of the application gateway resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
redirectConfigurations	array	Redirect configurations of the application gateway resource. For default limits, see Application Gateway limits _.
requestRoutingRules	array	Request routing rules of the application gateway resource.
resourceGuid	string	The resource GUID property of the application gateway resource.
rewriteRuleSets	array	Rewrite rules for the application gateway resource.
routingRules	array	Routing rules of the application gateway resource.
sku	object	SKU of the application gateway resource.
sslCertificates	array	SSL certificates of the application gateway resource. For default limits, see Application Gateway limits _.
sslPolicy	object	SSL policy of the application gateway resource.
sslProfiles	array	SSL profiles of the application gateway resource. For default limits, see Application Gateway limits _.
tags	object	Resource tags.
trustedClientCertificates	array	Trusted client certificates of the application gateway resource. For default limits, see Application Gateway limits _.
trustedRootCertificates	array	Trusted Root certificates of the application gateway resource. For default limits, see Application Gateway limits _.
type	string	Resource type.
urlPathMaps	array	URL path map of the application gateway resource. For default limits, see Application Gateway limits _.
webApplicationFirewallConfiguration	object	Web application firewall configuration.
zones	array	A list of availability zones denoting where the resource needs to come from.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, application_gateway_name, subscription_id		Gets the specified application gateway.
list	select	resource_group_name, subscription_id		Lists all application gateways in a resource group.
get_ssl_predefined_policy	select	predefined_policy_name, subscription_id		Gets Ssl predefined policy with the specified policy name.
list_all	select	subscription_id		Gets all the application gateways in a subscription.
create_or_update	insert	resource_group_name, application_gateway_name, subscription_id		Creates or updates the specified application gateway.
update_tags	update	resource_group_name, application_gateway_name, subscription_id		Updates the specified application gateway tags.
create_or_update	replace	resource_group_name, application_gateway_name, subscription_id		Creates or updates the specified application gateway.
delete	delete	resource_group_name, application_gateway_name, subscription_id		Deletes the specified application gateway.
list_available_ssl_options	exec	subscription_id		Lists available Ssl options for configuring Ssl policy.
list_available_ssl_predefined_policies	exec	subscription_id		Lists all SSL predefined policies for configuring Ssl policy.
list_available_server_variables	exec	subscription_id		Lists all available server variables.
list_available_request_headers	exec	subscription_id		Lists all available request headers.
list_available_response_headers	exec	subscription_id		Lists all available response headers.
list_available_waf_rule_sets	exec	subscription_id		Lists all available web application firewall rule sets.
start	exec	resource_group_name, application_gateway_name, subscription_id		Starts the specified application gateway.
stop	exec	resource_group_name, application_gateway_name, subscription_id		Stops the specified application gateway in a resource group.
backend_health	exec	resource_group_name, application_gateway_name, subscription_id	$expand	Gets the backend health of the specified application gateway in a resource group.
backend_health_on_demand	exec	resource_group_name, application_gateway_name, subscription_id	$expand	Gets the backend health for given combination of backend pool and http setting of the specified application gateway in a resource group.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
application_gateway_name	string	The name of the application gateway. Required.
predefined_policy_name	string	The name of the ssl predefined policy. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$expand	string	Expands BackendAddressPool and BackendHttpSettings referenced in backend health. Default value is None.

SELECT examples

get

Gets the specified application gateway.

SELECT
id,
name,
authenticationCertificates,
autoscaleConfiguration,
backendAddressPools,
backendHttpSettingsCollection,
backendSettingsCollection,
customErrorConfigurations,
defaultPredefinedSslPolicy,
enableFips,
enableHttp2,
entraJWTValidationConfigs,
etag,
firewallPolicy,
forceFirewallPolicyAssociation,
frontendIPConfigurations,
frontendPorts,
gatewayIPConfigurations,
globalConfiguration,
httpListeners,
identity,
listeners,
loadDistributionPolicies,
location,
operationalState,
privateEndpointConnections,
privateLinkConfigurations,
probes,
provisioningState,
redirectConfigurations,
requestRoutingRules,
resourceGuid,
rewriteRuleSets,
routingRules,
sku,
sslCertificates,
sslPolicy,
sslProfiles,
tags,
trustedClientCertificates,
trustedRootCertificates,
type,
urlPathMaps,
webApplicationFirewallConfiguration,
zones
FROM azure.network.application_gateways
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND application_gateway_name = '{{ application_gateway_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all application gateways in a resource group.

SELECT
id,
name,
authenticationCertificates,
autoscaleConfiguration,
backendAddressPools,
backendHttpSettingsCollection,
backendSettingsCollection,
customErrorConfigurations,
defaultPredefinedSslPolicy,
enableFips,
enableHttp2,
entraJWTValidationConfigs,
etag,
firewallPolicy,
forceFirewallPolicyAssociation,
frontendIPConfigurations,
frontendPorts,
gatewayIPConfigurations,
globalConfiguration,
httpListeners,
identity,
listeners,
loadDistributionPolicies,
location,
operationalState,
privateEndpointConnections,
privateLinkConfigurations,
probes,
provisioningState,
redirectConfigurations,
requestRoutingRules,
resourceGuid,
rewriteRuleSets,
routingRules,
sku,
sslCertificates,
sslPolicy,
sslProfiles,
tags,
trustedClientCertificates,
trustedRootCertificates,
type,
urlPathMaps,
webApplicationFirewallConfiguration,
zones
FROM azure.network.application_gateways
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_ssl_predefined_policy

Gets Ssl predefined policy with the specified policy name.

SELECT
id,
name,
cipherSuites,
minProtocolVersion
FROM azure.network.application_gateways
WHERE predefined_policy_name = '{{ predefined_policy_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_all

Gets all the application gateways in a subscription.

SELECT
id,
name,
authenticationCertificates,
autoscaleConfiguration,
backendAddressPools,
backendHttpSettingsCollection,
backendSettingsCollection,
customErrorConfigurations,
defaultPredefinedSslPolicy,
enableFips,
enableHttp2,
entraJWTValidationConfigs,
etag,
firewallPolicy,
forceFirewallPolicyAssociation,
frontendIPConfigurations,
frontendPorts,
gatewayIPConfigurations,
globalConfiguration,
httpListeners,
identity,
listeners,
loadDistributionPolicies,
location,
operationalState,
privateEndpointConnections,
privateLinkConfigurations,
probes,
provisioningState,
redirectConfigurations,
requestRoutingRules,
resourceGuid,
rewriteRuleSets,
routingRules,
sku,
sslCertificates,
sslPolicy,
sslProfiles,
tags,
trustedClientCertificates,
trustedRootCertificates,
type,
urlPathMaps,
webApplicationFirewallConfiguration,
zones
FROM azure.network.application_gateways
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates the specified application gateway.

INSERT INTO azure.network.application_gateways (
id,
location,
tags,
properties,
zones,
identity,
resource_group_name,
application_gateway_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ zones }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ application_gateway_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
identity,
location,
properties,
tags,
type,
zones
;

Manifest

# Description fields are for documentation purposes
- name: application_gateways
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the application_gateways resource.
  - name: application_gateway_name
    value: "{{ application_gateway_name }}"
    description: Required parameter for the application_gateways resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the application_gateways resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: location
    value: "{{ location }}"
    description: |
      Resource location.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: properties
    description: |
      Properties of the application gateway.
    value:
      sku:
        name: "{{ name }}"
        tier: "{{ tier }}"
        capacity: {{ capacity }}
        family: "{{ family }}"
      sslPolicy:
        disabledSslProtocols:
          - "{{ disabledSslProtocols }}"
        policyType: "{{ policyType }}"
        policyName: "{{ policyName }}"
        cipherSuites:
          - "{{ cipherSuites }}"
        minProtocolVersion: "{{ minProtocolVersion }}"
      operationalState: "{{ operationalState }}"
      gatewayIPConfigurations:
        - id: "{{ id }}"
          properties:
            subnet:
              id: "{{ id }}"
            provisioningState: "{{ provisioningState }}"
          name: "{{ name }}"
          etag: "{{ etag }}"
          type: "{{ type }}"
      authenticationCertificates:
        - id: "{{ id }}"
          properties:
            data: "{{ data }}"
            provisioningState: "{{ provisioningState }}"
          name: "{{ name }}"
          etag: "{{ etag }}"
          type: "{{ type }}"
      trustedRootCertificates:
        - id: "{{ id }}"
          properties:
            data: "{{ data }}"
            keyVaultSecretId: "{{ keyVaultSecretId }}"
            provisioningState: "{{ provisioningState }}"
          name: "{{ name }}"
          etag: "{{ etag }}"
          type: "{{ type }}"
      trustedClientCertificates:
        - id: "{{ id }}"
          properties:
            data: "{{ data }}"
            validatedCertData: "{{ validatedCertData }}"
            clientCertIssuerDN: "{{ clientCertIssuerDN }}"
            provisioningState: "{{ provisioningState }}"
          name: "{{ name }}"
          etag: "{{ etag }}"
          type: "{{ type }}"
      sslCertificates:
        - id: "{{ id }}"
          properties:
            data: "{{ data }}"
            password: "{{ password }}"
            publicCertData: "{{ publicCertData }}"
            keyVaultSecretId: "{{ keyVaultSecretId }}"
            hsm:
              keyId: "{{ keyId }}"
              publicCertData: "{{ publicCertData }}"
            provisioningState: "{{ provisioningState }}"
          name: "{{ name }}"
          etag: "{{ etag }}"
          type: "{{ type }}"
      frontendIPConfigurations:
        - id: "{{ id }}"
          properties:
            privateIPAddress: "{{ privateIPAddress }}"
            privateIPAllocationMethod: "{{ privateIPAllocationMethod }}"
            subnet:
              id: "{{ id }}"
            publicIPAddress:
              id: "{{ id }}"
            privateLinkConfiguration:
              id: "{{ id }}"
            provisioningState: "{{ provisioningState }}"
          name: "{{ name }}"
          etag: "{{ etag }}"
          type: "{{ type }}"
      frontendPorts:
        - id: "{{ id }}"
          properties:
            port: {{ port }}
            provisioningState: "{{ provisioningState }}"
          name: "{{ name }}"
          etag: "{{ etag }}"
          type: "{{ type }}"
      probes:
        - id: "{{ id }}"
          properties:
            protocol: "{{ protocol }}"
            host: "{{ host }}"
            path: "{{ path }}"
            interval: {{ interval }}
            timeout: {{ timeout }}
            unhealthyThreshold: {{ unhealthyThreshold }}
            pickHostNameFromBackendHttpSettings: {{ pickHostNameFromBackendHttpSettings }}
            pickHostNameFromBackendSettings: {{ pickHostNameFromBackendSettings }}
            minServers: {{ minServers }}
            match:
              body: "{{ body }}"
              statusCodes:
                - "{{ statusCodes }}"
            enableProbeProxyProtocolHeader: {{ enableProbeProxyProtocolHeader }}
            provisioningState: "{{ provisioningState }}"
            port: {{ port }}
          name: "{{ name }}"
          etag: "{{ etag }}"
          type: "{{ type }}"
      backendAddressPools:
        - id: "{{ id }}"
          properties:
            backendIPConfigurations:
              - id: "{{ id }}"
                name: "{{ name }}"
                type: "{{ type }}"
                properties:
                  gatewayLoadBalancer: "{{ gatewayLoadBalancer }}"
                  virtualNetworkTaps: "{{ virtualNetworkTaps }}"
                  applicationGatewayBackendAddressPools: "{{ applicationGatewayBackendAddressPools }}"
                  loadBalancerBackendAddressPools: "{{ loadBalancerBackendAddressPools }}"
                  loadBalancerInboundNatRules: "{{ loadBalancerInboundNatRules }}"
                  privateIPAddress: "{{ privateIPAddress }}"
                  privateIPAddressPrefixLength: {{ privateIPAddressPrefixLength }}
                  privateIPAllocationMethod: "{{ privateIPAllocationMethod }}"
                  privateIPAddressVersion: "{{ privateIPAddressVersion }}"
                  subnet: "{{ subnet }}"
                  primary: {{ primary }}
                  publicIPAddress: "{{ publicIPAddress }}"
                  applicationSecurityGroups: "{{ applicationSecurityGroups }}"
                  provisioningState: "{{ provisioningState }}"
                  privateLinkConnectionProperties: "{{ privateLinkConnectionProperties }}"
                etag: "{{ etag }}"
            backendAddresses:
              - fqdn: "{{ fqdn }}"
                ipAddress: "{{ ipAddress }}"
            provisioningState: "{{ provisioningState }}"
          name: "{{ name }}"
          etag: "{{ etag }}"
          type: "{{ type }}"
      backendHttpSettingsCollection:
        - id: "{{ id }}"
          properties:
            port: {{ port }}
            protocol: "{{ protocol }}"
            cookieBasedAffinity: "{{ cookieBasedAffinity }}"
            requestTimeout: {{ requestTimeout }}
            probe:
              id: "{{ id }}"
            authenticationCertificates:
              - id: "{{ id }}"
            trustedRootCertificates:
              - id: "{{ id }}"
            connectionDraining:
              enabled: {{ enabled }}
              drainTimeoutInSec: {{ drainTimeoutInSec }}
            hostName: "{{ hostName }}"
            pickHostNameFromBackendAddress: {{ pickHostNameFromBackendAddress }}
            affinityCookieName: "{{ affinityCookieName }}"
            probeEnabled: {{ probeEnabled }}
            path: "{{ path }}"
            dedicatedBackendConnection: {{ dedicatedBackendConnection }}
            validateCertChainAndExpiry: {{ validateCertChainAndExpiry }}
            validateSNI: {{ validateSNI }}
            sniName: "{{ sniName }}"
            provisioningState: "{{ provisioningState }}"
          name: "{{ name }}"
          etag: "{{ etag }}"
          type: "{{ type }}"
      backendSettingsCollection:
        - id: "{{ id }}"
          properties:
            port: {{ port }}
            protocol: "{{ protocol }}"
            timeout: {{ timeout }}
            probe:
              id: "{{ id }}"
            trustedRootCertificates:
              - id: "{{ id }}"
            hostName: "{{ hostName }}"
            pickHostNameFromBackendAddress: {{ pickHostNameFromBackendAddress }}
            enableL4ClientIpPreservation: {{ enableL4ClientIpPreservation }}
            provisioningState: "{{ provisioningState }}"
          name: "{{ name }}"
          etag: "{{ etag }}"
          type: "{{ type }}"
      httpListeners:
        - id: "{{ id }}"
          properties:
            frontendIPConfiguration:
              id: "{{ id }}"
            frontendPort:
              id: "{{ id }}"
            protocol: "{{ protocol }}"
            hostName: "{{ hostName }}"
            sslCertificate:
              id: "{{ id }}"
            sslProfile:
              id: "{{ id }}"
            requireServerNameIndication: {{ requireServerNameIndication }}
            provisioningState: "{{ provisioningState }}"
            customErrorConfigurations:
              - statusCode: "{{ statusCode }}"
                customErrorPageUrl: "{{ customErrorPageUrl }}"
            firewallPolicy:
              id: "{{ id }}"
            hostNames:
              - "{{ hostNames }}"
          name: "{{ name }}"
          etag: "{{ etag }}"
          type: "{{ type }}"
      listeners:
        - id: "{{ id }}"
          properties:
            frontendIPConfiguration:
              id: "{{ id }}"
            frontendPort:
              id: "{{ id }}"
            protocol: "{{ protocol }}"
            sslCertificate:
              id: "{{ id }}"
            sslProfile:
              id: "{{ id }}"
            provisioningState: "{{ provisioningState }}"
            hostNames:
              - "{{ hostNames }}"
          name: "{{ name }}"
          etag: "{{ etag }}"
          type: "{{ type }}"
      sslProfiles:
        - id: "{{ id }}"
          properties:
            trustedClientCertificates:
              - id: "{{ id }}"
            sslPolicy:
              disabledSslProtocols:
                - "{{ disabledSslProtocols }}"
              policyType: "{{ policyType }}"
              policyName: "{{ policyName }}"
              cipherSuites:
                - "{{ cipherSuites }}"
              minProtocolVersion: "{{ minProtocolVersion }}"
            clientAuthConfiguration:
              verifyClientCertIssuerDN: {{ verifyClientCertIssuerDN }}
              verifyClientRevocation: "{{ verifyClientRevocation }}"
              verifyClientAuthMode: "{{ verifyClientAuthMode }}"
            provisioningState: "{{ provisioningState }}"
          name: "{{ name }}"
          etag: "{{ etag }}"
          type: "{{ type }}"
      urlPathMaps:
        - id: "{{ id }}"
          properties:
            defaultBackendAddressPool:
              id: "{{ id }}"
            defaultBackendHttpSettings:
              id: "{{ id }}"
            defaultRewriteRuleSet:
              id: "{{ id }}"
            defaultRedirectConfiguration:
              id: "{{ id }}"
            defaultLoadDistributionPolicy:
              id: "{{ id }}"
            pathRules:
              - id: "{{ id }}"
                properties:
                  paths: "{{ paths }}"
                  backendAddressPool: "{{ backendAddressPool }}"
                  backendHttpSettings: "{{ backendHttpSettings }}"
                  redirectConfiguration: "{{ redirectConfiguration }}"
                  rewriteRuleSet: "{{ rewriteRuleSet }}"
                  loadDistributionPolicy: "{{ loadDistributionPolicy }}"
                  provisioningState: "{{ provisioningState }}"
                  firewallPolicy: "{{ firewallPolicy }}"
                name: "{{ name }}"
                etag: "{{ etag }}"
                type: "{{ type }}"
            provisioningState: "{{ provisioningState }}"
          name: "{{ name }}"
          etag: "{{ etag }}"
          type: "{{ type }}"
      requestRoutingRules:
        - id: "{{ id }}"
          properties:
            ruleType: "{{ ruleType }}"
            priority: {{ priority }}
            backendAddressPool:
              id: "{{ id }}"
            backendHttpSettings:
              id: "{{ id }}"
            httpListener:
              id: "{{ id }}"
            urlPathMap:
              id: "{{ id }}"
            rewriteRuleSet:
              id: "{{ id }}"
            redirectConfiguration:
              id: "{{ id }}"
            loadDistributionPolicy:
              id: "{{ id }}"
            entraJWTValidationConfig:
              id: "{{ id }}"
            provisioningState: "{{ provisioningState }}"
          name: "{{ name }}"
          etag: "{{ etag }}"
          type: "{{ type }}"
      routingRules:
        - id: "{{ id }}"
          properties:
            ruleType: "{{ ruleType }}"
            priority: {{ priority }}
            backendAddressPool:
              id: "{{ id }}"
            backendSettings:
              id: "{{ id }}"
            listener:
              id: "{{ id }}"
            provisioningState: "{{ provisioningState }}"
          name: "{{ name }}"
          etag: "{{ etag }}"
          type: "{{ type }}"
      rewriteRuleSets:
        - id: "{{ id }}"
          properties:
            rewriteRules:
              - name: "{{ name }}"
                ruleSequence: {{ ruleSequence }}
                conditions: "{{ conditions }}"
                actionSet:
                  requestHeaderConfigurations: "{{ requestHeaderConfigurations }}"
                  responseHeaderConfigurations: "{{ responseHeaderConfigurations }}"
                  urlConfiguration: "{{ urlConfiguration }}"
            provisioningState: "{{ provisioningState }}"
          name: "{{ name }}"
          etag: "{{ etag }}"
      redirectConfigurations:
        - id: "{{ id }}"
          properties:
            redirectType: "{{ redirectType }}"
            targetListener:
              id: "{{ id }}"
            targetUrl: "{{ targetUrl }}"
            includePath: {{ includePath }}
            includeQueryString: {{ includeQueryString }}
            requestRoutingRules:
              - id: "{{ id }}"
            urlPathMaps:
              - id: "{{ id }}"
            pathRules:
              - id: "{{ id }}"
          name: "{{ name }}"
          etag: "{{ etag }}"
          type: "{{ type }}"
      webApplicationFirewallConfiguration:
        enabled: {{ enabled }}
        firewallMode: "{{ firewallMode }}"
        ruleSetType: "{{ ruleSetType }}"
        ruleSetVersion: "{{ ruleSetVersion }}"
        disabledRuleGroups:
          - ruleGroupName: "{{ ruleGroupName }}"
            rules: "{{ rules }}"
        requestBodyCheck: {{ requestBodyCheck }}
        maxRequestBodySize: {{ maxRequestBodySize }}
        maxRequestBodySizeInKb: {{ maxRequestBodySizeInKb }}
        fileUploadLimitInMb: {{ fileUploadLimitInMb }}
        exclusions:
          - matchVariable: "{{ matchVariable }}"
            selectorMatchOperator: "{{ selectorMatchOperator }}"
            selector: "{{ selector }}"
      firewallPolicy:
        id: "{{ id }}"
      enableHttp2: {{ enableHttp2 }}
      enableFips: {{ enableFips }}
      autoscaleConfiguration:
        minCapacity: {{ minCapacity }}
        maxCapacity: {{ maxCapacity }}
      privateLinkConfigurations:
        - id: "{{ id }}"
          properties:
            ipConfigurations:
              - id: "{{ id }}"
                properties:
                  privateIPAddress: "{{ privateIPAddress }}"
                  privateIPAllocationMethod: "{{ privateIPAllocationMethod }}"
                  subnet: "{{ subnet }}"
                  primary: {{ primary }}
                  provisioningState: "{{ provisioningState }}"
                name: "{{ name }}"
                etag: "{{ etag }}"
                type: "{{ type }}"
            provisioningState: "{{ provisioningState }}"
          name: "{{ name }}"
          etag: "{{ etag }}"
          type: "{{ type }}"
      privateEndpointConnections:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          properties:
            privateEndpoint:
              id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              location: "{{ location }}"
              tags: "{{ tags }}"
              properties:
                subnet: "{{ subnet }}"
                networkInterfaces: "{{ networkInterfaces }}"
                provisioningState: "{{ provisioningState }}"
                ipVersionType: "{{ ipVersionType }}"
                privateLinkServiceConnections: "{{ privateLinkServiceConnections }}"
                manualPrivateLinkServiceConnections: "{{ manualPrivateLinkServiceConnections }}"
                customDnsConfigs: "{{ customDnsConfigs }}"
                applicationSecurityGroups: "{{ applicationSecurityGroups }}"
                ipConfigurations: "{{ ipConfigurations }}"
                customNetworkInterfaceName: "{{ customNetworkInterfaceName }}"
                billingSku: "{{ billingSku }}"
              extendedLocation:
                name: "{{ name }}"
                type: "{{ type }}"
              etag: "{{ etag }}"
            privateLinkServiceConnectionState:
              status: "{{ status }}"
              description: "{{ description }}"
              actionsRequired: "{{ actionsRequired }}"
            provisioningState: "{{ provisioningState }}"
            linkIdentifier: "{{ linkIdentifier }}"
          etag: "{{ etag }}"
      resourceGuid: "{{ resourceGuid }}"
      provisioningState: "{{ provisioningState }}"
      customErrorConfigurations:
        - statusCode: "{{ statusCode }}"
          customErrorPageUrl: "{{ customErrorPageUrl }}"
      forceFirewallPolicyAssociation: {{ forceFirewallPolicyAssociation }}
      loadDistributionPolicies:
        - id: "{{ id }}"
          properties:
            loadDistributionTargets:
              - id: "{{ id }}"
                properties:
                  weightPerServer: {{ weightPerServer }}
                  backendAddressPool: "{{ backendAddressPool }}"
                name: "{{ name }}"
                etag: "{{ etag }}"
                type: "{{ type }}"
            loadDistributionAlgorithm: "{{ loadDistributionAlgorithm }}"
            provisioningState: "{{ provisioningState }}"
          name: "{{ name }}"
          etag: "{{ etag }}"
          type: "{{ type }}"
      entraJWTValidationConfigs:
        - id: "{{ id }}"
          properties:
            unAuthorizedRequestAction: "{{ unAuthorizedRequestAction }}"
            tenantId: "{{ tenantId }}"
            clientId: "{{ clientId }}"
            audiences:
              - "{{ audiences }}"
            provisioningState: "{{ provisioningState }}"
          name: "{{ name }}"
          etag: "{{ etag }}"
      globalConfiguration:
        enableRequestBuffering: {{ enableRequestBuffering }}
        enableResponseBuffering: {{ enableResponseBuffering }}
      defaultPredefinedSslPolicy: "{{ defaultPredefinedSslPolicy }}"
  - name: zones
    value:
      - "{{ zones }}"
    description: |
      A list of availability zones denoting where the resource needs to come from.
  - name: identity
    description: |
      The identity of the application gateway, if configured.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update_tags

Updates the specified application gateway tags.

UPDATE azure.network.application_gateways
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND application_gateway_name = '{{ application_gateway_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
identity,
location,
properties,
tags,
type,
zones;

REPLACE examples

create_or_update

Creates or updates the specified application gateway.

REPLACE azure.network.application_gateways
SET 
id = '{{ id }}',
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}',
zones = '{{ zones }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND application_gateway_name = '{{ application_gateway_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
identity,
location,
properties,
tags,
type,
zones;

DELETE examples

delete

Deletes the specified application gateway.

DELETE FROM azure.network.application_gateways
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND application_gateway_name = '{{ application_gateway_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_available_ssl_options

Lists available Ssl options for configuring Ssl policy.

EXEC azure.network.application_gateways.list_available_ssl_options 
@subscription_id='{{ subscription_id }}' --required
;

list_available_ssl_predefined_policies

Lists all SSL predefined policies for configuring Ssl policy.

EXEC azure.network.application_gateways.list_available_ssl_predefined_policies 
@subscription_id='{{ subscription_id }}' --required
;

list_available_server_variables

Lists all available server variables.

EXEC azure.network.application_gateways.list_available_server_variables 
@subscription_id='{{ subscription_id }}' --required
;

list_available_request_headers

Lists all available request headers.

EXEC azure.network.application_gateways.list_available_request_headers 
@subscription_id='{{ subscription_id }}' --required
;

list_available_response_headers

Lists all available response headers.

EXEC azure.network.application_gateways.list_available_response_headers 
@subscription_id='{{ subscription_id }}' --required
;

list_available_waf_rule_sets

Lists all available web application firewall rule sets.

EXEC azure.network.application_gateways.list_available_waf_rule_sets 
@subscription_id='{{ subscription_id }}' --required
;

start

Starts the specified application gateway.

EXEC azure.network.application_gateways.start 
@resource_group_name='{{ resource_group_name }}' --required, 
@application_gateway_name='{{ application_gateway_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

stop

Stops the specified application gateway in a resource group.

EXEC azure.network.application_gateways.stop 
@resource_group_name='{{ resource_group_name }}' --required, 
@application_gateway_name='{{ application_gateway_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

backend_health

Gets the backend health of the specified application gateway in a resource group.

EXEC azure.network.application_gateways.backend_health 
@resource_group_name='{{ resource_group_name }}' --required, 
@application_gateway_name='{{ application_gateway_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@$expand='{{ $expand }}'
;

backend_health_on_demand

Gets the backend health for given combination of backend pool and http setting of the specified application gateway in a resource group.

EXEC azure.network.application_gateways.backend_health_on_demand 
@resource_group_name='{{ resource_group_name }}' --required, 
@application_gateway_name='{{ application_gateway_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@$expand='{{ $expand }}' 
@@json=
'{
"protocol": "{{ protocol }}", 
"host": "{{ host }}", 
"path": "{{ path }}", 
"timeout": {{ timeout }}, 
"pickHostNameFromBackendHttpSettings": {{ pickHostNameFromBackendHttpSettings }}, 
"enableProbeProxyProtocolHeader": {{ enableProbeProxyProtocolHeader }}, 
"match": "{{ match }}", 
"backendAddressPool": "{{ backendAddressPool }}", 
"backendHttpSettings": "{{ backendHttpSettings }}"
}'
;