application_backup_lists
Creates, updates, deletes, gets or lists an application_backup_lists resource.
Overview
| Name | application_backup_lists |
| Type | Resource |
| Id | azure.service_fabric_dataplane.application_backup_lists |
Fields
The following fields are returned by SELECT queries:
- get_application_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_application_backup_list | select | application_id, endpoint | timeout, Latest, StartDateTimeFilter, EndDateTimeFilter, ContinuationToken, MaxResults | Gets the list of backups available for every partition in this application. Returns a list of backups available for every partition in this Service Fabric application. The server enumerates all the backups available at the backup location 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 every 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 |
|---|---|---|
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 " |
endpoint | string | The service endpoint host (no scheme). (default: ) |
ContinuationToken | string | The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded. |
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. |
MaxResults | integer (int64) | The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message. |
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_application_backup_list
Gets the list of backups available for every partition in this application. Returns a list of backups available for every partition in this Service Fabric application. The server enumerates all the backups available at the backup location 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 every partition.
SELECT
ContinuationToken,
Items
FROM azure.service_fabric_dataplane.application_backup_lists
WHERE application_id = '{{ application_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND timeout = '{{ timeout }}'
AND Latest = '{{ Latest }}'
AND StartDateTimeFilter = '{{ StartDateTimeFilter }}'
AND EndDateTimeFilter = '{{ EndDateTimeFilter }}'
AND ContinuationToken = '{{ ContinuationToken }}'
AND MaxResults = '{{ MaxResults }}'
;