Start Compose Deployment Upgrade
Starts upgrading a compose deployment in the Service Fabric cluster.
Validates the supplied upgrade parameters and starts upgrading the deployment if the parameters are valid.
Request
| Method | Request URI |
|---|---|
| POST | /ComposeDeployments/{deploymentName}/$/Upgrade?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 |
ComposeDeploymentUpgradeDescription |
ComposeDeploymentUpgradeDescription | Yes | Body |
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.
ComposeDeploymentUpgradeDescription
Type: ComposeDeploymentUpgradeDescription
Required: Yes
Parameters for upgrading compose deployment.
Responses
| HTTP Status Code | Description | Response Schema |
|---|---|---|
| 202 (Accepted) | A successful response means that the upgrade has started. Use GetComposeDeploymentUpgrade operation to get the status of the upgrade. |
|
| All other status codes | The detailed error response. |
FabricError |