Get Compose Deployment Status

  • Article

Gets information about a Service Fabric compose deployment.

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.

Request

Method Request URI
GET /ComposeDeployments/{deploymentName}?api-version=6.0-preview&timeout={timeout}

Parameters

Name Type Required Location
deploymentName string Yes Path
api-version string Yes Query
timeout integer (int64) No Query

deploymentName

Type: string
Required: Yes

The identity of the deployment.

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.

Responses

HTTP Status Code Description Response Schema
200 (OK) Information about the compose deployment.
 ComposeDeploymentStatusInfo
All other status codes The detailed error response.
 FabricError