Application Gateways - List

Service:
Application Gateway
API Version:
2017-09-01

Lists all application gateways in a resource group.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways?api-version={api-version}

URI Parameters

Name In Required Type Description
subscriptionId
 path True
  • string

The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
resourceGroupName
 path True
  • string

The name of the resource group.
api-version
 query True
  • string

Client API version.

Responses

Name Type Description
200 OK

Success. The operation returns a list of ApplicationGateway resources.

Definitions

ApplicationGateway

Application gateway resource
ApplicationGatewayAuthenticationCertificate

Authentication certificates of an application gateway.
ApplicationGatewayBackendAddress

Backend address of an application gateway.
ApplicationGatewayBackendAddressPool

Backend Address Pool of an application gateway.
ApplicationGatewayBackendHttpSettings

Backend address pool settings of an application gateway.
ApplicationGatewayConnectionDraining

Connection draining of the backend http settings resource.
ApplicationGatewayFirewallDisabledRuleGroup

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

Frontend IP configuration of an application gateway.
ApplicationGatewayFrontendPort

Frontend port of an application gateway.
ApplicationGatewayHttpListener

Http listener of an application gateway.
ApplicationGatewayIPConfiguration

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

Path rule of URL path map of an application gateway.
ApplicationGatewayProbe

Probe of the application gateway.
ApplicationGatewayProbeHealthResponseMatch

Criterion for classifying a healthy probe response.
ApplicationGatewayRedirectConfiguration

Redirect configuration of an application gateway.
ApplicationGatewayRequestRoutingRule

Request routing rule of an application gateway.
ApplicationGatewaySku

SKU of the application gateway resource.
ApplicationGatewaySslCertificate

SSL certificates of an application gateway.
ApplicationGatewaySslPolicy

SSL policy of the application gateway resource.
ApplicationGatewayUrlPathMap

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

Web application firewall configuration.
SubResource

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

Application gateway resource

Name Type Description
authenticationCertificates

Authentication certificates of the application gateway resource.
backendAddressPools

Backend address pool of the application gateway resource.
backendHttpSettingsCollection

Backend http settings of the application gateway resource.
etag
  • string

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

Frontend IP addresses of the application gateway resource.
frontendPorts

Frontend ports of the application gateway resource.
gatewayIPConfigurations

Subnets of application the gateway resource.
httpListeners

Http listeners of the application gateway resource.
id
  • string

Resource ID.
location
  • string

Resource location.
name
  • string

Resource name.
operationalState
  • enum:
    • Stopped
    • Starting
    • Running
    • Stopping

Operational state of the application gateway resource.
probes

Probes of the application gateway resource.
provisioningState
  • string

Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
redirectConfigurations

Redirect configurations of the application gateway resource.
requestRoutingRules

Request routing rules of the application gateway resource.
resourceGuid
  • string

Resource GUID property of the application gateway resource.
sku

SKU of the application gateway resource.
sslCertificates

SSL certificates of the application gateway resource.
sslPolicy

SSL policy of the application gateway resource.
tags
  • <string, string>

Resource tags.
type
  • string

Resource type.
urlPathMaps

URL path map of the application gateway resource.
webApplicationFirewallConfiguration

Web application firewall configuration.

Authentication certificates of an application gateway.

Name Type Description
data
  • string

Certificate public data.
etag
  • string

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

Resource ID
name
  • string

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

Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
type
  • string

Type of the resource.

Backend address of an application gateway.

Name Type Description
fqdn
  • string

Fully qualified domain name (FQDN).
ipAddress
  • string

IP address

Backend Address Pool of an application gateway.

Name Type Description
backendAddresses

Backend addresses
backendIPConfigurations

Collection of references to IPs defined in network interfaces.
etag
  • string

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

Resource ID
name
  • string

Resource that is unique within a resource group. This name can be used to access the resource.
provisioningState
  • string

Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
type
  • string

Type of the resource.

Backend address pool settings of an application gateway.

Name Type Description
affinityCookieName
  • string

Cookie name to use for the affinity cookie.
authenticationCertificates

Array of references to application gateway authentication certificates.
connectionDraining

Connection draining of the backend http settings resource.
cookieBasedAffinity
  • enum:
    • Enabled
    • Disabled

Cookie based affinity.
etag
  • string

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

Host header to be sent to the backend servers.
id
  • string

Resource ID
name
  • string

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

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

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

Port
probe

Probe resource of an application gateway.
probeEnabled
  • boolean

Whether the probe is enabled. Default value is false.
protocol
  • enum:
    • Http
    • Https

Protocol.
provisioningState
  • string

Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
requestTimeout
  • integer
    int32

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.
type
  • string

Type of the resource.

Connection draining of the backend http settings resource.

Name Type Description
drainTimeoutInSec
  • integer
    int32

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

Whether connection draining is enabled or not.

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

Name Type Description
ruleGroupName
  • string

The name of the rule group that will be disabled.
rules
  • integer[]

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

Frontend IP configuration of an application gateway.

Name Type Description
etag
  • string

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

Resource ID
name
  • string

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

PrivateIPAddress of the network interface IP Configuration.
privateIPAllocationMethod
  • enum:
    • Static
    • Dynamic

PrivateIP allocation method.
provisioningState
  • string

Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
publicIPAddress

Reference of the PublicIP resource.
subnet

Reference of the subnet resource.
type
  • string

Type of the resource.

Frontend port of an application gateway.

Name Type Description
etag
  • string

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

Resource ID
name
  • string

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

Frontend port
provisioningState
  • string

Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
type
  • string

Type of the resource.

Http listener of an application gateway.

Name Type Description
etag
  • string

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

Frontend IP configuration resource of an application gateway.
frontendPort

Frontend port resource of an application gateway.
hostName
  • string

Host name of HTTP listener.
id
  • string

Resource ID
name
  • string

Name of the resource that is unique within a resource group. This name can be used to access the resource.
protocol
  • enum:
    • Http
    • Https

Protocol.
provisioningState
  • string

Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
requireServerNameIndication
  • boolean

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

SSL certificate resource of an application gateway.
type
  • string

Type of the resource.

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

Name Type Description
etag
  • string

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

Resource ID
name
  • string

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

Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
subnet

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

Type of the resource.
Name Type Description
nextLink
  • string

URL to get the next set of results.
value

List of an application gateways in a resource group.

Path rule of URL path map of an application gateway.

Name Type Description
backendAddressPool

Backend address pool resource of URL path map path rule.
backendHttpSettings

Backend http settings resource of URL path map path rule.
etag
  • string

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

Resource ID
name
  • string

Name of the resource that is unique within a resource group. This name can be used to access the resource.
paths
  • string[]

Path rules of URL path map.
provisioningState
  • string

Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
redirectConfiguration

Redirect configuration resource of URL path map path rule.
type
  • string

Type of the resource.

Probe of the application gateway.

Name Type Description
etag
  • string

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

Host name to send the probe to.
id
  • string

Resource ID
interval
  • integer
    int32

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

Criterion for classifying a healthy probe response.
minServers
  • integer
    int32

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

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

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

Whether the host header should be picked from the backend http settings. Default value is false.
protocol
  • enum:
    • Http
    • Https

Protocol.
provisioningState
  • string

Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
timeout
  • integer
    int32

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.
type
  • string

Type of the resource.
unhealthyThreshold
  • integer
    int32

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

Criterion for classifying a healthy probe response.

Name Type Description
body
  • string

Body that must be contained in the health response. Default value is empty.
statusCodes
  • string[]

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

Redirect configuration of an application gateway.

Name Type Description
etag
  • string

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

Resource ID
includePath
  • boolean

Include path in the redirected url.
includeQueryString
  • boolean

Include query string in the redirected url.
name
  • string

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

Path rules specifying redirect configuration.
redirectType
  • enum:
    • Permanent
    • Found
    • SeeOther
    • Temporary

Supported http redirection types - Permanent, Temporary, Found, SeeOther.
requestRoutingRules

Request routing specifying redirect configuration.
targetListener

Reference to a listener to redirect the request to.
targetUrl
  • string

Url to redirect the request to.
type
  • string

Type of the resource.
urlPathMaps

Url path maps specifying default redirect configuration.

Request routing rule of an application gateway.

Name Type Description
backendAddressPool

Backend address pool resource of the application gateway.

backendHttpSettings

Frontend port resource of the application gateway.
etag
  • string

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

Http listener resource of the application gateway.

id
  • string

Resource ID
name
  • string

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

Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
redirectConfiguration

Redirect configuration resource of the application gateway.
ruleType
  • enum:
    • Basic
    • PathBasedRouting

Rule type.
type
  • string

Type of the resource.
urlPathMap

URL path map resource of the application gateway.

SKU of the application gateway resource.

Name Type Description
capacity
  • integer
    int32

Capacity (instance count) of an application gateway.
name
  • enum:
    • Standard_Small
    • Standard_Medium
    • Standard_Large
    • WAF_Medium
    • WAF_Large

Name of an application gateway SKU.
tier
  • enum:
    • Standard
    • WAF

Tier of an application gateway.

SSL certificates of an application gateway.

Name Type Description
data
  • string

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

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

Resource ID
name
  • string

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

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

Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'.
publicCertData
  • string

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

Type of the resource.

SSL policy of the application gateway resource.

Name Type Description
cipherSuites
  • string[]

Ssl cipher suites to be enabled in the specified order to application gateway.
disabledSslProtocols
  • string[]

Ssl protocols to be disabled on application gateway.
minProtocolVersion
  • enum:
    • TLSv1_0
    • TLSv1_1
    • TLSv1_2

Minimum version of Ssl protocol to be supported on application gateway.
policyName
  • enum:
    • AppGwSslPolicy20150501
    • AppGwSslPolicy20170401
    • AppGwSslPolicy20170401S

Name of Ssl predefined policy
policyType
  • enum:
    • Predefined
    • Custom

Type of Ssl Policy

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

Name Type Description
defaultBackendAddressPool

Default backend address pool resource of URL path map.
defaultBackendHttpSettings

Default backend http settings resource of URL path map.
defaultRedirectConfiguration

Default redirect configuration resource of URL path map.
etag
  • string

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

Resource ID
name
  • string

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

Path rule of URL path map resource.
provisioningState
  • string

Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
type
  • string

Type of the resource.

Web application firewall configuration.

Name Type Description
disabledRuleGroups

The disabled rule groups.
enabled
  • boolean

Whether the web application firewall is enabled or not.
firewallMode
  • enum:
    • Detection
    • Prevention

Web application firewall mode.
ruleSetType
  • string

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

The version of the rule set type.

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

Name Type Description
id
  • string

Resource ID.