backup_locations
Creates, updates, deletes, gets or lists a backup_locations
resource.
Overview
Name | backup_locations |
Type | Resource |
Id | azure_stack.backup_admin.backup_locations |
Fields
- vw_backup_locations
- backup_locations
Name | Datatype | Description |
---|---|---|
id | text | URI of the resource. |
name | text | Name of the resource. |
external_store_default | text | field from the properties object |
location | text | Location of the resource. |
resourceGroupName | text | field from the properties object |
subscriptionId | text | field from the properties object |
tags | text | List of key value pairs. |
type | text | Type of resource. |
Name | Datatype | Description |
---|---|---|
id | string | URI of the resource. |
name | string | Name of the resource. |
location | string | Location of the resource. |
properties | object | Properties of a backup location. |
tags | object | List of key value pairs. |
type | string | Type of resource. |
Methods
Name | Accessible by | Required Params | Description |
---|---|---|---|
get | SELECT | location, resourceGroupName, subscriptionId | Returns a specific backup location based on name. |
list | SELECT | resourceGroupName, subscriptionId | Returns the list of backup locations. |
update | REPLACE | location, resourceGroupName, subscriptionId | Update a backup location. |
prune_external_store | EXEC | location, resourceGroupName, subscriptionId | Prune the external backup store. |
SELECT
examples
Returns the list of backup locations.
- vw_backup_locations
- backup_locations
SELECT
id,
name,
external_store_default,
location,
resourceGroupName,
subscriptionId,
tags,
type
FROM azure_stack.backup_admin.vw_backup_locations
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';
SELECT
id,
name,
location,
properties,
tags,
type
FROM azure_stack.backup_admin.backup_locations
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';
REPLACE
example
Replaces all fields in the specified backup_locations
resource.
/*+ update */
REPLACE azure_stack.backup_admin.backup_locations
SET
properties = '{{ properties }}',
location = '{{ location }}',
tags = '{{ tags }}'
WHERE
location = '{{ location }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';