ApplicationGatewayOnDemandProbe

{
  "$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-on-demand-probe-schema.json",
  "title": "ApplicationGatewayOnDemandProbe",
  "description": "Details of on demand test probe request.",
  "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/ApplicationGatewayOnDemandProbe",
  "type": "object",
  "properties": {
    "protocol": {
      "$ref": "#/$defs/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 <Protocol>://<host>:<port><path>."
    },
    "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": "#/$defs/ApplicationGatewayProbeHealthResponseMatch",
      "description": "Criterion for classifying a healthy probe response."
    },
    "backendAddressPool": {
      "$ref": "#/$defs/SubResource",
      "description": "Reference to backend pool of application gateway to which probe request will be sent."
    },
    "backendHttpSettings": {
      "$ref": "#/$defs/SubResource",
      "description": "Reference to backend http setting of application gateway to be used for test probe."
    }
  },
  "$defs": {
    "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"
          }
        }
      }
    },
    "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."
          }
        ]
      }
    },
    "SubResource": {
      "type": "object",
      "description": "Reference to another subresource.",
      "properties": {
        "id": {
          "type": "string",
          "description": "Resource ID."
        }
      }
    }
  }
}