vault

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

Overview

Name	vault
Type	Resource
Id	azure.recovery_services_data_replication.vault

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.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Gets or sets the provisioning state of the vault. Known values are: "Canceled", "Creating", "Deleting", "Deleted", "Failed", "Succeeded", and "Updating". (Canceled, Creating, Deleting, Deleted, Failed, Succeeded, Updating)
serviceResourceId	string	Gets or sets the service resource Id.
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".
vaultType	string	Gets or sets the type of vault. Known values are: "DisasterRecovery" and "Migrate". (DisasterRecovery, Migrate)

list

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.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Gets or sets the provisioning state of the vault. Known values are: "Canceled", "Creating", "Deleting", "Deleted", "Failed", "Succeeded", and "Updating". (Canceled, Creating, Deleting, Deleted, Failed, Succeeded, Updating)
serviceResourceId	string	Gets or sets the service resource Id.
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".
vaultType	string	Gets or sets the type of vault. Known values are: "DisasterRecovery" and "Migrate". (DisasterRecovery, Migrate)

list_by_subscription

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.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Gets or sets the provisioning state of the vault. Known values are: "Canceled", "Creating", "Deleting", "Deleted", "Failed", "Succeeded", and "Updating". (Canceled, Creating, Deleting, Deleted, Failed, Succeeded, Updating)
serviceResourceId	string	Gets or sets the service resource Id.
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".
vaultType	string	Gets or sets the type of vault. Known values are: "DisasterRecovery" and "Migrate". (DisasterRecovery, Migrate)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, vault_name, subscription_id		Gets the details of the vault.
list	select	resource_group_name, subscription_id	continuationToken	Gets the list of vaults in the given subscription and resource group.
list_by_subscription	select	subscription_id		Gets the list of vaults in the given subscription.
create	insert	resource_group_name, vault_name, subscription_id, location		Creates the vault.
update	update	resource_group_name, vault_name, subscription_id		Performs update on the vault.
delete	delete	resource_group_name, vault_name, subscription_id		Removes the 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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
vault_name	string	The vault name. Required.
continuationToken	string	Continuation token from the previous call. Default value is None.

SELECT examples

get

Gets the details of the vault.

SELECT
id,
name,
identity,
location,
provisioningState,
serviceResourceId,
systemData,
tags,
type,
vaultType
FROM azure.recovery_services_data_replication.vault
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vault_name = '{{ vault_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets the list of vaults in the given subscription and resource group.

SELECT
id,
name,
identity,
location,
provisioningState,
serviceResourceId,
systemData,
tags,
type,
vaultType
FROM azure.recovery_services_data_replication.vault
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND continuationToken = '{{ continuationToken }}'
;

list_by_subscription

Gets the list of vaults in the given subscription.

SELECT
id,
name,
identity,
location,
provisioningState,
serviceResourceId,
systemData,
tags,
type,
vaultType
FROM azure.recovery_services_data_replication.vault
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates the vault.

INSERT INTO azure.recovery_services_data_replication.vault (
tags,
location,
properties,
identity,
resource_group_name,
vault_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ vault_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: vault
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the vault resource.
  - name: vault_name
    value: "{{ vault_name }}"
    description: Required parameter for the vault resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the vault resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      serviceResourceId: "{{ serviceResourceId }}"
      vaultType: "{{ vaultType }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Performs update on the vault.

UPDATE azure.recovery_services_data_replication.vault
SET 
tags = '{{ tags }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND vault_name = '{{ vault_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Removes the vault.

DELETE FROM azure.recovery_services_data_replication.vault
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND vault_name = '{{ vault_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;