cluster_upgrade_progress

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

Overview

Name	cluster_upgrade_progress
Type	Resource
Id	azure.service_fabric_dataplane.cluster_upgrade_progress

Fields

The following fields are returned by SELECT queries:

get_cluster_upgrade_progress

Name	Datatype	Description
CodeVersion	string
ConfigVersion	string
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
NextUpgradeDomain	string
RollingUpgradeMode	string
StartTimestampUtc	string
UnhealthyEvaluations	array
UpgradeDescription	object	Represents a ServiceFabric cluster upgrade.
UpgradeDomainDurationInMilliseconds	string
UpgradeDomainProgressAtFailure	object	The detailed upgrade progress for nodes in the current upgrade domain at the point of failure. Not applicable to node-by-node upgrades.
UpgradeDomains	array
UpgradeDurationInMilliseconds	string
UpgradeState	string
UpgradeUnits	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_cluster_upgrade_progress	select	endpoint	timeout	Gets the progress of the current cluster upgrade. Gets the current progress of the ongoing cluster upgrade. If no upgrade is currently in progress, get the last state of the previous cluster upgrade.

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
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_cluster_upgrade_progress

Gets the progress of the current cluster upgrade. Gets the current progress of the ongoing cluster upgrade. If no upgrade is currently in progress, get the last state of the previous cluster upgrade.

SELECT
CodeVersion,
ConfigVersion,
CurrentUpgradeDomainProgress,
CurrentUpgradeUnitsProgress,
FailureReason,
FailureTimestampUtc,
IsNodeByNode,
NextUpgradeDomain,
RollingUpgradeMode,
StartTimestampUtc,
UnhealthyEvaluations,
UpgradeDescription,
UpgradeDomainDurationInMilliseconds,
UpgradeDomainProgressAtFailure,
UpgradeDomains,
UpgradeDurationInMilliseconds,
UpgradeState,
UpgradeUnits
FROM azure.service_fabric_dataplane.cluster_upgrade_progress
WHERE endpoint = '{{ endpoint }}' -- required
AND timeout = '{{ timeout }}'
;