backup_vaults

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

Overview

Name	backup_vaults
Type	Resource
Id	azure.data_protection.backup_vaults

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
identity	object	Input Managed Identity Details (title: DppIdentityDetails)
properties	object	BackupVaultResource properties (title: BackupVault)

get_in_resource_group

Name	Datatype	Description
identity	object	Input Managed Identity Details (title: DppIdentityDetails)
properties	object	BackupVaultResource properties (title: BackupVault)

get_in_subscription

Name	Datatype	Description
identity	object	Input Managed Identity Details (title: DppIdentityDetails)
properties	object	BackupVaultResource properties (title: BackupVault)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, vaultName		Returns a resource belonging to a resource group.
get_in_resource_group	select	resourceGroupName, subscriptionId		Returns resource collection belonging to a resource group.
get_in_subscription	select	subscriptionId		Returns resource collection belonging to a subscription.
create_or_update	insert	subscriptionId, resourceGroupName, vaultName, data__location, data__properties	x-ms-authorization-auxiliary	Creates or updates a BackupVault resource belonging to a resource group.
update	update	subscriptionId, resourceGroupName, vaultName	x-ms-authorization-auxiliary	Updates a BackupVault resource belonging to a resource group. For example, updating tags for a resource.
delete	delete	subscriptionId, resourceGroupName, vaultName		Deletes a BackupVault resource from the resource group.
check_name_availability	exec	resourceGroupName, subscriptionId, location

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
location	string	The location in which uniqueness will be verified.
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.
vaultName	string	The name of the backup vault.
x-ms-authorization-auxiliary	string

SELECT examples

get

Returns a resource belonging to a resource group.

SELECT
identity,
properties
FROM azure.data_protection.backup_vaults
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND vaultName = '{{ vaultName }}' -- required
;

get_in_resource_group

Returns resource collection belonging to a resource group.

SELECT
identity,
properties
FROM azure.data_protection.backup_vaults
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

get_in_subscription

Returns resource collection belonging to a subscription.

SELECT
identity,
properties
FROM azure.data_protection.backup_vaults
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a BackupVault resource belonging to a resource group.

INSERT INTO azure.data_protection.backup_vaults (
data__identity,
data__properties,
subscriptionId,
resourceGroupName,
vaultName,
x-ms-authorization-auxiliary
)
SELECT 
'{{ identity }}',
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ vaultName }}',
'{{ x-ms-authorization-auxiliary }}'
RETURNING
identity,
properties
;

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: vaultName
      value: string
      description: Required parameter for the backup_vaults resource.
    - name: identity
      value: object
      description: |
        Input Managed Identity Details
    - name: properties
      value: object
      description: |
        BackupVaultResource properties
    - name: x-ms-authorization-auxiliary
      value: string

UPDATE examples

update

Updates a BackupVault resource belonging to a resource group. For example, updating tags for a resource.

UPDATE azure.data_protection.backup_vaults
SET 
data__identity = '{{ identity }}',
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND vaultName = '{{ vaultName }}' --required
AND x-ms-authorization-auxiliary = '{{ x-ms-authorization-auxiliary}}'
RETURNING
identity,
properties;

DELETE examples

delete

Deletes a BackupVault resource from the resource group.

DELETE FROM azure.data_protection.backup_vaults
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND vaultName = '{{ vaultName }}' --required
;

Lifecycle Methods

check_name_availability

OK

EXEC azure.data_protection.backup_vaults.check_name_availability 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@location='{{ location }}' --required 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;