Represents the health of the stateful service replica. Contains the replica aggregated health state, the health events and the unhealthy evaluations.


Name Type Required
ServiceKind string Yes
AggregatedHealthState string (enum) No
HealthEvents array of HealthEvent No
UnhealthyEvaluations array of HealthEvaluationWrapper No
HealthStatistics HealthStatistics No
PartitionId string (uuid) No
ReplicaId string No


Type: string
Required: Yes

A discriminator property. Its value must be 'Stateful' for objects of type 'StatefulServiceReplicaHealth'.


Type: string (enum)
Required: No

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.

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.

Possible values are:

  • Invalid - Indicates an invalid health state. All Service Fabric enumerations have the invalid type. The value is zero.
  • Ok - Indicates the health state is okay. The value is 1.
  • Warning - Indicates the health state is at a warning level. The value is 2.
  • Error - 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.
  • Unknown - Indicates an unknown health status. The value is 65535.


Type: array of HealthEvent
Required: No

The list of health events reported on the entity.


Type: array of HealthEvaluationWrapper
Required: No

The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager.


Type: HealthStatistics
Required: No

Shows the health statistics for all children types of the queried entity.


Type: string (uuid)
Required: No

Id of the partition to which this replica belongs.


Type: string
Required: No

Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id.