# Azure Service Fabric Cluster API

**Canonical:** https://apis.io/apis/microsoft-azure-service-fabric/microsoft-azure-service-fabric-cluster-api/  
**Provider:** Azure Service Fabric — https://apis.io/providers/microsoft-azure-service-fabric/  
**Base URL:** https://management.azure.com  
**Documentation:** https://learn.microsoft.com/en-us/rest/api/servicefabric/

Azure Service Fabric Cluster API is one of 46 APIs that [Azure Service Fabric](https://apis.io/providers/microsoft-azure-service-fabric/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 12 JSON Schema definitions. Tagged areas include Cluster. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 12 JSON Schemas.

The Cluster API from Azure Service Fabric — 26 operation(s) for cluster.

## Operations (31)

| Method | Path | Summary |
|---|---|---|
| GET | `/$/GetClusterManifest` | Get the Service Fabric cluster manifest |
| GET | `/$/GetClusterHealth` | Gets the health of a Service Fabric cluster |
| POST | `/$/GetClusterHealth` | Gets the health of a Service Fabric cluster using the specified policy |
| GET | `/$/GetClusterHealthChunk` | Gets the health of a Service Fabric cluster using health chunks |
| POST | `/$/GetClusterHealthChunk` | Gets the health of a Service Fabric cluster using health chunks |
| POST | `/$/ReportClusterHealth` | Sends a health report on the Service Fabric cluster |
| GET | `/$/GetProvisionedCodeVersions` | Gets a list of fabric code versions that are provisioned in a Service Fabric… |
| GET | `/$/GetProvisionedConfigVersions` | Gets a list of fabric config versions that are provisioned in a Service Fabric… |
| GET | `/$/GetUpgradeProgress` | Gets the progress of the current cluster upgrade |
| GET | `/$/GetClusterConfiguration` | Get the Service Fabric standalone cluster configuration |
| GET | `/$/GetClusterConfigurationUpgradeStatus` | Get the cluster configuration upgrade status of a Service Fabric standalone… |
| GET | `/$/GetUpgradeOrchestrationServiceState` | Get the service state of Service Fabric Upgrade Orchestration Service |
| POST | `/$/SetUpgradeOrchestrationServiceState` | Update the service state of Service Fabric Upgrade Orchestration Service |
| POST | `/$/Provision` | Provision the code or configuration packages of a Service Fabric cluster |
| POST | `/$/Unprovision` | Unprovision the code or configuration packages of a Service Fabric cluster |
| POST | `/$/RollbackUpgrade` | Roll back the upgrade of a Service Fabric cluster |
| POST | `/$/MoveToNextUpgradeDomain` | Make the cluster upgrade move on to the next upgrade domain |
| POST | `/$/Upgrade` | Start upgrading the code or configuration version of a Service Fabric cluster |
| POST | `/$/StartClusterConfigurationUpgrade` | Start upgrading the configuration of a Service Fabric standalone cluster |
| POST | `/$/UpdateUpgrade` | Update the upgrade parameters of a Service Fabric cluster upgrade |
| GET | `/$/GetAadMetadata` | Gets the Azure Active Directory metadata used for secured connection to cluster |
| GET | `/$/GetClusterVersion` | Get the current Service Fabric cluster version |
| GET | `/$/GetLoadInformation` | Gets the load of a Service Fabric cluster |
| POST | `/$/ToggleVerboseServicePlacementHealthReporting` | Changes the verbosity of service placement health reporting |
| POST | `/$/ValidateUpgrade` | Validate and assess the impact of a code or configuration version update of a… |
| GET | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}` | Gets a Service Fabric cluster resource |
| PUT | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}` | Creates or updates a Service Fabric cluster resource |
| PATCH | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}` | Updates the configuration of a Service Fabric cluster resource |
| DELETE | `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters/{clusterName}` | Deletes a Service Fabric cluster resource |
| GET | `/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/clusters` | Gets the list of Service Fabric cluster resources created in the specified… |
| GET | `/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/clusters` | Gets the list of Service Fabric cluster resources created in the specified… |

## Machine-readable artifacts (15)

- **OpenAPI** — https://artifacts.apis.io/microsoft-azure-service-fabric/openapi/microsoft-azure-service-fabric-cluster-api-openapi.yml
- **Documentation** — https://learn.microsoft.com/en-us/rest/api/servicefabric/managedclusters/managed-clusters
- **JSONSchema** — https://artifacts.apis.io/microsoft-azure-service-fabric/json-schema/microsoft-azure-service-fabric-restart-deployed-code-package-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/microsoft-azure-service-fabric/json-schema/microsoft-azure-service-fabric-managed-maintenance-window-status-schema.json
- **JSONSchema** — https://artifacts.apis.io/microsoft-azure-service-fabric/json-schema/microsoft-azure-service-fabric-restart-replica-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/microsoft-azure-service-fabric/json-schema/microsoft-azure-service-fabric-application-fetch-health-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/microsoft-azure-service-fabric/json-schema/microsoft-azure-service-fabric-managed-cluster-schema.json
- **JSONSchema** — https://artifacts.apis.io/microsoft-azure-service-fabric/json-schema/microsoft-azure-service-fabric-long-running-operation-result-schema.json
- **Documentation** — https://learn.microsoft.com/en-us/rest/api/servicefabric/sfclient-index
- **JSONSchema** — https://artifacts.apis.io/microsoft-azure-service-fabric/json-schema/microsoft-azure-service-fabric-service-update-description-schema.json
- **JSONSchema** — https://artifacts.apis.io/microsoft-azure-service-fabric/json-schema/microsoft-azure-service-fabric-node-info-schema.json
- **JSONSchema** — https://artifacts.apis.io/microsoft-azure-service-fabric/json-schema/microsoft-azure-service-fabric-cluster-configuration-upgrade-description-schema.json
- **JSONSchema** — https://artifacts.apis.io/microsoft-azure-service-fabric/json-schema/microsoft-azure-service-fabric-chaos-parameters-schema.json
- **JSONSchema** — https://artifacts.apis.io/microsoft-azure-service-fabric/json-schema/microsoft-azure-service-fabric-application-update-description-schema.json
- **JSONSchema** — https://artifacts.apis.io/microsoft-azure-service-fabric/json-schema/microsoft-azure-service-fabric-cluster-health-policy-schema.json

## Other Azure Service Fabric APIs (12)

- [Azure Service Fabric Clusters API](https://apis.io/apis/microsoft-azure-service-fabric/microsoft-azure-service-fabric-clusters-api/)
- [Azure Service Fabric Operations API](https://apis.io/apis/microsoft-azure-service-fabric/microsoft-azure-service-fabric-operations-api/)
- [Azure Service Fabric Applications API](https://apis.io/apis/microsoft-azure-service-fabric/microsoft-azure-service-fabric-applications-api/)
- [Azure Service Fabric Application API](https://apis.io/apis/microsoft-azure-service-fabric/microsoft-azure-service-fabric-application-api/)
- [Azure Service Fabric Application Type API](https://apis.io/apis/microsoft-azure-service-fabric/microsoft-azure-service-fabric-applicationtype-api/)
- [Azure Service Fabric Application Types API](https://apis.io/apis/microsoft-azure-service-fabric/microsoft-azure-service-fabric-applicationtypes-api/)
- [Azure Service Fabric Application Type Version API](https://apis.io/apis/microsoft-azure-service-fabric/microsoft-azure-service-fabric-applicationtypeversion-api/)
- [Azure Service Fabric Application Type Versions API](https://apis.io/apis/microsoft-azure-service-fabric/microsoft-azure-service-fabric-applicationtypeversions-api/)
- [Azure Service Fabric Chaos API](https://apis.io/apis/microsoft-azure-service-fabric/microsoft-azure-service-fabric-chaos-api/)
- [Azure Service Fabric Cluster Version API](https://apis.io/apis/microsoft-azure-service-fabric/microsoft-azure-service-fabric-clusterversion-api/)
- [Azure Service Fabric Code Package API](https://apis.io/apis/microsoft-azure-service-fabric/microsoft-azure-service-fabric-code-package-api/)
- [Azure Service Fabric Compose Deployment API](https://apis.io/apis/microsoft-azure-service-fabric/microsoft-azure-service-fabric-compose-deployment-api/)

## Tags

Cluster

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/microsoft-azure-service-fabric/microsoft-azure-service-fabric-cluster-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/microsoft-azure-service-fabric/.