Create 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.
Request
| Method | Request URI |
|---|---|
| PUT | /ComposeDeployments/$/Create?api-version=6.0-preview&timeout={timeout} |
Parameters
| Name | Type | Required | Location |
|---|---|---|---|
api-version |
string | Yes | Query |
timeout |
integer (int64) | No | Query |
CreateComposeDeploymentDescription |
CreateComposeDeploymentDescription | Yes | Body |
api-version
Type: string
Required: Yes
Default: 6.0-preview
The version of the API. This parameter is required and its value must be '"6.0-preview'.
timeout
Type: integer (int64)
Required: No
Default: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1
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.
CreateComposeDeploymentDescription
Type: CreateComposeDeploymentDescription
Required: Yes
Describes the compose deployment that needs to be created.
Responses
| HTTP Status Code | Description | Response Schema |
|---|---|---|
| 202 (Accepted) | A successful operation will return 202 status code. |
|
| All other status codes | The detailed error response. |
FabricError |