How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Microsoft Azure

Microsoft Azure Compose Deployment API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Microsoft Azure Compose Deployment 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 Compose Deployment. 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 7 operations across 7 paths, and defines 52 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

7 operations 7 paths 52 schemas 3 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2020-08-01-preview
Resource Areas
1

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 3 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Compose Deployment 7
PUT
/ComposeDeployments/$/Create
Microsoft Azure Creates A Service Fabric Compose Deployment
microsoftAzureCreatecomposedeployment 3 params → 202default
GET
/ComposeDeployments/{deploymentName}
Microsoft Azure Gets Information About A Service Fabric Compose Deployment
microsoftAzureGetcomposedeploymentstatus 3 params → 200default
GET
/ComposeDeployments
Microsoft Azure Gets The List Of Compose Deployments Created In The Service Fabric Cluster
microsoftAzureGetcomposedeploymentstatuslist 4 params → 200default
GET
/ComposeDeployments/{deploymentName}/$/GetUpgradeProgress
Microsoft Azure Gets Details For The Latest Upgrade Performed On This Service Fabric Compose Deployment
microsoftAzureGetcomposedeploymentupgradeprogress 3 params → 200default
POST
/ComposeDeployments/{deploymentName}/$/Delete
Microsoft Azure Deletes An Existing Service Fabric Compose Deployment From Cluster
microsoftAzureRemovecomposedeployment 3 params → 202default
POST
/ComposeDeployments/{deploymentName}/$/Upgrade
Microsoft Azure Starts Upgrading A Compose Deployment In The Service Fabric Cluster
microsoftAzureStartcomposedeploymentupgrade 4 params → 202default
POST
/ComposeDeployments/{deploymentName}/$/RollbackUpgrade
Microsoft Azure Starts Rolling Back A Compose Deployment Upgrade In The Service Fabric Cluster
microsoftAzureStartrollbackcomposedeploymentupgrade 3 params → 200default

Schemas 52

The contract defines 52 schemas that model the data the API accepts and returns. The most detailed are ComposeDeploymentUpgradeProgressInfo (20 properties), ComposeDeploymentUpgradeDescription (9 properties), MonitoringPolicyDescription (6 properties), ApplicationHealthPolicy (4 properties). Each schema is shown below with its type and property counts.

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…
ComposeDeploymentUpgradeState
string
The state of the compose deployment upgrade.
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.…
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
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.…
HealthEvaluationWrapper
object
Wrapper object for health evaluation.
1 property
UpgradeMode
string
The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, Monitored, and UnmonitoredDeferred.
SafetyCheckInfoList
array
List of pending safety checks
CurrentUpgradeDomainDuration
string
The estimated amount of time spent processing current Upgrade Domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, the…
ComposeDeploymentUpgradeProgressInfo
object
Describes the parameters for a compose deployment upgrade.
20 properties
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).
UpgradeKind
string
The kind of upgrade out of the following possible values.
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…
TargetDeploymentName
string
The name of the target deployment.
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…
ServiceTypeHealthPolicy
object
Represents the health policy used to evaluate the health of services belonging to a service type.
3 properties
PagedComposeDeploymentStatusInfoList
object
The list of compose deployments in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtain…
2 properties
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…
NodeUpgradeProgressInfoList
array
List of upgrading nodes and their statuses
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…
ApplicationName
string
The name of the application, including the 'fabric:' URI scheme.
NodeName
string
The name of a Service Fabric node.
FabricErrorError
object
Error object containing error code and error message.
2 properties 1 required
NodeUpgradeProgressInfo
object
Information about the upgrading node and its status
4 properties
TargetApplicationName
string
The name of the target application, including the 'fabric:' URI scheme.
UpgradeDuration
string
The estimated amount of time that the overall upgrade elapsed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is…
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.…
ComposeDeploymentUpgradeDescription
object
Describes the parameters for a compose deployment upgrade.
9 properties 3 required
MonitoringPolicyDescription
object
Describes the parameters for monitoring an upgrade in Monitored mode.
6 properties
TargetApplicationTypeVersion
string
The target application type version (found in the application manifest) for the application upgrade.
NodeUpgradeDurationString
string
The estimated time spent processing the node since it was deactivated during a node-by-node upgrade.
ApplicationUnhealthyEvaluations
array
List of health evaluations that resulted in the current aggregated health state.
ComposeDeploymentStatus
string
The status of the compose deployment.
FailureUpgradeDomainProgressInfo
object
Information about the upgrade domain progress at the time of upgrade failure.
2 properties
DeploymentName
string
The name of the deployment.
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
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…
RegistryCredential
object
Credential information to connect to container registry.
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…
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…
NodeUpgradePhase
string
The state of the upgrading node.
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
CreateComposeDeploymentDescription
object
Defines description for creating a Service Fabric compose deployment.
3 properties 2 required
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
ApplicationHealthPolicy
object
Defines a health policy used to evaluate the health of an application or one of its children entities.
4 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
ComposeDeploymentStatusInfo
object
Information about a Service Fabric compose deployment.
4 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…
FailureReason
string
The cause of an upgrade failure that resulted in FailureAction being executed.
UpgradeDomainName
string
The name of the upgrade domain

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-compose-deployment-api-openapi.yml Raw ↑

Other APIs Microsoft Azure publishes across the network.

Microsoft Azure AI Search API
AE Profile APIs.io
Microsoft Azure Communication Services API
AE Profile APIs.io
Microsoft Azure Event Grid API
AE Profile APIs.io
Microsoft Azure Functions API
AE Profile APIs.io
Microsoft Azure DevOps REST API
AE Profile APIs.io
Microsoft Azure AI Foundry API
AE Profile APIs.io
Microsoft Azure Resource JSON Schema
AE Profile APIs.io
Microsoft Azure JSON-LD Context
AE Profile APIs.io
Microsoft Azure AccessConnector API
AE Profile APIs.io
Microsoft Azure AccessControlRecords API
AE Profile APIs.io
Microsoft Azure AccessPolicies API
AE Profile APIs.io
Microsoft Azure AccessReviewInstanceAcceptRecommmendations API
AE Profile APIs.io
#Compose Deployment
← Back to M APIs
API Details
ID
microsoft-azure:microsoft-azure-compose-deployment-api
Docs
https://learn.microsoft.com/en-us/rest/api/azure/
Provider
Microsoft Azure
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=microsoft-azure-compose-deployment-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/microsoft-azure-compose-deployment-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Microsoft Azure Compose Deployment 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.