start_compose_deployment_upgrades
Creates, updates, deletes, gets or lists a start_compose_deployment_upgrades resource.
Overview
| Name | start_compose_deployment_upgrades |
| Type | Resource |
| Id | azure.service_fabric_dataplane.start_compose_deployment_upgrades |
Fields
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
start_compose_deployment_upgrade | exec | deployment_name, endpoint, DeploymentName, ComposeFileContent, UpgradeKind | timeout | 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. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
deployment_name | string | The identity of the deployment. |
endpoint | string | The service endpoint host (no scheme). (default: ) |
timeout | integer (int64) | 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. |
Lifecycle Methods
- 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.
EXEC azure.service_fabric_dataplane.start_compose_deployment_upgrades.start_compose_deployment_upgrade
@deployment_name='{{ deployment_name }}' --required,
@endpoint='{{ endpoint }}' --required,
@timeout='{{ timeout }}'
@@json=
'{
"DeploymentName": "{{ DeploymentName }}",
"ComposeFileContent": "{{ ComposeFileContent }}",
"RegistryCredential": "{{ RegistryCredential }}",
"UpgradeKind": "{{ UpgradeKind }}",
"RollingUpgradeMode": "{{ RollingUpgradeMode }}",
"UpgradeReplicaSetCheckTimeoutInSeconds": {{ UpgradeReplicaSetCheckTimeoutInSeconds }},
"ForceRestart": {{ ForceRestart }},
"MonitoringPolicy": "{{ MonitoringPolicy }}",
"ApplicationHealthPolicy": "{{ ApplicationHealthPolicy }}"
}'
;