backups

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

Overview

Name	backups
Type	Resource
Id	azure_extras.storsimple_8000_series.backups

Fields

The following fields are returned by SELECT queries:

list_by_device

The collection of backups.

Name	Datatype	Description
id	string	The path ID that uniquely identifies the object.
name	string	The name of the object.
kind	string	The Kind of the object. Currently only Series8000 is supported
properties	object	The properties of the backup.
type	string	The hierarchical type of the object.

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	$filter	Retrieves all the backups in a device.
delete	delete	deviceName, backupName, subscriptionId, resourceGroupName, managerName		Deletes the backup.
clone	exec	deviceName, backupName, backupElementName, subscriptionId, resourceGroupName, managerName, targetDeviceId, targetVolumeName, targetAccessControlRecordIds, backupElement		Clones the backup element as a new volume.
restore	exec	deviceName, backupName, subscriptionId, resourceGroupName, managerName		Restores the backup on the device.

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
backupElementName	string	The backup element name.
backupName	string	The backupSet name
deviceName	string	The device name
managerName	string	The manager name
resourceGroupName	string	The resource group name
subscriptionId	string	The subscription id
$filter	string	OData Filter options

SELECT examples

list_by_device

Retrieves all the backups in a device.

SELECT
id,
name,
kind,
properties,
type
FROM azure_extras.storsimple_8000_series.backups
WHERE deviceName = '{{ deviceName }}' -- required
AND 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_8000_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 backup element as a new volume.

EXEC azure_extras.storsimple_8000_series.backups.clone 
@deviceName='{{ deviceName }}' --required, 
@backupName='{{ backupName }}' --required, 
@backupElementName='{{ backupElementName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@managerName='{{ managerName }}' --required 
@@json=
'{
"targetDeviceId": "{{ targetDeviceId }}", 
"targetVolumeName": "{{ targetVolumeName }}", 
"targetAccessControlRecordIds": "{{ targetAccessControlRecordIds }}", 
"backupElement": "{{ backupElement }}"
}'
;

restore

Restores the backup on the device.

EXEC azure_extras.storsimple_8000_series.backups.restore 
@deviceName='{{ deviceName }}' --required, 
@backupName='{{ backupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@managerName='{{ managerName }}' --required
;