Skip to main content

partition_restore_progress

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

Overview

Namepartition_restore_progress
TypeResource
Idazure.service_fabric_dataplane.partition_restore_progress

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
FailureErrorobjectError object containing error code and error message. All required parameters must be populated in order to send to Azure.
RestoreStatestring
RestoredEpochobjectAn Epoch is a configuration number for the partition as a whole. When the configuration of the replica set changes, for example when the Primary replica changes, the operations that are replicated from the new Primary replica are said to be a new Epoch from the ones which were sent by the old Primary replica.
RestoredLsnstring
TimeStampUtcstring (date-time)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_partition_restore_progressselectpartition_id, endpointtimeoutGets details for the latest restore operation triggered for this partition. Returns information about the state of the latest restore operation along with details or failure reason in case of completion.

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
endpointstringThe service endpoint host (no scheme). (default: )
partition_idstringThe identity of the partition.
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.

SELECT examples

Gets details for the latest restore operation triggered for this partition. Returns information about the state of the latest restore operation along with details or failure reason in case of completion.

SELECT
FailureError,
RestoreState,
RestoredEpoch,
RestoredLsn,
TimeStampUtc
FROM azure.service_fabric_dataplane.partition_restore_progress
WHERE partition_id = '{{ partition_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND timeout = '{{ timeout }}'
;