Application Gateways - Backend Health

Service:: Application Gateway

API Version:: 2017-09-01

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

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendhealth?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.
applicationGatewayName	path	True	string	The name of the application gateway.
api-version	query	True	string	Client API version.

Responses

Name	Type	Description
200 OK	ApplicationGatewayBackendHealth	Request successful.
202 Accepted		Accepted and the operation will complete asynchronously.

Definitions

ApplicationGatewayBackendAddress	Backend address of an application gateway.
ApplicationGatewayBackendAddressPool	Reference of an ApplicationGatewayBackendAddressPool resource.
ApplicationGatewayBackendHealth
ApplicationGatewayBackendHealthHttpSettings	Application gateway BackendHealthHttp settings.
ApplicationGatewayBackendHealthPool	Application gateway BackendHealth pool.
ApplicationGatewayBackendHealthServer	Application gateway backendhealth http settings.
ApplicationGatewayBackendHttpSettings	Reference of an ApplicationGatewayBackendHttpSettings resource.
ApplicationGatewayConnectionDraining	Connection draining of the backend http settings resource.
SubResource	Reference to another subresource.

ApplicationGatewayBackendAddress

Backend address of an application gateway.

Name	Type	Description
fqdn	string	Fully qualified domain name (FQDN).
ipAddress	string	IP address

ApplicationGatewayBackendAddressPool

Reference of an ApplicationGatewayBackendAddressPool resource.

Name	Type	Description
backendAddresses	ApplicationGatewayBackendAddress[]	Backend addresses
backendIPConfigurations	SubResource[]	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.

ApplicationGatewayBackendHealth

Name	Type	Description
backendAddressPools	ApplicationGatewayBackendHealthPool[]	Application gateway BackendHealth pool.

ApplicationGatewayBackendHealthHttpSettings

Application gateway BackendHealthHttp settings.

Name	Type	Description
backendHttpSettings	ApplicationGatewayBackendHttpSettings	Reference of an ApplicationGatewayBackendHttpSettings resource.
servers	ApplicationGatewayBackendHealthServer[]	List of ApplicationGatewayBackendHealthServer resources.

ApplicationGatewayBackendHealthPool

Application gateway BackendHealth pool.

Name	Type	Description
backendAddressPool	ApplicationGatewayBackendAddressPool	Reference of an ApplicationGatewayBackendAddressPool resource.
backendHttpSettingsCollection	ApplicationGatewayBackendHealthHttpSettings[]	List of ApplicationGatewayBackendHealthHttpSettings resources.

ApplicationGatewayBackendHealthServer

Application gateway backendhealth http settings.

Name	Type	Description
address	string	IP address or FQDN of backend server.
health	enum: Unknown Up Down Partial Draining	Health of backend server.
ipConfiguration	SubResource	Reference of IP configuration of backend server.

ApplicationGatewayBackendHttpSettings

Reference of an ApplicationGatewayBackendHttpSettings resource.

Name	Type	Description
affinityCookieName	string	Cookie name to use for the affinity cookie.
authenticationCertificates	SubResource[]	Array of references to application gateway authentication certificates.
connectionDraining	ApplicationGatewayConnectionDraining	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	SubResource	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.

ApplicationGatewayConnectionDraining

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.

SubResource

Reference to another subresource.

Name	Type	Description
id	string	Resource ID.