Microsoft Azure Replica API

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 

# --- truncated at 32 KB (71 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-replica-api-openapi.yml