backups

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

Overview

Name	backups
Type	Resource
Id	azure_stack.backup_admin.backups

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 for a backup.
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 for a backup.
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, backup		Returns a backup from a location based on name.
list	select	subscriptionId, resourceGroupName, location	$top, $skip	Returns a list of backups from a location.
restore	exec	subscriptionId, location, resourceGroupName, backup		Restore a backup.

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
backup	string	Name of the backup.
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 backup from a location based on name.

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

list

Returns a list of backups from a location.

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

Lifecycle Methods

restore

Restore a backup.

EXEC azure_stack.backup_admin.backups.restore 
@subscriptionId='{{ subscriptionId }}' --required, 
@location='{{ location }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@backup='{{ backup }}' --required 
@@json=
'{
"roleName": "{{ roleName }}", 
"decryptionCertBase64": "{{ decryptionCertBase64 }}", 
"decryptionCertPassword": "{{ decryptionCertPassword }}"
}'
;