swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Cluster API
schemes:
- https
tags:
- name: Cluster
paths:
  /$/GetClusterManifest:
    get:
      operationId: microsoftAzureGetclustermanifest
      summary: Microsoft Azure Get The Service Fabric Cluster Manifest
      description: Get the Service Fabric cluster manifest. The cluster manifest contains properties of the cluster that include different node types on the cluster,<br>security configurations, fault, and upgrade domain topologies, etc.<br><br>These properties are specified as part of the ClusterConfig.JSON file while deploying a stand-alone cluster. However, most of the information in the cluster manifest<br>is generated internally by service fabric during cluster deployment in other deployment scenarios (e.g. when using Azure portal).<br><br>The contents of the cluster manifest are for informational purposes only and users are not expected to take a dependency on the format of the file contents or its interpretation.
      tags:
      - Cluster
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 200 status code and the requested cluster manifest information.
          schema:
            $ref: '#/definitions/ClusterManifest'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /$/GetClusterHealth:
    get:
      operationId: microsoftAzureGetclusterhealth
      summary: Microsoft Azure Gets The Health Of A Service Fabric Cluster
      description: Use EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state.<br>Similarly, use NodesHealthStateFilter and ApplicationsHealthStateFilter to filter the collection of nodes and applications returned based on their aggregated health state.
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/NodesHealthStateFilterOptionalQueryParam'
      - $ref: '#/parameters/ApplicationsHealthStateFilterOptionalQueryParam'
      - $ref: '#/parameters/EventsHealthStateFilterOptionalQueryParam'
      - $ref: '#/parameters/ExcludeHealthStatisticsOptionalQueryParam'
      - $ref: '#/parameters/IncludeSystemApplicationHealthStatisticsOptionalQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Cluster
      responses:
        '200':
          description: A successful operation will return 200 status code and the requested cluster health information.
          schema:
            $ref: '#/definitions/ClusterHealth'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
    post:
      operationId: microsoftAzureGetclusterhealthusingpolicy
      summary: Microsoft Azure Gets The Health Of A Service Fabric Cluster Using The Specified Policy
      description: Use EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state.<br>Similarly, use NodesHealthStateFilter and ApplicationsHealthStateFilter to filter the collection of nodes and applications returned based on their aggregated health state.<br>Use ClusterHealthPolicies to override the health policies used to evaluate the health.
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/NodesHealthStateFilterOptionalQueryParam'
      - $ref: '#/parameters/ApplicationsHealthStateFilterOptionalQueryParam'
      - $ref: '#/parameters/EventsHealthStateFilterOptionalQueryParam'
      - $ref: '#/parameters/ExcludeHealthStatisticsOptionalQueryParam'
      - $ref: '#/parameters/IncludeSystemApplicationHealthStatisticsOptionalQueryParam'
      - $ref: '#/parameters/ClusterHealthPoliciesOptionalBodyParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Cluster
      responses:
        '200':
          description: A successful operation will return 200 status code and the requested cluster health information.
          schema:
            $ref: '#/definitions/ClusterHealth'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /$/GetClusterHealthChunk:
    get:
      operationId: microsoftAzureGetclusterhealthchunk
      summary: Microsoft Azure Gets The Health Of A Service Fabric Cluster Using Health Chunks
      description: Gets the health of a Service Fabric cluster using health chunks. Includes the aggregated health state of the cluster, but none of the cluster entities.<br>To expand the cluster health and get the health state of all or some of the entities, use the POST URI and specify the cluster health chunk query description.
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Cluster
      responses:
        '200':
          description: A successful operation will return 200 status code and the requested cluster health chunk information.
          schema:
            $ref: '#/definitions/ClusterHealthChunk'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
    post:
      operationId: microsoftAzureGetclusterhealthchunkusingpolicyandadvancedfilters
      summary: Microsoft Azure Gets The Health Of A Service Fabric Cluster Using Health Chunks
      description: Gets the health of a Service Fabric cluster using health chunks. The health evaluation is done based on the input cluster health chunk query description.<br>The query description allows users to specify health policies for evaluating the cluster and its children.<br>Users can specify very flexible filters to select which cluster entities to return. The selection can be done based on the entities health state and based on the hierarchy.<br>The query can return multi-level children of the entities based on the specified filters. For example, it can return one application with a specified name, and for this application, return<br>only services that are in Error or Warning, and all partitions and replicas for one of these services.
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/ClusterHealthChunkQueryDescriptionOptionalBodyParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Cluster
      responses:
        '200':
          description: A successful operation will return 200 status code and the requested cluster health chunk information.
          schema:
            $ref: '#/definitions/ClusterHealthChunk'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /$/ReportClusterHealth:
    post:
      operationId: microsoftAzureReportclusterhealth
      summary: Microsoft Azure Sends A Health Report On The Service Fabric Cluster
      description: Sends a health report on a Service Fabric cluster. The report must contain the information about the source of the health report and property on which it is reported.<br>The report is sent to a Service Fabric gateway node, which forwards to the health store.<br>The report may be accepted by the gateway, but rejected by the health store after extra validation.<br>For example, the health store may reject the report because of an invalid parameter, like a stale sequence number.<br>To see whether the report was applied in the health store, run GetClusterHealth and check that the report appears in the HealthEvents section.
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/HealthInformationRequiredBodyParam'
      - $ref: '#/parameters/ImmediateOptionalQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Cluster
      responses:
        '200':
          description: A successful operation will return 200 status code when the cluster health report is accepted for processing.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /$/GetProvisionedCodeVersions:
    get:
      operationId: microsoftAzureGetprovisionedfabriccodeversioninfolist
      summary: Microsoft Azure Gets A List Of Fabric Code Versions That Are Provisioned In A Service Fabric Cluster
      description: Gets a list of information about fabric code versions that are provisioned in the cluster. The parameter CodeVersion can be used to optionally filter the output to only that particular version.
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/CodeVersionOptionalQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Cluster
      responses:
        '200':
          description: A successful operation will return 200 status code and the requested provisioned code versions information.
          schema:
            $ref: '#/definitions/FabricCodeVersionInfoList'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /$/GetProvisionedConfigVersions:
    get:
      operationId: microsoftAzureGetprovisionedfabricconfigversioninfolist
      summary: Microsoft Azure Gets A List Of Fabric Config Versions That Are Provisioned In A Service Fabric Cluster
      description: Gets a list of information about fabric config versions that are provisioned in the cluster. The parameter ConfigVersion can be used to optionally filter the output to only that particular version.
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/ConfigVersionOptionalQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Cluster
      responses:
        '200':
          description: A successful operation will return 200 status code and the requested provisioned config versions information.
          schema:
            $ref: '#/definitions/FabricConfigVersionInfoList'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /$/GetUpgradeProgress:
    get:
      operationId: microsoftAzureGetclusterupgradeprogress
      summary: Microsoft Azure Gets The Progress Of The Current Cluster Upgrade
      description: Gets the current progress of the ongoing cluster upgrade. If no upgrade is currently in progress, get the last state of the previous cluster upgrade.
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Cluster
      responses:
        '200':
          description: A successful operation will return 200 status code and the requested cluster upgrade progress.
          schema:
            $ref: '#/definitions/ClusterUpgradeProgressObject'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /$/GetClusterConfiguration:
    get:
      operationId: microsoftAzureGetclusterconfiguration
      summary: Microsoft Azure Get The Service Fabric Standalone Cluster Configuration
      description: The cluster configuration contains properties of the cluster that include different node types on the cluster,<br>security configurations, fault, and upgrade domain topologies, etc.
      tags:
      - Cluster
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/ConfigurationApiVersionRequiredQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 200 status code and the requested cluster configuration information.
          schema:
            $ref: '#/definitions/ClusterConfiguration'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /$/GetClusterConfigurationUpgradeStatus:
    get:
      operationId: microsoftAzureGetclusterconfigurationupgradestatus
      summary: Microsoft Azure Get The Cluster Configuration Upgrade Status Of A Service Fabric Standalone Cluster
      description: Get the cluster configuration upgrade status details of a Service Fabric standalone cluster.
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Cluster
      responses:
        '200':
          description: A successful operation will return 200 status code and the requested cluster configuration upgrade status.
          schema:
            $ref: '#/definitions/ClusterConfigurationUpgradeStatusInfo'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /$/GetUpgradeOrchestrationServiceState:
    get:
      operationId: microsoftAzureGetupgradeorchestrationservicestate
      summary: Microsoft Azure Get The Service State Of Service Fabric Upgrade Orchestration Service
      description: Get the service state of Service Fabric Upgrade Orchestration Service. This API is internally used for support purposes.
      tags:
      - Cluster
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 200 status code and the requested service state of Service Fabric Upgrade Orchestration Service.
          schema:
            $ref: '#/definitions/UpgradeOrchestrationServiceState'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /$/SetUpgradeOrchestrationServiceState:
    post:
      operationId: microsoftAzureSetupgradeorchestrationservicestate
      summary: Microsoft Azure Update The Service State Of Service Fabric Upgrade Orchestration Service
      description: Update the service state of Service Fabric Upgrade Orchestration Service. This API is internally used for support purposes.
      tags:
      - Cluster
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/UpgradeOrchestrationServiceStateRequiredBodyParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful response means that the service state of Service Fabric Upgrade Orchestration Service has been updated.
          schema:
            $ref: '#/definitions/UpgradeOrchestrationServiceStateSummary'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /$/Provision:
    post:
      summary: Microsoft Azure Provision The Code Or Configuration Packages Of A Service Fabric Cluster
      description: Validate and provision the code or configuration packages of a Service Fabric cluster.
      operationId: microsoftAzureProvisioncluster
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/ProvisionFabricDescriptionRequiredBodyParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Cluster
      responses:
        '200':
          description: A successful response means that the code or configuration packages have been provisioned.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /$/Unprovision:
    post:
      summary: Microsoft Azure Unprovision The Code Or Configuration Packages Of A Service Fabric Cluster
      description: It is supported to unprovision code and configuration separately.
      operationId: microsoftAzureUnprovisioncluster
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/UnprovisionFabricDescriptionRequiredBodyParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Cluster
      responses:
        '200':
          description: A successful response means that the code or configuration packages have been unprovisioned.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /$/RollbackUpgrade:
    post:
      summary: Microsoft Azure Roll Back The Upgrade Of A Service Fabric Cluster
      description: Roll back the code or configuration upgrade of a Service Fabric cluster.
      operationId: microsoftAzureRollbackclusterupgrade
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Cluster
      responses:
        '202':
          description: A successful response means that the rollback of a cluster upgrade has been initiated.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /$/MoveToNextUpgradeDomain:
    post:
      summary: Microsoft Azure Make The Cluster Upgrade Move On To The Next Upgrade Domain
      description: Make the cluster code or configuration upgrade move on to the next upgrade domain if appropriate.
      operationId: microsoftAzureResumeclusterupgrade
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/ResumeClusterUpgradeDescriptionRequiredBodyParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Cluster
      responses:
        '200':
          description: A successful response means that the cluster upgrade has moved on to the next upgrade domain.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /$/Upgrade:
    post:
      summary: Microsoft Azure Start Upgrading The Code Or Configuration Version Of A Service Fabric Cluster
      description: Validate the supplied upgrade parameters and start upgrading the code or configuration version of a Service Fabric cluster if the parameters are valid.
      operationId: microsoftAzureStartclusterupgrade
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/StartClusterUpgradeDescriptionRequiredBodyParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Cluster
      responses:
        '202':
          description: A successful response means that the cluster code or configuration upgrade has started. Use GetUpgradeProgress operation to get the status of the upgrade.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /$/StartClusterConfigurationUpgrade:
    post:
      summary: Microsoft Azure Start Upgrading The Configuration Of A Service Fabric Standalone Cluster
      description: Validate the supplied configuration upgrade parameters and start upgrading the cluster configuration if the parameters are valid.
      operationId: microsoftAzureStartclusterconfigurationupgrade
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/ClusterConfigurationUpgradeDescriptionRequiredBodyParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Cluster
      x-ms-examples:
        Start upgrading the configuration of a Service Fabric standalone cluster:
          $ref: ./examples/StartClusterConfigurationUpgrade-1.json
      responses:
        '202':
          description: A successful response means that the cluster configuration upgrade has started. Use GetClusterConfigurationUpgradeStatus operation to get the status of the upgrade.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /$/UpdateUpgrade:
    post:
      operationId: microsoftAzureUpdateclusterupgrade
      summary: Microsoft Azure Update The Upgrade Parameters Of A Service Fabric Cluster Upgrade
      description: Update the upgrade parameters used during a Service Fabric cluster upgrade.
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/UpdateClusterUpgradeDescriptionRequiredBodyParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Cluster
      responses:
        '200':
          description: A successful operation returns 200 status code.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /$/GetAadMetadata:
    get:
      operationId: microsoftAzureGetaadmetadata
      summary: Microsoft Azure Gets The Azure Active Directory Metadata Used For Secured Connection To Cluster
      description: Gets the Azure Active Directory metadata used for secured connection to cluster.<br>This API is not supposed to be called separately. It provides information needed to set up an Azure Active Directory secured connection with a Service Fabric cluster.
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      schemes:
      - https
      tags:
      - Cluster
      responses:
        '200':
          description: A successful operation will return 200 status code and the Azure Active Directory metadata.
          schema:
            $ref: '#/definitions/AadMetadataObject'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /$/GetClusterVersion:
    get:
      operationId: microsoftAzureGetclusterversion
      summary: Microsoft Azure Get The Current Service Fabric Cluster Version
      description: If a cluster upgrade is happening, then this API will return the lowest (older) version of the current and target cluster runtime versions.
      tags:
      - Cluster
      parameters:
      - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      x-ms-examples:
        Get cluster version:
          $ref: ./examples/GetClusterVersion-1.json
      responses:
        '200':
          description: A successful operation will return 200 status code and the requested cluster version information.
          schema:
            $ref: '#/definitions/ClusterVersion'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /$/GetLoadInformation:
    get:
      operationId: microsoftAzureGetclusterload
      summary: Microsoft Azure Gets The Load Of A Service Fabric Cluster
      description: Retrieves the load information of a Service Fabric cluster for all the metrics that have load or capacity defined.
      tags:
      - Cluster
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 200 status code and the requested cluster load information.
          schema:
            $ref: '#/definitions/ClusterLoadInfo'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /$/ToggleVerboseServicePlacementHealthReporting:
    post:
      operationId: microsoftAzureToggleverboseserviceplacementhealthreporting
      summary: Microsoft Azure Changes The Verbosity Of Service Placement Health Reporting
      description: If verbosity is set to true, then detailed health reports will be generated when replicas cannot be placed or dropped.<br>If verbosity is set to false, then no health reports will be generated when replicas cannot be placed or dropped.
      tags:
      - Cluster
      parameters:
      - $ref: '#/parameters/ApiVersion_6-4_RequiredQueryParam'
      - $ref: '#/parameters/VerboseServicePlacementHealthReportingParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful response means that the verbosity of service placement health reporting was updated.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /$/ValidateUpgrade:
    post:
      summary: Microsoft Azure Validate And Assess The Impact Of A Code Or Configuration Version Update Of A Service Fabric Cluster
      description: Validate the supplied upgrade parameters and assess the expected impact of a code or configuration version upgrade of a Service Fabric cluster. The upgrade will not be initiated.
      operationId: microsoftAzureValidateclusterupgrade
      parameters:
      - $ref: '#/parameters/ApiVersion_8-2_RequiredQueryParam'
      - $ref: '#/parameters/StartClusterUpgradeDescriptionRequiredBodyParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Cluster
      responses:
        '200':
          description: A successful response means that the cluster code or configuration upgrade has valid parameters. The response body describes the assessed expected impact of the upgrade.
          schema:
            $ref: '#/definitions/ValidateClusterUpgradeResult'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
definitions:
  NodeHealthStateChunk:
    description: Represents the health state chunk of a node, which contains the node name and its aggregated health state.
    allOf:
    - $ref: '#/definitions/EntityHealthStateChunk'
    properties:
      NodeName:
        $ref: '#/definitions/NodeName'
        description: The name of a Service Fabric node.
  FabricErrorError:
    description: Error object containing error code and error message.
    properties:
      Code:
        $ref: '#/definitions/FabricErrorCodes'
        description: "Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code.\n\n  - Possible values of the error code for HTTP status code 400 (Bad Request)\n    - \"FABRIC_E_INVALID_PARTITION_KEY\"\n    - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n    - \"FABRIC_E_INVALID_ADDRESS\"\n    - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n    - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n    - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n    - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n    - \"FABRIC_E_INVALID_CONFIGURATION\"\n    - \"FABRIC_E_INVALID_NAME_URI\"\n    - \"FABRIC_E_PATH_TOO_LONG\"\n    - \"FABRIC_E_KEY_TOO_LARGE\"\n    - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n    - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n    - \"FABRIC_E_VALUE_EMPTY\"\n    - \"FABRIC_E_BACKUP_IS_ENABLED\"\n    - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n    - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n    - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n    - \"E_INVALIDARG\"\n\n  - Possible values of the error code for HTTP status code 404 (Not Found)\n    - \"FABRIC_E_NODE_NOT_FOUND\"\n    - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n    - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n    - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n    - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n    - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n    - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n    - \"FABRIC_E_PARTITION_NOT_FOUND\"\n    - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n    - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n    - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n    - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n    - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n    - \"FABRIC_E_FILE_NOT_FOUND\"\n    - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n    - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n    - \"FABRIC_E_ENUMERATION_COMPLETED\"\n    - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n    - \"FABRIC_E_KEY_NOT_FOUND\"\n    - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n    - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n    - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n    - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n    - \"FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR\"\n\n  - Possible values of the error code for HTTP status code 409 (Conflict)\n    - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n    - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n    - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n    - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n    - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n    - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n    - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n    - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n    - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n    - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n    - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n    - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n    - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n    - \"FABRIC_E_NAME_NOT_EMPTY\"\n    - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n    - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n    - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n    - \"FABRIC_E_HEALTH_STALE_REPORT\"\n    - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n    - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n    - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n    - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n    - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n    - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n  - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n    - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n  - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n    - \"FABRIC_E_NODE_IS_UP\"\n    - \"E_FAIL\"\n    - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS\"\n    - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND\"\n    - \"FABRIC_E_VOLUME_ALREADY_EXISTS\"\n    - \"FABRIC_E_VOLUME_NOT_FOUND\"\n    - \"SerializationError\"\n\n  - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n    - \"FABRIC_E_NO_WRITE_QUORUM\"\n    - \"FABRIC_E_NOT_PRIMARY\"\n    - \"FABRIC_E_NOT_READY\"\n    - \"FABRIC_E_RECONFIGURATION_PENDING\"\n    - \"FABRIC_E_SERVICE_OFFLINE\"\n    - \"E_ABORT\"\n    - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n  - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n    - \"FABRIC_E_COMMUNICATION_ERROR\"\n    - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n    - \"FABRIC_E_TIMEOUT\""
      Message:
        type: string
        description: Error message.
    required:
    - Code
  UpgradeDomainInfoList:
    type: array
    description: List of upgrade domains and their statuses. Not applicable to node-by-node upgrades.
    items:
      $ref: '#/definitions/UpgradeDomainInfo'
  HealthInformation:
    description: Represents common health report information. It is included in all health reports sent to health store and in all health events returned by health queries.
    required:
    - SourceId
    - Property
    - HealthState
    properties:
      SourceId:
        type: string
        description: The source name that identifies the client/watchdog/system component that generated the health information.
      Property:
        type: string
        description: 'The property of the health information. An entity can have health reports for different properties.

          The property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report.

          For example, a reporter with SourceId "LocalWatchdog" can monitor the state of the available disk on a node,

          so it can report "AvailableDisk" property on that node.

          The same reporter can monitor the node connectivity, so it can report a property "Connectivity" on the same node.

          In the health store, these reports are treated as separate health events for the specified node.


          Together with the SourceId, the property uniquely identifies the health information.'
      HealthState:
        $ref: '#/definitions/HealthState'
        description: The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
      TimeToLiveInMilliSeconds:
        type: string
        format: duration
        description: 'The duration for which this health report is valid. This field uses ISO8601 format for specifying the duration.

          When clients report periodically, they should send reports with higher frequency than time to live.

          If clients report on transition, they can set the time to live to infinite.

          When time to live expires, the health event that contains the health information

          is either removed from health store, if RemoveWhenExpired is true, or evaluated at error, if RemoveWhenExpired false.


          If not specified, time to live defaults to infinite value.'
      Description:
        type: string
        description: 'The description of the health information. It represents free text used to add human readable information about the report.

          The maximum string length for the description is 4096 characters.

          If the provided string is longer, it will be automatically truncated.

          When truncated, the last characters of the description contain a marker "[Truncated]", and total string size is 4096 characters.

          The presence of the marker indicates to users that truncation occurred.

          Note that when truncated, the description has less than 4096 characters from the original string.'
      SequenceNumber:
        type: string
        description: 'The sequence number for this health report as a numeric string.

          The report sequence number is used by the health store to detect stale reports.

          If not specified, a sequence number is auto-generated by the health client when a report is added.'
      RemoveWhenExpired:
        type: boolean
        description: 'Value that indicates whether the report is removed from health store when it expires.

          If set to true, the report is removed from the health store after it expires.

          If set to false, the report is treated as an error when expired. The value of this property is false by default.

          When clients report periodically, they should set RemoveWhenExpired false (default).

          This way, if the reporter has issues (e.g. deadlock) and can''t report, the entity is evaluated at error when the health report expires.

          This flags the entity as being in Error health state.'
      HealthReportId:
        type: string
        description: 'A health report ID which identifies the health report and can be used to find more detailed information about a specific health event at

          aka.ms/sfhealthid'
  HealthEvaluationWrapper:
    description: Wrapper object for health evaluation.
    properties:
      HealthEvaluation:
        $ref: '#/definitions/HealthEvaluation'
        description: Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity.
  LoadMetricInformation:
    description: Represents data structure that contains load information for a certain metric in a cluster.
    properties:
      Name:
        type: string
        description: Name of the metric for which this load information is provided.
      IsBalancedBefore:
        type: boolean
        description: Value that indicates whether the metrics is balanced or not before resource balancer run
      IsBalancedAfter:
        type: boolean
        description: Value that indicates whether the metrics is balanced or not after resource balancer run.
      DeviationBefore:
        type: string
        format: double
        description: The standard average deviation of the metrics before resource balancer run.
      DeviationAfter:
        type: string
        format: double
        description: The standard average deviation of the metrics after resource balancer run.
      BalancingThreshold:
        type: string
        format: double
        description: The balancing threshold for a certain metric.
      Action:
        type: string
        description: The current action being taken with regard to this metric
      ActivityThreshold:
        type: string
        format: double
        description: The Activity Threshold specified for this metric in the system Cluster Manifest.
      ClusterCapacity:
        type: string
        description: The total cluster capacity for a given metric
      ClusterLoad:
        type: string
        description: The total cluster load. In future releases of Service Fabric this parameter will be deprecated in favor of CurrentClusterLoad.
      CurrentClusterLoad:
        type: string
        format: double
        description: The total cluster load.
      ClusterRemainingCapacity:
        type: string
        description: The remaining capacity for the metric in the cluster. In future releases of Service Fabric this parameter will be deprecated in favor of ClusterCapacityRemaining.
      ClusterCapacityRemaining:
        type: string
        description: The remaining capacity for the metric in the cluster.
      IsClusterCapacityViolation:
        type: boolean
        description: Indicates that the metric is currently over capacity in the cluster.
      NodeBufferPercentage:
        type: string
        format: double
        description: The reserved percentage of total node capacity for this metric.
      ClusterBufferedCapacity:
        type: string
        description: Remaining capacity in the cluster excluding the reserved space. In future releases of Service Fabric this parameter will be deprecated in favor of BufferedClusterCapacityRemaining.
      BufferedClusterCapacityRemaining:
        type: string
        format: double
        description: Remaining capacity in the cluster excluding the reserved space.
      ClusterRemainingBufferedCapacity:
        type: string
        description: The remaining percentage of cluster total capacity for this metric.
      MinNodeLoadValue:
        type: string
        description: The minimum load on any node for this metric. In future releases of Service Fabric this parameter will be deprecated in favor of MinimumNodeLoad.
      MinimumNodeLoad:
        type: string
        format: double
        description: The minimum load on any node for this metric.
      MinNodeLoadNodeId:
        $ref: '#/definitions/NodeId'
        description: The node id of the node with the minimum load for this metric.
      MaxNodeLoadValue:
        type: string
        description: The maximum load on any node for this metric. In future releases of Service Fabric this parameter will be deprecated in favor of MaximumNodeLoad.
      MaximumNodeLoad:
        type: string
        format: double
        description: The maximum load on any node for this metric.
      MaxNodeLoadNodeId:
        $ref: '#/definitions/NodeId'
        description: The node id of the node with the maximum load for this metric.
      PlannedLoadRemoval:
        type: string
        format: double
        description: 'This value represents the load of the replicas that are planned to be removed in the future within the cluster.

          This kind of load is reported for replicas that are currently being moving to other nodes and for replicas that are currently being dropped but still use the load on the source node.'
  ApplicationTypeName:
    type: string
    description: The application type name as defined in the application manifest.
  SafetyCheckWrapper:
    description: A wrapper for the safety check object. Safety checks are performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state.
    properties:
      SafetyCheck:
        $ref: '#/definitions/SafetyCheck'
        description: Represents a safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state.
  NodeHealthStateFilter:
    description: 'Defines matching criteria to determine whether a node should be included in the returned cluster health chunk.

      One filter can match zero, one or multiple nodes, depending on its properties.

      Can be specified in the cluster health chunk query description.'
    properties:
      NodeNameFilter:
        type: string
        description: 'Name of the node that matches the filter. The filter is applied only to the specified node, if it exists.

          If the node doesn''t exist, no node is returned in the cluster health chunk based on this filter.

          If the node exists, it is included in the cluster health chunk if the health state matches the other filter properties.

          If not specified, all nodes that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter.'
      HealthStateFilter:
        type: integer
        default: 0
        description: 'The filter for the health state of the nodes. It allows selecting nodes if they match the desired health states.

          The possible values are integer value of one of the following health states. Only nodes that match the filter are returned. All nodes are used to evaluate the cluster aggregated health state.

          If not specified, default value is None, unless the node name is specified. If the filter has default value and node name is specified, the matching node is returned.

          The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise ''OR'' operator.

          For example, if the provided value is 6, it matches nodes with HealthState value of OK (2) and Warning (4).


          - Default - Default value. Matches any HealthState. The value is zero.

          - None - Filter that doesn''t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.

          - Ok - Filter that matches input with HealthState value Ok. The value is 2.

          - Warning - Filter that matches input with HealthState value Warning. The value is 4.

          - Error - Filter that matches input with HealthState value Error. The value is 8.

          - All - Filter that matches input with any HealthState value. The value is 65535.'
  HealthStateCount:
    description: Represents information about how many health entities are in Ok, Warning and Error health state.
    properties:
      OkCount:
        type: integer
        format: int64
        description: The number of health entities with aggregated health state Ok.
        minimum: 0
      WarningCount:
        type: integer
        format: int64
        description: The number of health entities with aggregated health state Warning.
        minimum: 0
      ErrorCount:
        type: integer
        format: int64
        description: The number of health entities with aggregated health state Error.
        minimum: 0
  UnhealthyEvaluations:
    description: List of health evaluations that resulted in the current aggregated health state.
    type: array
    items:
      $ref: '#/definitions/HealthEvaluationWrapper'
  HealthState:
    type: string
    description: The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
    enum:
    - Invalid
    - Ok
    - Warning
    - Error
    - Unknown
    x-ms-enum:
      name: HealthState
      modelAsString: true
      values:
      - value: Invalid
        description: Indicates an invalid health state. All Service Fabric enumerations have the invalid type. The value is zero.
      - value: Ok
        description: Indicates the health state is okay. The value is 1.
      - value: Warning
        description: Indicates the health state is at a warning level. The value is 2.
      - value: Error
        description: Indicates the health state is at an error level. Error health state should be investigated, as they can impact the correct functionality of the cluster. The value is 3.
      - value: Unknown
        description: Indicates an unknown health status. The value is 65535.
  CurrentUpgradeDomainName:
    type: string
    description: The name of the upgrade domain. Not applicable to node-by-node upgrades.
  FabricCodeVersionInfoList:
    type: array
    items:
      $ref: '#/definitions/FabricCodeVersionInfo'
    description: List of all Service Fabric code versions.
  ApplicationHealthStateFilter:
    description: 'Defines matching criteria to determine whether a application should be included in the cluster health chunk.

      One filter can match zero, one or multiple applications, depending on its properties.'
    properties:
      ApplicationNameFilter:
        type: string
        description: 'The name of the application that matches the filter, as a fabric uri. The filter is applied only to the specified application, if it exists.

          If the application doesn''t exist, no application is returned in the cluster health chunk based on this filter.

          If the application exists, it is included in the cluster health chunk if it respects the other filter properties.

          If not specified, all applications are matched against the other filter members, like health state filter.'
      ApplicationTypeNameFilter:
        type: string
        description: 'The name of the application type that matches the filter.

          If specified, the filter is applied only to applications of the selected application type, if any exists.

          If no applications of the specified application type exists, no application is returned in the cluster health chunk based on this filter.

          Each application of the specified application type is included in the cluster health chunk if it respects the other filter properties.

          If not specified, all applications are matched against the other filter members, like health state filter.'
      HealthStateFilter:
        type: integer
        default: 0
        description: 'The filter for the health state of the applications. It allows selecting applications if they match the desired health states.

          The possible values are integer value of one of the following health states. Only applications that match the filter are returned. All applications are used to evaluate the cluster aggregated health state.

          If not specified, default value is None, unless the application name or the application type name are specified. If the filter has default value and application name is specified, the matching application is returned.

          The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise ''OR'' operator.

          For example, if the provided value is 6, it matches applications with HealthState value of OK (2) and Warning (4).


          - Default - Default value. Matches any HealthState. The value is zero.

          - None - Filter that doesn''t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.

          - Ok - Filter that matches input with HealthState value Ok. The value is 2.

          - Warning - Filter that matches input with HealthState value Warning. The value is 4.

          - Error - Filter that matches input with HealthState value Error. The value is 8.

          - All - Filter that matches input with any HealthState value. The value is 65535.'
      ServiceFilters:
        type: array
        items:
          $ref: '#/definitions/ServiceHealthStateFilter'
        description: 'Defines a list of filters that specify which services to be included in the returned cluster health chunk as children of the application. The services are returned only if the parent application matches a filter.

          If the list is empty, no services are returned. All the services are used to evaluate the parent application aggregated health state, regardless of the input filters.

          The application filter may specify multiple service filters.

          For example, it can specify a filter to return all services with health state Error and another filter to always include a service identified by its service name.'
      DeployedApplicationFilters:
        type: array
        items:
          $ref: '#/definitions/DeployedApplicationHealthStateFilter'
        description: 'Defines a list of filters that specify which deployed applications to be included in the returned cluster health chunk as children of the application. The deployed applications are returned only if the parent application matches a filter.

          If the list is empty, no deployed applications are returned. All the deployed applications are used to evaluate the parent application aggregated health state, regardless of the input filters.

          The application filter may specify multiple deployed application filters.

          For example, it can specify a filter to return all deployed applications with health state Error and another filter to always include a deployed application on a specified node.'
  FabricErrorCodes:
    type: string
    description: "Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code.\n\n  - Possible values of the error code for HTTP status code 400 (Bad Request)\n    - \"FABRIC_E_INVALID_PARTITION_KEY\"\n    - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n    - \"FABRIC_E_INVALID_ADDRESS\"\n    - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n    - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n    - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n    - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n    - \"FABRIC_E_INVALID_CONFIGURATION\"\n    - \"FABRIC_E_INVALID_NAME_URI\"\n    - \"FABRIC_E_PATH_TOO_LONG\"\n    - \"FABRIC_E_KEY_TOO_LARGE\"\n    - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n    - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n    - \"FABRIC_E_VALUE_EMPTY\"\n    - \"FABRIC_E_BACKUP_IS_ENABLED\"\n    - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n    - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n    - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n    - \"E_INVALIDARG\"\n\n  - Possible values of the error code for HTTP status code 404 (Not Found)\n    - \"FABRIC_E_NODE_NOT_FOUND\"\n    - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n    - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n    - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n    - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n    - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n    - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n    - \"FABRIC_E_PARTITION_NOT_FOUND\"\n    - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n    - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n    - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n    - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n    - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n    - \"FABRIC_E_FILE_NOT_FOUND\"\n    - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n    - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n    - \"FABRIC_E_ENUMERATION_COMPLETED\"\n    - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n    - \"FABRIC_E_KEY_NOT_FOUND\"\n    - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n    - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n    - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n    - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n    - \"FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR\"\n\n  - Possible values of the error code for HTTP status code 409 (Conflict)\n    - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n    - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n    - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n    - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n    - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n    - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n    - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n    - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n    - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n    - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n    - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n    - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n    - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n    - \"FABRIC_E_NAME_NOT_EMPTY\"\n    - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n    - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n    - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n    - \"FABRIC_E_HEALTH_STALE_REPORT\"\n    - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n    - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n    - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n    - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n    - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n    - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n  - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n    - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n  - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n    - \"FABRIC_E_NODE_IS_UP\"\n    - \"E_FAIL\"\n    - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS\"\n    - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND\"\n    - \"FABRIC_E_VOLUME_ALREADY_EXISTS\"\n    - \"FABRIC_E_VOLUME_NOT_FOUND\"\n    - \"SerializationError\"\n\n  - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n    - \"FABRIC_E_NO_WRITE_QUORUM\"\n    - \"FABRIC_E_NOT_PRIMARY\"\n    - \"FABRIC_E_NOT_READY\"\n    - \"FABRIC_E_RECONFIGURATION_PENDING\"\n    - \"FABRIC_E_SERVICE_OFFLINE\"\n    - \"E_ABORT\"\n    - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n  - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n    - \"FABRIC_E_COMMUNICATION_ERROR\"\n    - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n    - \"FABRIC_E_TIMEOUT\""
    enum:
    - FABRIC_E_INVALID_PARTITION_KEY
    - FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR
    - FABRIC_E_INVALID_ADDRESS
    - FABRIC_E_APPLICATION_NOT_UPGRADING
    - FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR
    - FABRIC_E_FABRIC_NOT_UPGRADING
    - FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR
    - FABRIC_E_INVALID_CONFIGURATION
    - FABRIC_E_INVALID_NAME_URI
    - FABRIC_E_PATH_TOO_LONG
    - FABRIC_E_KEY_TOO_LARGE
    - FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED
    - FABRIC_E_INVALID_ATOMIC_GROUP
    - FABRIC_E_VALUE_EMPTY
    - FABRIC_E_NODE_NOT_FOUND
    - FABRIC_E_APPLICATION_TYPE_NOT_FOUND
    - FABRIC_E_APPLICATION_NOT_FOUND
    - FABRIC_E_SERVICE_TYPE_NOT_FOUND
    - FABRIC_E_SERVICE_DOES_NOT_EXIST
    - FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND
    - FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND
    - FABRIC_E_PARTITION_NOT_FOUND
    - FABRIC_E_REPLICA_DOES_NOT_EXIST
    - FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST
    - FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND
    - FABRIC_E_DIRECTORY_NOT_FOUND
    - FABRIC_E_FABRIC_VERSION_NOT_FOUND
    - FABRIC_E_FILE_NOT_FOUND
    - FABRIC_E_NAME_DOES_NOT_EXIST
    - FABRIC_E_PROPERTY_DOES_NOT_EXIST
    - FABRIC_E_ENUMERATION_COMPLETED
    - FABRIC_E_SERVICE_MANIFEST_NOT_FOUND
    - FABRIC_E_KEY_NOT_FOUND
    - FABRIC_E_HEALTH_ENTITY_NOT_FOUND
    - FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS
    - FABRIC_E_APPLICATION_ALREADY_EXISTS
    - FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION
    - FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS
    - FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS
    - FABRIC_E_SERVICE_ALREADY_EXISTS
    - FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS
    - FABRIC_E_APPLICATION_TYPE_IN_USE
    - FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION
    - FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS
    - FABRIC_E_FABRIC_VERSION_IN_USE
    - FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS
    - FABRIC_E_NAME_ALREADY_EXISTS
    - FABRIC_E_NAME_NOT_EMPTY
    - FABRIC_E_PROPERTY_CHECK_FAILED
    - FABRIC_E_SERVICE_METADATA_MISMATCH
    - FABRIC_E_SERVICE_TYPE_MISMATCH
    - FABRIC_E_HEALTH_STALE_REPORT
    - FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED
    - FABRIC_E_NODE_HAS_NOT_STOPPED_YET
    - FABRIC_E_INSTANCE_ID_MISMATCH
    - FABRIC_E_VALUE_TOO_LARGE
    - FABRIC_E_NO_WRITE_QUORUM
    - FABRIC_E_NOT_PRIMARY
    - FABRIC_E_NOT_READY
    - FABRIC_E_RECONFIGURATION_PENDING
    - FABRIC_E_SERVICE_OFFLINE
    - E_ABORT
    - FABRIC_E_COMMUNICATION_ERROR
    - FABRIC_E_OPERATION_NOT_COMPLETE
    - FABRIC_E_TIMEOUT
    - FABRIC_E_NODE_IS_UP
    - E_FAIL
    - FABRIC_E_BACKUP_IS_ENABLED
    - FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH
    - FABRIC_E_INVALID_FOR_STATELESS_SERVICES
    - FABRIC_E_BACKUP_NOT_ENABLED
    - FABRIC_E_BACKUP_POLICY_NOT_EXISTING
    - FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING
    - FABRIC_E_BACKUP_IN_PROGRESS
    - FABRIC_E_RESTORE_IN_PROGRESS
    - FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING
    - FABRIC_E_INVALID_SERVICE_SCALING_POLICY
    - E_INVALIDARG
    - FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS
    - FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND
    - FABRIC_E_VOLUME_ALREADY_EXISTS
    - FABRIC_E_VOLUME_NOT_FOUND
    - SerializationError
    - FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR
    x-ms-enum:
      name: FabricErrorCodes
      modelAsString: true
      values:
      - value: FABRIC_E_INVALID_PARTITION_KEY
      - value: FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR
      - value: FABRIC_E_INVALID_ADDRESS
      - value: FABRIC_E_APPLICATION_NOT_UPGRADING
      - value: FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR
      - value: FABRIC_E_FABRIC_NOT_UPGRADING
      - value: FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR
      - value: FABRIC_E_INVALID_CONFIGURATION
      - value: FABRIC_E_INVALID_NAME_URI
      - value: FABRIC_E_PATH_TOO_LONG
      - value: FABRIC_E_KEY_TOO_LARGE
      - value: FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED
      - value: FABRIC_E_INVALID_ATOMIC_GROUP
      - value: FABRIC_E_VALUE_EMPTY
      - value: FABRIC_E_NODE_NOT_FOUND
      - value: FABRIC_E_APPLICATION_TYPE_NOT_FOUND
      - value: FABRIC_E_APPLICATION_NOT_FOUND
      - value: FABRIC_E_SERVICE_TYPE_NOT_FOUND
      - value: FABRIC_E_SERVICE_DOES_NOT_EXIST
      - value: FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND
      - value: FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND
      - value: FABRIC_E_PARTITION_NOT_FOUND
      - value: FABRIC_E_REPLICA_DOES_NOT_EXIST
      - value: FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST
      - value: FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND
      - value: FABRIC_E_DIRECTORY_NOT_FOUND
      - value: FABRIC_E_FABRIC_VERSION_NOT_FOUND
      - value: FABRIC_E_FILE_NOT_FOUND
      - value: FABRIC_E_NAME_DOES_NOT_EXIST
      - value: FABRIC_E_PROPERTY_DOES_NOT_EXIST
      - value: FABRIC_E_ENUMERATION_COMPLETED
      - value: FABRIC_E_SERVICE_MANIFEST_NOT_FOUND
      - value: FABRIC_E_KEY_NOT_FOUND
      - value: FABRIC_E_HEALTH_ENTITY_NOT_FOUND
      - value: FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS
      - value: FABRIC_E_APPLICATION_ALREADY_EXISTS
      - value: FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION
      - value: FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS
      - value: FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS
      - value: FABRIC_E_SERVICE_ALREADY_EXISTS
      - value: FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS
      - value: FABRIC_E_APPLICATION_TYPE_IN_USE
      - value: FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION
      - value: FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS
      - value: FABRIC_E_FABRIC_VERSION_IN_USE
      - value: FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS
      - value: FABRIC_E_NAME_ALREADY_EXISTS
      - value: FABRIC_E_NAME_NOT_EMPTY
      - value: FABRIC_E_PROPERTY_CHECK_FAILED
      - value: FABRIC_E_SERVICE_METADATA_MISMATCH
      - value: FABRIC_E_SERVICE_TYPE_MISMATCH
      - value: FABRIC_E_HEALTH_STALE_REPORT
      - value: FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED
      - value: FABRIC_E_NODE_HAS_NOT_STOPPED_YET
      - value: FABRIC_E_INSTANCE_ID_MISMATCH
      - value: FABRIC_E_VALUE_TOO_LARGE
      - value: FABRIC_E_NO_WRITE_QUORUM
      - value: FABRIC_E_NOT_PRIMARY
      - value: FABRIC_E_NOT_READY
      - value: FABRIC_E_RECONFIGURATION_PENDING
      - value: FABRIC_E_SERVICE_OFFLINE
      - value: E_ABORT
      - value: FABRIC_E_COMMUNICATION_ERROR
      - value: FABRIC_E_OPERATION_NOT_COMPLETE
      - value: FABRIC_E_TIMEOUT
      - value: FABRIC_E_NODE_IS_UP
      - value: E_FAIL
      - value: FABRIC_E_BACKUP_IS_ENABLED
      - value: FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH
      - value: FABRIC_E_INVALID_FOR_STATELESS_SERVICES
      - value: FABRIC_E_BACKUP_NOT_ENABLED
      - value: FABRIC_E_BACKUP_POLICY_NOT_EXISTING
      - value: FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING
      - value: FABRIC_E_BACKUP_IN_PROGRESS
      - value: FABRIC_E_RESTORE_IN_PROGRESS
      - value: FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING
      - value: FABRIC_E_INVALID_SERVICE_SCALING_POLICY
      - value: E_INVALIDARG
      - value: FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS
      - value: FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND
      - value: FABRIC_E_VOLUME_ALREADY_EXISTS
      - value: FABRIC_E_VOLUME_NOT_FOUND
      - value: SerializationError
      - value: FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR
  FailureReason:
    type: string
    description: The cause of an upgrade failure that resulted in FailureAction being executed.
    enum:
    - None
    - Interrupted
    - HealthCheck
    - UpgradeDomainTimeout
    - OverallUpgradeTimeout
    x-ms-enum:
      name: FailureReason
      modelAsString: true
      values:
      - value: None
        description: Indicates the reason is invalid or unknown. All Service Fabric enumerations have the invalid type. The value is zero.
      - value: Interrupted
        description: There was an external request to roll back the upgrade. The value is 1
      - value: HealthCheck
        description: The upgrade failed due to health policy violations. The value is 2
      - value: UpgradeDomainTimeout
        description: An upgrade domain took longer than the allowed upgrade domain timeout to process. The value is 3
      - value: OverallUpgradeTimeout
        description: The overall upgrade took longer than the allowed upgrade timeout to process. The value is 4
  ClusterHealth:
    description: 'Represents the health of the cluster.

      Contains the cluster aggregated health state, the cluster application and node health states as well as the health events and the unhealthy evaluations.'
    allOf:
    - $ref: '#/definitions/EntityHealth'
    properties:
      NodeHealthStates:
        type: array
        items:
          $ref: '#/definitions/NodeHealthState'
        description: Cluster node health states as found in the health store.
      ApplicationHealthStates:
        type: array
        items:
          $ref: '#/definitions/ApplicationHealthState'
        description: Cluster application health states as found in the health store.
  ClusterLoadInfo:
    description: Information about load in a Service Fabric cluster. It holds a summary of all metrics and their load in a cluster.
    properties:
      LastBalancingStartTimeUtc:
        type: string
        format: date-time
        description: The starting time of last resource balancing run.
      LastBalancingEndTimeUtc:
        type: string
        format: date-time
        description: The end time of last resource balancing run.
      LoadMetricInformation:
        type: array
        items:
          $ref: '#/definitions/LoadMetricInformation'
        description: List that contains metrics and their load information in this cluster.
  NodeUpgradeProgressInfoList:
    type: array
    description: List of upgrading nodes and their statuses
    items:
      $ref: '#/definitions/NodeUpgradeProgressInfo'
  SafetyCheckKind:
    type: string
    description: The kind of safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state. Following are the kinds of safety checks.
    enum:
    - Invalid
    - EnsureSeedNodeQuorum
    - EnsurePartitionQuorum
    - WaitForPrimaryPlacement
    - WaitForPrimarySwap
    - WaitForReconfiguration
    - WaitForInbuildReplica
    - EnsureAvailability
    x-ms-enum:
      name: SafetyCheckKind
      modelAsString: true
      values:
      - value: Invalid
        description: Indicates that the upgrade safety check kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
      - value: EnsureSeedNodeQuorum
        description: Indicates that if we bring down the node then this will result in global seed node quorum loss. The value is 1.
      - value: EnsurePartitionQuorum
        description: Indicates that there is some partition for which if we bring down the replica on the node, it will result in quorum loss for that partition. The value is 2.
      - value: WaitForPrimaryPlacement
        description: Indicates that there is some replica on the node that was moved out of this node due to upgrade. Service Fabric is now waiting for the primary to be moved back to this node. The value is 3.
      - value: WaitForPrimarySwap
        description: Indicates that Service Fabric is waiting for a primary replica to be moved out of the node before starting upgrade on that node. The value is 4.
      - value: WaitForReconfiguration
        description: Indicates that there is some replica on the node that is involved in a reconfiguration. Service Fabric is waiting for the reconfiguration to be complete before staring upgrade on that node. The value is 5.
      - value: WaitForInbuildReplica
        description: Indicates that there is either a replica on the node that is going through copy, or there is a primary replica on the node that is copying data to some other replica. In both cases, bringing down the replica on the node due to upgrade will abort the copy. The value is 6.
      - value: EnsureAvailability
        description: Indicates that there is either a stateless service partition on the node having exactly one instance, or there is a primary replica on the node for which the partition is quorum loss. In both cases, bringing down the replicas due to upgrade will result in loss of availability. The value is 7.
  ApplicationHealthPolicy:
    description: Defines a health policy used to evaluate the health of an application or one of its children entities.
    properties:
      ConsiderWarningAsError:
        type: boolean
        description: Indicates whether warnings are treated with the same severity as errors.
        default: false
      MaxPercentUnhealthyDeployedApplications:
        type: integer
        description: 'The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100.

          The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error.

          This is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster.

          The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.'
        default: 0
      DefaultServiceTypeHealthPolicy:
        $ref: '#/definitions/ServiceTypeHealthPolicy'
        description: The health policy used by default to evaluate the health of a service type.
      ServiceTypeHealthPolicyMap:
        $ref: '#/definitions/ServiceTypeHealthPolicyMap'
        description: The map with service type health policy per service type name. The map is empty by default.
  ServiceTypeHealthPolicy:
    description: Represents the health policy used to evaluate the health of services belonging to a service type.
    properties:
      MaxPercentUnhealthyPartitionsPerService:
        type: integer
        description: 'The maximum allowed percentage of unhealthy partitions per service. Allowed values are Byte values from zero to 100


          The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error.

          If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning.

          The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service.

          The computation rounds up to tolerate one failure on small numbers of partitions. Default percentage is zero.'
        default: 0
      MaxPercentUnhealthyReplicasPerPartition:
        type: integer
        description: 'The maximum allowed percentage of unhealthy replicas per partition. Allowed values are Byte values from zero to 100.


          The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error.

          If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning.

          The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition.

          The computation rounds up to tolerate one failure on small numbers of replicas. Default percentage is zero.'
        default: 0
      MaxPercentUnhealthyServices:
        type: integer
        description: 'The maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100.


          The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error.

          If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning.

          This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type.

          The computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero.'
        default: 0
  NodeName:
    type: string
    description: The name of a Service Fabric node.
  ValidateClusterUpgradeResult:
    description: Specifies result of validating a cluster upgrade.
    properties:
      ServiceHostUpgradeImpact:
        $ref: '#/definitions/ServiceHostUpgradeImpact'
        description: The expected impact of the upgrade.
      ValidationDetails:
        type: string
        description: A string containing additional details for the Fabric upgrade validation result.
  NodeUpgradeDurationString:
    type: string
    description: The estimated time spent processing the node since it was deactivated during a node-by-node upgrade.
  CurrentUpgradeDomainProgressInfo:
    description: Information about the current in-progress upgrade domain. Not applicable to node-by-node upgrades.
    properties:
      DomainName:
        $ref: '#/definitions/UpgradeDomainName'
        description: The name of the upgrade domain
      NodeUpgradeProgressList:
        $ref: '#/definitions/NodeUpgradeProgressInfoList'
        description: List of upgrading nodes and their statuses
  ClusterVersion:
    description: The cluster version.
    properties:
      Version:
        type: string
        description: The Service Fabric cluster runtime version.
  ReplicaHealthStateChunk:
    description: 'Represents the health state chunk of a stateful service replica or a stateless service instance.

      The replica health state contains the replica ID and its aggregated health state.'
    allOf:
    - $ref: '#/definitions/EntityHealthStateChunk'
    properties:
      ReplicaOrInstanceId:
        $ref: '#/definitions/ReplicaOrInstanceId'
        description: Id of a stateful service replica or a stateless service instance. This ID is used in the queries that apply to both stateful and stateless services. It is used by Service Fabric to uniquely identify a replica of a partition of a stateful service or an instance of a stateless service partition. It is unique within a partition and does not change for the lifetime of the replica or the instance. If a stateful replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the ID. If a stateless instance is failed over on the same or different node it will get a different value for the ID.
  ClusterHealthPolicies:
    description: Health policies to evaluate cluster health.
    properties:
      ApplicationHealthPolicyMap:
        $ref: '#/definitions/ApplicationHealthPolicyMap'
        description: 'Defines a map that contains specific application health policies for different applications.

          Each entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health.

          If an application is not specified in the map, the application health evaluation uses the ApplicationHealthPolicy found in its application manifest or the default application health policy (if no health policy is defined in the manifest).

          The map is empty by default.'
      ClusterHealthPolicy:
        $ref: '#/definitions/ClusterHealthPolicy'
        description: Defines a health policy used to evaluate the health of the cluster or of a cluster node.
  NodeHealthStateChunkList:
    description: The list of node health state chunks in the cluster that respect the input filters in the chunk query. Returned by get cluster health state chunks query.
    allOf:
    - $ref: '#/definitions/EntityHealthStateChunkList'
    properties:
      Items:
        type: array
        items:
          $ref: '#/definitions/NodeHealthStateChunk'
        description: The list of node health state chunks that respect the input filters in the chunk query.
  UpdateClusterUpgradeDescription:
    description: Parameters for updating a cluster upgrade.
    properties:
      UpgradeKind:
        $ref: '#/definitions/UpgradeType'
        description: The type of upgrade out of the following possible values.
      UpdateDescription:
        $ref: '#/definitions/RollingUpgradeUpdateDescription'
        description: Describes the parameters for updating a rolling upgrade of application or cluster.
      ClusterHealthPolicy:
        $ref: '#/definitions/ClusterHealthPolicy'
        description: Defines a health policy used to evaluate the health of the cluster or of a cluster node.
      EnableDeltaHealthEvaluation:
        $ref: '#/definitions/DeltaHealthEvaluationBool'
        description: When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain.
      ClusterUpgradeHealthPolicy:
        $ref: '#/definitions/ClusterUpgradeHealthPolicyObject'
        description: Defines a health policy used to evaluate the health of the cluster during a cluster upgrade.
      ApplicationHealthPolicyMap:
        $ref: '#/definitions/ApplicationHealthPolicies'
        description: Defines the application health policy map used to evaluate the health of an application or one of its children entities.
  EntityHealthStateChunkList:
    description: A base type for the list of health state chunks found in the cluster. It contains the total number of health states that match the input filters.
    properties:
      TotalCount:
        type: integer
        format: int64
        description: Total number of entity health state objects that match the specified filters from the cluster health chunk query description.
  PartitionHealthStateChunkList:
    description: 'The list of partition health state chunks that respect the input filters in the chunk query description.

      Returned by get cluster health state chunks query as part of the parent application hierarchy.'
    properties:
      Items:
        type: array
        items:
          $ref: '#/definitions/PartitionHealthStateChunk'
        description: The list of partition health state chunks that respect the input filters in the chunk query.
  FabricCodeVersionInfo:
    description: Information about a Service Fabric code version.
    properties:
      CodeVersion:
        description: The product version of Service Fabric.
        type: string
  UpgradeDomainInfo:
    description: Information about an upgrade domain.
    properties:
      Name:
        $ref: '#/definitions/UpgradeDomainName'
        description: The name of the upgrade domain
      State:
        $ref: '#/definitions/UpgradeDomainState'
        description: The state of the upgrade domain.
  HealthEvaluation:
    discriminator: Kind
    description: Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity.
    properties:
      Kind:
        $ref: '#/definitions/HealthEvaluationKind'
        description: The health manager in the cluster performs health evaluations in determining the aggregated health state of an entity. This enumeration provides information on the kind of evaluation that was performed. Following are the possible values.
      AggregatedHealthState:
        $ref: '#/definitions/HealthState'
        description: The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
      Description:
        type: string
        description: Description of the health evaluation, which represents a summary of the evaluation process.
    required:
    - Kind
  UpgradeOrchestrationServiceState:
    description: Service state of Service Fabric Upgrade Orchestration Service.
    properties:
      ServiceState:
        type: string
        description: The state of Service Fabric Upgrade Orchestration Service.
  ServiceHealthStateChunk:
    description: Represents the health state chunk of a service, which contains the service name, its aggregated health state and any partitions that respect the filters in the cluster health chunk query description.
    allOf:
    - $ref: '#/definitions/EntityHealthStateChunk'
    properties:
      ServiceName:
        $ref: '#/definitions/ServiceName'
        description: The name of the service whose health state chunk is provided in this object.
      PartitionHealthStateChunks:
        $ref: '#/definitions/PartitionHealthStateChunkList'
        description: The list of partition health state chunks belonging to the service that respect the filters in the cluster health chunk query description.
  ClusterConfiguration:
    description: Information about the standalone cluster configuration.
    properties:
      ClusterConfiguration:
        type: string
        description: The contents of the cluster configuration file.
  ApplicationHealthPolicies:
    description: Defines the application health policy map used to evaluate the health of an application or one of its children entities.
    properties:
      ApplicationHealthPolicyMap:
        $ref: '#/definitions/ApplicationHealthPolicyMap'
        description: The wrapper that contains the map with application health policies used to evaluate specific applications in the cluster.
  ApplicationTypeHealthPolicyMap:
    type: array
    items:
      $ref: '#/definitions/ApplicationTypeHealthPolicyMapItem'
    description: 'Defines a map with max percentage unhealthy applications for specific application types.

      Each entry specifies as key the application type name and as value an integer that represents the MaxPercentUnhealthyApplications percentage used to evaluate the applications of the specified application type.


      The application type health policy map can be used during cluster health evaluation to describe special application types.

      The application types included in the map are evaluated against the percentage specified in the map, and not with the global MaxPercentUnhealthyApplications defined in the cluster health policy.

      The applications of application types specified in the map are not counted against the global pool of applications.

      For example, if some applications of a type are critical, the cluster administrator can add an entry to the map for that application type

      and assign it a value of 0% (that is, do not tolerate any failures).

      All other applications can be evaluated with MaxPercentUnhealthyApplications set to 20% to tolerate some failures out of the thousands of application instances.

      The application type health policy map is used only if the cluster manifest enables application type health evaluation using the configuration entry for HealthManager/EnableApplicationTypeHealthEvaluation.'
  SafetyCheck:
    discriminator: Kind
    description: Represents a safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state.
    properties:
      Kind:
        $ref: '#/definitions/SafetyCheckKind'
        description: The kind of safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state. Following are the kinds of safety checks.
    required:
    - Kind
  HealthEvent:
    description: Represents health information reported on a health entity, such as cluster, application or node, with additional metadata added by the Health Manager.
    allOf:
    - $ref: '#/definitions/HealthInformation'
    properties:
      IsExpired:
        type: boolean
        description: Returns true if the health event is expired, otherwise false.
      SourceUtcTimestamp:
        type: string
        format: date-time
        description: The date and time when the health report was sent by the source.
      LastModifiedUtcTimestamp:
        type: string
        format: date-time
        description: The date and time when the health report was last modified by the health store.
      LastOkTransitionAt:
        type: string
        format: date-time
        description: 'If the current health state is ''Ok'', this property returns the time at which the health report was first reported with ''Ok''.

          For periodic reporting, many reports with the same state may have been generated.

          This property returns the date and time when the first ''Ok'' health report was received.


          If the current health state is ''Error'' or ''Warning'', returns the date and time at which the health state was last in ''Ok'', before transitioning to a different state.


          If the health state was never ''Ok'', the value will be zero date-time.'
      LastWarningTransitionAt:
        type: string
        format: date-time
        description: 'If the current health state is ''Warning'', this property returns the time at which the health report was first reported with ''Warning''. For periodic reporting, many reports with the same state may have been generated however, this property returns only the date and time at the first ''Warning'' health report was received.


          If the current health state is ''Ok'' or ''Error'', returns the date and time at which the health state was last in ''Warning'', before transitioning to a different state.


          If the health state was never ''Warning'', the value will be zero date-time.'
      LastErrorTransitionAt:
        type: string
        format: date-time
        description: 'If the current health state is ''Error'', this property returns the time at which the health report was first reported with ''Error''. For periodic reporting, many reports with the same state may have been generated however, this property returns only the date and time at the first ''Error'' health report was received.


          If the current health state is ''Ok'' or ''Warning'', returns the date and time at which the health state was last in ''Error'', before transitioning to a different state.


          If the health state was never ''Error'', the value will be zero date-time.'
  NodeUpgradePhase:
    type: string
    description: The state of the upgrading node.
    enum:
    - Invalid
    - PreUpgradeSafetyCheck
    - Upgrading
    - PostUpgradeSafetyCheck
    x-ms-enum:
      name: NodeUpgradePhase
      modelAsString: true
      values:
      - value: Invalid
        description: Indicates the upgrade state is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
      - value: PreUpgradeSafetyCheck
        description: The upgrade has not started yet due to pending safety checks. The value is 1
      - value: Upgrading
        description: The upgrade is in progress. The value is 2
      - value: PostUpgradeSafetyCheck
        description: The upgrade has completed and post upgrade safety checks are being performed. The value is 3
  DeployedServicePackageHealthStateFilter:
    description: 'Defines matching criteria to determine whether a deployed service package should be included as a child of a deployed application in the cluster health chunk.

      The deployed service packages are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent deployed application and its parent application must be included in the cluster health chunk.

      One filter can match zero, one or multiple deployed service packages, depending on its properties.'
    properties:
      ServiceManifestNameFilter:
        type: string
        description: 'The name of the service manifest which identifies the deployed service packages that matches the filter.

          If specified, the filter is applied only to the specified deployed service packages, if any.

          If no deployed service packages with specified manifest name exist, nothing is returned in the cluster health chunk based on this filter.

          If any deployed service package exists, they are included in the cluster health chunk if it respects the other filter properties.

          If not specified, all deployed service packages that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter.'
      ServicePackageActivationIdFilter:
        type: string
        description: 'The activation ID of a deployed service package that matches the filter.

          If not specified, the filter applies to all deployed service packages that match the other parameters.

          If specified, the filter matches only the deployed service package with the specified activation ID.'
      HealthStateFilter:
        type: integer
        default: 0
        description: 'The filter for the health state of the deployed service packages. It allows selecting deployed service packages if they match the desired health states.

          The possible values are integer value of one of the following health states. Only deployed service packages that match the filter are returned. All deployed service packages are used to evaluate the parent deployed application aggregated health state.

          If not specified, default value is None, unless the deployed service package ID is specified. If the filter has default value and deployed service package ID is specified, the matching deployed service package is returned.

          The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise ''OR'' operator.

          For example, if the provided value is 6, it matches deployed service packages with HealthState value of OK (2) and Warning (4).


          - Default - Default value. Matches any HealthState. The value is zero.

          - None - Filter that doesn''t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.

          - Ok - Filter that matches input with HealthState value Ok. The value is 2.

          - Warning - Filter that matches input with HealthState value Warning. The value is 4.

          - Error - Filter that matches input with HealthState value Error. The value is 8.

          - All - Filter that matches input with any HealthState value. The value is 65535.'
  ServiceManifestName:
    type: string
    description: The name of the service manifest.
  ReplicaHealthStateChunkList:
    description: The list of replica health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.
    properties:
      Items:
        type: array
        items:
          $ref: '#/definitions/ReplicaHealthStateChunk'
        description: The list of replica health state chunks that respect the input filters in the chunk query.
  UnprovisionFabricDescription:
    description: Describes the parameters for unprovisioning a cluster.
    properties:
      CodeVersion:
        type: string
        description: The cluster code package version.
      ConfigVersion:
        type: string
        description: The cluster manifest version.
  EntityHealthStateChunk:
    description: A base type for the health state chunk of various entities in the cluster. It contains the aggregated health state.
    properties:
      HealthState:
        $ref: '#/definitions/HealthState'
        description: The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
  EntityHealth:
    description: Health information common to all entities in the cluster. It contains the aggregated health state, health events and unhealthy evaluation.
    properties:
      AggregatedHealthState:
        $ref: '#/definitions/HealthState'
        description: 'The HealthState representing the aggregated health state of the entity computed by Health Manager.

          The health evaluation of the entity reflects all events reported on the entity and its children (if any).

          The aggregation is done by applying the desired health policy.'
      HealthEvents:
        type: array
        items:
          $ref: '#/definitions/HealthEvent'
        description: The list of health events reported on the entity.
      UnhealthyEvaluations:
        $ref: '#/definitions/UnhealthyEvaluations'
        description: The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.
      HealthStatistics:
        $ref: '#/definitions/HealthStatistics'
        description: Shows the health statistics for all children types of the queried entity.
  HealthStatistics:
    description: 'The health statistics of an entity, returned as part of the health query result when the query description is configured to include statistics.

      The statistics include health state counts for all children types of the current entity.

      For example, for cluster, the health statistics include health state counts for nodes, applications, services, partitions, replicas, deployed applications and deployed service packages.

      For partition, the health statistics include health counts for replicas.'
    properties:
      HealthStateCountList:
        type: array
        items:
          $ref: '#/definitions/EntityKindHealthStateCount'
        description: List of health state counts per entity kind, which keeps track of how many children of the queried entity are in Ok, Warning and Error state.
  FailedUpgradeDomainProgressObject:
    description: The detailed upgrade progress for nodes in the current upgrade domain at the point of failure. Not applicable to node-by-node upgrades.
    properties:
      DomainName:
        $ref: '#/definitions/UpgradeDomainName'
        description: The name of the upgrade domain
      NodeUpgradeProgressList:
        $ref: '#/definitions/NodeUpgradeProgressInfoList'
        description: List of upgrading nodes and their statuses
  ClusterUpgradeDescriptionObject:
    description: Represents a ServiceFabric cluster upgrade
    properties:
      ConfigVersion:
        $ref: '#/definitions/ClusterFabricConfigVersionString'
        description: The cluster configuration version (specified in the cluster manifest).
      CodeVersion:
        $ref: '#/definitions/ClusterFabricCodeVersionString'
        description: The ServiceFabric code version of the cluster.
      UpgradeKind:
        $ref: '#/definitions/UpgradeKind'
        description: The kind of upgrade out of the following possible values.
      RollingUpgradeMode:
        $ref: '#/definitions/UpgradeMode'
        description: The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, Monitored, and UnmonitoredDeferred.
      UpgradeReplicaSetCheckTimeoutInSeconds:
        $ref: '#/definitions/UpgradeReplicaSetCheckTimeout'
        description: The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).
      ForceRestart:
        $ref: '#/definitions/ForceRestart'
        description: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).
      SortOrder:
        $ref: '#/definitions/UpgradeSortOrder'
        description: Defines the order in which an upgrade proceeds through the cluster.
      EnableDeltaHealthEvaluation:
        $ref: '#/definitions/DeltaHealthEvaluationBool'
        description: When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain.
      MonitoringPolicy:
        $ref: '#/definitions/MonitoringPolicyDescription'
        description: Describes the parameters for monitoring an upgrade in Monitored mode.
      ClusterHealthPolicy:
        $ref: '#/definitions/ClusterHealthPolicy'
        description: Defines a health policy used to evaluate the health of the cluster or of a cluster node.
      ClusterUpgradeHealthPolicy:
        $ref: '#/definitions/ClusterUpgradeHealthPolicyObject'
        description: Defines a health policy used to evaluate the health of the cluster during a cluster upgrade.
      ApplicationHealthPolicyMap:
        $ref: '#/definitions/ApplicationHealthPolicyMapObject'
        description: Represents the map of application health policies for a ServiceFabric cluster upgrade
  ServiceHostUpgradeImpact:
    type: string
    description: The expected impact of the upgrade.
    enum:
    - Invalid
    - None
    - ServiceHostRestart
    - UnexpectedServiceHostRestart
    x-ms-enum:
      name: ServiceHostUpgradeImpact
      modelAsString: true
      values:
      - value: Invalid
        description: Indicates the upgrade impact is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
      - value: None
        description: The upgrade is not expected to cause service host restarts. The value is 1.
      - value: ServiceHostRestart
        description: The upgrade is expected to cause a service host restart. The value is 2.
      - value: UnexpectedServiceHostRestart
        description: The upgrade will cause an unexpected service host restart. This indicates a bug in the Service Fabric runtime and proceeding with an upgrade with this impact may lead to skipped safety checks. Running the upgrade with the ForceRestart flag will force proper safety checks. The value is 3.
  EntityHealthState:
    description: A base type for the health state of various entities in the cluster. It contains the aggregated health state.
    properties:
      AggregatedHealthState:
        $ref: '#/definitions/HealthState'
        description: The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
  ForceRestart:
    type: boolean
    description: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).
    default: false
  InstanceCloseDelayDurationInSeconds:
    type: integer
    format: int64
    description: 'Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster

      upgrade, only for those instances which have a non-zero delay duration configured in the service description. See InstanceCloseDelayDurationSeconds property in $ref: "#/definitions/StatelessServiceDescription.yaml" for details.

      Note, the default value of InstanceCloseDelayDurationInSeconds is 4294967295, which indicates that the behavior will entirely depend on the delay configured in the stateless service description.'
    default: 4294967295
  ClusterHealthChunkQueryDescription:
    description: The cluster health chunk query description, which can specify the health policies to evaluate cluster health and very expressive filters to select which cluster entities to include in response.
    properties:
      NodeFilters:
        type: array
        items:
          $ref: '#/definitions/NodeHealthStateFilter'
        description: 'Defines a list of filters that specify which nodes to be included in the returned cluster health chunk.

          If no filters are specified, no nodes are returned. All the nodes are used to evaluate the cluster''s aggregated health state, regardless of the input filters.

          The cluster health chunk query may specify multiple node filters.

          For example, it can specify a filter to return all nodes with health state Error and another filter to always include a node identified by its NodeName.'
      ApplicationFilters:
        type: array
        items:
          $ref: '#/definitions/ApplicationHealthStateFilter'
        description: 'Defines a list of filters that specify which applications to be included in the returned cluster health chunk.

          If no filters are specified, no applications are returned. All the applications are used to evaluate the cluster''s aggregated health state, regardless of the input filters.

          The cluster health chunk query may specify multiple application filters.

          For example, it can specify a filter to return all applications with health state Error and another filter to always include applications of a specified application type.'
      ClusterHealthPolicy:
        $ref: '#/definitions/ClusterHealthPolicy'
        description: Defines a health policy used to evaluate the health of the cluster or of a cluster node.
      ApplicationHealthPolicies:
        $ref: '#/definitions/ApplicationHealthPolicies'
        description: Defines the application health policy map used to evaluate the health of an application or one of its children entities.
  UpgradeUnitName:
    type: string
    description: The name of the upgrade unit
  HealthCheckRetryTimeout:
    type: string
    description: The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
    default: PT0H10M0S
  CurrentUpgradeUnitsProgressInfo:
    description: Information about the current in-progress upgrade units.
    properties:
      DomainName:
        $ref: '#/definitions/CurrentUpgradeDomainName'
        description: The name of the upgrade domain. Not applicable to node-by-node upgrades.
      NodeUpgradeProgressList:
        $ref: '#/definitions/NodeUpgradeProgressInfoList'
        description: List of upgrading nodes and their statuses
  ClusterHealthChunk:
    description: 'Represents the health chunk of the cluster.

      Contains the cluster aggregated health state, and the cluster entities that respect the input filter.'
    properties:
      HealthState:
        $ref: '#/definitions/HealthState'
        description: 'The HealthState representing the aggregated health state of the cluster computed by Health Manager.

          The health evaluation of the entity reflects all events reported on the entity and its children (if any).

          The aggregation is done by applying the desired cluster health policy and the application health policies.'
      NodeHealthStateChunks:
        $ref: '#/definitions/NodeHealthStateChunkList'
        description: The list of node health state chunks in the cluster that respect the filters in the cluster health chunk query description.
      ApplicationHealthStateChunks:
        $ref: '#/definitions/ApplicationHealthStateChunkList'
        description: The list of application health state chunks in the cluster that respect the filters in the cluster health chunk query description.
  UpgradeUnitInfo:
    description: Information about an upgrade unit.
    properties:
      Name:
        $ref: '#/definitions/UpgradeUnitName'
        description: The name of the upgrade unit
      State:
        $ref: '#/definitions/UpgradeUnitState'
        description: The state of the upgrade unit.
  UpgradeDurationString:
    type: string
    description: The estimated elapsed time spent processing the current overall upgrade.
  FailureAction:
    type: string
    description: 'The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations.

      Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically.

      Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode.'
    enum:
    - Invalid
    - Rollback
    - Manual
    x-ms-enum:
      name: FailureAction
      modelAsString: true
      values:
      - value: Invalid
        description: Indicates the failure action is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
      - value: Rollback
        description: The upgrade will start rolling back automatically. The value is 1
      - value: Manual
        description: The upgrade will switch to UnmonitoredManual upgrade mode. The value is 2
  SafetyCheckInfoList:
    type: array
    description: List of pending safety checks
    items:
      $ref: '#/definitions/SafetyCheckWrapper'
  UpgradeDomainState:
    type: string
    description: The state of the upgrade domain.
    enum:
    - Invalid
    - Pending
    - InProgress
    - Completed
    x-ms-enum:
      name: UpgradeDomainState
      modelAsString: true
      values:
      - value: Invalid
        description: Indicates the upgrade domain state is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
      - value: Pending
        description: The upgrade domain has not started upgrading yet. The value is 1
      - value: InProgress
        description: The upgrade domain is being upgraded but not complete yet. The value is 2
      - value: Completed
        description: The upgrade domain has completed upgrade. The value is 3
  ClusterManifest:
    description: Information about the cluster manifest.
    properties:
      Manifest:
        type: string
        description: The contents of the cluster manifest file.
  ClusterUpgradeProgressObject:
    description: Information about a cluster upgrade.
    properties:
      CodeVersion:
        $ref: '#/definitions/ClusterFabricCodeVersionString'
        description: The ServiceFabric code version of the cluster.
      ConfigVersion:
        $ref: '#/definitions/ClusterFabricConfigVersionString'
        description: The cluster configuration version (specified in the cluster manifest).
      UpgradeDomains:
        $ref: '#/definitions/UpgradeDomainInfoList'
        description: List of upgrade domains and their statuses. Not applicable to node-by-node upgrades.
      UpgradeUnits:
        $ref: '#/definitions/UpgradeUnitInfoList'
        description: List of upgrade units and their statuses.
      UpgradeState:
        $ref: '#/definitions/UpgradeState'
        description: The state of the upgrade domain.
      NextUpgradeDomain:
        $ref: '#/definitions/NextUpgradeDomain'
        description: The name of the next upgrade domain to be processed. Not applicable to node-by-node upgrades.
      RollingUpgradeMode:
        $ref: '#/definitions/UpgradeMode'
        description: The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, Monitored, and UnmonitoredDeferred.
      UpgradeDescription:
        $ref: '#/definitions/ClusterUpgradeDescriptionObject'
        description: Represents a ServiceFabric cluster upgrade
      UpgradeDurationInMilliseconds:
        $ref: '#/definitions/UpgradeDurationString'
        description: The estimated elapsed time spent processing the current overall upgrade.
      UpgradeDomainDurationInMilliseconds:
        $ref: '#/definitions/UpgradeDomainDurationString'
        description: The estimated elapsed time spent processing the current upgrade domain. Not applicable to node-by-node upgrades.
      UnhealthyEvaluations:
        $ref: '#/definitions/UnhealthyEvaluations'
        description: List of health evaluations that resulted in the current aggregated health state.
      CurrentUpgradeDomainProgress:
        $ref: '#/definitions/CurrentUpgradeDomainProgressInfo'
        description: Information about the current in-progress upgrade domain. Not applicable to node-by-node upgrades.
      CurrentUpgradeUnitsProgress:
        $ref: '#/definitions/CurrentUpgradeUnitsProgressInfo'
        description: Information about the current in-progress upgrade units.
      StartTimestampUtc:
        $ref: '#/definitions/UpgradeStartTimeUTCString'
        description: The start time of the upgrade in UTC.
      FailureTimestampUtc:
        $ref: '#/definitions/UpgradeFailureTimeUTCString'
        description: The failure time of the upgrade in UTC.
      FailureReason:
        $ref: '#/definitions/FailureReason'
        description: The cause of an upgrade failure that resulted in FailureAction being executed.
      UpgradeDomainProgressAtFailure:
        $ref: '#/definitions/FailedUpgradeDomainProgressObject'
        description: The detailed upgrade progress for nodes in the current upgrade domain at the point of failure. Not applicable to node-by-node upgrades.
      IsNodeByNode:
        type: boolean
        description: Indicates whether this upgrade is node-by-node.
        default: false
  ServiceHealthStateChunkList:
    description: The list of service health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.
    properties:
      Items:
        type: array
        items:
          $ref: '#/definitions/ServiceHealthStateChunk'
        description: The list of service health state chunks that respect the input filters in the chunk query.
  ServiceHealthStateFilter:
    description: 'Defines matching criteria to determine whether a service should be included as a child of an application in the cluster health chunk.

      The services are only returned if the parent application matches a filter specified in the cluster health chunk query description.

      One filter can match zero, one or multiple services, depending on its properties.'
    properties:
      ServiceNameFilter:
        type: string
        description: 'The name of the service that matches the filter. The filter is applied only to the specified service, if it exists.

          If the service doesn''t exist, no service is returned in the cluster health chunk based on this filter.

          If the service exists, it is included as the application''s child if the health state matches the other filter properties.

          If not specified, all services that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter.'
      HealthStateFilter:
        type: integer
        default: 0
        description: 'The filter for the health state of the services. It allows selecting services if they match the desired health states.

          The possible values are integer value of one of the following health states. Only services that match the filter are returned. All services are used to evaluate the cluster aggregated health state.

          If not specified, default value is None, unless the service name is specified. If the filter has default value and service name is specified, the matching service is returned.

          The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise ''OR'' operator.

          For example, if the provided value is 6, it matches services with HealthState value of OK (2) and Warning (4).


          - Default - Default value. Matches any HealthState. The value is zero.

          - None - Filter that doesn''t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.

          - Ok - Filter that matches input with HealthState value Ok. The value is 2.

          - Warning - Filter that matches input with HealthState value Warning. The value is 4.

          - Error - Filter that matches input with HealthState value Error. The value is 8.

          - All - Filter that matches input with any HealthState value. The value is 65535.'
      PartitionFilters:
        type: array
        items:
          $ref: '#/definitions/PartitionHealthStateFilter'
        description: 'Defines a list of filters that specify which partitions to be included in the returned cluster health chunk as children of the service. The partitions are returned only if the parent service matches a filter.

          If the list is empty, no partitions are returned. All the partitions are used to evaluate the parent service aggregated health state, regardless of the input filters.

          The service filter may specify multiple partition filters.

          For example, it can specify a filter to return all partitions with health state Error and another filter to always include a partition identified by its partition ID.'
  UpgradeReplicaSetCheckTimeout:
    type: integer
    format: int64
    description: The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).
    default: 42949672925
  ClusterUpgradeHealthPolicyObject:
    description: Defines a health policy used to evaluate the health of the cluster during a cluster upgrade.
    properties:
      MaxPercentDeltaUnhealthyNodes:
        type: integer
        description: The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. The default value is 10%.
        maximum: 100
        minimum: 0
      MaxPercentUpgradeDomainDeltaUnhealthyNodes:
        type: integer
        description: The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. The default value is 15%.
        maximum: 100
        minimum: 0
  EntityKindHealthStateCount:
    description: Represents health state count for entities of the specified entity kind.
    properties:
      EntityKind:
        $ref: '#/definitions/EntityKind'
        description: The entity kind for which health states are evaluated.
      HealthStateCount:
        $ref: '#/definitions/HealthStateCount'
        description: The health state count for the entities of the specified kind.
  ClusterHealthPolicy:
    description: Defines a health policy used to evaluate the health of the cluster or of a cluster node.
    properties:
      ConsiderWarningAsError:
        type: boolean
        description: Indicates whether warnings are treated with the same severity as errors.
        default: false
      MaxPercentUnhealthyNodes:
        type: integer
        description: 'The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10.


          The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error.

          If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning.

          The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster.

          The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.


          In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that.'
        default: 0
      MaxPercentUnhealthyApplications:
        type: integer
        description: 'The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10.


          The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error.

          If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning.

          This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap.

          The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero.'
        default: 0
      ApplicationTypeHealthPolicyMap:
        $ref: '#/definitions/ApplicationTypeHealthPolicyMap'
        description: 'Defines a map with max percentage unhealthy applications for specific application types.

          Each entry specifies as key the application type name and as value an integer that represents the MaxPercentUnhealthyApplications percentage used to evaluate the applications of the specified application type.


          The application type health policy map can be used during cluster health evaluation to describe special application types.

          The application types included in the map are evaluated against the percentage specified in the map, and not with the global MaxPercentUnhealthyApplications defined in the cluster health policy.

          The applications of application types specified in the map are not counted against the global pool of applications.

          For example, if some applications of a type are critical, the cluster administrator can add an entry to the map for that application type

          and assign it a value of 0% (that is, do not tolerate any failures).

          All other applications can be evaluated with MaxPercentUnhealthyApplications set to 20% to tolerate some failures out of the thousands of application instances.

          The application type health policy map is used only if the cluster manifest enables application type health evaluation using the configuration entry for HealthManager/EnableApplicationTypeHealthEvaluation.'
      NodeTypeHealthPolicyMap:
        $ref: '#/definitions/NodeTypeHealthPolicyMap'
        description: "Defines a map with max percentage unhealthy nodes for specific node types.\nEach entry specifies as key the node type name and as value an integer that represents the MaxPercentUnhealthyNodes percentage used to evaluate the nodes of the specified node type.\n\nThe node type health policy map can be used during cluster health evaluation to describe special node types. \nThey are evaluated against the percentages associated with their node type name in the map. \nSetting this has no impact on the global pool of nodes used for MaxPercentUnhealthyNodes. \nThe node type health policy map is used only if the cluster manifest enables node type health evaluation using the configuration entry for HealthManager/EnableNodeTypeHealthEvaluation.\n\nFor example, given a cluster with many nodes of different types, with important work hosted on node type \"SpecialNodeType\" that should not tolerate any nodes down. \nYou can specify global MaxPercentUnhealthyNodes to 20% to tolerate some failures for all nodes, but for the node type \"SpecialNodeType\", set the MaxPercentUnhealthyNodes to 0 by \nsetting the value in the key value pair in NodeTypeHealthPolicyMapItem. The key is the node type name. \nThis way, as long as no nodes of type \"SpecialNodeType\" are in Error state, \neven if some of the many nodes in the global pool are in Error state, but below the global unhealthy percentage, the cluster would be evaluated to Warning. \nA Warning health state does not impact cluster upgrade or other monitoring triggered by Error health state. \nBut even one node of type SpecialNodeType in Error would make cluster unhealthy (in Error rather than Warning/Ok), which triggers rollback or pauses the cluster upgrade, depending on the upgrade configuration. \n\nConversely, setting the global MaxPercentUnhealthyNodes to 0, and setting SpecialNodeType's max percent unhealthy nodes to 100, \nwith one node of type SpecialNodeType in Error state would still put the cluster in an Error state, since the global restriction is more strict in this case."
  DeployedServicePackageHealthStateChunkList:
    description: The list of deployed service package health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.
    properties:
      Items:
        type: array
        items:
          $ref: '#/definitions/DeployedServicePackageHealthStateChunk'
        description: The list of deployed service package health state chunks that respect the input filters in the chunk query.
  PartitionId:
    type: string
    format: uuid
    description: An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different.
  ClusterFabricCodeVersionString:
    type: string
    description: The ServiceFabric code version of the cluster.
  ClusterConfigurationUpgradeStatusInfo:
    description: Information about a standalone cluster configuration upgrade status.
    properties:
      UpgradeState:
        $ref: '#/definitions/UpgradeState'
        description: The state of the upgrade domain.
      ProgressStatus:
        type: integer
        description: The cluster manifest version.
      ConfigVersion:
        type: string
        description: The cluster configuration version.
      Details:
        type: string
        description: The cluster upgrade status details.
  HealthEvaluationKind:
    type: string
    description: The health manager in the cluster performs health evaluations in determining the aggregated health state of an entity. This enumeration provides information on the kind of evaluation that was performed. Following are the possible values.
    enum:
    - Invalid
    - Event
    - Replicas
    - Partitions
    - DeployedServicePackages
    - DeployedApplications
    - Services
    - Nodes
    - Applications
    - SystemApplication
    - UpgradeDomainDeployedApplications
    - UpgradeDomainNodes
    - Replica
    - Partition
    - DeployedServicePackage
    - DeployedApplication
    - Service
    - Node
    - Application
    - DeltaNodesCheck
    - UpgradeDomainDeltaNodesCheck
    - ApplicationTypeApplications
    - NodeTypeNodes
    x-ms-enum:
      name: HealthEvaluationKind
      modelAsString: true
      values:
      - value: Invalid
        description: Indicates that the health evaluation is invalid. The value is zero.
      - value: Event
        description: Indicates that the health evaluation is for a health event. The value is 1.
      - value: Replicas
        description: Indicates that the health evaluation is for the replicas of a partition. The value is 2.
      - value: Partitions
        description: Indicates that the health evaluation is for the partitions of a service. The value is 3.
      - value: DeployedServicePackages
        description: Indicates that the health evaluation is for the deployed service packages of a deployed application. The value is 4.
      - value: DeployedApplications
        description: Indicates that the health evaluation is for the deployed applications of an application. The value is 5.
      - value: Services
        description: Indicates that the health evaluation is for services of an application. The value is 6.
      - value: Nodes
        description: Indicates that the health evaluation is for the cluster nodes. The value is 7.
      - value: Applications
        description: Indicates that the health evaluation is for the cluster applications. The value is 8.
      - value: SystemApplication
        description: Indicates that the health evaluation is for the system application. The value is 9.
      - value: UpgradeDomainDeployedApplications
        description: Indicates that the health evaluation is for the deployed applications of an application in an upgrade domain. The value is 10.
      - value: UpgradeDomainNodes
        description: Indicates that the health evaluation is for the cluster nodes in an upgrade domain. The value is 11.
      - value: Replica
        description: Indicates that the health evaluation is for a replica. The value is 13.
      - value: Partition
        description: Indicates that the health evaluation is for a partition. The value is 14.
      - value: DeployedServicePackage
        description: Indicates that the health evaluation is for a deployed service package. The value is 16.
      - value: DeployedApplication
        description: Indicates that the health evaluation is for a deployed application. The value is 17.
      - value: Service
        description: Indicates that the health evaluation is for a service. The value is 15.
      - value: Node
        description: Indicates that the health evaluation is for a node. The value is 12.
      - value: Application
        description: Indicates that the health evaluation is for an application. The value is 18.
      - value: DeltaNodesCheck
        description: Indicates that the health evaluation is for the delta of unhealthy cluster nodes. The value is 19.
      - value: UpgradeDomainDeltaNodesCheck
        description: Indicates that the health evaluation is for the delta of unhealthy upgrade domain cluster nodes. The value is 20.
      - value: ApplicationTypeApplications
        description: – Indicates that the health evaluation is for applications of an application type. The value is 21.
      - value: NodeTypeNodes
        description: – Indicates that the health evaluation is for nodes of a node type. The value is 22.
  ApplicationHealthPolicyMapItem:
    description: Defines an item in ApplicationHealthPolicyMap.
    required:
    - Key
    - Value
    properties:
      Key:
        $ref: '#/definitions/ApplicationName'
        description: The key of the application health policy map item. This is the name of the application.
      Value:
        $ref: '#/definitions/ApplicationHealthPolicy'
        description: The value of the application health policy map item. This is the ApplicationHealthPolicy for this application.
  UpgradeSortOrder:
    type: string
    description: Defines the order in which an upgrade proceeds through the cluster.
    enum:
    - Invalid
    - Default
    - Numeric
    - Lexicographical
    - ReverseNumeric
    - ReverseLexicographical
    default: Default
    x-ms-enum:
      name: UpgradeSortOrder
      modelAsString: true
      values:
      - value: Invalid
        description: Indicates that this sort order is not valid. All Service Fabric enumerations have the invalid type. The value is 0.
      - value: Default
        description: Indicates that the default sort order (as specified in cluster manifest) will be used. The value is 1.
      - value: Numeric
        description: Indicates that forward numeric sort order (UD names sorted as numbers) will be used. The value is 2.
      - value: Lexicographical
        description: Indicates that forward lexicographical sort order (UD names sorted as strings) will be used. The value is 3.
      - value: ReverseNumeric
        description: Indicates that reverse numeric sort order (UD names sorted as numbers) will be used. The value is 4.
      - value: ReverseLexicographical
        description: Indicates that reverse lexicographical sort order (UD names sorted as strings) will be used. The value is 5.
  PartitionHealthStateChunk:
    description: Represents the health state chunk of a partition, which contains the partition ID, its aggregated health state and any replicas that respect the filters in the cluster health chunk query description.
    allOf:
    - $ref: '#/definitions/EntityHealthStateChunk'
    properties:
      PartitionId:
        $ref: '#/definitions/PartitionId'
        description: The Id of the partition.
      ReplicaHealthStateChunks:
        $ref: '#/definitions/ReplicaHealthStateChunkList'
        description: The list of replica health state chunks belonging to the partition that respect the filters in the cluster health chunk query description.
  ServiceTypeHealthPolicyMap:
    type: array
    items:
      $ref: '#/definitions/ServiceTypeHealthPolicyMapItem'
    description: 'Defines a ServiceTypeHealthPolicy per service type name.


      The entries in the map replace the default service type health policy for each specified service type. For example, in an application that contains both a stateless gateway service type and a stateful engine service type, the health policies for the stateless and stateful services can be configured differently. With policy per service type, there''s more granular control of the health of the service.


      If no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation.'
  ServiceName:
    type: string
    description: The full name of the service with 'fabric:' URI scheme.
  ApplicationHealthStateChunk:
    description: 'Represents the health state chunk of a application.

      The application health state chunk contains the application name, its aggregated health state and any children services and deployed applications that respect the filters in cluster health chunk query description.'
    allOf:
    - $ref: '#/definitions/EntityHealthStateChunk'
    properties:
      ApplicationName:
        $ref: '#/definitions/ApplicationName'
        description: The name of the application, including the 'fabric:' URI scheme.
      ApplicationTypeName:
        $ref: '#/definitions/ApplicationTypeName'
        description: The application type name as defined in the application manifest.
      ServiceHealthStateChunks:
        $ref: '#/definitions/ServiceHealthStateChunkList'
        description: The list of service health state chunks in the cluster that respect the filters in the cluster health chunk query description.
      DeployedApplicationHealthStateChunks:
        $ref: '#/definitions/DeployedApplicationHealthStateChunkList'
        description: The list of deployed application health state chunks in the cluster that respect the filters in the cluster health chunk query description.
  UpgradeDomainTimeout:
    type: string
    description: The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
    default: P10675199DT02H48M05.4775807S
  UpgradeOrchestrationServiceStateSummary:
    description: Service state summary of Service Fabric Upgrade Orchestration Service.
    properties:
      CurrentCodeVersion:
        type: string
        description: The current code version of the cluster.
      CurrentManifestVersion:
        type: string
        description: The current manifest version of the cluster.
      TargetCodeVersion:
        type: string
        description: The target code version of  the cluster.
      TargetManifestVersion:
        type: string
        description: The target manifest version of the cluster.
      PendingUpgradeType:
        type: string
        description: The type of the pending upgrade of the cluster.
  UpgradeType:
    type: string
    description: The type of upgrade out of the following possible values.
    default: Rolling
    enum:
    - Invalid
    - Rolling
    - Rolling_ForceRestart
    x-ms-enum:
      name: UpgradeType
      modelAsString: true
      values:
      - value: Invalid
        description: Indicates the upgrade kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
      - value: Rolling
        description: The upgrade progresses one upgrade domain at a time. The value is 1.
      - value: Rolling_ForceRestart
        description: The upgrade gets restarted by force. The value is 2.
  FabricError:
    description: The REST API operations for Service Fabric return standard HTTP status codes. This type defines the additional information returned from the Service Fabric API operations that are not successful.
    properties:
      Error:
        $ref: '#/definitions/FabricErrorError'
        description: Error object containing error code and error message.
    required:
    - Error
  ProvisionFabricDescription:
    description: Describes the parameters for provisioning a cluster.
    properties:
      CodeFilePath:
        type: string
        description: The cluster code package file path.
      ClusterManifestFilePath:
        type: string
        description: The cluster manifest file path.
  ClusterFabricConfigVersionString:
    type: string
    description: The cluster configuration version (specified in the cluster manifest).
  UpgradeUnitState:
    type: string
    description: The state of the upgrade unit.
    enum:
    - Invalid
    - Pending
    - InProgress
    - Completed
    - Failed
    x-ms-enum:
      name: UpgradeUnitState
      modelAsString: true
      values:
      - value: Invalid
        description: Indicates the upgrade unit state is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
      - value: Pending
        description: The upgrade unit has not started upgrading yet. The value is 1
      - value: InProgress
        description: The upgrade unit is being upgraded but not complete yet. The value is 2
      - value: Completed
        description: The upgrade unit has completed upgrade. The value is 3
      - value: Failed
        description: The upgrade unit has failed to upgrade. The value is 4
  RollingUpgradeUpdateDescription:
    description: Describes the parameters for updating a rolling upgrade of application or cluster.
    properties:
      RollingUpgradeMode:
        $ref: '#/definitions/UpgradeMode'
        description: The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, Monitored, and UnmonitoredDeferred.
      ForceRestart:
        $ref: '#/definitions/ForceRestart'
        description: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).
      ReplicaSetCheckTimeoutInMilliseconds:
        $ref: '#/definitions/UpgradeReplicaSetCheckTimeout'
        description: The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).
      FailureAction:
        $ref: '#/definitions/FailureAction'
        description: 'The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations.

          Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically.

          Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode.'
      HealthCheckWaitDurationInMilliseconds:
        $ref: '#/definitions/HealthCheckWaitDuration'
        description: The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
      HealthCheckStableDurationInMilliseconds:
        $ref: '#/definitions/HealthCheckStableDuration'
        description: The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
      HealthCheckRetryTimeoutInMilliseconds:
        $ref: '#/definitions/HealthCheckRetryTimeout'
        description: The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
      UpgradeTimeoutInMilliseconds:
        $ref: '#/definitions/UpgradeTimeout'
        description: The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
      UpgradeDomainTimeoutInMilliseconds:
        $ref: '#/definitions/UpgradeDomainTimeout'
        description: The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
      InstanceCloseDelayDurationInSeconds:
        $ref: '#/definitions/InstanceCloseDelayDurationInSeconds'
        description: 'Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster

          upgrade, only for those instances which have a non-zero delay duration configured in the service description. See InstanceCloseDelayDurationSeconds property in $ref: "#/definitions/StatelessServiceDescription.yaml" for details.

          Note, the default value of InstanceCloseDelayDurationInSeconds is 4294967295, which indicates that the behavior will entirely depend on the delay configured in the stateless service description.'
    required:
    - RollingUpgradeMode
  PartitionHealthStateFilter:
    description: 'Defines matching criteria to determine whether a partition should be included as a child of a service in the cluster health chunk.

      The partitions are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent service and application must be included in the cluster health chunk.

      One filter can match zero, one or multiple partitions, depending on its properties.'
    properties:
      PartitionIdFilter:
        type: string
        format: uuid
        description: 'ID of the partition that matches the filter. The filter is applied only to the specified partition, if it exists.

          If the partition doesn''t exist, no partition is returned in the cluster health chunk based on this filter.

          If the partition exists, it is included in the cluster health chunk if it respects the other filter properties.

          If not specified, all partitions that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter.'
      HealthStateFilter:
        type: integer
        default: 0
        description: 'The filter for the health state of the partitions. It allows selecting partitions if they match the desired health states.

          The possible values are integer value of one of the following health states. Only partitions that match the filter are returned. All partitions are used to evaluate the cluster aggregated health state.

          If not specified, default value is None, unless the partition ID is specified. If the filter has default value and partition ID is specified, the matching partition is returned.

          The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise ''OR'' operator.

          For example, if the provided value is 6, it matches partitions with HealthState value of OK (2) and Warning (4).


          - Default - Default value. Matches any HealthState. The value is zero.

          - None - Filter that doesn''t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.

          - Ok - Filter that matches input with HealthState value Ok. The value is 2.

          - Warning - Filter that matches input with HealthState value Warning. The value is 4.

          - Error - Filter that matches input with HealthState value Error. The value is 8.

          - All - Filter that matches input with any HealthState value. The value is 65535.'
      ReplicaFilters:
        type: array
        items:
          $ref: '#/definitions/ReplicaHealthStateFilter'
        description: 'Defines a list of filters that specify which replicas to be included in the returned cluster health chunk as children of the parent partition. The replicas are returned only if the parent partition matches a filter.

          If the list is empty, no replicas are returned. All the replicas are used to evaluate the parent partition aggregated health state, regardless of the input filters.

          The partition filter may specify multiple replica filters.

          For example, it can specify a filter to return all replicas with health state Error and another filter to always include a replica identified by its replica id.'
  UpgradeMode:
    type: string
    description: The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, Monitored, and UnmonitoredDeferred.
    enum:
    - Invalid
    - UnmonitoredAuto
    - UnmonitoredManual
    - Monitored
    - UnmonitoredDeferred
    default: UnmonitoredAuto
    x-ms-enum:
      name: UpgradeMode
      modelAsString: true
      values:
      - value: Invalid
        description: Indicates the upgrade mode is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
      - value: UnmonitoredAuto
        description: The upgrade will proceed automatically without performing any health monitoring. The value is 1
      - value: UnmonitoredManual
        description: The upgrade will stop after completing each upgrade domain, giving the opportunity to manually monitor health before proceeding. The value is 2
      - value: Monitored
        description: The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. The value is 3
      - value: UnmonitoredDeferred
        description: Perform a node-by-node upgrade. No action is performed when upgrade starts; upgrade is applied on each node when it is deactivated with intent restart or higher. The value is 4
  ApplicationTypeHealthPolicyMapItem:
    description: Defines an item in ApplicationTypeHealthPolicyMap.
    required:
    - Key
    - Value
    properties:
      Key:
        type: string
        description: The key of the application type health policy map item. This is the name of the application type.
      Value:
        type: integer
        description: 'The value of the application type health policy map item.

          The max percent unhealthy applications allowed for the application type. Must be between zero and 100.'
  DeployedApplicationHealthStateChunk:
    description: Represents the health state chunk of a deployed application, which contains the node where the application is deployed, the aggregated health state and any deployed service packages that respect the chunk query description filters.
    allOf:
    - $ref: '#/definitions/EntityHealthStateChunk'
    properties:
      NodeName:
        type: string
        description: The name of node where the application is deployed.
      DeployedServicePackageHealthStateChunks:
        $ref: '#/definitions/DeployedServicePackageHealthStateChunkList'
        description: The list of deployed service package health state chunks belonging to the deployed application that respect the filters in the cluster health chunk query description.
  MonitoringPolicyDescription:
    description: Describes the parameters for monitoring an upgrade in Monitored mode.
    properties:
      FailureAction:
        $ref: '#/definitions/FailureAction'
        description: 'The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations.

          Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically.

          Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode.'
      HealthCheckWaitDurationInMilliseconds:
        $ref: '#/definitions/HealthCheckWaitDuration'
        description: The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
      HealthCheckStableDurationInMilliseconds:
        $ref: '#/definitions/HealthCheckStableDuration'
        description: The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
      HealthCheckRetryTimeoutInMilliseconds:
        $ref: '#/definitions/HealthCheckRetryTimeout'
        description: The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
      UpgradeTimeoutInMilliseconds:
        $ref: '#/definitions/UpgradeTimeout'
        description: The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
      UpgradeDomainTimeoutInMilliseconds:
        $ref: '#/definitions/UpgradeDomainTimeout'
        description: The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
  NodeId:
    description: An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name.
    properties:
      Id:
        type: string
        description: Value of the node Id. This is a 128 bit integer.
  ServicePackageActivationId:
    type: string
    description: 'The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service

      is ''SharedProcess'' (or if it is not specified, in which case it defaults to ''SharedProcess''), then value of ServicePackageActivationId

      is always an empty string.'
  ApplicationHealthPolicyMap:
    type: array
    items:
      $ref: '#/definitions/ApplicationHealthPolicyMapItem'
    description: 'Defines a map that contains specific application health policies for different applications.

      Each entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health.

      If an application is not specified in the map, the application health evaluation uses the ApplicationHealthPolicy found in its application manifest or the default application health policy (if no health policy is defined in the manifest).

      The map is empty by default.'
  HealthCheckWaitDuration:
    type: string
    description: The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
    default: '0'
  UpgradeFailureTimeUTCString:
    type: string
    description: The failure time of the upgrade in UTC.
  ReplicaOrInstanceId:
    type: string
    description: Id of a stateful service replica or a stateless service instance. This ID is used in the queries that apply to both stateful and stateless services. It is used by Service Fabric to uniquely identify a replica of a partition of a stateful service or an instance of a stateless service partition. It is unique within a partition and does not change for the lifetime of the replica or the instance. If a stateful replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the ID. If a stateless instance is failed over on the same or different node it will get a different value for the ID.
  DeployedApplicationHealthStateChunkList:
    description: The list of deployed application health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.
    properties:
      Items:
        type: array
        items:
          $ref: '#/definitions/DeployedApplicationHealthStateChunk'
        description: The list of deployed application health state chunks that respect the input filters in the chunk query.
  FabricConfigVersionInfoList:
    type: array
    items:
      $ref: '#/definitions/FabricConfigVersionInfo'
    description: List of all Service Fabric config versions.
  UpgradeDomainName:
    type: string
    description: The name of the upgrade domain
  FabricConfigVersionInfo:
    description: Information about a Service Fabric config version.
    properties:
      ConfigVersion:
        description: The config version of Service Fabric.
        type: string
  UpgradeUnitInfoList:
    type: array
    description: List of upgrade units and their statuses.
    items:
      $ref: '#/definitions/UpgradeUnitInfo'
  UpgradeKind:
    type: string
    description: The kind of upgrade out of the following possible values.
    default: Rolling
    enum:
    - Invalid
    - Rolling
    x-ms-enum:
      name: UpgradeKind
      modelAsString: true
      values:
      - value: Invalid
        description: Indicates the upgrade kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
      - value: Rolling
        description: The upgrade progresses one upgrade domain at a time. The value is 1
  NodeTypeHealthPolicyMap:
    type: array
    items:
      $ref: '#/definitions/NodeTypeHealthPolicyMapItem'
    description: "Defines a map with max percentage unhealthy nodes for specific node types.\nEach entry specifies as key the node type name and as value an integer that represents the MaxPercentUnhealthyNodes percentage used to evaluate the nodes of the specified node type.\n\nThe node type health policy map can be used during cluster health evaluation to describe special node types. \nThey are evaluated against the percentages associated with their node type name in the map. \nSetting this has no impact on the global pool of nodes used for MaxPercentUnhealthyNodes. \nThe node type health policy map is used only if the cluster manifest enables node type health evaluation using the configuration entry for HealthManager/EnableNodeTypeHealthEvaluation.\n\nFor example, given a cluster with many nodes of different types, with important work hosted on node type \"SpecialNodeType\" that should not tolerate any nodes down. \nYou can specify global MaxPercentUnhealthyNodes to 20% to tolerate some failures for all nodes, but for the node type \"SpecialNodeType\", set the MaxPercentUnhealthyNodes to 0 by \nsetting the value in the key value pair in NodeTypeHealthPolicyMapItem. The key is the node type name. \nThis way, as long as no nodes of type \"SpecialNodeType\" are in Error state, \neven if some of the many nodes in the global pool are in Error state, but below the global unhealthy percentage, the cluster would be evaluated to Warning. \nA Warning health state does not impact cluster upgrade or other monitoring triggered by Error health state. \nBut even one node of type SpecialNodeType in Error would make cluster unhealthy (in Error rather than Warning/Ok), which triggers rollback or pauses the cluster upgrade, depending on the upgrade configuration. \n\nConversely, setting the global MaxPercentUnhealthyNodes to 0, and setting SpecialNodeType's max percent unhealthy nodes to 100, \nwith one node of type SpecialNodeType in Error state would still put the cluster in an Error state, since the global restriction is more strict in this case."
  ApplicationName:
    type: string
    description: The name of the application, including the 'fabric:' URI scheme.
  ServiceTypeHealthPolicyMapItem:
    description: Defines an item in ServiceTypeHealthPolicyMap.
    required:
    - Key
    - Value
    properties:
      Key:
        type: string
        description: The key of the service type health policy map item. This is the name of the service type.
      Value:
        $ref: '#/definitions/ServiceTypeHealthPolicy'
        description: The value of the service type health policy map item. This is the ServiceTypeHealthPolicy for this service type.
  NodeHealthState:
    description: Represents the health state of a node, which contains the node identifier and its aggregated health state.
    allOf:
    - $ref: '#/definitions/EntityHealthState'
    properties:
      Name:
        $ref: '#/definitions/NodeName'
        description: The name of a Service Fabric node.
      Id:
        $ref: '#/definitions/NodeId'
        description: An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name.
  UpgradeDomainDurationString:
    type: string
    description: The estimated elapsed time spent processing the current upgrade domain. Not applicable to node-by-node upgrades.
  ResumeClusterUpgradeDescription:
    description: Describes the parameters for resuming a cluster upgrade.
    properties:
      UpgradeDomain:
        type: string
        description: The next upgrade domain for this cluster upgrade.
    required:
    - UpgradeDomain
  ApplicationHealthPolicyMapObject:
    description: Represents the map of application health policies for a ServiceFabric cluster upgrade
    properties:
      ApplicationHealthPolicyMap:
        $ref: '#/definitions/ApplicationHealthPolicyMap'
        description: 'Defines a map that contains specific application health policies for different applications.

          Each entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health.

          If an application is not specified in the map, the application health evaluation uses the ApplicationHealthPolicy found in its application manifest or the default application health policy (if no health policy is defined in the manifest).

          The map is empty by default.'
  NodeUpgradeProgressInfo:
    description: Information about the upgrading node and its status
    properties:
      NodeName:
        $ref: '#/definitions/NodeName'
        description: The name of a Service Fabric node.
      UpgradePhase:
        $ref: '#/definitions/NodeUpgradePhase'
        description: The state of the upgrading node.
      PendingSafetyChecks:
        $ref: '#/definitions/SafetyCheckInfoList'
        description: List of pending safety checks
      UpgradeDuration:
        $ref: '#/definitions/NodeUpgradeDurationString'
        description: The estimated time spent processing the node since it was deactivated during a node-by-node upgrade.
  ReplicaHealthStateFilter:
    description: 'Defines matching criteria to determine whether a replica should be included as a child of a partition in the cluster health chunk.

      The replicas are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent partition, service and application must be included in the cluster health chunk.

      One filter can match zero, one or multiple replicas, depending on its properties.'
    properties:
      ReplicaOrInstanceIdFilter:
        type: string
        description: 'Id of the stateful service replica or stateless service instance that matches the filter. The filter is applied only to the specified replica, if it exists.

          If the replica doesn''t exist, no replica is returned in the cluster health chunk based on this filter.

          If the replica exists, it is included in the cluster health chunk if it respects the other filter properties.

          If not specified, all replicas that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter.'
      HealthStateFilter:
        type: integer
        default: 0
        description: 'The filter for the health state of the replicas. It allows selecting replicas if they match the desired health states.

          The possible values are integer value of one of the following health states. Only replicas that match the filter are returned. All replicas are used to evaluate the parent partition aggregated health state.

          If not specified, default value is None, unless the replica ID is specified. If the filter has default value and replica ID is specified, the matching replica is returned.

          The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise ''OR'' operator.

          For example, if the provided value is 6, it matches replicas with HealthState value of OK (2) and Warning (4).


          - Default - Default value. Matches any HealthState. The value is zero.

          - None - Filter that doesn''t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.

          - Ok - Filter that matches input with HealthState value Ok. The value is 2.

          - Warning - Filter that matches input with HealthState value Warning. The value is 4.

          - Error - Filter that matches input with HealthState value Error. The value is 8.

          - All - Filter that matches input with any HealthState value. The value is 65535.'
  StartClusterUpgradeDescription:
    description: Describes the parameters for starting a cluster upgrade.
    properties:
      CodeVersion:
        type: string
        description: The cluster code version.
      ConfigVersion:
        type: string
        description: The cluster configuration version.
      UpgradeKind:
        $ref: '#/definitions/UpgradeKind'
        description: The kind of upgrade out of the following possible values.
      RollingUpgradeMode:
        $ref: '#/definitions/UpgradeMode'
        description: The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, Monitored, and UnmonitoredDeferred.
      UpgradeReplicaSetCheckTimeoutInSeconds:
        $ref: '#/definitions/UpgradeReplicaSetCheckTimeout'
        description: The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).
      ForceRestart:
        $ref: '#/definitions/ForceRestart'
        description: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).
      SortOrder:
        $ref: '#/definitions/UpgradeSortOrder'
        description: Defines the order in which an upgrade proceeds through the cluster.
      MonitoringPolicy:
        $ref: '#/definitions/MonitoringPolicyDescription'
        description: Describes the parameters for monitoring an upgrade in Monitored mode.
      ClusterHealthPolicy:
        $ref: '#/definitions/ClusterHealthPolicy'
        description: Defines a health policy used to evaluate the health of the cluster or of a cluster node.
      EnableDeltaHealthEvaluation:
        type: boolean
        description: When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain.
      ClusterUpgradeHealthPolicy:
        $ref: '#/definitions/ClusterUpgradeHealthPolicyObject'
        description: Defines a health policy used to evaluate the health of the cluster during a cluster upgrade.
      ApplicationHealthPolicyMap:
        $ref: '#/definitions/ApplicationHealthPolicies'
        description: Defines the application health policy map used to evaluate the health of an application or one of its children entities.
      InstanceCloseDelayDurationInSeconds:
        $ref: '#/definitions/InstanceCloseDelayDurationInSeconds'
        description: 'Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster

          upgrade, only for those instances which have a non-zero delay duration configured in the service description. See InstanceCloseDelayDurationSeconds property in $ref: "#/definitions/StatelessServiceDescription.yaml" for details.

          Note, the default value of InstanceCloseDelayDurationInSeconds is 4294967295, which indicates that the behavior will entirely depend on the delay configured in the stateless service description.'
  ApplicationHealthStateChunkList:
    description: The list of application health state chunks in the cluster that respect the input filters in the chunk query. Returned by get cluster health state chunks query.
    allOf:
    - $ref: '#/definitions/EntityHealthStateChunkList'
    properties:
      Items:
        type: array
        items:
          $ref: '#/definitions/ApplicationHealthStateChunk'
        description: The list of application health state chunks that respect the input filters in the chunk query.
  NodeTypeHealthPolicyMapItem:
    description: Defines an item in NodeTypeHealthPolicyMap.
    required:
    - Key
    - Value
    properties:
      Key:
        type: string
        description: The key of the node type health policy map item. This is the name of the node type.
      Value:
        type: integer
        description: "The value of the node type health policy map item.\nIf the percentage is respected but there is at least one unhealthy node in the node type, the health is evaluated as Warning. \nThe percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the node type. \nThe computation rounds up to tolerate one failure on small numbers of nodes.\nThe max percent unhealthy nodes allowed for the node type. Must be between zero and 100."
  NextUpgradeDomain:
    type: string
    description: The name of the next upgrade domain to be processed. Not applicable to node-by-node upgrades.
  HealthCheckStableDuration:
    type: string
    description: The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
    default: PT0H2M0S
  UpgradeTimeout:
    type: string
    description: The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
    default: P10675199DT02H48M05.4775807S
  ApplicationHealthState:
    description: Represents the health state of an application, which contains the application identifier and the aggregated health state.
    allOf:
    - $ref: '#/definitions/EntityHealthState'
    properties:
      Name:
        $ref: '#/definitions/ApplicationName'
        description: The name of the application, including the 'fabric:' URI scheme.
  UpgradeState:
    type: string
    description: The state of the upgrade domain.
    enum:
    - Invalid
    - RollingBackInProgress
    - RollingBackCompleted
    - RollingForwardPending
    - RollingForwardInProgress
    - RollingForwardCompleted
    - Failed
    x-ms-enum:
      name: UpgradeState
      modelAsString: true
      values:
      - value: Invalid
        description: Indicates the upgrade state is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
      - value: RollingBackInProgress
        description: The upgrade is rolling back to the previous version but is not complete yet. The value is 1
      - value: RollingBackCompleted
        description: The upgrade has finished rolling back. The value is 2
      - value: RollingForwardPending
        description: The current upgrade domain has finished upgrading. The overall upgrade is waiting for an explicit move next request in UnmonitoredManual mode or performing health checks in Monitored mode. The value is 3
      - value: RollingForwardInProgress
        description: The upgrade is rolling forward to the target version but is not complete yet. The value is 4
      - value: RollingForwardCompleted
        description: The upgrade has finished rolling forward. The value is 5
      - value: Failed
        description: The upgrade has failed and is unable to execute FailureAction. The value is 6
  AadMetadataObject:
    description: Azure Active Directory metadata object used for secured connection to cluster.
    properties:
      type:
        type: string
        description: The client authentication method.
      metadata:
        $ref: '#/definitions/AadMetadata'
        description: Azure Active Directory metadata used for secured connection to cluster.
  DeployedServicePackageHealthStateChunk:
    description: Represents the health state chunk of a deployed service package, which contains the service manifest name and the service package aggregated health state.
    allOf:
    - $ref: '#/definitions/EntityHealthStateChunk'
    properties:
      ServiceManifestName:
        $ref: '#/definitions/ServiceManifestName'
        description: The name of the service manifest.
      ServicePackageActivationId:
        $ref: '#/definitions/ServicePackageActivationId'
        description: 'The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service

          is ''SharedProcess'' (or if it is not specified, in which case it defaults to ''SharedProcess''), then value of ServicePackageActivationId

          is always an empty string.'
  DeployedApplicationHealthStateFilter:
    description: 'Defines matching criteria to determine whether a deployed application should be included as a child of an application in the cluster health chunk.

      The deployed applications are only returned if the parent application matches a filter specified in the cluster health chunk query description.

      One filter can match zero, one or multiple deployed applications, depending on its properties.'
    properties:
      NodeNameFilter:
        type: string
        description: 'The name of the node where the application is deployed in order to match the filter.

          If specified, the filter is applied only to the application deployed on the specified node.

          If the application is not deployed on the node with the specified name, no deployed application is returned in the cluster health chunk based on this filter.

          Otherwise, the deployed application is included in the cluster health chunk if it respects the other filter properties.

          If not specified, all deployed applications that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter.'
      HealthStateFilter:
        type: integer
        default: 0
        description: 'The filter for the health state of the deployed applications. It allows selecting deployed applications if they match the desired health states.

          The possible values are integer value of one of the following health states. Only deployed applications that match the filter are returned. All deployed applications are used to evaluate the cluster aggregated health state.

          If not specified, default value is None, unless the node name is specified. If the filter has default value and node name is specified, the matching deployed application is returned.

          The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise ''OR'' operator.

          For example, if the provided value is 6, it matches deployed applications with HealthState value of OK (2) and Warning (4).


          - Default - Default value. Matches any HealthState. The value is zero.

          - None - Filter that doesn''t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.

          - Ok - Filter that matches input with HealthState value Ok. The value is 2.

          - Warning - Filter that matches input with HealthState value Warning. The value is 4.

          - Error - Filter that matches input with HealthState value Error. The value is 8.

          - All - Filter that matches input with any HealthState value. The value is 65535.'
      DeployedServicePackageFilters:
        type: array
        items:
          $ref: '#/definitions/DeployedServicePackageHealthStateFilter'
        description: 'Defines a list of filters that specify which deployed service packages to be included in the returned cluster health chunk as children of the parent deployed application. The deployed service packages are returned only if the parent deployed application matches a filter.

          If the list is empty, no deployed service packages are returned. All the deployed service packages are used to evaluate the parent deployed application aggregated health state, regardless of the input filters.

          The deployed application filter may specify multiple deployed service package filters.

          For example, it can specify a filter to return all deployed service packages with health state Error and another filter to always include a deployed service package on a node.'
  AadMetadata:
    description: Azure Active Directory metadata used for secured connection to cluster.
    properties:
      authority:
        type: string
        description: The AAD authority url.
      client:
        type: string
        description: The AAD client application Id.
      cluster:
        type: string
        description: The AAD cluster application Id.
      login:
        type: string
        description: The AAD login url.
      redirect:
        type: string
        description: The client application redirect address.
      tenant:
        type: string
        description: The AAD tenant Id.
  EntityKind:
    type: string
    description: The entity type of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
    enum:
    - Invalid
    - Node
    - Partition
    - Service
    - Application
    - Replica
    - DeployedApplication
    - DeployedServicePackage
    - Cluster
    x-ms-enum:
      name: EntityKind
      modelAsString: true
      values:
      - value: Invalid
        description: Indicates an invalid entity kind. All Service Fabric enumerations have the invalid type. The value is zero.
      - value: Node
        description: Indicates the entity is a Service Fabric node. The value is 1.
      - value: Partition
        description: Indicates the entity is a Service Fabric partition. The value is 2.
      - value: Service
        description: Indicates the entity is a Service Fabric service. The value is 3.
      - value: Application
        description: Indicates the entity is a Service Fabric application. The value is 4.
      - value: Replica
        description: Indicates the entity is a Service Fabric replica. The value is 5.
      - value: DeployedApplication
        description: Indicates the entity is a Service Fabric deployed application. The value is 6.
      - value: DeployedServicePackage
        description: Indicates the entity is a Service Fabric deployed service package. The value is 7.
      - value: Cluster
        description: Indicates the entity is a Service Fabric cluster. The value is 8.
  ClusterConfigurationUpgradeDescription:
    description: Describes the parameters for a standalone cluster configuration upgrade.
    properties:
      ClusterConfig:
        type: string
        description: The cluster configuration as a JSON string. For example, [this file](https://github.com/Azure-Samples/service-fabric-dotnet-standalone-cluster-configuration/blob/master/Samples/ClusterConfig.Unsecure.DevCluster.json) contains JSON describing the [nodes and other properties of the cluster](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-manifest).
      HealthCheckRetryTimeout:
        type: string
        format: duration
        description: The length of time between attempts to perform health checks if the application or cluster is not healthy.
        default: PT0H0M0S
      HealthCheckWaitDurationInSeconds:
        type: string
        format: duration
        description: The length of time to wait after completing an upgrade domain before starting the health checks process.
        default: PT0H0M0S
      HealthCheckStableDurationInSeconds:
        type: string
        format: duration
        description: The length of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain.
        default: PT0H0M0S
      UpgradeDomainTimeoutInSeconds:
        type: string
        format: duration
        description: The timeout for the upgrade domain.
        default: PT0H0M0S
      UpgradeTimeoutInSeconds:
        type: string
        format: duration
        description: The upgrade timeout.
        default: PT0H0M0S
      MaxPercentUnhealthyApplications:
        type: integer
        description: The maximum allowed percentage of unhealthy applications during the upgrade. Allowed values are integer values from zero to 100.
        default: 0
      MaxPercentUnhealthyNodes:
        type: integer
        description: The maximum allowed percentage of unhealthy nodes during the upgrade. Allowed values are integer values from zero to 100.
        default: 0
      MaxPercentDeltaUnhealthyNodes:
        type: integer
        description: The maximum allowed percentage of delta health degradation during the upgrade. Allowed values are integer values from zero to 100.
        default: 0
      MaxPercentUpgradeDomainDeltaUnhealthyNodes:
        type: integer
        description: The maximum allowed percentage of upgrade domain delta health degradation during the upgrade. Allowed values are integer values from zero to 100.
        default: 0
      ApplicationHealthPolicies:
        $ref: '#/definitions/ApplicationHealthPolicies'
        description: Defines the application health policy map used to evaluate the health of an application or one of its children entities.
    required:
    - ClusterConfig
  UpgradeStartTimeUTCString:
    type: string
    description: The start time of the upgrade in UTC.
  DeltaHealthEvaluationBool:
    type: boolean
    description: When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain.
parameters:
  ProvisionFabricDescriptionRequiredBodyParam:
    name: ProvisionFabricDescription
    in: body
    description: Describes the parameters for provisioning a cluster.
    required: true
    x-ms-parameter-location: method
    schema:
      $ref: '#/definitions/ProvisionFabricDescription'
  IncludeSystemApplicationHealthStatisticsOptionalQueryParam:
    name: IncludeSystemApplicationHealthStatistics
    description: 'Indicates whether the health statistics should include the fabric:/System application health statistics. False by default.

      If IncludeSystemApplicationHealthStatistics is set to true, the health statistics include the entities that belong to the fabric:/System application.

      Otherwise, the query result includes health statistics only for user applications.

      The health statistics must be included in the query result for this parameter to be applied.'
    in: query
    x-ms-parameter-location: method
    type: boolean
    required: false
    default: false
  ApiVersion_6-4_RequiredQueryParam:
    name: api-version
    in: query
    x-ms-parameter-location: method
    type: string
    enum:
    - '6.4'
    required: true
    default: '6.4'
    description: 'The version of the API. This parameter is required and its value must be ''6.4''.


      Service Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.


      Additionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.'
    x-ms-enum:
      name: ApiVersion_6-4_RequiredQueryParam
      modelAsString: true
      values:
      - value: '6.4'
        description: The 6.4 version of the API.
  ClusterHealthPoliciesOptionalBodyParam:
    name: ClusterHealthPolicies
    in: body
    description: 'Describes the health policies used to evaluate the cluster health.

      If not present, the health evaluation uses the cluster health policy defined in the cluster manifest or the default cluster health policy.

      By default, each application is evaluated using its specific application health policy, defined in the application manifest, or the default health policy, if no policy is defined in manifest.

      If the application health policy map is specified, and it has an entry for an application, the specified application health policy

      is used to evaluate the application health.'
    required: false
    x-ms-parameter-location: method
    schema:
      $ref: '#/definitions/ClusterHealthPolicies'
  TimeoutOptionalQueryParam:
    name: timeout
    in: query
    x-ms-parameter-location: method
    type: integer
    format: int64
    required: false
    minimum: 1
    maximum: 4294967295
    default: 60
    description: The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.
  ExcludeHealthStatisticsOptionalQueryParam:
    name: ExcludeHealthStatistics
    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.'
    in: query
    x-ms-parameter-location: method
    type: boolean
    required: false
    default: false
  VerboseServicePlacementHealthReportingParam:
    name: Enabled
    in: query
    x-ms-parameter-location: method
    type: boolean
    required: true
    description: The verbosity of service placement health reporting.
  ApplicationsHealthStateFilterOptionalQueryParam:
    name: ApplicationsHealthStateFilter
    description: 'Allows filtering of the application health state objects returned in the result of cluster health

      query based on their health state.

      The possible values for this parameter include integer value obtained from members or bitwise operations

      on members of HealthStateFilter enumeration. Only applications that match the filter are returned.

      All applications are used to evaluate the aggregated health state. If not specified, all entries are returned.

      The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise ''OR'' operator.

      For example, if the provided value is 6 then health state of applications with HealthState value of OK (2) and Warning (4) are returned.


      - Default - Default value. Matches any HealthState. The value is zero.

      - None - Filter that doesn''t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.

      - Ok - Filter that matches input with HealthState value Ok. The value is 2.

      - Warning - Filter that matches input with HealthState value Warning. The value is 4.

      - Error - Filter that matches input with HealthState value Error. The value is 8.

      - All - Filter that matches input with any HealthState value. The value is 65535.'
    in: query
    x-ms-parameter-location: method
    type: integer
    required: false
    default: 0
  HealthInformationRequiredBodyParam:
    name: HealthInformation
    in: body
    description: Describes the health information for the health report. This information needs to be present in all of the health reports sent to the health manager.
    required: true
    x-ms-parameter-location: method
    schema:
      $ref: '#/definitions/HealthInformation'
  ConfigurationApiVersionRequiredQueryParam:
    name: ConfigurationApiVersion
    in: query
    x-ms-parameter-location: method
    type: string
    required: true
    description: The API version of the Standalone cluster json configuration.
  NodesHealthStateFilterOptionalQueryParam:
    name: NodesHealthStateFilter
    description: 'Allows filtering of the node health state objects returned in the result of cluster health query

      based on their health state. The possible values for this parameter include integer value of one of the

      following health states. Only nodes that match the filter are returned. All nodes are used to evaluate the aggregated health state.

      If not specified, all entries are returned.

      The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise ''OR'' operator.

      For example, if the provided value is 6 then health state of nodes with HealthState value of OK (2) and Warning (4) are returned.


      - Default - Default value. Matches any HealthState. The value is zero.

      - None - Filter that doesn''t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.

      - Ok - Filter that matches input with HealthState value Ok. The value is 2.

      - Warning - Filter that matches input with HealthState value Warning. The value is 4.

      - Error - Filter that matches input with HealthState value Error. The value is 8.

      - All - Filter that matches input with any HealthState value. The value is 65535.'
    in: query
    x-ms-parameter-location: method
    type: integer
    required: false
    default: 0
  ClusterConfigurationUpgradeDescriptionRequiredBodyParam:
    name: ClusterConfigurationUpgradeDescription
    in: body
    description: Parameters for a standalone cluster configuration upgrade.
    required: true
    x-ms-parameter-location: method
    schema:
      $ref: '#/definitions/ClusterConfigurationUpgradeDescription'
  CodeVersionOptionalQueryParam:
    name: CodeVersion
    in: query
    x-ms-parameter-location: method
    type: string
    required: false
    description: The product version of Service Fabric.
  ClusterHealthChunkQueryDescriptionOptionalBodyParam:
    name: ClusterHealthChunkQueryDescription
    in: body
    description: 'Describes the cluster and application health policies used to evaluate the cluster health and the filters to select which cluster entities to be returned.

      If the cluster health policy is present, it is used to evaluate the cluster events and the cluster nodes. If not present, the health evaluation uses the cluster health policy defined in the cluster manifest or the default cluster health policy.

      By default, each application is evaluated using its specific application health policy, defined in the application manifest, or the default health policy, if no policy is defined in manifest.

      If the application health policy map is specified, and it has an entry for an application, the specified application health policy

      is used to evaluate the application health.

      Users can specify very flexible filters to select which cluster entities to include in response. The selection can be done based on the entities health state and based on the hierarchy.

      The query can return multi-level children of the entities based on the specified filters. For example, it can return one application with a specified name, and for this application, return

      only services that are in Error or Warning, and all partitions and replicas for one of these services.'
    required: false
    x-ms-parameter-location: method
    schema:
      $ref: '#/definitions/ClusterHealthChunkQueryDescription'
  StartClusterUpgradeDescriptionRequiredBodyParam:
    name: StartClusterUpgradeDescription
    in: body
    description: Describes the parameters for starting a cluster upgrade.
    required: true
    x-ms-parameter-location: method
    schema:
      $ref: '#/definitions/StartClusterUpgradeDescription'
  ResumeClusterUpgradeDescriptionRequiredBodyParam:
    name: ResumeClusterUpgradeDescription
    in: body
    description: Describes the parameters for resuming a cluster upgrade.
    required: true
    x-ms-parameter-location: method
    schema:
      $ref: '#/definitions/ResumeClusterUpgradeDescription'
  UpdateClusterUpgradeDescriptionRequiredBodyParam:
    name: UpdateClusterUpgradeDescription
    in: body
    description: Parameters for updating a cluster upgrade.
    required: true
    x-ms-parameter-location: method
    schema:
      $ref: '#/definitions/UpdateClusterUpgradeDescription'
  ImmediateOptionalQueryParam:
    name: Immediate
    in: query
    x-ms-parameter-location: method
    type: boolean
    required: false
    default: false
    description: 'A flag that indicates whether the report should be sent immediately.

      A health report is sent to a Service Fabric gateway Application, which forwards to the health store.

      If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using.

      This is useful for critical reports that should be sent as soon as possible.

      Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn''t reach the Gateway.

      If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration.

      This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing.

      By default, reports are not sent immediately.'
  ApiVersion_8-2_RequiredQueryParam:
    name: api-version
    in: query
    x-ms-parameter-location: method
    type: string
    enum:
    - '8.2'
    required: true
    default: '8.2'
    description: 'The version of the API. This parameter is required and its value must be ''8.2''.


      Service Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.


      Additionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.'
    x-ms-enum:
      name: ApiVersion_8-2_RequiredQueryParam
      modelAsString: true
      values:
      - value: '8.2'
        description: The 8.2 version of the API.
  ConfigVersionOptionalQueryParam:
    name: ConfigVersion
    in: query
    x-ms-parameter-location: method
    type: string
    required: false
    description: The config version of Service Fabric.
  UnprovisionFabricDescriptionRequiredBodyParam:
    name: UnprovisionFabricDescription
    in: body
    description: Describes the parameters for unprovisioning a cluster.
    required: true
    x-ms-parameter-location: method
    schema:
      $ref: '#/definitions/UnprovisionFabricDescription'
  EventsHealthStateFilterOptionalQueryParam:
    name: EventsHealthStateFilter
    description: 'Allows filtering the collection of HealthEvent objects returned based on health state.

      The possible values for this parameter include integer value of one of the following health states.

      Only events that match the filter are returned. All events are used to evaluate the aggregated health state.

      If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise ''OR'' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned.


      - Default - Default value. Matches any HealthState. The value is zero.

      - None - Filter that doesn''t match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.

      - Ok - Filter that matches input with HealthState value Ok. The value is 2.

      - Warning - Filter that matches input with HealthState value Warning. The value is 4.

      - Error - Filter that matches input with HealthState value Error. The value is 8.

      - All - Filter that matches input with any HealthState value. The value is 65535.'
    in: query
    x-ms-parameter-location: method
    type: integer
    required: false
    default: 0
  UpgradeOrchestrationServiceStateRequiredBodyParam:
    name: UpgradeOrchestrationServiceState
    in: body
    x-ms-parameter-location: method
    required: true
    description: Service state of Service Fabric Upgrade Orchestration Service.
    schema:
      $ref: '#/definitions/UpgradeOrchestrationServiceState'
  ApiVersion_6-0_RequiredQueryParam:
    name: api-version
    in: query
    x-ms-parameter-location: method
    type: string
    enum:
    - '6.0'
    required: true
    default: '6.0'
    description: 'The version of the API. This parameter is required and its value must be ''6.0''.


      Service Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.


      Additionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.'
    x-ms-enum:
      name: ApiVersion_6-0_RequiredQueryParam
      modelAsString: true
      values:
      - value: '6.0'
        description: The 6.0 version of the API.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'