Microsoft Azure
Microsoft Azure Compose Deployment API

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

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Compose Deployment API
schemes:
- https
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: '#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam'
      - $ref: '#/parameters/CreateComposeDeploymentRequiredBodyParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Compose Deployment
      responses:
        '202':
          description: A successful operation will return 202 status code.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/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: '#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam'
      - $ref: '#/parameters/DeploymentNameRequiredPathParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Compose Deployment
      responses:
        '200':
          description: Information about the compose deployment.
          schema:
            $ref: '#/definitions/ComposeDeploymentStatusInfo'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/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: '#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam'
      - $ref: '#/parameters/ContinuationTokenOptionalQueryParam'
      - $ref: '#/parameters/MaxResultsOptionalQueryParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Compose Deployment
      responses:
        '200':
          description: List of status of compose deployments in the cluster.
          schema:
            $ref: '#/definitions/PagedComposeDeploymentStatusInfoList'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/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: '#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam'
      - $ref: '#/parameters/DeploymentNameRequiredPathParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Compose Deployment
      responses:
        '200':
          description: Details about the compose deployment upgrade.
          schema:
            $ref: '#/definitions/ComposeDeploymentUpgradeProgressInfo'
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/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: '#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam'
      - $ref: '#/parameters/DeploymentNameRequiredPathParam'
      - $ref: '#/parameters/TimeoutOptionalQueryParam'
      tags:
      - Compose Deployment
      responses:
        '202':
          description: A successful operation will return 202 status code.
        default:
          description: The detailed error response.
          schema:
            $ref: '#/definitions/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: '#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam'
      - $ref: '#/parameters/DeploymentNameRequiredPathParam'
      - $ref: '#/parameters/ComposeDeploymentUpgradeDescriptionRequiredBodyParam'
      - $ref: '#/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.
          schema:
            $ref: '#/definitions/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: '#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam'
      - $ref: '#/parameters/DeploymentNameRequiredPathParam'
      - $ref: '#/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.
          schema:
            $ref: '#/definitions/FabricError'
definitions:
  TargetDeploymentName:
    type: string
    description: The name of the target deployment.
  ComposeDeploymentStatus:
    type: string
    description: The status of the compose deployment.
    enum:
    - Invalid
    - Provisioning
    - Creating
    - Ready
    - Unprovisioning
    - Deleting
    - Failed
    - Upgrading
    x-ms-enum:
      name: ComposeDeploymentStatus
      modelAsString: true
      values:
      - value: Invalid
        description: Indicates that the compose deployment status is invalid. The value is zero.
      - value: Provisioning
        description: Indicates that the compose deployment is being provisioned in background. The value is 1.
      - value: Creating
        description: Indicates that the compose deployment is being created in background. The value is 2.
      - value: Ready
        description: Indicates that the compose deployment has been successfully created or upgraded. The value is 3.
      - value: Unprovisioning
        description: Indicates that the compose deployment is being unprovisioned in background. The value is 4.
      - value: Deleting
        description: Indicates that the compose deployment is being deleted in background. The value is 5.
      - value: Failed
        description: Indicates that the compose deployment was terminated due to persistent failures. The value is 6.
      - value: Upgrading
        description: Indicates that the compose deployment is being upgraded in the background. The value is 7.
  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
  FabricErrorError:
    description: Error object containing error code and error message.
    properties:
      Code:
        $ref: '#/definitions/FabricErrorCodes'
        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\""
      Message:
        type: string
        description: Error message.
    required:
    - Code
  TargetApplicationName:
    type: string
    description: The name of the target application, including the 'fabric:' URI scheme.
  HealthCheckWaitDuration:
    type: string
    description: 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 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.
    default: '0'
  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.
  HealthEvaluation:
    discriminator: Kind
    description: Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity.
    properties:
      Kind:
        $ref: '#/definitions/HealthEvaluationKind'
        description: The health manager in the cluster performs health evaluations in determining the aggregated health state of an entity. This enumeration provides information on the kind of evaluation that was performed. Following are the possible values.
      AggregatedHealthState:
        $ref: '#/definitions/HealthState'
        description: The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
      Description:
        type: string
        description: Description of the health evaluation, which represents a summary of the evaluation process.
    required:
    - Kind
  ApplicationUnhealthyEvaluations:
    description: List of health evaluations that resulted in the current aggregated health state.
    type: array
    items:
      $ref: '#/definitions/HealthEvaluationWrapper'
  HealthEvaluationWrapper:
    description: Wrapper object for health evaluation.
    properties:
      HealthEvaluation:
        $ref: '#/definitions/HealthEvaluation'
        description: Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity.
  SafetyCheck:
    discriminator: Kind
    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.
    properties:
      Kind:
        $ref: '#/definitions/SafetyCheckKind'
        description: The kind of 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. Following are the kinds of safety checks.
    required:
    - Kind
  HealthEvaluationKind:
    type: string
    description: The health manager in the cluster performs health evaluations in determining the aggregated health state of an entity. This enumeration provides information on the kind of evaluation that was performed. Following are the possible values.
    enum:
    - Invalid
    - Event
    - Replicas
    - Partitions
    - DeployedServicePackages
    - DeployedApplications
    - Services
    - Nodes
    - Applications
    - SystemApplication
    - UpgradeDomainDeployedApplications
    - UpgradeDomainNodes
    - Replica
    - Partition
    - DeployedServicePackage
    - DeployedApplication
    - Service
    - Node
    - Application
    - DeltaNodesCheck
    - UpgradeDomainDeltaNodesCheck
    - ApplicationTypeApplications
    - NodeTypeNodes
    x-ms-enum:
      name: HealthEvaluationKind
      modelAsString: true
      values:
      - value: Invalid
        description: Indicates that the health evaluation is invalid. The value is zero.
      - value: Event
        description: Indicates that the health evaluation is for a health event. The value is 1.
      - value: Replicas
        description: Indicates that the health evaluation is for the replicas of a partition. The value is 2.
      - value: Partitions
        description: Indicates that the health evaluation is for the partitions of a service. The value is 3.
      - value: DeployedServicePackages
        description: Indicates that the health evaluation is for the deployed service packages of a deployed application. The value is 4.
      - value: DeployedApplications
        description: Indicates that the health evaluation is for the deployed applications of an application. The value is 5.
      - value: Services
        description: Indicates that the health evaluation is for services of an application. The value is 6.
      - value: Nodes
        description: Indicates that the health evaluation is for the cluster nodes. The value is 7.
      - value: Applications
        description: Indicates that the health evaluation is for the cluster applications. The value is 8.
      - value: SystemApplication
        description: Indicates that the health evaluation is for the system application. The value is 9.
      - value: UpgradeDomainDeployedApplications
        description: Indicates that the health evaluation is for the deployed applications of an application in an upgrade domain. The value is 10.
      - value: UpgradeDomainNodes
        description: Indicates that the health evaluation is for the cluster nodes in an upgrade domain. The value is 11.
      - value: Replica
        description: Indicates that the health evaluation is for a replica. The value is 13.
      - value: Partition
        description: Indicates that the health evaluation is for a partition. The value is 14.
      - value: DeployedServicePackage
        description: Indicates that the health evaluation is for a deployed service package. The value is 16.
      - value: DeployedApplication
        description: Indicates that the health evaluation is for a deployed application. The value is 17.
      - value: Service
        description: Indicates that the health evaluation is for a service. The value is 15.
      - value: Node
        description: Indicates that the health evaluation is for a node. The value is 12.
      - value: Application
        description: Indicates that the health evaluation is for an application. The value is 18.
      - value: DeltaNodesCheck
        description: Indicates that the health evaluation is for the delta of unhealthy cluster nodes. The value is 19.
      - value: UpgradeDomainDeltaNodesCheck
        description: Indicates that the health evaluation is for the delta of unhealthy upgrade domain cluster nodes. The value is 20.
      - value: ApplicationTypeApplications
        description: – Indicates that the health evaluation is for applications of an application type. The value is 21.
      - value: NodeTypeNodes
        description: – Indicates that the health evaluation is for nodes of a node type. The value is 22.
  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: '#/definitions/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.
  FailureUpgradeDomainProgressInfo:
    description: Information about the upgrade domain progress at the time of upgrade failure.
    properties:
      DomainName:
        $ref: '#/definitions/UpgradeDomainName'
        description: The name of the upgrade domain
      NodeUpgradeProgressList:
        $ref: '#/definitions/NodeUpgradeProgressInfoList'
        description: List of upgrading nodes and their statuses
  NodeUpgradePhase:
    type: string
    description: The state of the upgrading node.
    enum:
    - Invalid
    - PreUpgradeSafetyCheck
    - Upgrading
    - PostUpgradeSafetyCheck
    x-ms-enum:
      name: NodeUpgradePhase
      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: PreUpgradeSafetyCheck
        description: The upgrade has not started yet due to pending safety checks. The value is 1
      - value: Upgrading
        description: The upgrade is in progress. The value is 2
      - value: PostUpgradeSafetyCheck
        description: The upgrade has completed and post upgrade safety checks are being performed. The value is 3
  HealthState:
    type: string
    description: The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.
    enum:
    - Invalid
    - Ok
    - Warning
    - Error
    - Unknown
    x-ms-enum:
      name: HealthState
      modelAsString: true
      values:
      - value: Invalid
        description: Indicates an invalid health state. All Service Fabric enumerations have the invalid type. The value is zero.
      - value: Ok
        description: Indicates the health state is okay. The value is 1.
      - value: Warning
        description: Indicates the health state is at a warning level. The value is 2.
      - value: Error
        description: Indicates the health state is at an error level. Error health state should be investigated, as they can impact the correct functionality of the cluster. The value is 3.
      - value: Unknown
        description: Indicates an unknown health status. The value is 65535.
  ServiceTypeHealthPolicyMap:
    type: array
    items:
      $ref: '#/definitions/ServiceTypeHealthPolicyMapItem'
    description: 'Defines a ServiceTypeHealthPolicy per service type name.


      The entries in the map replace the default service type health policy for each specified service type. For example, in an application that contains both a stateless gateway service type and a stateful engine service type, the health policies for the stateless and stateful services can be configured differently. With policy per service type, there''s more granular control of the health of the service.


      If no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation.'
  UpgradeDomainName:
    type: string
    description: The name of the upgrade domain
  ComposeDeploymentUpgradeDescription:
    description: Describes the parameters for a compose deployment upgrade.
    properties:
      DeploymentName:
        $ref: '#/definitions/DeploymentName'
        description: The name of the deployment.
      ComposeFileContent:
        type: string
        description: The content of the compose file that describes the deployment to create.
      RegistryCredential:
        $ref: '#/definitions/RegistryCredential'
        description: Credential information to connect to container registry.
      UpgradeKind:
        $ref: '#/definitions/UpgradeKind'
        description: The kind of upgrade out of the following possible values.
      RollingUpgradeMode:
        $ref: '#/definitions/UpgradeMode'
        description: The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, Monitored, and UnmonitoredDeferred.
      UpgradeReplicaSetCheckTimeoutInSeconds:
        $ref: '#/definitions/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).
      ForceRestart:
        $ref: '#/definitions/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).
      MonitoringPolicy:
        $ref: '#/definitions/MonitoringPolicyDescription'
        description: Describes the parameters for monitoring an upgrade in Monitored mode.
      ApplicationHealthPolicy:
        $ref: '#/definitions/ApplicationHealthPolicy'
        description: Defines a health policy used to evaluate the health of an application or one of its children entities.
    required:
    - DeploymentName
    - ComposeFileContent
    - UpgradeKind
  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
  ApplicationName:
    type: string
    description: The name of the application, including the 'fabric:' URI scheme.
  ServiceTypeHealthPolicyMapItem:
    description: Defines an item in ServiceTypeHealthPolicyMap.
    required:
    - Key
    - Value
    properties:
      Key:
        type: string
        description: The key of the service type health policy map item. This is the name of the service type.
      Value:
        $ref: '#/definitions/ServiceTypeHealthPolicy'
        description: The value of the service type health policy map item. This is the ServiceTypeHealthPolicy for this service type.
  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  

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

Documentation

Specifications

Other Resources

OpenAPI Specification
