application_upgrades

Creates, updates, deletes, gets or lists an application_upgrades resource.

Overview

Name	application_upgrades
Type	Resource
Id	azure.service_fabric_dataplane.application_upgrades

Fields

The following fields are returned by SELECT queries:

get_application_upgrade

Name	Datatype	Description
CurrentUpgradeDomainProgress	object	Information about the current in-progress upgrade domain. Not applicable to node-by-node upgrades.
CurrentUpgradeUnitsProgress	object	Information about the current in-progress upgrade units.
FailureReason	string
FailureTimestampUtc	string
IsNodeByNode	boolean
Name	string
NextUpgradeDomain	string
RollingUpgradeMode	string
StartTimestampUtc	string
TargetApplicationTypeVersion	string
TypeName	string
UnhealthyEvaluations	array
UpgradeDescription	object	Describes the parameters for an application upgrade. Note that upgrade description replaces the existing application description. This means that if the parameters are not specified, the existing parameters on the applications will be overwritten with the empty parameters list. This would result in the application using the default value of the parameters from the application manifest. If you do not want to change any existing parameter values, please get the application parameters first using the GetApplicationInfo query and then supply those values as Parameters in this ApplicationUpgradeDescription. All required parameters must be populated in order to send to Azure.
UpgradeDomainDurationInMilliseconds	string
UpgradeDomainProgressAtFailure	object	Information about the upgrade domain progress at the time of upgrade failure.
UpgradeDomains	array
UpgradeDurationInMilliseconds	string
UpgradeState	string
UpgradeStatusDetails	string
UpgradeUnits	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_application_upgrade	select	application_id, endpoint	timeout	Gets details for the latest upgrade performed on this application. Returns information about the state of the latest application upgrade along with details to aid debugging application health issues.
update_application_upgrade	exec	application_id, endpoint, Name, UpgradeKind	timeout	Updates an ongoing application upgrade in the Service Fabric cluster. Updates the parameters of an ongoing application upgrade from the ones specified at the time of starting the application upgrade. This may be required to mitigate stuck application upgrades due to incorrect parameters or issues in the application to make progress.

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
application_id	string	The 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.
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.

SELECT examples

get_application_upgrade

Gets details for the latest upgrade performed on this application. Returns information about the state of the latest application upgrade along with details to aid debugging application health issues.

SELECT
CurrentUpgradeDomainProgress,
CurrentUpgradeUnitsProgress,
FailureReason,
FailureTimestampUtc,
IsNodeByNode,
Name,
NextUpgradeDomain,
RollingUpgradeMode,
StartTimestampUtc,
TargetApplicationTypeVersion,
TypeName,
UnhealthyEvaluations,
UpgradeDescription,
UpgradeDomainDurationInMilliseconds,
UpgradeDomainProgressAtFailure,
UpgradeDomains,
UpgradeDurationInMilliseconds,
UpgradeState,
UpgradeStatusDetails,
UpgradeUnits
FROM azure.service_fabric_dataplane.application_upgrades
WHERE application_id = '{{ application_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND timeout = '{{ timeout }}'
;

Lifecycle Methods

update_application_upgrade

Updates an ongoing application upgrade in the Service Fabric cluster. Updates the parameters of an ongoing application upgrade from the ones specified at the time of starting the application upgrade. This may be required to mitigate stuck application upgrades due to incorrect parameters or issues in the application to make progress.

EXEC azure.service_fabric_dataplane.application_upgrades.update_application_upgrade 
@application_id='{{ application_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@timeout='{{ timeout }}' 
@@json=
'{
"Name": "{{ Name }}", 
"UpgradeKind": "{{ UpgradeKind }}", 
"ApplicationHealthPolicy": "{{ ApplicationHealthPolicy }}", 
"UpdateDescription": "{{ UpdateDescription }}"
}'
;