ApplicationFetchHealthRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-service-fabric/json-schema/microsoft-azure-service-fabric-application-fetch-health-request-schema.json",
  "title": "ApplicationFetchHealthRequest",
  "description": "Parameters for fetching the health of an application.",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/microsoft-azure-service-fabric-managed-clusters-api-openapi.yml#/components/schemas/ApplicationFetchHealthRequest",
  "type": "object",
  "properties": {
    "eventsHealthStateFilter": {
      "$ref": "#/$defs/HealthFilter"
    },
    "deployedApplicationsHealthStateFilter": {
      "$ref": "#/$defs/HealthFilter"
    },
    "servicesHealthStateFilter": {
      "$ref": "#/$defs/HealthFilter"
    },
    "excludeHealthStatistics": {
      "type": "boolean",
      "description": "Indicates whether the health statistics should be returned as part of the query result. False by default. The statistics show the number of children entities in health state Ok, Warning, and Error.",
      "default": false
    },
    "timeout": {
      "type": "integer",
      "format": "int64",
      "description": "Request timeout for the health query in seconds. The default value is 60 seconds.",
      "default": 60
    }
  },
  "$defs": {
    "HealthFilter": {
      "type": "string",
      "description": "Enum for filtering health events.",
      "enum": [
        "Default",
        "None",
        "Ok",
        "Warning",
        "Error",
        "All"
      ],
      "x-ms-enum": {
        "name": "HealthFilter",
        "modelAsString": true,
        "values": [
          {
            "name": "Default",
            "value": "Default",
            "description": "Default value. Matches any health state."
          },
          {
            "name": "None",
            "value": "None",
            "description": "Filter that doesn't match any health state. Used to return no results on a given collection of health entities."
          },
          {
            "name": "Ok",
            "value": "Ok",
            "description": "Filter for health state Ok."
          },
          {
            "name": "Warning",
            "value": "Warning",
            "description": "Filter for health state Warning."
          },
          {
            "name": "Error",
            "value": "Error",
            "description": "Filter for health state Error."
          },
          {
            "name": "All",
            "value": "All",
            "description": "Filter that matches input with any health state."
          }
        ]
      }
    }
  }
}