# Azure Service Fabric Compose Deployment API

**Canonical:** https://apis.io/apis/microsoft-azure-service-fabric/microsoft-azure-service-fabric-compose-deployment-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 Compose Deployment 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 Compose Deployment. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 12 JSON Schemas.

The Compose Deployment API from Azure Service Fabric — 7 operation(s) for compose deployment.

## Operations (7)

| Method | Path | Summary |
|---|---|---|
| PUT | `/ComposeDeployments/$/Create` | Creates a Service Fabric compose deployment |
| GET | `/ComposeDeployments/{deploymentName}` | Gets information about a Service Fabric compose deployment |
| GET | `/ComposeDeployments` | Gets the list of compose deployments created in the Service Fabric cluster |
| GET | `/ComposeDeployments/{deploymentName}/$/GetUpgradeProgress` | Gets details for the latest upgrade performed on this Service Fabric compose… |
| POST | `/ComposeDeployments/{deploymentName}/$/Delete` | Deletes an existing Service Fabric compose deployment from cluster |
| POST | `/ComposeDeployments/{deploymentName}/$/Upgrade` | Starts upgrading a compose deployment in the Service Fabric cluster |
| POST | `/ComposeDeployments/{deploymentName}/$/RollbackUpgrade` | Starts rolling back a compose deployment upgrade in the Service Fabric cluster |

## Machine-readable artifacts (15)

- **OpenAPI** — https://artifacts.apis.io/microsoft-azure-service-fabric/openapi/microsoft-azure-service-fabric-compose-deployment-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 API](https://apis.io/apis/microsoft-azure-service-fabric/microsoft-azure-service-fabric-cluster-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/)

## Tags

Compose Deployment

---

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