partition_backup_lists
Creates, updates, deletes, gets or lists a partition_backup_lists resource.
Overview
| Name | partition_backup_lists |
| Type | Resource |
| Id | azure.service_fabric_dataplane.partition_backup_lists |
Fields
The following fields are returned by SELECT queries:
- get_partition_backup_list
| Name | Datatype | Description |
|---|---|---|
ContinuationToken | string | |
Items | array |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_partition_backup_list | select | partition_id, endpoint | timeout, Latest, StartDateTimeFilter, EndDateTimeFilter | Gets the list of backups available for the specified partition. Returns a list of backups available for the specified partition. The server enumerates all the backups available in the backup store configured in the backup policy. It also allows filtering of the result based on start and end datetime or just fetching the latest available backup for the partition. |
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. |
EndDateTimeFilter | string (date-time) | Specify the end date time till which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, enumeration is done till the most recent backup. |
Latest | boolean | Specifies whether to get only the most recent backup available for a partition for the specified time range. |
StartDateTimeFilter | string (date-time) | Specify the start date time from which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, all backups from the beginning are enumerated. |
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_partition_backup_list
Gets the list of backups available for the specified partition. Returns a list of backups available for the specified partition. The server enumerates all the backups available in the backup store configured in the backup policy. It also allows filtering of the result based on start and end datetime or just fetching the latest available backup for the partition.
SELECT
ContinuationToken,
Items
FROM azure.service_fabric_dataplane.partition_backup_lists
WHERE partition_id = '{{ partition_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND timeout = '{{ timeout }}'
AND Latest = '{{ Latest }}'
AND StartDateTimeFilter = '{{ StartDateTimeFilter }}'
AND EndDateTimeFilter = '{{ EndDateTimeFilter }}'
;