vaults

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

Overview

Name	vaults
Type	Resource
Id	azure.recovery_services.vaults

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
identity	object	Identity for the resource.
location	string	The geo-location where the resource lives
properties	object	Properties of the vault.
sku	object	The resource model definition representing SKU
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

list_by_resource_group

Name	Datatype	Description
identity	object	Identity for the resource.
location	string	The geo-location where the resource lives
properties	object	Properties of the vault.
sku	object	The resource model definition representing SKU
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

list_by_subscription_id

Name	Datatype	Description
identity	object	Identity for the resource.
location	string	The geo-location where the resource lives
properties	object	Properties of the vault.
sku	object	The resource model definition representing SKU
systemData	object	Metadata pertaining to creation and last modification of the resource.
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, vaultName		Get the Vault details.
list_by_resource_group	select	subscriptionId, resourceGroupName		Retrieve a list of Vaults.
list_by_subscription_id	select	subscriptionId		Fetches all the resources of the specified type in the subscription.
create_or_update	insert	subscriptionId, resourceGroupName, vaultName	x-ms-authorization-auxiliary	Creates or updates a Recovery Services vault.
update	update	subscriptionId, resourceGroupName, vaultName	x-ms-authorization-auxiliary	Updates the vault.
delete	delete	subscriptionId, resourceGroupName, vaultName		Deletes a 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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
vaultName	string	The name of the recovery services vault.
x-ms-authorization-auxiliary	string

SELECT examples

get

Get the Vault details.

SELECT
identity,
location,
properties,
sku,
systemData,
tags
FROM azure.recovery_services.vaults
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND vaultName = '{{ vaultName }}' -- required
;

list_by_resource_group

Retrieve a list of Vaults.

SELECT
identity,
location,
properties,
sku,
systemData,
tags
FROM azure.recovery_services.vaults
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription_id

Fetches all the resources of the specified type in the subscription.

SELECT
identity,
location,
properties,
sku,
systemData,
tags
FROM azure.recovery_services.vaults
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a Recovery Services vault.

INSERT INTO azure.recovery_services.vaults (
data__tags,
data__location,
data__identity,
data__properties,
data__sku,
subscriptionId,
resourceGroupName,
vaultName,
x-ms-authorization-auxiliary
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ identity }}',
'{{ properties }}',
'{{ sku }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ vaultName }}',
'{{ x-ms-authorization-auxiliary }}'
RETURNING
identity,
location,
properties,
sku,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: vaults
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the vaults resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the vaults resource.
    - name: vaultName
      value: string
      description: Required parameter for the vaults resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: identity
      value: object
      description: |
        Identity for the resource.
    - name: properties
      value: object
      description: |
        Properties of the vault.
    - name: sku
      value: object
      description: |
        The resource model definition representing SKU
    - name: x-ms-authorization-auxiliary
      value: string

UPDATE examples

update

Updates the vault.

UPDATE azure.recovery_services.vaults
SET 
data__location = '{{ location }}',
data__tags = '{{ tags }}',
data__properties = '{{ properties }}',
data__sku = '{{ sku }}',
data__identity = '{{ identity }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND vaultName = '{{ vaultName }}' --required
AND x-ms-authorization-auxiliary = '{{ x-ms-authorization-auxiliary}}'
RETURNING
identity,
location,
properties,
sku,
systemData,
tags;

DELETE examples

delete

Deletes a vault.

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