Microsoft Azure Cluster API
The Cluster API from Microsoft Azure — 23 operation(s) for cluster.
Microsoft Azure Cluster 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 Cluster. 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 25 operations across 23 paths, and defines 137 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.
25 operations
23 paths
137 schemas
12 GET13 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 25
Across 23 paths, the API surfaces 25 operations — 12 GET, 13 POST. Each is listed below with its method, path, parameters, and response codes.
Cluster 25
GET
/$/GetClusterManifest
Microsoft Azure Get The Service Fabric Cluster Manifest
GET
/$/GetClusterHealth
Microsoft Azure Gets The Health Of A Service Fabric Cluster
POST
/$/GetClusterHealth
Microsoft Azure Gets The Health Of A Service Fabric Cluster Using The Specified Policy
GET
/$/GetClusterHealthChunk
Microsoft Azure Gets The Health Of A Service Fabric Cluster Using Health Chunks
POST
/$/GetClusterHealthChunk
Microsoft Azure Gets The Health Of A Service Fabric Cluster Using Health Chunks
POST
/$/ReportClusterHealth
Microsoft Azure Sends A Health Report On The Service Fabric Cluster
GET
/$/GetProvisionedCodeVersions
Microsoft Azure Gets A List Of Fabric Code Versions That Are Provisioned In A Service Fabric Cluster
GET
/$/GetProvisionedConfigVersions
Microsoft Azure Gets A List Of Fabric Config Versions That Are Provisioned In A Service Fabric Cluster
GET
/$/GetUpgradeProgress
Microsoft Azure Gets The Progress Of The Current Cluster Upgrade
GET
/$/GetClusterConfiguration
Microsoft Azure Get The Service Fabric Standalone Cluster Configuration
GET
/$/GetClusterConfigurationUpgradeStatus
Microsoft Azure Get The Cluster Configuration Upgrade Status Of A Service Fabric Standalone Cluster
GET
/$/GetUpgradeOrchestrationServiceState
Microsoft Azure Get The Service State Of Service Fabric Upgrade Orchestration Service
POST
/$/SetUpgradeOrchestrationServiceState
Microsoft Azure Update The Service State Of Service Fabric Upgrade Orchestration Service
POST
/$/Provision
Microsoft Azure Provision The Code Or Configuration Packages Of A Service Fabric Cluster
POST
/$/Unprovision
Microsoft Azure Unprovision The Code Or Configuration Packages Of A Service Fabric Cluster
POST
/$/RollbackUpgrade
Microsoft Azure Roll Back The Upgrade Of A Service Fabric Cluster
POST
/$/MoveToNextUpgradeDomain
Microsoft Azure Make The Cluster Upgrade Move On To The Next Upgrade Domain
POST
/$/Upgrade
Microsoft Azure Start Upgrading The Code Or Configuration Version Of A Service Fabric Cluster
POST
/$/StartClusterConfigurationUpgrade
Microsoft Azure Start Upgrading The Configuration Of A Service Fabric Standalone Cluster
POST
/$/UpdateUpgrade
Microsoft Azure Update The Upgrade Parameters Of A Service Fabric Cluster Upgrade
GET
/$/GetAadMetadata
Microsoft Azure Gets The Azure Active Directory Metadata Used For Secured Connection To Cluster
GET
/$/GetClusterVersion
Microsoft Azure Get The Current Service Fabric Cluster Version
GET
/$/GetLoadInformation
Microsoft Azure Gets The Load Of A Service Fabric Cluster
POST
/$/ToggleVerboseServicePlacementHealthReporting
Microsoft Azure Changes The Verbosity Of Service Placement Health Reporting
POST
/$/ValidateUpgrade
Microsoft Azure Validate And Assess The Impact Of A Code Or Configuration Version Update Of A Service Fabric Cluster
Schemas 137
The contract defines 137 schemas that model the data the API accepts and returns. The most detailed are LoadMetricInformation (25 properties), ClusterUpgradeProgressObject (18 properties), StartClusterUpgradeDescription (13 properties), ClusterUpgradeDescriptionObject (12 properties). Each schema is shown below with its type and property counts.
FabricConfigVersionInfo
object
Information about a Service Fabric config version.
1 property
UpgradeDomainTimeout
string
The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration.…
SafetyCheckWrapper
object
A wrapper for the safety check object. Safety checks are performed by service fabric before continuing with the operations. These checks ensure the availabilit…
1 property
UpgradeType
string
The type of upgrade out of the following possible values.
ClusterFabricCodeVersionString
string
The ServiceFabric code version of the cluster.
PartitionHealthStateChunkList
object
The list of partition health state chunks that respect the input filters in the chunk query description. Returned by get cluster health state chunks query as p…
1 property
EntityKind
string
The entity type of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
DeployedApplicationHealthStateChunk
object
Represents the health state chunk of a deployed application, which contains the node where the application is deployed, the aggregated health state and any dep…
2 properties
NodeUpgradeProgressInfoList
array
List of upgrading nodes and their statuses
ClusterConfigurationUpgradeStatusInfo
object
Information about a standalone cluster configuration upgrade status.
4 properties
ClusterVersion
object
The cluster version.
1 property
ClusterLoadInfo
object
Information about load in a Service Fabric cluster. It holds a summary of all metrics and their load in a cluster.
3 properties
FabricErrorError
object
Error object containing error code and error message.
2 properties
1 required
AadMetadataObject
object
Azure Active Directory metadata object used for secured connection to cluster.
2 properties
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.…
EntityHealthStateChunkList
object
A base type for the list of health state chunks found in the cluster. It contains the total number of health states that match the input filters.
1 property
NodeUpgradeDurationString
string
The estimated time spent processing the node since it was deactivated during a node-by-node upgrade.
ApplicationHealthPolicyMap
array
Defines a map that contains specific application health policies for different applications. Each entry specifies as key the application name and as value an A…
ReplicaHealthStateChunk
object
Represents the health state chunk of a stateful service replica or a stateless service instance. The replica health state contains the replica ID and its aggre…
1 property
UpgradeStartTimeUTCString
string
The start time of the upgrade in UTC.
ApplicationHealthPolicyMapItem
object
Defines an item in ApplicationHealthPolicyMap.
2 properties
2 required
CurrentUpgradeDomainName
string
The name of the upgrade domain. Not applicable to node-by-node upgrades.
UpgradeFailureTimeUTCString
string
The failure time of the upgrade in UTC.
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
UpgradeUnitState
string
The state of the upgrade unit.
ApplicationHealthStateFilter
object
Defines matching criteria to determine whether a application should be included in the cluster health chunk. One filter can match zero, one or multiple applica…
5 properties
EntityHealth
object
Health information common to all entities in the cluster. It contains the aggregated health state, health events and unhealthy evaluation.
4 properties
SafetyCheck
object
Represents a safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliab…
1 property
1 required
ApplicationHealthStateChunkList
object
The list of application health state chunks in the cluster that respect the input filters in the chunk query. Returned by get cluster health state chunks query.
1 property
HealthStateCount
object
Represents information about how many health entities are in Ok, Warning and Error health state.
3 properties
DeployedServicePackageHealthStateFilter
object
Defines matching criteria to determine whether a deployed service package should be included as a child of a deployed application in the cluster health chunk.…
3 properties
ApplicationHealthState
object
Represents the health state of an application, which contains the application identifier and the aggregated health state.
1 property
UpgradeTimeout
string
The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration.…
ApplicationHealthPolicyMapObject
object
Represents the map of application health policies for a ServiceFabric cluster upgrade
1 property
DeployedServicePackageHealthStateChunk
object
Represents the health state chunk of a deployed service package, which contains the service manifest name and the service package aggregated health state.
2 properties
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…
SafetyCheckInfoList
array
List of pending safety checks
ReplicaOrInstanceId
string
Id of a stateful service replica or a stateless service instance. This ID is used in the queries that apply to both stateful and stateless services. It is used…
ForceRestart
boolean
If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).
PartitionHealthStateChunk
object
Represents the health state chunk of a partition, which contains the partition ID, its aggregated health state and any replicas that respect the filters in the…
2 properties
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
ServiceTypeHealthPolicy
object
Represents the health policy used to evaluate the health of services belonging to a service type.
3 properties
ClusterUpgradeProgressObject
object
Information about a cluster upgrade.
18 properties
ClusterHealthChunkQueryDescription
object
The cluster health chunk query description, which can specify the health policies to evaluate cluster health and very expressive filters to select which cluste…
4 properties
UpgradeUnitInfoList
array
List of upgrade units and their statuses.
FabricCodeVersionInfoList
array
List of all Service Fabric code versions.
NodeHealthStateChunkList
object
The list of node health state chunks in the cluster that respect the input filters in the chunk query. Returned by get cluster health state chunks query.
1 property
ServiceManifestName
string
The name of the service manifest.
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
LoadMetricInformation
object
Represents data structure that contains load information for a certain metric in a cluster.
25 properties
NodeUpgradeProgressInfo
object
Information about the upgrading node and its status
4 properties
UpgradeDomainDurationString
string
The estimated elapsed time spent processing the current upgrade domain. Not applicable to node-by-node upgrades.
NodeHealthStateFilter
object
Defines matching criteria to determine whether a node should be included in the returned cluster health chunk. One filter can match zero, one or multiple nodes…
2 properties
RollingUpgradeUpdateDescription
object
Describes the parameters for updating a rolling upgrade of application or cluster.
10 properties
1 required
UpgradeUnitName
string
The name of the upgrade unit
ServiceHostUpgradeImpact
string
The expected impact of the upgrade.
HealthCheckWaitDuration
string
The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 dur…
UpgradeDomainState
string
The state of the upgrade domain.
ClusterUpgradeHealthPolicyObject
object
Defines a health policy used to evaluate the health of the cluster during a cluster upgrade.
2 properties
SafetyCheckKind
string
The kind of safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliabi…
UpgradeUnitInfo
object
Information about an upgrade unit.
2 properties
UnhealthyEvaluations
array
List of health evaluations that resulted in the current aggregated health state.
ApplicationHealthPolicy
object
Defines a health policy used to evaluate the health of an application or one of its children entities.
4 properties
NodeId
object
An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name.
1 property
InstanceCloseDelayDurationInSeconds
integer
Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance…
ReplicaHealthStateFilter
object
Defines matching criteria to determine whether a replica should be included as a child of a partition in the cluster health chunk. The replicas are only return…
2 properties
FailureReason
string
The cause of an upgrade failure that resulted in FailureAction being executed.
HealthEvaluationWrapper
object
Wrapper object for health evaluation.
1 property
NodeHealthStateChunk
object
Represents the health state chunk of a node, which contains the node name and its aggregated health state.
1 property
PartitionHealthStateFilter
object
Defines matching criteria to determine whether a partition should be included as a child of a service in the cluster health chunk. The partitions are only retu…
3 properties
UpgradeKind
string
The kind of upgrade out of the following possible values.
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…
UpgradeReplicaSetCheckTimeout
integer
The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expire…
NodeTypeHealthPolicyMap
array
Defines a map with max percentage unhealthy nodes for specific node types. Each entry specifies as key the node type name and as value an integer that represen…
FailureAction
string
The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is i…
NodeHealthState
object
Represents the health state of a node, which contains the node identifier and its aggregated health state.
2 properties
UpgradeState
string
The state of the upgrade domain.
ServiceName
string
The full name of the service with 'fabric:' URI scheme.
ClusterConfigurationUpgradeDescription
object
Describes the parameters for a standalone cluster configuration upgrade.
11 properties
1 required
ClusterConfiguration
object
Information about the standalone cluster configuration.
1 property
StartClusterUpgradeDescription
object
Describes the parameters for starting a cluster upgrade.
13 properties
ApplicationName
string
The name of the application, including the 'fabric:' URI scheme.
UpgradeDurationString
string
The estimated elapsed time spent processing the current overall upgrade.
MonitoringPolicyDescription
object
Describes the parameters for monitoring an upgrade in Monitored mode.
6 properties
NextUpgradeDomain
string
The name of the next upgrade domain to be processed. Not applicable to node-by-node upgrades.
ValidateClusterUpgradeResult
object
Specifies result of validating a cluster upgrade.
2 properties
HealthState
string
The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
ClusterHealthChunk
object
Represents the health chunk of the cluster. Contains the cluster aggregated health state, and the cluster entities that respect the input filter.
3 properties
ServiceTypeHealthPolicyMapItem
object
Defines an item in ServiceTypeHealthPolicyMap.
2 properties
2 required
AadMetadata
object
Azure Active Directory metadata used for secured connection to cluster.
6 properties
NodeUpgradePhase
string
The state of the upgrading node.
DeployedApplicationHealthStateChunkList
object
The list of deployed application health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.
1 property
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
DeployedServicePackageHealthStateChunkList
object
The list of deployed service package health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.
1 property
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…
FabricCodeVersionInfo
object
Information about a Service Fabric code version.
1 property
ResumeClusterUpgradeDescription
object
Describes the parameters for resuming a cluster upgrade.
1 property
1 required
ApplicationTypeName
string
The application type name as defined in the application manifest.
HealthCheckRetryTimeout
string
The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a strin…
EntityHealthStateChunk
object
A base type for the health state chunk of various entities in the cluster. It contains the aggregated health state.
1 property
UpgradeMode
string
The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, Monitored, and UnmonitoredDeferred.
ClusterHealthPolicies
object
Health policies to evaluate cluster health.
2 properties
UpgradeDomainInfoList
array
List of upgrade domains and their statuses. Not applicable to node-by-node upgrades.
ClusterManifest
object
Information about the cluster manifest.
1 property
ApplicationHealthStateChunk
object
Represents the health state chunk of a application. The application health state chunk contains the application name, its aggregated health state and any child…
4 properties
CurrentUpgradeDomainProgressInfo
object
Information about the current in-progress upgrade domain. Not applicable to node-by-node upgrades.
2 properties
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…
ClusterHealthPolicy
object
Defines a health policy used to evaluate the health of the cluster or of a cluster node.
5 properties
UpdateClusterUpgradeDescription
object
Parameters for updating a cluster upgrade.
6 properties
DeltaHealthEvaluationBool
boolean
When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain.
ServiceHealthStateChunkList
object
The list of service health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.
1 property
UnprovisionFabricDescription
object
Describes the parameters for unprovisioning a cluster.
2 properties
FailedUpgradeDomainProgressObject
object
The detailed upgrade progress for nodes in the current upgrade domain at the point of failure. Not applicable to node-by-node upgrades.
2 properties
NodeTypeHealthPolicyMapItem
object
Defines an item in NodeTypeHealthPolicyMap.
2 properties
2 required
NodeName
string
The name of a Service Fabric node.
EntityHealthState
object
A base type for the health state of various entities in the cluster. It contains the aggregated health state.
1 property
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
ApplicationTypeHealthPolicyMapItem
object
Defines an item in ApplicationTypeHealthPolicyMap.
2 properties
2 required
UpgradeOrchestrationServiceState
object
Service state of Service Fabric Upgrade Orchestration Service.
1 property
ClusterHealth
object
Represents the health of the cluster. Contains the cluster aggregated health state, the cluster application and node health states as well as the health events…
2 properties
ApplicationTypeHealthPolicyMap
array
Defines a map with max percentage unhealthy applications for specific application types. Each entry specifies as key the application type name and as value an…
ApplicationHealthPolicies
object
Defines the application health policy map used to evaluate the health of an application or one of its children entities.
1 property
CurrentUpgradeUnitsProgressInfo
object
Information about the current in-progress upgrade units.
2 properties
FabricConfigVersionInfoList
array
List of all Service Fabric config versions.
UpgradeDomainInfo
object
Information about an upgrade domain.
2 properties
ProvisionFabricDescription
object
Describes the parameters for provisioning a cluster.
2 properties
UpgradeSortOrder
string
Defines the order in which an upgrade proceeds through the cluster.
ServiceHealthStateFilter
object
Defines matching criteria to determine whether a service should be included as a child of an application in the cluster health chunk. The services are only ret…
3 properties
HealthCheckStableDuration
string
The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a str…
DeployedApplicationHealthStateFilter
object
Defines matching criteria to determine whether a deployed application should be included as a child of an application in the cluster health chunk. The deployed…
3 properties
ClusterFabricConfigVersionString
string
The cluster configuration version (specified in the cluster manifest).
ServiceHealthStateChunk
object
Represents the health state chunk of a service, which contains the service name, its aggregated health state and any partitions that respect the filters in the…
2 properties
UpgradeOrchestrationServiceStateSummary
object
Service state summary of Service Fabric Upgrade Orchestration Service.
5 properties
ClusterUpgradeDescriptionObject
object
Represents a ServiceFabric cluster upgrade
12 properties
UpgradeDomainName
string
The name of the upgrade domain
ReplicaHealthStateChunkList
object
The list of replica health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Microsoft Azure 12
Other APIs Microsoft Azure publishes across the network.
Microsoft Azure AI Search API
Microsoft Azure Communication Services API
Microsoft Azure Event Grid API
Microsoft Azure Functions API
Microsoft Azure DevOps REST API
Microsoft Azure AI Foundry API
Microsoft Azure Resource JSON Schema
Microsoft Azure JSON-LD Context
Microsoft Azure AccessConnector API
Microsoft Azure AccessControlRecords API
Microsoft Azure AccessPolicies API
Microsoft Azure AccessReviewInstanceAcceptRecommmendations API
#Cluster
Where this information came from
This is an independent, third-party profile of Microsoft Azure Cluster API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.