backup_schedules

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

Overview

Name	backup_schedules
Type	Resource
Id	azure_extras.storsimple_8000_series.backup_schedules

Fields

The following fields are returned by SELECT queries:

get

The backup schedule.

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

list_by_backup_policy

The collection of backup schedules.

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 schedule.
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, backupScheduleName, subscriptionId, resourceGroupName, managerName		Gets the properties of the specified backup schedule name.
list_by_backup_policy	select	deviceName, backupPolicyName, subscriptionId, resourceGroupName, managerName		Gets all the backup schedules in a backup policy.
create_or_update	insert	deviceName, backupPolicyName, backupScheduleName, subscriptionId, resourceGroupName, managerName, data__properties		Creates or updates the backup schedule.
delete	delete	deviceName, backupPolicyName, backupScheduleName, subscriptionId, resourceGroupName, managerName		Deletes the backup schedule.

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.
backupScheduleName	string	The name the backup schedule.
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 schedule name.

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

list_by_backup_policy

Gets all the backup schedules in a backup policy.

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

INSERT examples

create_or_update

Creates or updates the backup schedule.

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

Manifest

# Description fields are for documentation purposes
- name: backup_schedules
  props:
    - name: deviceName
      value: string
      description: Required parameter for the backup_schedules resource.
    - name: backupPolicyName
      value: string
      description: Required parameter for the backup_schedules resource.
    - name: backupScheduleName
      value: string
      description: Required parameter for the backup_schedules resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the backup_schedules resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the backup_schedules resource.
    - name: managerName
      value: string
      description: Required parameter for the backup_schedules 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 schedule.

DELETE examples

delete

Deletes the backup schedule.

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