partitions
Creates, updates, deletes, gets or lists a partitions resource.
Overview
| Name | partitions |
| Type | Resource |
| Id | azure.service_fabric_dataplane.partitions |
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 |
|---|---|---|---|---|
backup_partition | exec | partition_id, endpoint | BackupTimeout, timeout | Triggers backup of the partition's state. Creates a backup of the stateful persisted partition's state. In case the partition is already being periodically backed up, then by default the new backup is created at the same backup storage. One can also override the same by specifying the backup storage details as part of the request body. Once the backup is initiated, its progress can be tracked using the GetBackupProgress operation. In case, the operation times out, specify a greater backup timeout value in the query parameter. |
restore_partition | exec | partition_id, endpoint, BackupId, BackupLocation | RestoreTimeout, timeout | Triggers restore of the state of the partition using the specified restore partition description. Restores the state of a of the stateful persisted partition using the specified backup point. In case the partition is already being periodically backed up, then by default the backup point is looked for in the storage specified in backup policy. One can also override the same by specifying the backup storage details as part of the restore partition description in body. Once the restore is initiated, its progress can be tracked using the GetRestoreProgress operation. In case, the operation times out, specify a greater restore timeout value in the query parameter. |
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: ) |
partition_id | string | The identity of the partition. |
BackupTimeout | integer | Specifies the maximum amount of time, in minutes, to wait for the backup operation to complete. Post that, the operation completes with timeout error. However, in certain corner cases it could be that though the operation returns back timeout, the backup actually goes through. In case of timeout error, its recommended to invoke this operation again with a greater timeout value. The default value for the same is 10 minutes. |
RestoreTimeout | integer | Specifies the maximum amount of time to wait, in minutes, for the restore operation to complete. Post that, the operation returns back with timeout error. However, in certain corner cases it could be that the restore operation goes through even though it completes with timeout. In case of timeout error, its recommended to invoke this operation again with a greater timeout value. the default value for the same is 10 minutes. |
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
- backup_partition
- restore_partition
Triggers backup of the partition's state. Creates a backup of the stateful persisted partition's state. In case the partition is already being periodically backed up, then by default the new backup is created at the same backup storage. One can also override the same by specifying the backup storage details as part of the request body. Once the backup is initiated, its progress can be tracked using the GetBackupProgress operation. In case, the operation times out, specify a greater backup timeout value in the query parameter.
EXEC azure.service_fabric_dataplane.partitions.backup_partition
@partition_id='{{ partition_id }}' --required,
@endpoint='{{ endpoint }}' --required,
@BackupTimeout='{{ BackupTimeout }}',
@timeout='{{ timeout }}'
@@json=
'{
"BackupStorage": "{{ BackupStorage }}"
}'
;
Triggers restore of the state of the partition using the specified restore partition description. Restores the state of a of the stateful persisted partition using the specified backup point. In case the partition is already being periodically backed up, then by default the backup point is looked for in the storage specified in backup policy. One can also override the same by specifying the backup storage details as part of the restore partition description in body. Once the restore is initiated, its progress can be tracked using the GetRestoreProgress operation. In case, the operation times out, specify a greater restore timeout value in the query parameter.
EXEC azure.service_fabric_dataplane.partitions.restore_partition
@partition_id='{{ partition_id }}' --required,
@endpoint='{{ endpoint }}' --required,
@RestoreTimeout='{{ RestoreTimeout }}',
@timeout='{{ timeout }}'
@@json=
'{
"BackupId": "{{ BackupId }}",
"BackupLocation": "{{ BackupLocation }}",
"BackupStorage": "{{ BackupStorage }}"
}'
;