v2

latestSwagger 2.0raw.githubusercontent.com2019-06-202346811.1 MB
Compose Deployment

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.

get/ComposeDeployments/{deploymentName}

Path parameters

deploymentNamestring required

The identity of the deployment.

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.

Response

Information about the compose deployment.

Namestring

The name of the deployment.

ApplicationNamestring

The name of the application, including the 'fabric:' URI scheme.

Status'Invalid' | 'Provisioning' | 'Creating' | 'Ready' | 'Unprovisioning' | 'Deleting' | 'Failed' | 'Upgrading'

The status of the compose deployment.

StatusDetailsstring

The status details of compose deployment including failure message.