ApplicationGatewayBackendHealthOnDemand

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-application-gateway/json-schema/microsoft-azure-application-gateway-application-gateway-backend-health-on-demand-schema.json",
  "title": "ApplicationGatewayBackendHealthOnDemand",
  "description": "Result of on demand test probe.",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/microsoft-azure-application-gateway-application-gateways-api-openapi.yml#/components/schemas/ApplicationGatewayBackendHealthOnDemand",
  "type": "object",
  "properties": {
    "backendAddressPool": {
      "$ref": "#/$defs/ApplicationGatewayBackendAddressPool",
      "description": "Reference to an ApplicationGatewayBackendAddressPool resource."
    },
    "backendHealthHttpSettings": {
      "$ref": "#/$defs/ApplicationGatewayBackendHealthHttpSettings",
      "description": "Application gateway BackendHealthHttp settings."
    }
  },
  "$defs": {
    "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": "#/$defs/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": "#/$defs/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": "#/$defs/NetworkInterfaceIPConfiguration"
          },
          "readOnly": true
        },
        "backendAddresses": {
          "type": "array",
          "description": "Backend addresses.",
          "items": {
            "$ref": "#/$defs/ApplicationGatewayBackendAddress"
          }
        },
        "provisioningState": {
          "$ref": "#/$defs/ProvisioningState",
          "description": "The provisioning state of the backend address pool resource.",
          "readOnly": true
        }
      }
    },
    "ApplicationGatewayBackendHealthHttpSettings": {
      "type": "object",
      "description": "Application gateway BackendHealthHttp settings.",
      "properties": {
        "backendHttpSettings": {
          "$ref": "#/$defs/ApplicationGatewayBackendHttpSettings",
          "description": "Reference to an ApplicationGatewayBackendHttpSettings resource."
        },
        "servers": {
          "type": "array",
          "description": "List of ApplicationGatewayBackendHealthServer resources.",
          "items": {
            "$ref": "#/$defs/ApplicationGatewayBackendHealthServer"
          }
        }
      }
    },
    "ApplicationGatewayBackendHealthServer": {
      "type": "object",
      "description": "Application gateway backendhealth http settings.",
      "properties": {
        "address": {
          "type": "string",
          "description": "IP address or FQDN of backend server."
        },
        "ipConfiguration": {
          "$ref": "#/$defs/NetworkInterfaceIPConfiguration",
          "description": "Reference to IP configuration of backend server."
        },
        "health": {
          "$ref": "#/$defs/ApplicationGatewayBackendHealthServerHealth",
          "description": "Health of backend server."
        },
        "healthProbeLog": {
          "type": "string",
          "description": "Health Probe Log."
        }
      }
    },
    "ApplicationGatewayBackendHealthServerHealth": {
      "type": "string",
      "description": "Health of backend server.",
      "enum": [
        "Unknown",
        "Up",
        "Down",
        "Partial",
        "Draining"
      ],
      "x-ms-enum": {
        "name": "ApplicationGatewayBackendHealthServerHealth",
        "modelAsString": true,
        "values": [
          {
            "name": "Unknown",
            "value": "Unknown",
            "description": "Unknown"
          },
          {
            "name": "Up",
            "value": "Up",
            "description": "Up"
          },
          {
            "name": "Down",
            "value": "Down",
            "description": "Down"
          },
          {
            "name": "Partial",
            "value": "Partial",
            "description": "Partial"
          },
          {
            "name": "Draining",
            "value": "Draining",
            "description": "Draining"
          }
        ]
      }
    },
    "ApplicationGatewayBackendHttpSettings": {
      "type": "object",
      "description": "Backend address pool settings of an application gateway.",
      "properties": {
        "properties": {
          "$ref": "#/$defs/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": "#/$defs/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": "#/$defs/ApplicationGatewayProtocol",
          "description": "The protocol used to communicate with the backend."
        },
        "cookieBasedAffinity": {
          "$ref": "#/$defs/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": "#/$defs/SubResource",
          "description": "Probe resource of an application gateway."
        },
        "authenticationCertificates": {
          "type": "array",
          "description": "Array of references to application gateway authentication certificates.",
          "items": {
            "$ref": "#/$defs/SubResource"
          }
        },
        "trustedRootCertificates": {
          "type": "array",
          "description": "Array of references to application gateway trusted root certificates.",
          "items": {
            "$ref": "#/$defs/SubResource"
          }
        },
        "connectionDraining": {
          "$ref": "#/$defs/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": "#/$defs/ProvisioningState",
          "description": "The provisioning state of the backend HTTP settings resource.",
          "readOnly": true
        }
      }
    },
    "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"
      ]
    },
    "ApplicationGatewayCookieBasedAffinity": {
      "type": "string",
      "description": "Cookie based affinity.",
      "enum": [
        "Enabled",
        "Disabled"
      ],
      "x-ms-enum": {
        "name": "ApplicationGatewayCookieBasedAffinity",
        "modelAsString": true,
        "values": [
          {
            "name": "Enabled",
            "value": "Enabled",
            "description": "Enabled"
          },
          {
            "name": "Disabled",
            "value": "Disabled",
            "description": "Disabled"
          }
        ]
      }
    },
    "ApplicationGatewayProtocol": {
      "type": "string",
      "description": "Application Gateway protocol.",
      "enum": [
        "Http",
        "Https",
        "Tcp",
        "Tls"
      ],
      "x-ms-enum": {
        "name": "ApplicationGatewayProtocol",
        "modelAsString": true,
        "values": [
          {
            "name": "Http",
            "value": "Http",
            "description": "Supported for httpListeners and  backendHttpSettingsCollection properties."
          },
          {
            "name": "Https",
            "value": "Https",
            "description": "Supported for httpListeners and  backendHttpSettingsCollection properties."
          },
          {
            "name": "Tcp",
            "value": "Tcp",
            "description": "Supported for listeners and backendSettingsCollection properties."
          },
          {
            "name": "Tls",
            "value": "Tls",
            "description": "Supported for listeners and backendSettingsCollection properties."
          }
        ]
      }
    },
    "NetworkInterfaceIPConfiguration": {
      "type": "object",
      "description": "IPConfiguration in a network interface.",
      "properties": {
        "properties": {
          "$ref": "#/$defs/NetworkInterfaceIPConfigurationPropertiesFormat",
          "description": "Network interface IP configuration properties.",
          "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": "#/$defs/SubResourceModel"
        }
      ]
    },
    "ProvisioningState": {
      "type": "string",
      "description": "Provisioning states of a resource.",
      "enum": [
        "Failed",
        "Succeeded",
        "Canceled",
        "Creating",
        "Updating",
        "Deleting"
      ],
      "x-ms-enum": {
        "name": "ProvisioningState",
        "modelAsString": true,
        "values": [
          {
            "name": "Failed",
            "value": "Failed",
            "description": "Failed"
          },
          {
            "name": "Succeeded",
            "value": "Succeeded",
            "description": "Succeeded"
          },
          {
            "name": "Canceled",
            "value": "Canceled",
            "description": "Canceled"
          },
          {
            "name": "Creating",
            "value": "Creating",
            "description": "Creating"
          },
          {
            "name": "Updating",
            "value": "Updating",
            "description": "Updating"
          },
          {
            "name": "Deleting",
            "value": "Deleting",
            "description": "Deleting"
          }
        ]
      }
    },
    "SubResource": {
      "type": "object",
      "description": "Reference to another subresource.",
      "properties": {
        "id": {
          "type": "string",
          "description": "Resource ID."
        }
      }
    },
    "SubResourceModel": {
      "type": "object",
      "description": "Reference to another subresource.",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of the resource."
        },
        "type": {
          "type": "string",
          "description": "Resource type.",
          "readOnly": true
        }
      },
      "allOf": [
        {
          "$ref": "#/$defs/SubResource"
        }
      ],
      "x-ms-azure-resource": true
    }
  }
}