swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Replica API
schemes:
- https
tags:
- name: Replica
paths:
  /Partitions/{partitionId}/$/GetReplicas:
    get:
      summary: Microsoft Azure Gets The Information About Replicas Of A Service Fabric Service Partition
      description: The GetReplicas endpoint returns information about the replicas of the specified partition. The response includes the ID, role, status, health, node name, uptime, and other details about the replica.
      operationId: microsoftAzureGetreplicainfolist
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/PartitionIdRequiredPathParam'
      - $ref: '#/parameters/ContinuationTokenOptionalQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Replica
      responses:
        '200':
          description: Information about the replicas of the specified partition.
          schema:
            $ref: '#/definitions/PagedReplicaInfoList'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Partitions/{partitionId}/$/GetReplicas/{replicaId}:
    get:
      summary: Microsoft Azure Gets The Information About A Replica Of A Service Fabric Partition
      description: The response includes the ID, role, status, health, node name, uptime, and other details about the replica.
      operationId: microsoftAzureGetreplicainfo
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/PartitionIdRequiredPathParam'
      - $ref: '#/parameters/ReplicaIdRequiredPathParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Replica
      responses:
        '200':
          description: Information about the specified replicas of the specified partition of a Service Fabric service.
          schema:
            $ref: '#/definitions/ReplicaInfo'
        '204':
          description: An empty response is returned if the specified replicaId is not a replica of the specified partition.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetHealth:
    get:
      operationId: microsoftAzureGetreplicahealth
      summary: Microsoft Azure Gets The Health Of A Service Fabric Stateful Service Replica Or Stateless Service Instance
      description: Gets the health of a Service Fabric replica.<br>Use EventsHealthStateFilter to filter the collection of health events reported on the replica based on the health state.
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/PartitionIdRequiredPathParam'
      - $ref: '#/parameters/ReplicaIdRequiredPathParam'
      - $ref: '#/parameters/EventsHealthStateFilterOptionalQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Replica
      responses:
        '200':
          description: A successful operation will return 200 status code and the requested replica health.
          schema:
            $ref: '#/definitions/ReplicaHealth'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
    post:
      operationId: microsoftAzureGetreplicahealthusingpolicy
      summary: Microsoft Azure Gets The Health Of A Service Fabric Stateful Service Replica Or Stateless Service Instance Using The Specified Policy
      description: Gets the health of a Service Fabric stateful service replica or stateless service instance.<br>Use EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state.<br>Use ApplicationHealthPolicy to optionally override the health policies used to evaluate the health. This API only uses 'ConsiderWarningAsError' field of the ApplicationHealthPolicy. The rest of the fields are ignored while evaluating the health of the replica.
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/PartitionIdRequiredPathParam'
      - $ref: '#/parameters/ReplicaIdRequiredPathParam'
      - $ref: '#/parameters/EventsHealthStateFilterOptionalQueryParam'
      - $ref: '#/parameters/ApplicationHealthPolicyOptionalBodyParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Replica
      responses:
        '200':
          description: A successful operation will return 200 status code and the requested replica health information.
          schema:
            $ref: '#/definitions/ReplicaHealth'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/ReportHealth:
    post:
      operationId: microsoftAzureReportreplicahealth
      summary: Microsoft Azure Sends A Health Report On The Service Fabric Replica
      description: Reports health state of the specified Service Fabric replica. 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 Replica, 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 GetReplicaHealth and check that the report appears in the HealthEvents section.
      tags:
      - Replica
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/PartitionIdRequiredPathParam'
      - $ref: '#/parameters/ReplicaIdRequiredPathParam'
      - $ref: '#/parameters/ReplicaHealthReportServiceKindRequiredQueryParam'
      - $ref: '#/parameters/HealthInformationRequiredBodyParam'
      - $ref: '#/parameters/ImmediateOptionalQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 200 status code.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetReplicas:
    get:
      operationId: microsoftAzureGetdeployedservicereplicainfolist
      summary: Microsoft Azure Gets The List Of Replicas Deployed On A Service Fabric Node
      description: Gets the list containing the information about replicas deployed on a Service Fabric node. The information include partition ID, replica ID, status of the replica, name of the service, name of the service type, and other information. Use PartitionId or ServiceManifestName query parameters to return information about the deployed replicas matching the specified values for those parameters.
      tags:
      - Replica
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/NodeNameRequiredPathParam'
      - $ref: '#/parameters/ApplicationIdRequiredPathParam'
      - $ref: '#/parameters/PartitionIdOptionalQueryParam'
      - $ref: '#/parameters/ServiceManifestNameOptionalQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 200 status code and the list of deployed service replica information.
          schema:
            $ref: '#/definitions/DeployedServiceReplicaInfoList'
        '204':
          description: An empty response is returned if the specified applicationId is not found on the specified node. An empty response is also returned if there are no replicas matching the specified filter values for PartitionId or ServiceManifestName query parameters.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetDetail:
    get:
      operationId: microsoftAzureGetdeployedservicereplicadetailinfo
      summary: Microsoft Azure Gets The Details Of Replica Deployed On A Service Fabric Node
      description: Gets the details of the replica deployed on a Service Fabric node. The information includes service kind, service name, current service operation, current service operation start date time, partition ID, replica/instance ID, reported load, and other information.
      tags:
      - Replica
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/NodeNameRequiredPathParam'
      - $ref: '#/parameters/PartitionIdRequiredPathParam'
      - $ref: '#/parameters/ReplicaIdRequiredPathParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 200 status code and the list of deployed service replica information.
          schema:
            $ref: '#/definitions/DeployedServiceReplicaDetailInfo'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas:
    get:
      operationId: microsoftAzureGetdeployedservicereplicadetailinfobypartitionid
      summary: Microsoft Azure Gets The Details Of Replica Deployed On A Service Fabric Node
      description: Gets the details of the replica deployed on a Service Fabric node. The information includes service kind, service name, current service operation, current service operation start date time, partition ID, replica/instance ID, reported load, and other information.
      tags:
      - Replica
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/NodeNameRequiredPathParam'
      - $ref: '#/parameters/PartitionIdRequiredPathParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 200 status code and the list of deployed service replica information.
          schema:
            $ref: '#/definitions/DeployedServiceReplicaDetailInfo'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/Restart:
    post:
      operationId: microsoftAzureRestartreplica
      summary: Microsoft Azure Restarts A Service Replica Of A Persisted Service Running On A Node
      description: Restarts a service replica of a persisted service running on a node. Warning - There are no safety checks performed when this API is used. Incorrect use of this API can lead to availability loss for stateful services.
      tags:
      - Replica
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/NodeNameRequiredPathParam'
      - $ref: '#/parameters/PartitionIdRequiredPathParam'
      - $ref: '#/parameters/ReplicaIdRequiredPathParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 200 status code. A successful operation means that the restart command was received by the replica on the node and it is in the process of restarting.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
  /Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/Delete:
    post:
      operationId: microsoftAzureRemovereplica
      summary: Microsoft Azure Removes A Service Replica Running On A Node
      description: This API simulates a Service Fabric replica failure by removing a replica from a Service Fabric cluster. The removal closes the replica, transitions the replica to the role None, and then removes all of the state information of the replica from the cluster. This API tests the replica state removal path, and simulates the report fault permanent path through client APIs. Warning - There are no safety checks performed when this API is used. Incorrect use of this API can lead to data loss for stateful services. In addition, the forceRemove flag impacts all other replicas hosted in the same process.
      tags:
      - Replica
      parameters:
      - $ref: '#/parameters/ApiVersion_6-0_RequiredQueryParam'
      - $ref: '#/parameters/NodeNameRequiredPathParam'
      - $ref: '#/parameters/PartitionIdRequiredPathParam'
      - $ref: '#/parameters/ReplicaIdRequiredPathParam'
      - $ref: '#/parameters/ForceRemoveReplicaOptionalQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      responses:
        '200':
          description: A successful operation will return 200 status code. A successful operation means that the restart command was received by the replica on the node and it is in the process of restarting.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/FabricError'
definitions:
  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
  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.
  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.'
  DeployedServiceReplicaInfoList:
    type: array
    items:
      $ref: '#/definitions/DeployedServiceReplicaInfo'
    description: List of deployed service replica information.
  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'
  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.
  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
  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.
  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.'
  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.
  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.
  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.'
  CodePackageName:
    type: string
    description: The name of the code package defined in the service manifest.
  ServiceTypeName:
    type: string
    description: Name of the service type as specified in the service manifest.
  ServiceName:
    type: string
    description: The full name of the service with 'fabric:' URI scheme.
  ServiceManifestName:
    type: string
    description: The name of the service manifest.
  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.
  ServiceKind:
    type: string
    description: The kind of service (Stateless or Stateful).
    enum:
    - Invalid
    - Stateless
    - Stateful
    x-ms-enum:
      name: ServiceKind
      modelAsString: true
      values:
      - value: Invalid
        description: Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
      - value: Stateless
        description: Does not use Service Fabric to make its state highly available or reliable. The value is 1.
      - value: Stateful
        description: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2.
  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.
  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
  ContinuationToken:
    type: string
    description: The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.
  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.
  ReplicaHealth:
    allOf:
    - $ref: '#/definitions/EntityHealth'
    discriminator: ServiceKind
    description: 'Represents a base class for stateful service replica or stateless service instance health.

      Contains the replica aggregated health state, the health events and the unhealthy evaluations.'
    properties:
      ServiceKind:
        $ref: '#/definitions/ServiceKind'
        description: The kind of service (Stateless or Stateful).
      PartitionId:
        $ref: '#/definitions/PartitionId'
        description: Id of the partition to which this replica belongs.
    required:
    - ServiceKind
  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
  DeployedServiceReplicaInfo:
    discriminator: ServiceKind
    description: Information about a Service Fabric service replica deployed on a node.
    required:
    - ServiceKind
    properties:
      ServiceKind:
        $ref: '#/definitions/ServiceKind'
        description: The kind of service (Stateless or Stateful).
      ServiceName:
        $ref: '#/definitions/ServiceName'
        description: The full name of the service with 'fabric:' URI scheme.
      ServiceTypeName:
        $ref: '#/definitions/ServiceTypeName'
        description: Name of the service type as specified in the service manifest.
      ServiceManifestName:
        $ref: '#/definitions/ServiceManifestName'
        description: The name of the service manifest in which this service type is defined.
      CodePackageName:
        $ref: '#/definitions/CodePackageName'
        description: The name of the code package that hosts this replica.
      PartitionId:
        $ref: '#/definitions/PartitionId'
        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.
      ReplicaStatus:
        $ref: '#/definitions/ReplicaStatus'
        description: The status of a replica of a service.
      Address:
        type: string
        description: The last address returned by the replica in Open or ChangeRole.
      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.'
      HostProcessId:
        type: string
        description: Host process ID of the process that is hosting the replica. This will be zero if the replica is down. In hyper-v containers this host process ID will be from different kernel.
  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
  LoadMetricReportInfo:
    description: Information about load reported by replica.
    properties:
      Name:
        type: string
        description: The name of the metric.
      Value:
        type: integer
        format: int32
        description: The value of the load for the metric. In future releases of Service Fabric this parameter will be deprecated in favor of CurrentValue.
      CurrentValue:
        type: string
        format: double
        description: The double value of the load for the metric.
      LastReportedUtc:
        type: string
        format: date-time
        description: The UTC time when the load is reported.
  NodeName:
    type: string
    description: The name of a Service Fabric node.
  LoadMetricReportInfoList:
    type: array
    items:
      $ref: '#/definitions/LoadMetricReportInfo'
    description: List of load reported by replica.
  DeployedServiceReplicaDetailInfo:
    discriminator: ServiceKind
    description: Information about a Service Fabric service replica deployed on a node.
    required:
    - ServiceKind
    properties:
      ServiceKind:
        $ref: '#/definitions/ServiceKind'
        description: The kind of service (Stateless or Stateful).
      ServiceName:
        $ref: '#/definitions/ServiceName'
        description: Full hierarchical name of the service in URI format starting with `fabric:`.
      PartitionId:
        $ref: '#/definitions/PartitionId'
        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.
      CurrentServiceOperation:
        $ref: '#/definitions/ServiceOperationName'
        description: Specifies the current active life-cycle operation on a stateful service replica or stateless service instance.
      CurrentServiceOperationStartTimeUtc:
        type: string
        format: date-time
        description: The start time of the current service operation in UTC format.
      ReportedLoad:
        $ref: '#/definitions/LoadMetricReportInfoList'
        description: List of load reported by replica.
  ReplicaStatus:
    type: string
    description: The status of a replica of a service.
    enum:
    - Invalid
    - InBuild
    - Standby
    - Ready
    - Down
    - Dropped
    x-ms-enum:
      name: ReplicaStatus
      modelAsString: true
      values:
      - value: Invalid
        description: Indicates the replica status is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
      - value: InBuild
        description: The replica is being built. This means that a primary replica is seeding this replica. The value is 1.
      - value: Standby
        description: The replica is in standby. The value is 2.
      - value: Ready
        description: The replica is ready. The value is 3.
      - value: Down
        description: The replica is down. The value is 4.
      - value: Dropped
        description: Replica is dropped. This means that the replica has been removed from the replica set. If it is persisted, its state has been deleted. The value is 5.
  ReplicaInfo:
    discriminator: ServiceKind
    description: Information about the identity, status, health, node name, uptime, and other details about the replica.
    required:
    - ServiceKind
    properties:
      ServiceKind:
        $ref: '#/definitions/ServiceKind'
        description: The kind of service (Stateless or Stateful).
      ReplicaStatus:
        $ref: '#/definitions/ReplicaStatus'
        description: The status of a replica of a service.
      HealthState:
        $ref: '#/definitions/HealthState'
        description: The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
      NodeName:
        $ref: '#/definitions/NodeName'
        description: The name of a Service Fabric node.
      Address:
        type: string
        description: The address the replica is listening on.
      LastInBuildDurationInSeconds:
        type: string
        description: The last in build duration of the replica in seconds.
  ServiceOperationName:
    type: string
    description: Specifies the current active life-cycle operation on a stateful service replica or stateless service instance.
    enum:
    - Unknown
    - None
    - Open
    - ChangeRole
    - Close
    - Abort
    x-ms-enum:
      name: ServiceOperationName
      modelAsString: true
      values:
      - value: Unknown
        description: Reserved for future use.
      - value: None
        description: The service replica or instance is not going through any life-cycle changes.
      - value: Open
        description: The service replica or instance is being opened.
      - value: ChangeRole
        description: The service replica is changing roles.
      - value: Close
        description: The service replica or instance is being closed.
      - value: Abort
        description: The service replica or instance is being aborted.
  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.
  PagedReplicaInfoList:
    description: The list of replicas in the cluster for a given partition. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.
    properties:
      ContinuationToken:
        $ref: '#/definitions/ContinuationToken'
        description: The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.
      Items:
        type: array
        description: List of replica information.
        items:
          $ref: '#/definitions/ReplicaInfo'
parameters:
  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.'
  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'
  PartitionIdRequiredPathParam:
    name: partitionId
    in: path
    x-ms-parameter-location: method
    x-ms-skip-url-encoding: true
    type: string
    format: uuid
    required: true
    description: The identity of the partition.
  ReplicaIdRequiredPathParam:
    name: replicaId
    in: path
    x-ms-parameter-location: method
    x-ms-skip-url-encoding: true
    type: string
    required: true
    description: The identifier of the replica.
  ServiceManifestNameOptionalQueryParam:
    name: ServiceManifestName
    in: query
    x-ms-parameter-location: method
    type: string
    required: false
    description: The name of a service manifest registered as part of an application type in a Service Fabric cluster.
  ApplicationHealthPolicyOptionalBodyParam:
    name: ApplicationHealthPolicy
    in: body
    description: 'Describes the health policies used to evaluate the health of an application or one of its children.

      If not present, the health evaluation uses the health policy from application manifest or the default health policy.'
    required: false
    x-ms-parameter-location: method
    schema:
      $ref: '#/definitions/ApplicationHealthPolicy'
  ReplicaHealthReportServiceKindRequiredQueryParam:
    name: ServiceKind
    in: query
    required: true
    x-ms-parameter-location: method
    description: The kind of service replica (Stateless or Stateful) for which the health is being reported. Following are the possible values.
    type: string
    enum:
    - Stateless
    - Stateful
    default: Stateful
    x-ms-enum:
      name: ReplicaHealthReportServiceKind
      modelAsString: true
      values:
      - value: Stateless
        description: Does not use Service Fabric to make its state highly available or reliable. The value is 1
      - value: Stateful
        description: Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2.
  NodeNameRequiredPathParam:
    name: nodeName
    in: path
    x-ms-parameter-location: method
    type: string
    required: true
    description: The name of the node.
  PartitionIdOptionalQueryParam:
    name: PartitionId
    in: query
    x-ms-parameter-location: method
    type: string
    format: uuid
    required: false
    description: The identity of the partition.
  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
  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.
  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.
  ForceRemoveReplicaOptionalQueryParam:
    name: ForceRemove
    in: query
    x-ms-parameter-location: method
    type: boolean
    required: false
    description: Remove a Service Fabric application or service forcefully without going through the graceful shutdown sequence. This parameter can be used to forcefully delete an application or service for which delete is timing out due to issues in the service code that prevents graceful close of replicas.
  ApplicationIdRequiredPathParam:
    name: applicationId
    in: path
    x-ms-parameter-location: method
    x-ms-skip-url-encoding: true
    type: string
    required: true
    description: 'The identity of the application. This is typically the full name of the application without the ''fabric:'' URI scheme.

      Starting from version 6.0, hierarchical names are delimited with the "~" character.

      For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions.'
  ContinuationTokenOptionalQueryParam:
    name: ContinuationToken
    in: query
    x-ms-parameter-location: method
    x-ms-skip-url-encoding: true
    type: string
    required: false
    description: The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'