backup_policies

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

Overview

Name	backup_policies
Type	Resource
Id	azure_extras.storsimple_8000_series.backup_policies

Fields

The following fields are returned by SELECT queries:

get

The backup policy.

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 policy.
type	string	The hierarchical type of the object.

list_by_device

The collection of backup policies.

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 policy.
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
get	select	deviceName, backupPolicyName, subscriptionId, resourceGroupName, managerName		Gets the properties of the specified backup policy name.
list_by_device	select	deviceName, subscriptionId, resourceGroupName, managerName		Gets all the backup policies in a device.
create_or_update	insert	deviceName, backupPolicyName, subscriptionId, resourceGroupName, managerName, data__properties		Creates or updates the backup policy.
delete	delete	deviceName, backupPolicyName, subscriptionId, resourceGroupName, managerName		Deletes the backup policy.
backup_now	exec	deviceName, backupPolicyName, backupType, subscriptionId, resourceGroupName, managerName		Backup the backup policy now.

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
backupPolicyName	string	The backup policy name.
backupType	string	The backup Type. This can be cloudSnapshot or localSnapshot.
deviceName	string	The device name
managerName	string	The manager name
resourceGroupName	string	The resource group name
subscriptionId	string	The subscription id

SELECT examples

get

Gets the properties of the specified backup policy name.

SELECT
id,
name,
kind,
properties,
type
FROM azure_extras.storsimple_8000_series.backup_policies
WHERE deviceName = '{{ deviceName }}' -- required
AND backupPolicyName = '{{ backupPolicyName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND managerName = '{{ managerName }}' -- required
;

list_by_device

Gets all the backup policies in a device.

SELECT
id,
name,
kind,
properties,
type
FROM azure_extras.storsimple_8000_series.backup_policies
WHERE deviceName = '{{ deviceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND managerName = '{{ managerName }}' -- required
;

INSERT examples

create_or_update

Creates or updates the backup policy.

INSERT INTO azure_extras.storsimple_8000_series.backup_policies (
data__kind,
data__properties,
deviceName,
backupPolicyName,
subscriptionId,
resourceGroupName,
managerName
)
SELECT 
'{{ kind }}',
'{{ properties }}' /* required */,
'{{ deviceName }}',
'{{ backupPolicyName }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ managerName }}'
RETURNING
id,
name,
kind,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: backup_policies
  props:
    - name: deviceName
      value: string
      description: Required parameter for the backup_policies resource.
    - name: backupPolicyName
      value: string
      description: Required parameter for the backup_policies resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the backup_policies resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the backup_policies resource.
    - name: managerName
      value: string
      description: Required parameter for the backup_policies resource.
    - name: kind
      value: string
      description: |
        The Kind of the object. Currently only Series8000 is supported
      valid_values: ['Series8000']
    - name: properties
      value: object
      description: |
        The properties of the backup policy.

DELETE examples

delete

Deletes the backup policy.

DELETE FROM azure_extras.storsimple_8000_series.backup_policies
WHERE deviceName = '{{ deviceName }}' --required
AND backupPolicyName = '{{ backupPolicyName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND managerName = '{{ managerName }}' --required
;

Lifecycle Methods

backup_now

Backup the backup policy now.

EXEC azure_extras.storsimple_8000_series.backup_policies.backup_now 
@deviceName='{{ deviceName }}' --required, 
@backupPolicyName='{{ backupPolicyName }}' --required, 
@backupType='{{ backupType }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@managerName='{{ managerName }}' --required
;