backups

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

Overview

Name	backups
Type	Resource
Id	azure_extras.storsimple_1200_series.backups

Fields

The following fields are returned by SELECT queries:

list_by_device

The collection of backups.

Name	Datatype	Description
id	string	The identifier.
name	string	The name.
properties	object	Properties of backup
type	string	The type.

list_by_manager

The collection of backups.

Name	Datatype	Description
id	string	The identifier.
name	string	The name.
properties	object	Properties of backup
type	string	The type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_device	select	deviceName, subscriptionId, resourceGroupName, managerName	forFailover, $filter	Retrieves all the backups in a device. Can be used to get the backups for failover also.
list_by_manager	select	subscriptionId, resourceGroupName, managerName	$filter	Retrieves all the backups in a manager.
delete	delete	deviceName, backupName, subscriptionId, resourceGroupName, managerName		Deletes the backup.
clone	exec	deviceName, backupName, elementName, subscriptionId, resourceGroupName, managerName, properties		Clones the given backup element to a new disk or share with given details.

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
backupName	string	The backup name.
deviceName	string	The device name.
elementName	string	The backup element name.
managerName	string	The manager name
resourceGroupName	string	The resource group name
subscriptionId	string	The subscription id
$filter	string	OData Filter options
forFailover	boolean	Set to true if you need backups which can be used for failover.

SELECT examples

list_by_device

Retrieves all the backups in a device. Can be used to get the backups for failover also.

SELECT
id,
name,
properties,
type
FROM azure_extras.storsimple_1200_series.backups
WHERE deviceName = '{{ deviceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND managerName = '{{ managerName }}' -- required
AND forFailover = '{{ forFailover }}'
AND $filter = '{{ $filter }}'
;

list_by_manager

Retrieves all the backups in a manager.

SELECT
id,
name,
properties,
type
FROM azure_extras.storsimple_1200_series.backups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND managerName = '{{ managerName }}' -- required
AND $filter = '{{ $filter }}'
;

DELETE examples

delete

Deletes the backup.

DELETE FROM azure_extras.storsimple_1200_series.backups
WHERE deviceName = '{{ deviceName }}' --required
AND backupName = '{{ backupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND managerName = '{{ managerName }}' --required
;

Lifecycle Methods

clone

Clones the given backup element to a new disk or share with given details.

EXEC azure_extras.storsimple_1200_series.backups.clone 
@deviceName='{{ deviceName }}' --required, 
@backupName='{{ backupName }}' --required, 
@elementName='{{ elementName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@managerName='{{ managerName }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;