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

The following fields are returned by SELECT queries:

get

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.

list

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

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, location		Returns a specific backup location based on name.
list	select	subscriptionId, resourceGroupName	$top, $skip	Returns the list of backup locations.
update	replace	subscriptionId, resourceGroupName, location		Update a backup location.
prune_external_store	exec	subscriptionId, resourceGroupName, location		Prune the external backup store.

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
location	string	Name of the backup location.
resourceGroupName	string	Name of the resource group.
subscriptionId	string	Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
$skip	string	OData skip parameter.
$top	string	OData top parameter.

SELECT examples

get

Returns a specific backup location based on name.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure_stack.backup_admin.backup_locations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND location = '{{ location }}' -- required
;

list

Returns the list of backup locations.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure_stack.backup_admin.backup_locations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;

REPLACE examples

update

Update a backup location.

REPLACE azure_stack.backup_admin.backup_locations
SET 
data__properties = '{{ properties }}',
data__location = '{{ location }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

Lifecycle Methods

prune_external_store

Prune the external backup store.

EXEC azure_stack.backup_admin.backup_locations.prune_external_store 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@location='{{ location }}' --required 
@@json=
'{
"operationType": "{{ operationType }}"
}'
;