v2

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

Compose Deployment

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.

post/ComposeDeployments/{deploymentName}/$/Upgrade

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.

Request body

DeploymentNamestring required

The name of the deployment.

ComposeFileContentstring required

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

UpgradeKind'Invalid' | 'Rolling' required

The kind of upgrade out of the following possible values.

RollingUpgradeMode'Invalid' | 'UnmonitoredAuto' | 'UnmonitoredManual' | 'Monitored'

The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored.

UpgradeReplicaSetCheckTimeoutInSecondsinteger

The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).

ForceRestartboolean

If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).

Response

A successful response means that the upgrade has started. Use GetComposeDeploymentUpgrade operation to get the status of the upgrade.