backup_vaults

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

Overview

Name	backup_vaults
Type	Resource
Id	azure.netapp.backup_vaults

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Azure lifecycle management.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_net_app_account

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Azure lifecycle management.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, account_name, backup_vault_name, subscription_id		Get the Backup Vault.
list_by_net_app_account	select	resource_group_name, account_name, subscription_id		List and describe all Backup Vaults in the NetApp account.
create_or_update	insert	resource_group_name, account_name, backup_vault_name, subscription_id, location		Create or update the specified Backup Vault in the NetApp account.
update	update	resource_group_name, account_name, backup_vault_name, subscription_id		Patch the specified NetApp Backup Vault.
create_or_update	replace	resource_group_name, account_name, backup_vault_name, subscription_id, location		Create or update the specified Backup Vault in the NetApp account.
delete	delete	resource_group_name, account_name, backup_vault_name, subscription_id		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
account_name	string	The name of the NetApp account. Required.
backup_vault_name	string	The name of the Backup Vault. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get the Backup Vault.

SELECT
id,
name,
location,
provisioningState,
systemData,
tags,
type
FROM azure.netapp.backup_vaults
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND backup_vault_name = '{{ backup_vault_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_net_app_account

List and describe all Backup Vaults in the NetApp account.

SELECT
id,
name,
location,
provisioningState,
systemData,
tags,
type
FROM azure.netapp.backup_vaults
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update the specified Backup Vault in the NetApp account.

INSERT INTO azure.netapp.backup_vaults (
tags,
location,
properties,
resource_group_name,
account_name,
backup_vault_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ backup_vault_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: backup_vaults
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the backup_vaults resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the backup_vaults resource.
  - name: backup_vault_name
    value: "{{ backup_vault_name }}"
    description: Required parameter for the backup_vaults resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the backup_vaults resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Backup Vault Properties.
    value:
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Patch the specified NetApp Backup Vault.

UPDATE azure.netapp.backup_vaults
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND backup_vault_name = '{{ backup_vault_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or update the specified Backup Vault in the NetApp account.

REPLACE azure.netapp.backup_vaults
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND backup_vault_name = '{{ backup_vault_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete the specified Backup Vault.

DELETE FROM azure.netapp.backup_vaults
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND backup_vault_name = '{{ backup_vault_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;