backups

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

Overview

Name	backups
Type	Resource
Id	azure_isv.netapp.backups

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	Backup Properties

list_by_vault

Name	Datatype	Description
properties	object	Backup Properties

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, accountName, backupVaultName, backupName		Get the specified Backup under Backup Vault.
list_by_vault	select	subscriptionId, resourceGroupName, accountName, backupVaultName	$filter	List all backups Under a Backup Vault
create	insert	subscriptionId, resourceGroupName, accountName, backupVaultName, backupName, data__properties		Create a backup under the Backup Vault
update	update	subscriptionId, resourceGroupName, accountName, backupVaultName, backupName		Patch a Backup under the Backup Vault
delete	delete	subscriptionId, resourceGroupName, accountName, backupVaultName, backupName		Delete a Backup under the Backup Vault

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
accountName	string	The name of the NetApp account
backupName	string	The name of the backup
backupVaultName	string	The name of the Backup Vault
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
$filter	string	An option to specify the VolumeResourceId. If present, then only returns the backups under the specified volume

SELECT examples

get

Get the specified Backup under Backup Vault.

SELECT
properties
FROM azure_isv.netapp.backups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND backupVaultName = '{{ backupVaultName }}' -- required
AND backupName = '{{ backupName }}' -- required
;

list_by_vault

List all backups Under a Backup Vault

SELECT
properties
FROM azure_isv.netapp.backups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND backupVaultName = '{{ backupVaultName }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create

Create a backup under the Backup Vault

INSERT INTO azure_isv.netapp.backups (
data__properties,
subscriptionId,
resourceGroupName,
accountName,
backupVaultName,
backupName
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ backupVaultName }}',
'{{ backupName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: backups
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the backups resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the backups resource.
    - name: accountName
      value: string
      description: Required parameter for the backups resource.
    - name: backupVaultName
      value: string
      description: Required parameter for the backups resource.
    - name: backupName
      value: string
      description: Required parameter for the backups resource.
    - name: properties
      value: object
      description: |
        Backup Properties

UPDATE examples

update

Patch a Backup under the Backup Vault

UPDATE azure_isv.netapp.backups
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND backupVaultName = '{{ backupVaultName }}' --required
AND backupName = '{{ backupName }}' --required
RETURNING
properties;

DELETE examples

delete

Delete a Backup under the Backup Vault

DELETE FROM azure_isv.netapp.backups
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND backupVaultName = '{{ backupVaultName }}' --required
AND backupName = '{{ backupName }}' --required
;