backup_schedule_groups

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

Overview

Name	backup_schedule_groups
Type	Resource
Id	azure_extras.storsimple_1200_series.backup_schedule_groups

Fields

The following fields are returned by SELECT queries:

get

The backup schedule group.

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

list_by_device

The collection of backup schedule groups.

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	deviceName, scheduleGroupName, subscriptionId, resourceGroupName, managerName		Returns the properties of the specified backup schedule group name.
list_by_device	select	deviceName, subscriptionId, resourceGroupName, managerName		Retrieves all the backup schedule groups in a device.
create_or_update	insert	deviceName, scheduleGroupName, subscriptionId, resourceGroupName, managerName, data__properties		Creates or Updates the backup schedule Group.
delete	delete	deviceName, scheduleGroupName, subscriptionId, resourceGroupName, managerName		Deletes the backup schedule group.

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
deviceName	string	The name of the device.
managerName	string	The manager name
resourceGroupName	string	The resource group name
scheduleGroupName	string	The name of the schedule group.
subscriptionId	string	The subscription id

SELECT examples

get

Returns the properties of the specified backup schedule group name.

SELECT
id,
name,
properties,
type
FROM azure_extras.storsimple_1200_series.backup_schedule_groups
WHERE deviceName = '{{ deviceName }}' -- required
AND scheduleGroupName = '{{ scheduleGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND managerName = '{{ managerName }}' -- required
;

list_by_device

Retrieves all the backup schedule groups in a device.

SELECT
id,
name,
properties,
type
FROM azure_extras.storsimple_1200_series.backup_schedule_groups
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 schedule Group.

INSERT INTO azure_extras.storsimple_1200_series.backup_schedule_groups (
data__properties,
deviceName,
scheduleGroupName,
subscriptionId,
resourceGroupName,
managerName
)
SELECT 
'{{ properties }}' /* required */,
'{{ deviceName }}',
'{{ scheduleGroupName }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ managerName }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: backup_schedule_groups
  props:
    - name: deviceName
      value: string
      description: Required parameter for the backup_schedule_groups resource.
    - name: scheduleGroupName
      value: string
      description: Required parameter for the backup_schedule_groups resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the backup_schedule_groups resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the backup_schedule_groups resource.
    - name: managerName
      value: string
      description: Required parameter for the backup_schedule_groups resource.
    - name: properties
      value: object
      description: |
        Properties of BackupScheduleGroup

DELETE examples

delete

Deletes the backup schedule group.

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