v10

latestSwagger 2.02026-07-132477431.2 MB

Compose Deployment

Creates a Service Fabric compose deployment.

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.

put/ComposeDeployments/$/Create

Query parameters

api-version'6.0-preview' required

The version of the API. This parameter is required and its value must be '"6.0-preview'.

timeoutinteger

The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.

Request body

DeploymentNamestring required

The name of the deployment.

ComposeFileContentstring required

The content of the compose file that describes the deployment to create.

Response

A successful operation will return 202 status code.