backup_vaults

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

Overview

Name	backup_vaults
Type	Resource
Id	azure_isv.netapp.backup_vaults

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Backup Vault Properties
tags	object	Resource tags.

list_by_netapp_account

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Backup Vault Properties
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, accountName, backupVaultName		Get the Backup Vault
list_by_netapp_account	select	subscriptionId, resourceGroupName, accountName		List and describe all Backup Vaults in the NetApp account.
create_or_update	insert	subscriptionId, resourceGroupName, accountName, backupVaultName, data__location		Create or update the specified Backup Vault in the NetApp account
update	update	subscriptionId, resourceGroupName, accountName, backupVaultName		Patch the specified NetApp Backup Vault
delete	delete	subscriptionId, resourceGroupName, accountName, backupVaultName		Delete the specified 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
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.

SELECT examples

get

Get the Backup Vault

SELECT
location,
properties,
tags
FROM azure_isv.netapp.backup_vaults
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND backupVaultName = '{{ backupVaultName }}' -- required
;

list_by_netapp_account

List and describe all Backup Vaults in the NetApp account.

SELECT
location,
properties,
tags
FROM azure_isv.netapp.backup_vaults
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
;

INSERT examples

create_or_update

Create or update the specified Backup Vault in the NetApp account

INSERT INTO azure_isv.netapp.backup_vaults (
data__tags,
data__location,
data__properties,
subscriptionId,
resourceGroupName,
accountName,
backupVaultName
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ backupVaultName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: backup_vaults
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the backup_vaults resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the backup_vaults resource.
    - name: accountName
      value: string
      description: Required parameter for the backup_vaults resource.
    - name: backupVaultName
      value: string
      description: Required parameter for the backup_vaults resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        Backup Vault Properties

UPDATE examples

update

Patch the specified NetApp Backup Vault

UPDATE azure_isv.netapp.backup_vaults
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND backupVaultName = '{{ backupVaultName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Delete the specified Backup Vault

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