Skip to main content

backup_locations

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

Overview

Namebackup_locations
TypeResource
Idazure_stack.backup_admin.backup_locations

Fields

NameDatatypeDescription
idtextURI of the resource.
nametextName of the resource.
external_store_defaulttextfield from the properties object
locationtextLocation of the resource.
resourceGroupNametextfield from the properties object
subscriptionIdtextfield from the properties object
tagstextList of key value pairs.
typetextType of resource.

Methods

NameAccessible byRequired ParamsDescription
getSELECTlocation, resourceGroupName, subscriptionIdReturns a specific backup location based on name.
listSELECTresourceGroupName, subscriptionIdReturns the list of backup locations.
updateREPLACElocation, resourceGroupName, subscriptionIdUpdate a backup location.
prune_external_storeEXEClocation, resourceGroupName, subscriptionIdPrune the external backup store.

SELECT examples

Returns the list of 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 }}';

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 }}';