Microsoft Azure

Microsoft Azure Compose Deployment API

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

Documentation GitHub OpenAPI

Operations 7

PUT /ComposeDeployments/$/Create Microsoft Azure Creates A Service Fabric Compose Deployment #

GET /ComposeDeployments/{deploymentName} Microsoft Azure Gets Information About A Service Fabric Compose Deployment #

GET /ComposeDeployments Microsoft Azure Gets The List Of Compose Deployments Created In The Service Fabric Cluster #

GET /ComposeDeployments/{deploymentName}/$/GetUpgradeProgress Microsoft Azure Gets Details For The Latest Upgrade Performed On This Service Fabric Compose Deployment #

POST /ComposeDeployments/{deploymentName}/$/Delete Microsoft Azure Deletes An Existing Service Fabric Compose Deployment From Cluster #

POST /ComposeDeployments/{deploymentName}/$/Upgrade Microsoft Azure Starts Upgrading A Compose Deployment In The Service Fabric Cluster #

POST /ComposeDeployments/{deploymentName}/$/RollbackUpgrade Microsoft Azure Starts Rolling Back A Compose Deployment Upgrade In The Service Fabric Cluster #

Documentation

https://learn.microsoft.com/en-us/rest/api/azure/

https://learn.microsoft.com/en-us/azure/role-based-access-control/

https://learn.microsoft.com/en-us/rest/api/monitor/action-groups?view=rest-monitor-2021-09-01

https://learn.microsoft.com/en-us/entra/identity/

https://learn.microsoft.com/en-us/rest/api/monitor/activity-log-alerts?view=rest-monitor-2020-10-01

https://learn.microsoft.com/en-us/entra/identity/hybrid/connect/whatis-azure-ad-connect

https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/resource-providers-and-types

https://azuremarketplace.microsoft.com/en-us/marketplace/apps/robomq.adptoad?tab=overview

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.advisor-readme?view=azure-dotnet-preview

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.agfoodplatform-readme?view=azure-dotnet-preview

https://azure.microsoft.com/en-us/products/data-manager-for-agriculture

https://learn.microsoft.com/en-us/azure/ai-services/translator/

https://learn.microsoft.com/en-us/azure/azure-health-insights/

https://learn.microsoft.com/en-us/azure/azure-monitor/alerts/alerts-overview

https://learn.microsoft.com/en-us/azure/analysis-services/

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/analytics.purview.datamap-readme?view=azure-dotnet-preview

https://learn.microsoft.com/en-us/azure/ai-services/anomaly-detector/

https://learn.microsoft.com/en-us/azure/api-center/

https://learn.microsoft.com/en-us/azure/azure-monitor/scom-manage-instance/overview

https://learn.microsoft.com/en-us/azure/api-management/

https://learn.microsoft.com/en-us/rest/api/apimanagement/

https://learn.microsoft.com/en-us/microsoft-365-app-certification/docs/acat-overview

https://learn.microsoft.com/en-us/azure/azure-app-configuration/

https://learn.microsoft.com/en-us/azure/app-service/

https://learn.microsoft.com/en-us/rest/api/appservice/app-service-certificate-orders/get?view=rest-appservice-2024-04-01

https://learn.microsoft.com/en-us/azure/app-service/environment/

https://learn.microsoft.com/en-us/rest/api/appservice/app-service-plans?view=rest-appservice-2024-04-01

https://learn.microsoft.com/en-us/azure/

https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app

https://learn.microsoft.com/en-us/azure/azure-monitor/app/app-insights-overview

https://learn.microsoft.com/en-us/cli/azure/monitor/app-insights/component/linked-storage?view=azure-cli-latest

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.applicationinsights-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/azure/azure-arc/

https://learn.microsoft.com/en-us/azure/governance/resource-graph/

https://learn.microsoft.com/en-us/azure/devops/artifacts/?view=azure-devops

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/security.attestation-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/azure/attestation/

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.authorization-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/python/api/azure-cognitiveservices-search-autosuggest/azure.cognitiveservices.search.autosuggest.autosuggestclient?view=azure-python-preview

https://learn.microsoft.com/en-us/azure/automanage/

https://learn.microsoft.com/en-us/azure/automation/

https://learn.microsoft.com/en-us/azure/backup/

https://learn.microsoft.com/en-us/azure/baremetal-infrastructure/

https://learn.microsoft.com/en-us/azure/batch/

https://learn.microsoft.com/en-us/azure/ai-services/translator/document-translation/quickstarts/client-library-sdks

https://learn.microsoft.com/en-us/azure/ai-services/speech-service/batch-synthesis

https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.billingbenefits-readme?view=azure-dotnet-preview

https://learn.microsoft.com/en-us/azure/cost-management-billing/

https://learn.microsoft.com/en-us/azure/storage/blobs/

https://learn.microsoft.com/en-us/archive/msdn-magazine/2018/june/blockchain-introducing-azure-blockchain-workbench

https://learn.microsoft.com/en-us/azure/governance/blueprints/

https://learn.microsoft.com/en-us/azure/bot-service/?view=azure-bot-service-4.0

https://learn.microsoft.com/en-us/azure/role-based-access-control/built-in-roles

https://learn.microsoft.com/en-us/azure/cloud-adoption-framework/scenarios/cloud-scale-analytics/govern-metadata-standards

https://learn.microsoft.com/en-us/azure/carbon-optimization/view-emissions

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.cdn-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/azure/web-application-firewall/

https://learn.microsoft.com/en-us/rest/api/appservice/certificate-orders-diagnostics?view=rest-appservice-2024-04-01

https://learn.microsoft.com/en-us/azure/api-management/api-management-howto-mutual-certificates-for-clients

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.changeanalysis-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/javascript/api/overview/azure/arm-changes-readme?view=azure-node-latest

https://learn.microsoft.com/en-us/azure/chaos-studio/

https://learn.microsoft.com/en-us/rest/api/policy/policy-restrictions?view=rest-policy-2023-03-01

https://learn.microsoft.com/en-us/azure/cloud-shell/overview

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.trustedsigning-readme?view=azure-dotnet-preview

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.cognitiveservices-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/rest/api/cognitiveservices/

https://learn.microsoft.com/en-us/python/api/overview/azure/commerce?view=azure-python

https://learn.microsoft.com/en-us/azure/azure-monitor/alerts/alerts-types

https://learn.microsoft.com/en-us/azure/search/search-blob-metadata-properties

https://learn.microsoft.com/en-us/azure/cloud-adoption-framework/ready/considerations/fundamental-concepts

https://learn.microsoft.com/en-us/azure/sentinel/entities-reference

https://learn.microsoft.com/en-us/dynamics365/field-service/configure-incident-types

https://learn.microsoft.com/en-us/azure/azure-monitor/

https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/parameter-files

https://learn.microsoft.com/en-us/azure/storage/tables/table-storage-design-modeling

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.operationalinsights-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/azure/virtual-machines/share-gallery-community

https://learn.microsoft.com/en-us/rest/api/policy/component-policy-states?view=rest-policy-2022-04-01

https://learn.microsoft.com/en-us/azure/role-based-access-control/built-in-roles/compute

https://learn.microsoft.com/en-us/azure/ai-services/computer-vision/

https://learn.microsoft.com/en-us/azure/virtual-network-manager/concept-connectivity-configuration

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.appcontainers-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/rest/api/containerapps/

https://learn.microsoft.com/en-us/azure/container-apps/revisions-manage

https://learn.microsoft.com/en-us/azure/containers/

https://learn.microsoft.com/en-us/azure/templates/microsoft.containerservice/fleets

https://learn.microsoft.com/en-us/azure/ai-services/content-moderator/

https://learn.microsoft.com/en-us/azure/ai-services/content-safety/

https://learn.microsoft.com/en-us/azure/cosmos-db/postgresql/

https://learn.microsoft.com/en-us/dotnet/api/microsoft.azure.cognitiveservices.search.customimagesearch.customimagesearchclient?view=azure-dotnet

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/search.documents-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/azure/ai-services/custom-vision-service/

https://learn.microsoft.com/en-us/rest/api/speech/

https://learn.microsoft.com/en-us/rest/api/storageservices/data-lake-storage-gen2

https://learn.microsoft.com/en-us/rest/api/data-manager-for-agri/

https://learn.microsoft.com/en-us/azure/dms/

https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/control-plane-and-data-plane

https://learn.microsoft.com/en-us/azure/defender-for-cloud/data-sensitivity-settings

https://learn.microsoft.com/en-us/azure/databox/

https://learn.microsoft.com/en-us/rest/api/sql/database-threat-detection-policies/get?view=rest-sql-2014-04-01

https://learn.microsoft.com/en-us/azure/external-attack-surface-management/

https://learn.microsoft.com/en-us/azure/storage/files/

https://learn.microsoft.com/en-us/rest/api/appservice/web-apps/delete?view=rest-appservice-2024-04-01

https://learn.microsoft.com/en-us/azure/azure-resource-manager/templates/deployment-script-template

https://learn.microsoft.com/en-us/azure/deployment-environments/

https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/deployment-stacks

https://learn.microsoft.com/en-us/azure/iot-dps/

https://learn.microsoft.com/en-us/azure/api-management/diagnostic-logs-reference

https://learn.microsoft.com/en-us/azure/ai-services/document-intelligence/?view=doc-intel-4.0.0

https://learn.microsoft.com/en-us/azure/iot-edge/?view=iotedge-1.5

https://learn.microsoft.com/en-us/shows/azure-cosmos-db-conf-2022/creating-enterprise-knowledge-graphs-from-unstructured-data

https://learn.microsoft.com/en-us/python/api/azureml-core/azureml.core.experiment.experiment?view=azure-ml-py

https://learn.microsoft.com/en-us/azure/expressroute/cross-connections-api-development

https://learn.microsoft.com/en-us/fabric/admin/

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/ai.vision.face-readme?view=azure-dotnet-preview

https://learn.microsoft.com/en-us/dotnet/api/microsoft.azure.management.resourcemanager.fluent.featureclient?view=azure-dotnet-legacy

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/ai.formrecognizer-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/azure/virtual-machines/azure-compute-gallery

https://learn.microsoft.com/en-us/rest/api/monitor/diagnostic-settings?view=rest-monitor-2021-05-01-preview

https://learn.microsoft.com/en-us/azure/templates/microsoft.insights/guestdiagnosticsettingsassociation

https://learn.microsoft.com/en-us/azure/hdinsight-aks/

https://docs.citusdata.com/en/v9.2/portals/citus_cloud.html

https://learn.microsoft.com/en-us/dotnet/api/microsoft.azure.cognitiveservices.search.imagesearch.imagesearchclient?view=azure-dotnet

https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/data-collection-rule-overview

https://learn.microsoft.com/en-us/azure/integration-environments/create-integration-environment

https://learn.microsoft.com/en-us/azure/hdinsight/kafka/rest-proxy

https://learn.microsoft.com/en-us/rest/api/appservice/kube-environments/create-or-update?view=rest-appservice-2024-04-01

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.kusto-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/azure/azure-large-instances/what-is-azure-large-instances

https://learn.microsoft.com/en-us/azure/azure-monitor/app/live-stream

https://learn.microsoft.com/en-us/dotnet/api/azure.search.documents.searchclient?view=azure-dotnet

https://learn.microsoft.com/en-us/azure/azure-monitor/logs/log-analytics-overview

https://learn.microsoft.com/en-us/azure/azure-monitor/logs/log-analytics-tutorial

https://learn.microsoft.com/en-us/azure/azure-monitor/logs/query-packs

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.logic-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/azure/ai-services/luis/client-libraries-rest-api

https://learn.microsoft.com/en-us/azure/azure-resource-manager/managed-applications/

https://learn.microsoft.com/en-us/azure/azure-managed-lustre/

https://learn.microsoft.com/en-us/azure/synapse-analytics/security/synapse-workspace-managed-private-endpoints

https://learn.microsoft.com/en-us/entra/identity/managed-identities-azure-resources/overview

https://learn.microsoft.com/en-us/javascript/api/overview/azure/arm-links-readme?view=azure-node-latest

https://learn.microsoft.com/en-us/dotnet/api/microsoft.azure.management.resourcemanager.managementlockclient?view=azure-dotnet-legacy

https://learn.microsoft.com/en-us/azure/azure-maps/how-to-create-data-registries

https://learn.microsoft.com/en-us/azure/azure-maps/how-to-use-feedback-tool

https://learn.microsoft.com/en-us/azure/azure-maps/

https://learn.microsoft.com/en-us/rest/api/maps/render/get-map-tileset?view=rest-maps-2024-04-01

https://learn.microsoft.com/en-us/rest/api/maps/timezone?view=rest-maps-2024-04-01

https://learn.microsoft.com/en-us/azure/azure-maps/how-to-creator-wayfinding

https://learn.microsoft.com/en-us/azure/azure-maps/how-to-request-weather-data

https://learn.microsoft.com/en-us/partner-center/marketplace-offers/create-new-saas-offer

https://learn.microsoft.com/sr-cyrl-rs/azure/media-services/latest/

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.media-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/azure/ai-services/metrics-advisor/

https://learn.microsoft.com/en-us/azure/ai-services/language-service/

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/ai.language.conversations-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/rest/api/language/text-analysis-authoring/import?view=rest-language-2023-04-01

https://azure.microsoft.com/en-us/products/ai-services/question-answering

https://learn.microsoft.com/en-us/azure/defender-for-cloud/

https://learn.microsoft.com/en-us/rest/api/application-insights/

https://learn.microsoft.com/en-us/rest/api/marketplacecatalog/dataplane/reviews/get?view=rest-marketplacecatalog-dataplane-2023-01-01-preview&tabs=HTTP

https://learn.microsoft.com/en-us/azure/azure-netapp-files/

https://learn.microsoft.com/en-us/azure/playwright-testing/how-to-manage-authentication

https://azure.microsoft.com/en-us/products/ai-services/ai-document-intelligence

https://learn.microsoft.com/en-us/azure/defender-for-cloud/azure-devops-extension

https://learn.microsoft.com/en-us/azure/sentinel/upload-indicators-api

https://learn.microsoft.com/en-us/troubleshoot/azure/virtual-machines/windows/serial-console-windows

https://learn.microsoft.com/en-us/azure/templates/microsoft.servicelinker/linkers

https://learn.microsoft.com/en-us/azure/container-instances/container-instances-standby-pool-overview

https://learn.microsoft.com/en-us/azure/storage/file-sync/

https://learn.microsoft.com/en-us/rest/api/mobilepacketcore/

https://azure.microsoft.com/en-us/products/azure-network-function-manager

https://learn.microsoft.com/en-us/azure/network-watcher/traffic-analytics

https://learn.microsoft.com/en-us/azure/service-health/resource-health-overview

https://learn.microsoft.com/en-us/azure/security/

https://learn.microsoft.com/en-us/azure/migrate/

https://learn.microsoft.com/en-us/rest/api/migrate/

https://learn.microsoft.com/en-us/java/api/com.azure.mixedreality.remoterendering?view=azure-java-stable

https://learn.microsoft.com/en-us/java/api/com.azure.mixedreality.authentication.mixedrealitystsclient?view=azure-java-stable

https://learn.microsoft.com/en-us/rest/api/monitor/

https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/data-collection-endpoint-overview

https://learn.microsoft.com/en-us/rest/api/monitor/data-collection-rule-associations?view=rest-monitor-2023-03-11

https://learn.microsoft.com/en-us/rest/api/monitor/data-collection-rules?view=rest-monitor-2023-03-11

https://learn.microsoft.com/en-us/python/api/azure-mgmt-monitor/azure.mgmt.monitor.monitormanagementclient?view=azure-python

https://learn.microsoft.com/en-us/azure/batch/monitor-batch

https://learn.microsoft.com/en-us/rest/api/monitor/metrics?view=rest-monitor-2023-10-01

https://learn.microsoft.com/en-us/rest/api/monitor/metric-definitions?view=rest-monitor-2023-10-01

https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/monitor-resource-manager

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.sql-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/azure/virtual-network-manager/

https://learn.microsoft.com/en-us/azure/networking/

https://learn.microsoft.com/en-us/azure/virtual-network/network-security-groups-overview

https://learn.microsoft.com/en-us/azure/virtual-network-manager/concept-network-groups

https://learn.microsoft.com/en-us/azure/private-link/network-security-perimeter-concepts

https://docs.newrelic.com/docs/infrastructure/microsoft-azure-integrations/get-started/introduction-azure-monitoring-integrations/

https://learn.microsoft.com/en-us/dotnet/api/microsoft.azure.cognitiveservices.search.newssearch.newssearchclient?view=azure-dotnet

https://docs.nginx.com/nginx/deployment-guides/microsoft-azure/

https://learn.microsoft.com/en-us/azure/notification-hubs/

https://azure.microsoft.com/en-us/products/spring-apps

https://learn.microsoft.com/en-us/azure/ai-services/openai/

https://learn.microsoft.com/en-us/azure/ai-services/openai/reference

https://learn.microsoft.com/en-us/azure/ai-services/openai/overview

https://learn.microsoft.com/en-us/azure/ai-services/openai/reference-preview

https://learn.microsoft.com/en-us/azure/ai-services/openai/api-version-deprecation

https://learn.microsoft.com/en-us/azure/ai-services/openai/reference

https://learn.microsoft.com/en-us/javascript/api/overview/azure/arm-oep-readme?view=azure-node-preview

https://learn.microsoft.com/en-us/azure/orbital/

https://docs.paloaltonetworks.com/cloud-ngfw/azure

https://learn.microsoft.com/en-us/azure/cost-management-billing/manage/

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.peering-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/azure/ai-services/personalizer/

https://learn.microsoft.com/en-us/javascript/api/overview/azure/arm-playwrighttesting-readme?view=azure-node-latest

https://learn.microsoft.com/en-us/azure/governance/policy/

https://learn.microsoft.com/en-us/azure/governance/policy/concepts/event-overview

https://learn.microsoft.com/en-us/rest/api/policy/

https://learn.microsoft.com/en-us/azure/governance/policy/concepts/definition-structure-basics

https://learn.microsoft.com/en-us/azure/governance/policy/overview

https://learn.microsoft.com/en-us/azure/azure-portal/

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.postgresql-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/javascript/api/overview/azure/arm-powerbiembedded-readme?view=azure-node-latest

https://learn.microsoft.com/en-us/javascript/api/overview/azure/arm-powerbidedicated-readme?view=azure-node-latest

https://learn.microsoft.com/en-us/power-platform/

https://learn.microsoft.com/en-us/azure/ai-services/custom-vision-service/use-prediction-api

https://learn.microsoft.com/en-us/azure/private-link/

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.privatedns-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/azure/private-link/private-endpoint-overview

https://learn.microsoft.com/en-us/power-bi/enterprise/service-security-private-links-on-premises

https://azure.microsoft.com/en-us/products/programmable-connectivity

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.providerhub-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/rest/api/purview/

https://learn.microsoft.com/en-us/purview/legacy/concept-policies-devops

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.purview-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/purview/legacy/tutorial-metadata-policy-collections-apis

https://learn.microsoft.com/en-us/purview/

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/analytics.purview.sharing-readme?view=azure-dotnet-preview

https://learn.microsoft.com/en-us/purview/legacy/concept-workflow

https://learn.microsoft.com/en-us/azure/ai-services/qnamaker/

https://learn.microsoft.com/en-us/dotnet/api/microsoft.azure.cognitiveservices.knowledge.qnamaker.runtime?view=azure-dotnet-legacy

https://learn.microsoft.com/en-us/azure/quantum/

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.quantum-readme?view=azure-dotnet-preview

https://learn.microsoft.com/en-us/azure/storage/queues/

https://learn.microsoft.com/en-us/rest/api/quota/

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/recovery-services?view=azure-dotnet

https://docs.openshift.com/aro/4/welcome/index.html

https://learn.microsoft.com/en-us/azure/openshift/

https://learn.microsoft.com/en-us/azure/azure-cache-for-redis/

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.redisenterprise-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/rest/api/relay/

https://learn.microsoft.com/en-us/mem/intune/fundamentals/remediations

https://learn.microsoft.com/en-us/azure/cost-management-billing/reservations/reservation-apis

https://learn.microsoft.com/en-us/rest/api/appservice/resource-health-metadata/list?view=rest-appservice-2024-04-01

https://learn.microsoft.com/en-us/azure/azure-resource-manager/

https://learn.microsoft.com/en-us/rest/api/resources/

https://learn.microsoft.com/en-us/azure/resource-mover/

https://learn.microsoft.com/en-us/azure/virtual-network/virtual-networks-udr-overview

https://learn.microsoft.com/en-us/azure/virtual-machines/windows/run-command

https://learn.microsoft.com/en-us/rest/api/monitor/scheduled-query-rules?view=rest-monitor-2021-08-01

https://learn.microsoft.com/en-us/azure/scheduler/

https://learn.microsoft.com/en-us/azure/event-hubs/schema-registry-overview

https://learn.microsoft.com/en-us/rest/api/networkmanager/scope-connections/create-or-update?view=rest-networkmanager-2023-11-01

https://github.com/Azure/service-fabric-issues/issues/1021

https://learn.microsoft.com/en-us/python/api/azure-search-documents/azure.search.documents.indexes.searchindexclient?view=azure-python

https://learn.microsoft.com/en-us/python/api/azure-mgmt-search/azure.mgmt.search.searchmanagementclient?view=azure-python

https://learn.microsoft.com/en-us/azure/search/

https://learn.microsoft.com/en-us/azure/compliance/

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.securityinsights-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/azure/service-bus-messaging/

https://learn.microsoft.com/en-us/rest/api/servicebus/

https://learn.microsoft.com/en-us/rest/api/servicefabric/sfclient-index

https://learn.microsoft.com/en-us/azure/service-fabric/

https://learn.microsoft.com/en-us/azure/virtual-machines/share-gallery-direct

https://learn.microsoft.com/en-us/azure/virtual-machines/shared-image-galleries

https://learn.microsoft.com/en-us/azure/azure-signalr/

https://learn.microsoft.com/en-us/azure/site-recovery/

https://learn.microsoft.com/en-us/rest/api/site-recovery/

https://learn.microsoft.com/en-us/azure/virtual-machines/snapshot-copy-managed-disk

https://learn.microsoft.com/en-us/python/api/azure-synapse-spark/azure.synapse.spark.sparkclient?view=azure-python-preview

https://learn.microsoft.com/en-us/rest/api/speakerrecognition/

https://learn.microsoft.com/en-us/azure/ai-services/speech-service/

https://learn.microsoft.com/en-us/azure/ai-services/speech-service/rest-speech-to-text

https://learn.microsoft.com/en-us/dotnet/api/microsoft.azure.cognitiveservices.language.spellcheck.spellcheckclient?view=azure-dotnet

https://learn.microsoft.com/en-us/azure-sphere/?view=azure-sphere-integrated

https://learn.microsoft.com/en-us/azure/azure-sql/?view=azuresql

https://learn.microsoft.com/en-us/rest/api/sql/

https://learn.microsoft.com/en-us/azure/azure-sql/database/automated-backups-overview?view=azuresql

https://learn.microsoft.com/en-us/azure/azure-sql/database/?view=azuresql

https://learn.microsoft.com/en-us/azure/azure-sql/database/dynamic-data-masking-overview?view=azuresql

https://learn.microsoft.com/en-us/azure/azure-sql/database/disaster-recovery-guidance?view=azuresql

https://learn.microsoft.com/en-us/azure/azure-sql/database/database-import-export-private-link?view=azuresql

https://learn.microsoft.com/en-us/azure/azure-sql/database/replication-to-sql-database?view=azuresql

https://learn.microsoft.com/en-us/azure/azure-sql/database/firewall-configure?view=azuresql

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.sqlvirtualmachine-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/azure-stack/

https://docs.azure.cn/en-us/azure-stack/hci/

https://learn.microsoft.com/en-us/rest/api/appservice/static-sites/get-static-site?view=rest-appservice-2024-04-01

https://learn.microsoft.com/en-us/azure/storsimple/

https://learn.microsoft.com/en-us/javascript/api/overview/azure/arm-storsimple8000series-readme?view=azure-node-latest

https://learn.microsoft.com/en-us/azure/storage/

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.storageactions-readme?view=azure-dotnet-preview

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.storagecache-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/azure/import-export/

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.storage-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/azure/storage-mover/

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.storagepool-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/azure/stream-analytics/

https://learn.microsoft.com/en-us/javascript/api/overview/azure/arm-subscriptions-readme?view=azure-node-latest

https://learn.microsoft.com/en-us/azure/cloud-adoption-framework/ready/landing-zone/design-area/resource-org-subscriptions

https://learn.microsoft.com/en-us/python/api/azure-mgmt-synapse/azure.mgmt.synapse.synapsemanagementclient?view=azure-python

https://learn.microsoft.com/en-us/azure/synapse-analytics/sql/connect-overview

https://learn.microsoft.com/en-us/microsoft-365/syntex/

https://learn.microsoft.com/en-us/system-center/vmm/?view=sc-vmm-2025

https://learn.microsoft.com/en-us/azure/data-factory/control-flow-get-metadata-activity

https://learn.microsoft.com/en-us/rest/api/chaosstudio/target-types/list?view=rest-chaosstudio-2024-01-01

https://learn.microsoft.com/en-us/azure/azure-resource-manager/templates/template-specs

https://learn.microsoft.com/en-us/azure/azure-monitor/alerts/action-groups

https://learn.microsoft.com/en-us/azure/azure-monitor/alerts/alerts-create-activity-log-alert-rule

https://learn.microsoft.com/en-us/microsoft-365/test-base/overview?view=o365-worldwide

https://learn.microsoft.com/en-us/python/api/overview/azure/ai-textanalytics-readme?view=azure-python

https://learn.microsoft.com/en-us/azure/time-series-insights/

https://learn.microsoft.com/en-us/rest/api/appservice/top-level-domains/list?view=rest-appservice-2024-04-01

https://learn.microsoft.com/en-us/azure/expressroute/traffic-collector

https://learn.microsoft.com/en-us/azure/traffic-manager/

https://learn.microsoft.com/en-us/azure/update-manager/overview

https://learn.microsoft.com/en-us/azure/update-manager/manage-vms-programmatically

https://learn.microsoft.com/en-us/rest/api/consumption/

https://learn.microsoft.com/en-us/azure/azure-video-indexer/

https://learn.microsoft.com/en-us/javascript/api/@azure/video-analyzer-edge/?view=azure-node-legacy

https://learn.microsoft.com/en-us/azure/virtual-wan/

https://learn.microsoft.com/en-us/javascript/api/overview/azure/arm-visualstudio-readme?view=azure-node-preview

https://learn.microsoft.com/en-us/azure/azure-monitor/vm/vminsights-overview

https://learn.microsoft.com/en-us/azure/azure-vmware/

https://learn.microsoft.com/en-us/rest/api/avs/

https://learn.microsoft.com/en-us/azure/virtual-network/

https://learn.microsoft.com/en-us/azure/communications-gateway/provisioning-platform

https://learn.microsoft.com/en-us/rest/api/voiceservices/

https://learn.microsoft.com/en-us/azure/azure-web-pubsub/

https://learn.microsoft.com/en-us/rest/api/webpubsub/

https://learn.microsoft.com/en-us/python/api/azure-mgmt-web/azure.mgmt.web.websitemanagementclient?view=azure-python

https://learn.microsoft.com/en-us/lifecycle/faq/extended-security-updates

https://learn.microsoft.com/en-us/azure/azure-monitor/visualize/workbooks-overview

https://learn.microsoft.com/en-us/dotnet/api/overview/azure/resourcemanager.workloads-readme?view=azure-dotnet

https://learn.microsoft.com/en-us/rest/api/containerregistry/

https://azure.microsoft.com/en-us/products/container-registry

https://learn.microsoft.com/en-us/rest/api/aks/

https://azure.microsoft.com/en-us/products/kubernetes-service

https://learn.microsoft.com/en-us/rest/api/cosmos-db/

https://learn.microsoft.com/en-us/rest/api/cosmos-db-resource-provider/

https://azure.microsoft.com/en-us/products/cosmos-db

https://learn.microsoft.com/en-us/rest/api/resources/

https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/manage-resources-rest

https://learn.microsoft.com/en-us/rest/api/cognitiveservices/

https://learn.microsoft.com/en-us/rest/api/keyvault/

https://azure.microsoft.com/en-us/products/key-vault

Specifications

https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-compose-deployment-api-openapi.yml

Other Resources

https://azure.microsoft.com/en-us/pricing/details/api-management/

https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/json-ld/azure-blob-storage-context.jsonld

https://azure.microsoft.com/en-us/pricing/details/azure-openai/

https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/json-ld/azure-openai-service-context.jsonld

https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/json-ld/azure-container-registry-context.jsonld

https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/json-ld/azure-kubernetes-service-context.jsonld

https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/json-ld/azure-cosmos-db-context.jsonld

https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/json-ld/azure-resource-manager-context.jsonld

https://azure.microsoft.com/en-us/pricing/details/cognitive-services/

https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/json-ld/azure-cognitive-services-context.jsonld

https://azure.microsoft.com/en-us/pricing/details/key-vault/

https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/json-ld/azure-key-vault-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/microsoft-azure-compose-deployment-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Compose Deployment API
tags:
- name: Compose Deployment
paths:
  /ComposeDeployments/$/Create:
    put:
      summary: Microsoft Azure Creates A Service Fabric Compose Deployment
      description: Compose is a file format that describes multi-container applications. This API allows deploying container based applications defined in compose format in a Service Fabric cluster. Once the deployment is created, its status can be tracked via the `GetComposeDeploymentStatus` API.
      operationId: microsoftAzureCreatecomposedeployment
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-0-Preview_RequiredQueryParam'
      - $ref: '#/components/parameters/CreateComposeDeploymentRequiredBodyParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - Compose Deployment
      responses:
        '202':
          description: A successful operation will return 202 status code.
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
  /ComposeDeployments/{deploymentName}:
    get:
      summary: Microsoft Azure Gets Information About A Service Fabric Compose Deployment
      description: Returns the status of the compose deployment that was created or in the process of being created in the Service Fabric cluster and whose name matches the one specified as the parameter. The response includes the name, status, and other details about the deployment.
      operationId: microsoftAzureGetcomposedeploymentstatus
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-0-Preview_RequiredQueryParam'
      - $ref: '#/components/parameters/DeploymentNameRequiredPathParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - Compose Deployment
      responses:
        '200':
          description: Information about the compose deployment.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComposeDeploymentStatusInfo'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
  /ComposeDeployments:
    get:
      summary: Microsoft Azure Gets The List Of Compose Deployments Created In The Service Fabric Cluster
      description: Gets the status about the compose deployments that were created or in the process of being created in the Service Fabric cluster. The response includes the name, status, and other details about the compose deployments. If the list of deployments do not fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page.
      operationId: microsoftAzureGetcomposedeploymentstatuslist
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-0-Preview_RequiredQueryParam'
      - $ref: '#/components/parameters/ContinuationTokenOptionalQueryParam'
      - $ref: '#/components/parameters/MaxResultsOptionalQueryParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - Compose Deployment
      responses:
        '200':
          description: List of status of compose deployments in the cluster.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedComposeDeploymentStatusInfoList'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
  /ComposeDeployments/{deploymentName}/$/GetUpgradeProgress:
    get:
      summary: Microsoft Azure Gets Details For The Latest Upgrade Performed On This Service Fabric Compose Deployment
      description: Returns the information about the state of the compose deployment upgrade along with details to aid debugging application health issues.
      operationId: microsoftAzureGetcomposedeploymentupgradeprogress
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-0-Preview_RequiredQueryParam'
      - $ref: '#/components/parameters/DeploymentNameRequiredPathParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - Compose Deployment
      responses:
        '200':
          description: Details about the compose deployment upgrade.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComposeDeploymentUpgradeProgressInfo'
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
  /ComposeDeployments/{deploymentName}/$/Delete:
    post:
      summary: Microsoft Azure Deletes An Existing Service Fabric Compose Deployment From Cluster
      description: Deletes an existing Service Fabric compose deployment.
      operationId: microsoftAzureRemovecomposedeployment
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-0-Preview_RequiredQueryParam'
      - $ref: '#/components/parameters/DeploymentNameRequiredPathParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - Compose Deployment
      responses:
        '202':
          description: A successful operation will return 202 status code.
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
  /ComposeDeployments/{deploymentName}/$/Upgrade:
    post:
      summary: Microsoft Azure Starts Upgrading A Compose Deployment In The Service Fabric Cluster
      description: Validates the supplied upgrade parameters and starts upgrading the deployment if the parameters are valid.
      operationId: microsoftAzureStartcomposedeploymentupgrade
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-0-Preview_RequiredQueryParam'
      - $ref: '#/components/parameters/DeploymentNameRequiredPathParam'
      - $ref: '#/components/parameters/ComposeDeploymentUpgradeDescriptionRequiredBodyParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - Compose Deployment
      responses:
        '202':
          description: A successful response means that the upgrade has started. Use GetComposeDeploymentUpgrade operation to get the status of the upgrade.
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
  /ComposeDeployments/{deploymentName}/$/RollbackUpgrade:
    post:
      summary: Microsoft Azure Starts Rolling Back A Compose Deployment Upgrade In The Service Fabric Cluster
      description: Rollback a service fabric compose deployment upgrade.
      operationId: microsoftAzureStartrollbackcomposedeploymentupgrade
      parameters:
      - $ref: '#/components/parameters/ApiVersion_6-4-Preview_RequiredQueryParam'
      - $ref: '#/components/parameters/DeploymentNameRequiredPathParam'
      - $ref: '#/components/parameters/TimeoutOptionalQueryParam'
      tags:
      - Compose Deployment
      responses:
        '200':
          description: A successful response means that the rollback has started. Use GetComposeDeploymentUpgrade operation to get the status of the rollback.
        default:
          description: The detailed error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FabricError'
components:
  schemas:
    HealthCheckRetryTimeout:
      type: string
      description: 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 string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
      default: PT0H10M0S
    ComposeDeploymentUpgradeState:
      type: string
      description: The state of the compose deployment upgrade.
      enum:
      - Invalid
      - ProvisioningTarget
      - RollingForwardInProgress
      - RollingForwardPending
      - UnprovisioningCurrent
      - RollingForwardCompleted
      - RollingBackInProgress
      - UnprovisioningTarget
      - RollingBackCompleted
      - Failed
      x-ms-enum:
        name: ComposeDeploymentUpgradeState
        modelAsString: true
        values:
        - value: Invalid
          description: Indicates the upgrade state is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
        - value: ProvisioningTarget
          description: The upgrade is in the progress of provisioning target application type version. The value is 1.
        - value: RollingForwardInProgress
          description: The upgrade is rolling forward to the target version but is not complete yet. The value is 2.
        - value: RollingForwardPending
          description: The current upgrade domain has finished upgrading. The overall upgrade is waiting for an explicit move next request in UnmonitoredManual mode or performing health checks in Monitored mode. The value is 3
        - value: UnprovisioningCurrent
          description: The upgrade is in the progress of unprovisioning current application type version and rolling forward to the target version is completed. The value is 4.
        - value: RollingForwardCompleted
          description: The upgrade has finished rolling forward. The value is 5.
        - value: RollingBackInProgress
          description: The upgrade is rolling back to the previous version but is not complete yet. The value is 6.
        - value: UnprovisioningTarget
          description: The upgrade is in the progress of unprovisioning target application type version and rolling back to the current version is completed. The value is 7.
        - value: RollingBackCompleted
          description: The upgrade has finished rolling back. The value is 8.
        - value: Failed
          description: The upgrade has failed and is unable to execute FailureAction. The value is 9.
    UpgradeTimeout:
      type: string
      description: 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. If that fails, then it is interpreted as a number representing the total number of milliseconds.
      default: P10675199DT02H48M05.4775807S
    SafetyCheckWrapper:
      description: A wrapper for the safety check object. Safety checks are performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state.
      properties:
        SafetyCheck:
          $ref: '#/components/schemas/SafetyCheck'
          description: Represents a safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state.
    UpgradeDomainTimeout:
      type: string
      description: 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. If that fails, then it is interpreted as a number representing the total number of milliseconds.
      default: P10675199DT02H48M05.4775807S
    HealthEvaluationWrapper:
      description: Wrapper object for health evaluation.
      properties:
        HealthEvaluation:
          $ref: '#/components/schemas/HealthEvaluation'
          description: Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity.
    UpgradeMode:
      type: string
      description: The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, Monitored, and UnmonitoredDeferred.
      enum:
      - Invalid
      - UnmonitoredAuto
      - UnmonitoredManual
      - Monitored
      - UnmonitoredDeferred
      default: UnmonitoredAuto
      x-ms-enum:
        name: UpgradeMode
        modelAsString: true
        values:
        - value: Invalid
          description: Indicates the upgrade mode is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
        - value: UnmonitoredAuto
          description: The upgrade will proceed automatically without performing any health monitoring. The value is 1
        - value: UnmonitoredManual
          description: The upgrade will stop after completing each upgrade domain, giving the opportunity to manually monitor health before proceeding. The value is 2
        - value: Monitored
          description: The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. The value is 3
        - value: UnmonitoredDeferred
          description: Perform a node-by-node upgrade. No action is performed when upgrade starts; upgrade is applied on each node when it is deactivated with intent restart or higher. The value is 4
    SafetyCheckInfoList:
      type: array
      description: List of pending safety checks
      items:
        $ref: '#/components/schemas/SafetyCheckWrapper'
    CurrentUpgradeDomainDuration:
      type: string
      description: 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, then it is interpreted as a number representing the total number of milliseconds.
      default: PT0H2M0S
    ComposeDeploymentUpgradeProgressInfo:
      description: Describes the parameters for a compose deployment upgrade.
      properties:
        DeploymentName:
          $ref: '#/components/schemas/TargetDeploymentName'
          description: The name of the target deployment.
        ApplicationName:
          $ref: '#/components/schemas/TargetApplicationName'
          description: The name of the target application, including the 'fabric:' URI scheme.
        UpgradeState:
          $ref: '#/components/schemas/ComposeDeploymentUpgradeState'
          description: The state of the compose deployment upgrade.
        UpgradeStatusDetails:
          type: string
          description: Additional detailed information about the status of the pending upgrade.
        UpgradeKind:
          $ref: '#/components/schemas/UpgradeKind'
          description: The kind of upgrade out of the following possible values.
        RollingUpgradeMode:
          $ref: '#/components/schemas/UpgradeMode'
          description: The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, Monitored, and UnmonitoredDeferred.
        ForceRestart:
          $ref: '#/components/schemas/ForceRestart'
          description: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).
        UpgradeReplicaSetCheckTimeoutInSeconds:
          $ref: '#/components/schemas/UpgradeReplicaSetCheckTimeout'
          description: 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 expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).
        MonitoringPolicy:
          $ref: '#/components/schemas/MonitoringPolicyDescription'
          description: Describes the parameters for monitoring an upgrade in Monitored mode.
        ApplicationHealthPolicy:
          $ref: '#/components/schemas/ApplicationHealthPolicy'
          description: Defines a health policy used to evaluate the health of an application or one of its children entities.
        TargetApplicationTypeVersion:
          $ref: '#/components/schemas/TargetApplicationTypeVersion'
          description: The target application type version (found in the application manifest) for the application upgrade.
        UpgradeDuration:
          $ref: '#/components/schemas/UpgradeDuration'
          description: 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 interpreted as a number representing the total number of milliseconds.
        CurrentUpgradeDomainDuration:
          $ref: '#/components/schemas/CurrentUpgradeDomainDuration'
          description: 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, then it is interpreted as a number representing the total number of milliseconds.
        ApplicationUnhealthyEvaluations:
          $ref: '#/components/schemas/ApplicationUnhealthyEvaluations'
          description: List of health evaluations that resulted in the current aggregated health state.
        CurrentUpgradeDomainProgress:
          $ref: '#/components/schemas/CurrentUpgradeDomainProgressInfo'
          description: Information about the current in-progress upgrade domain. Not applicable to node-by-node upgrades.
        StartTimestampUtc:
          type: string
          description: The estimated UTC datetime when the upgrade started.
        FailureTimestampUtc:
          type: string
          description: The estimated UTC datetime when the upgrade failed and FailureAction was executed.
        FailureReason:
          $ref: '#/components/schemas/FailureReason'
          description: The cause of an upgrade failure that resulted in FailureAction being executed.
        UpgradeDomainProgressAtFailure:
          $ref: '#/components/schemas/FailureUpgradeDomainProgressInfo'
          description: Information about the upgrade domain progress at the time of upgrade failure.
        ApplicationUpgradeStatusDetails:
          type: string
          description: Additional details of application upgrade including failure message.
    ForceRestart:
      type: boolean
      description: If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).
      default: false
    UpgradeKind:
      type: string
      description: The kind of upgrade out of the following possible values.
      default: Rolling
      enum:
      - Invalid
      - Rolling
      x-ms-enum:
        name: UpgradeKind
        modelAsString: true
        values:
        - value: Invalid
          description: Indicates the upgrade kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero.
        - value: Rolling
          description: The upgrade progresses one upgrade domain at a time. The value is 1
    CurrentUpgradeDomainProgressInfo:
      description: Information about the current in-progress upgrade domain. Not applicable to node-by-node upgrades.
      properties:
        DomainName:
          $ref: '#/components/schemas/UpgradeDomainName'
          description: The name of the upgrade domain
        NodeUpgradeProgressList:
          $ref: '#/components/schemas/NodeUpgradeProgressInfoList'
          description: List of upgrading nodes and their statuses
    FabricErrorCodes:
      type: string
      description: "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 the error code values that can be returned for a specific HTTP status code.\n\n  - Possible values of the error code for HTTP status code 400 (Bad Request)\n    - \"FABRIC_E_INVALID_PARTITION_KEY\"\n    - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n    - \"FABRIC_E_INVALID_ADDRESS\"\n    - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n    - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n    - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n    - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n    - \"FABRIC_E_INVALID_CONFIGURATION\"\n    - \"FABRIC_E_INVALID_NAME_URI\"\n    - \"FABRIC_E_PATH_TOO_LONG\"\n    - \"FABRIC_E_KEY_TOO_LARGE\"\n    - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n    - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n    - \"FABRIC_E_VALUE_EMPTY\"\n    - \"FABRIC_E_BACKUP_IS_ENABLED\"\n    - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n    - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n    - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n    - \"E_INVALIDARG\"\n\n  - Possible values of the error code for HTTP status code 404 (Not Found)\n    - \"FABRIC_E_NODE_NOT_FOUND\"\n    - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n    - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n    - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n    - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n    - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n    - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n    - \"FABRIC_E_PARTITION_NOT_FOUND\"\n    - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n    - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n    - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n    - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n    - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n    - \"FABRIC_E_FILE_NOT_FOUND\"\n    - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n    - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n    - \"FABRIC_E_ENUMERATION_COMPLETED\"\n    - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n    - \"FABRIC_E_KEY_NOT_FOUND\"\n    - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n    - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n    - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n    - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n    - \"FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR\"\n\n  - Possible values of the error code for HTTP status code 409 (Conflict)\n    - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n    - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n    - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n    - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n    - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n    - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n    - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n    - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n    - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n    - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n    - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n    - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n    - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n    - \"FABRIC_E_NAME_NOT_EMPTY\"\n    - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n    - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n    - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n    - \"FABRIC_E_HEALTH_STALE_REPORT\"\n    - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n    - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n    - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n    - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n    - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n    - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n  - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n    - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n  - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n    - \"FABRIC_E_NODE_IS_UP\"\n    - \"E_FAIL\"\n    - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS\"\n    - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND\"\n    - \"FABRIC_E_VOLUME_ALREADY_EXISTS\"\n    - \"FABRIC_E_VOLUME_NOT_FOUND\"\n    - \"SerializationError\"\n\n  - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n    - \"FABRIC_E_NO_WRITE_QUORUM\"\n    - \"FABRIC_E_NOT_PRIMARY\"\n    - \"FABRIC_E_NOT_READY\"\n    - \"FABRIC_E_RECONFIGURATION_PENDING\"\n    - \"FABRIC_E_SERVICE_OFFLINE\"\n    - \"E_ABORT\"\n    - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n  - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n    - \"FABRIC_E_COMMUNICATION_ERROR\"\n    - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n    - \"FABRIC_E_TIMEOUT\""
      enum:
      - FABRIC_E_INVALID_PARTITION_KEY
      - FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR
      - FABRIC_E_INVALID_ADDRESS
      - FABRIC_E_APPLICATION_NOT_UPGRADING
      - FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR
      - FABRIC_E_FABRIC_NOT_UPGRADING
      - FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR
      - FABRIC_E_INVALID_CONFIGURATION
      - FABRIC_E_INVALID_NAME_URI
      - FABRIC_E_PATH_TOO_LONG
      - FABRIC_E_KEY_TOO_LARGE
      - FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED
      - FABRIC_E_INVALID_ATOMIC_GROUP
      - FABRIC_E_VALUE_EMPTY
      - FABRIC_E_NODE_NOT_FOUND
      - FABRIC_E_APPLICATION_TYPE_NOT_FOUND
      - FABRIC_E_APPLICATION_NOT_FOUND
      - FABRIC_E_SERVICE_TYPE_NOT_FOUND
      - FABRIC_E_SERVICE_DOES_NOT_EXIST
      - FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND
      - FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND
      - FABRIC_E_PARTITION_NOT_FOUND
      - FABRIC_E_REPLICA_DOES_NOT_EXIST
      - FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST
      - FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND
      - FABRIC_E_DIRECTORY_NOT_FOUND
      - FABRIC_E_FABRIC_VERSION_NOT_FOUND
      - FABRIC_E_FILE_NOT_FOUND
      - FABRIC_E_NAME_DOES_NOT_EXIST
      - FABRIC_E_PROPERTY_DOES_NOT_EXIST
      - FABRIC_E_ENUMERATION_COMPLETED
      - FABRIC_E_SERVICE_MANIFEST_NOT_FOUND
      - FABRIC_E_KEY_NOT_FOUND
      - FABRIC_E_HEALTH_ENTITY_NOT_FOUND
      - FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS
      - FABRIC_E_APPLICATION_ALREADY_EXISTS
      - FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION
      - FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS
      - FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS
      - FABRIC_E_SERVICE_ALREADY_EXISTS
      - FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS
      - FABRIC_E_APPLICATION_TYPE_IN_USE
      - FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION
      - FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS
      - FABRIC_E_FABRIC_VERSION_IN_USE
      - FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS
      - FABRIC_E_NAME_ALREADY_EXISTS
      - FABRIC_E_NAME_NOT_EMPTY
      - FABRIC_E_PROPERTY_CHECK_FAILED
      - FABRIC_E_SERVICE_METADATA_MISMATCH
      - FABRIC_E_SERVICE_TYPE_MISMATCH
      - FABRIC_E_HEALTH_STALE_REPORT
      - FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED
      - FABRIC_E_NODE_HAS_NOT_STOPPED_YET
      - FABRIC_E_INSTANCE_ID_MISMATCH
      - FABRIC_E_VALUE_TOO_LARGE
      - FABRIC_E_NO_WRITE_QUORUM
      - FABRIC_E_NOT_PRIMARY
      - FABRIC_E_NOT_READY
      - FABRIC_E_RECONFIGURATION_PENDING
      - FABRIC_E_SERVICE_OFFLINE
      - E_ABORT
      - FABRIC_E_COMMUNICATION_ERROR
      - FABRIC_E_OPERATION_NOT_COMPLETE
      - FABRIC_E_TIMEOUT
      - FABRIC_E_NODE_IS_UP
      - E_FAIL
      - FABRIC_E_BACKUP_IS_ENABLED
      - FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH
      - FABRIC_E_INVALID_FOR_STATELESS_SERVICES
      - FABRIC_E_BACKUP_NOT_ENABLED
      - FABRIC_E_BACKUP_POLICY_NOT_EXISTING
      - FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING
      - FABRIC_E_BACKUP_IN_PROGRESS
      - FABRIC_E_RESTORE_IN_PROGRESS
      - FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING
      - FABRIC_E_INVALID_SERVICE_SCALING_POLICY
      - E_INVALIDARG
      - FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS
      - FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND
      - FABRIC_E_VOLUME_ALREADY_EXISTS
      - FABRIC_E_VOLUME_NOT_FOUND
      - SerializationError
      - FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR
      x-ms-enum:
        name: FabricErrorCodes
        modelAsString: true
        values:
        - value: FABRIC_E_INVALID_PARTITION_KEY
        - value: FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR
        - value: FABRIC_E_INVALID_ADDRESS
        - value: FABRIC_E_APPLICATION_NOT_UPGRADING
        - value: FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR
        - value: FABRIC_E_FABRIC_NOT_UPGRADING
        - value: FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR
        - value: FABRIC_E_INVALID_CONFIGURATION
        - value: FABRIC_E_INVALID_NAME_URI
        - value: FABRIC_E_PATH_TOO_LONG
        - value: FABRIC_E_KEY_TOO_LARGE
        - value: FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED
        - value: FABRIC_E_INVALID_ATOMIC_GROUP
        - value: FABRIC_E_VALUE_EMPTY
        - value: FABRIC_E_NODE_NOT_FOUND
        - value: FABRIC_E_APPLICATION_TYPE_NOT_FOUND
        - value: FABRIC_E_APPLICATION_NOT_FOUND
        - value: FABRIC_E_SERVICE_TYPE_NOT_FOUND
        - value: FABRIC_E_SERVICE_DOES_NOT_EXIST
        - value: FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND
        - value: FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND
        - value: FABRIC_E_PARTITION_NOT_FOUND
        - value: FABRIC_E_REPLICA_DOES_NOT_EXIST
        - value: FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST
        - value: FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND
        - value: FABRIC_E_DIRECTORY_NOT_FOUND
        - value: FABRIC_E_FABRIC_VERSION_NOT_FOUND
        - value: FABRIC_E_FILE_NOT_FOUND
        - value: FABRIC_E_NAME_DOES_NOT_EXIST
        - value: FABRIC_E_PROPERTY_DOES_NOT_EXIST
        - value: FABRIC_E_ENUMERATION_COMPLETED
        - value: FABRIC_E_SERVICE_MANIFEST_NOT_FOUND
        - value: FABRIC_E_KEY_NOT_FOUND
        - value: FABRIC_E_HEALTH_ENTITY_NOT_FOUND
        - value: FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS
        - value: FABRIC_E_APPLICATION_ALREADY_EXISTS
        - value: FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION
        - value: FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS
        - value: FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS
        - value: FABRIC_E_SERVICE_ALREADY_EXISTS
        - value: FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS
        - value: FABRIC_E_APPLICATION_TYPE_IN_USE
        - value: FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION
        - value: FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS
        - value: FABRIC_E_FABRIC_VERSION_IN_USE
        - value: FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS
        - value: FABRIC_E_NAME_ALREADY_EXISTS
        - value: FABRIC_E_NAME_NOT_EMPTY
        - value: FABRIC_E_PROPERTY_CHECK_FAILED
        - value: FABRIC_E_SERVICE_METADATA_MISMATCH
        - value: FABRIC_E_SERVICE_TYPE_MISMATCH
        - value: FABRIC_E_HEALTH_STALE_REPORT
        - value: FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED
        - value: FABRIC_E_NODE_HAS_NOT_STOPPED_YET
        - value: FABRIC_E_INSTANCE_ID_MISMATCH
        - value: FABRIC_E_VALUE_TOO_LARGE
        - value: FABRIC_E_NO_WRITE_QUORUM
        - value: FABRIC_E_NOT_PRIMARY
        - value: FABRIC_E_NOT_READY
        - value: FABRIC_E_RECONFIGURATION_PENDING
        - value: FABRIC_E_SERVICE_OFFLINE
        - value: E_ABORT
        - value: FABRIC_E_COMMUNICATION_ERROR
        - value: FABRIC_E_OPERATION_NOT_COMPLETE
        - value: FABRIC_E_TIMEOUT
        - value: FABRIC_E_NODE_IS_UP
        - value: E_FAIL
        - value: FABRIC_E_BACKUP_IS_ENABLED
        - value: FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH
        - value: FABRIC_E_INVALID_FOR_STATELESS_SERVICES
        - value: FABRIC_E_BACKUP_NOT_ENABLED
        - value: FABRIC_E_BACKUP_POLICY_NOT_EXISTING
        - value: FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING
        - value: FABRIC_E_BACKUP_IN_PROGRESS
        - value: FABRIC_E_RESTORE_IN_PROGRESS
        - value: FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING
        - value: FABRIC_E_INVALID_SERVICE_SCALING_POLICY
        - value: E_INVALIDARG
        - value: FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS
        - value: FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND
        - value: FABRIC_E_VOLUME_ALREADY_EXISTS
        - value: FABRIC_E_VOLUME_NOT_FOUND
        - value: SerializationError
        - value: FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR
    TargetDeploymentName:
      type: string
      description: The name of the target deployment.
    UpgradeReplicaSetCheckTimeout:
      type: integer
      format: int64
      description: 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 expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).
      default: 42949672925
    ServiceTypeHealthPolicy:
      description: Represents the health policy used to evaluate the health of services belonging to a service type.
      properties:


# --- truncated at 32 KB (70 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-compose-deployment-api-openapi.yml