Skip to main content

start_application_upgrades

Creates, updates, deletes, gets or lists a start_application_upgrades resource.

Overview

Namestart_application_upgrades
TypeResource
Idazure.service_fabric_dataplane.start_application_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:

NameAccessible byRequired ParamsOptional ParamsDescription
start_application_upgradeexecapplication_id, endpoint, Name, TargetApplicationTypeVersion, UpgradeKindtimeoutStarts upgrading an application in the Service Fabric cluster. Validates the supplied application upgrade parameters and starts upgrading the application if the parameters are valid. Note, ApplicationParameters are not preserved across an application upgrade. In order to preserve current application parameters, the user should get the parameters using GetApplicationInfo operation first and pass them into the upgrade API call as shown in the example.

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.

NameDatatypeDescription
application_idstringThe identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myappapp1" in 6.0+ and "myapp/app1" in previous versions.
endpointstringThe service endpoint host (no scheme). (default: )
timeoutinteger (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

Starts upgrading an application in the Service Fabric cluster. Validates the supplied application upgrade parameters and starts upgrading the application if the parameters are valid. Note, ApplicationParameters are not preserved across an application upgrade. In order to preserve current application parameters, the user should get the parameters using GetApplicationInfo operation first and pass them into the upgrade API call as shown in the example.

EXEC azure.service_fabric_dataplane.start_application_upgrades.start_application_upgrade 
@application_id='{{ application_id }}' --required,
@endpoint='{{ endpoint }}' --required,
@timeout='{{ timeout }}'
@@json=
'{
"Name": "{{ Name }}",
"TargetApplicationTypeVersion": "{{ TargetApplicationTypeVersion }}",
"Parameters": "{{ Parameters }}",
"UpgradeKind": "{{ UpgradeKind }}",
"RollingUpgradeMode": "{{ RollingUpgradeMode }}",
"UpgradeReplicaSetCheckTimeoutInSeconds": {{ UpgradeReplicaSetCheckTimeoutInSeconds }},
"ForceRestart": {{ ForceRestart }},
"SortOrder": "{{ SortOrder }}",
"MonitoringPolicy": "{{ MonitoringPolicy }}",
"ApplicationHealthPolicy": "{{ ApplicationHealthPolicy }}",
"InstanceCloseDelayDurationInSeconds": {{ InstanceCloseDelayDurationInSeconds }},
"ManagedApplicationIdentity": "{{ ManagedApplicationIdentity }}"
}'
;