Microsoft Azure Replica API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Replica. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.
This API exposes
10 operations
across 9 paths,
and defines 38 schemas.
It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.
The identity and technical contract details declared by the specification.
HealthEvaluationWrapper
object
Wrapper object for health evaluation.
1 property
PartitionId
string
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 uni…
DeployedServiceReplicaInfo
object
Information about a Service Fabric service replica deployed on a node.
10 properties
1 required
EntityKind
string
The entity type of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
FabricErrorCodes
string
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…
ServicePackageActivationId
string
The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is 'SharedProcess' (or if it is n…
HealthStatistics
object
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…
1 property
DeployedServiceReplicaInfoList
array
List of deployed service replica information.
ServiceTypeHealthPolicy
object
Represents the health policy used to evaluate the health of services belonging to a service type.
3 properties
PagedReplicaInfoList
object
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 ca…
2 properties
ServiceOperationName
string
Specifies the current active life-cycle operation on a stateful service replica or stateless service instance.
ServiceName
string
The full name of the service with 'fabric:' URI scheme.
CodePackageName
string
The name of the code package defined in the service manifest.
ContinuationToken
string
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…
NodeName
string
The name of a Service Fabric node.
FabricErrorError
object
Error object containing error code and error message.
2 properties
1 required
HealthInformation
object
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.
8 properties
3 required
HealthEvent
object
Represents health information reported on a health entity, such as cluster, application or node, with additional metadata added by the Health Manager.
6 properties
LoadMetricReportInfoList
array
List of load reported by replica.
ServiceTypeName
string
Name of the service type as specified in the service manifest.
ServiceManifestName
string
The name of the service manifest.
ReplicaInfo
object
Information about the identity, status, health, node name, uptime, and other details about the replica.
6 properties
1 required
ServiceTypeHealthPolicyMap
array
Defines a ServiceTypeHealthPolicy per service type name. The entries in the map replace the default service type health policy for each specified service type.…
DeployedServiceReplicaDetailInfo
object
Information about a Service Fabric service replica deployed on a node.
6 properties
1 required
LoadMetricReportInfo
object
Information about load reported by replica.
4 properties
ReplicaHealth
object
Represents a base class for stateful service replica or stateless service instance health. Contains the replica aggregated health state, the health events and…
2 properties
1 required
HealthState
string
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
ServiceTypeHealthPolicyMapItem
object
Defines an item in ServiceTypeHealthPolicyMap.
2 properties
2 required
UnhealthyEvaluations
array
List of health evaluations that resulted in the current aggregated health state.
HealthEvaluation
object
Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity.
3 properties
1 required
ReplicaStatus
string
The status of a replica of a service.
EntityHealth
object
Health information common to all entities in the cluster. It contains the aggregated health state, health events and unhealthy evaluation.
4 properties
ApplicationHealthPolicy
object
Defines a health policy used to evaluate the health of an application or one of its children entities.
4 properties
EntityKindHealthStateCount
object
Represents health state count for entities of the specified entity kind.
2 properties
FabricError
object
The REST API operations for Service Fabric return standard HTTP status codes. This type defines the additional information returned from the Service Fabric API…
1 property
1 required
ServiceKind
string
The kind of service (Stateless or Stateful).
HealthStateCount
object
Represents information about how many health entities are in Ok, Warning and Error health state.
3 properties
HealthEvaluationKind
string
The health manager in the cluster performs health evaluations in determining the aggregated health state of an entity. This enumeration provides information on…
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Microsoft Azure publishes across the network.
