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
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.
backupStorageVersion	string	Backup storage version. Known values are: "V1", "V2", and "Unassigned". (V1, V2, Unassigned)
bcdrSecurityLevel	string	Security levels of Recovery Services Vault for business continuity and disaster recovery. Known values are: "Poor", "Fair", "Good", and "Excellent". (Poor, Fair, Good, Excellent)
encryption	object	Customer Managed Key details of the resource.
etag	string	etag for the resource.
identity	object	Identity for the resource.
location	string	The geo-location where the resource lives. Required.
monitoringSettings	object	Monitoring Settings of the vault.
moveDetails	object	The details of the latest move operation performed on the Azure Resource.
moveState	string	The State of the Resource after the move operation. Known values are: "Unknown", "InProgress", "PrepareFailed", "CommitFailed", "PrepareTimedout", "CommitTimedout", "MoveSucceeded", "Failure", "CriticalFailure", and "PartialSuccess". (Unknown, InProgress, PrepareFailed, CommitFailed, PrepareTimedout, CommitTimedout, MoveSucceeded, Failure, CriticalFailure, PartialSuccess)
privateEndpointConnections	array	List of private endpoint connection.
privateEndpointStateForBackup	string	Private endpoint state for backup. Known values are: "None" and "Enabled". (None, Enabled)
privateEndpointStateForSiteRecovery	string	Private endpoint state for site recovery. Known values are: "None" and "Enabled". (None, Enabled)
provisioningState	string	Provisioning State.
publicNetworkAccess	string	property to enable or disable resource provider inbound network traffic from public clients. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
redundancySettings	object	The redundancy Settings of a Vault.
resourceGuardOperationRequests	array	ResourceGuardOperationRequests on which LAC check will be performed.
restoreSettings	object	Restore Settings of the vault.
secureScore	string	Secure Score of Recovery Services Vault. Known values are: "None", "Minimum", "Adequate", and "Maximum". (None, Minimum, Adequate, Maximum)
securitySettings	object	Security Settings of the vault.
sku	object	Identifies the unique system identifier for each Azure resource.
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".
upgradeDetails	object	Details for upgrading vault.

list_by_resource_group

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.
backupStorageVersion	string	Backup storage version. Known values are: "V1", "V2", and "Unassigned". (V1, V2, Unassigned)
bcdrSecurityLevel	string	Security levels of Recovery Services Vault for business continuity and disaster recovery. Known values are: "Poor", "Fair", "Good", and "Excellent". (Poor, Fair, Good, Excellent)
encryption	object	Customer Managed Key details of the resource.
etag	string	etag for the resource.
identity	object	Identity for the resource.
location	string	The geo-location where the resource lives. Required.
monitoringSettings	object	Monitoring Settings of the vault.
moveDetails	object	The details of the latest move operation performed on the Azure Resource.
moveState	string	The State of the Resource after the move operation. Known values are: "Unknown", "InProgress", "PrepareFailed", "CommitFailed", "PrepareTimedout", "CommitTimedout", "MoveSucceeded", "Failure", "CriticalFailure", and "PartialSuccess". (Unknown, InProgress, PrepareFailed, CommitFailed, PrepareTimedout, CommitTimedout, MoveSucceeded, Failure, CriticalFailure, PartialSuccess)
privateEndpointConnections	array	List of private endpoint connection.
privateEndpointStateForBackup	string	Private endpoint state for backup. Known values are: "None" and "Enabled". (None, Enabled)
privateEndpointStateForSiteRecovery	string	Private endpoint state for site recovery. Known values are: "None" and "Enabled". (None, Enabled)
provisioningState	string	Provisioning State.
publicNetworkAccess	string	property to enable or disable resource provider inbound network traffic from public clients. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
redundancySettings	object	The redundancy Settings of a Vault.
resourceGuardOperationRequests	array	ResourceGuardOperationRequests on which LAC check will be performed.
restoreSettings	object	Restore Settings of the vault.
secureScore	string	Secure Score of Recovery Services Vault. Known values are: "None", "Minimum", "Adequate", and "Maximum". (None, Minimum, Adequate, Maximum)
securitySettings	object	Security Settings of the vault.
sku	object	Identifies the unique system identifier for each Azure resource.
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".
upgradeDetails	object	Details for upgrading vault.

list_by_subscription_id

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.
backupStorageVersion	string	Backup storage version. Known values are: "V1", "V2", and "Unassigned". (V1, V2, Unassigned)
bcdrSecurityLevel	string	Security levels of Recovery Services Vault for business continuity and disaster recovery. Known values are: "Poor", "Fair", "Good", and "Excellent". (Poor, Fair, Good, Excellent)
encryption	object	Customer Managed Key details of the resource.
etag	string	etag for the resource.
identity	object	Identity for the resource.
location	string	The geo-location where the resource lives. Required.
monitoringSettings	object	Monitoring Settings of the vault.
moveDetails	object	The details of the latest move operation performed on the Azure Resource.
moveState	string	The State of the Resource after the move operation. Known values are: "Unknown", "InProgress", "PrepareFailed", "CommitFailed", "PrepareTimedout", "CommitTimedout", "MoveSucceeded", "Failure", "CriticalFailure", and "PartialSuccess". (Unknown, InProgress, PrepareFailed, CommitFailed, PrepareTimedout, CommitTimedout, MoveSucceeded, Failure, CriticalFailure, PartialSuccess)
privateEndpointConnections	array	List of private endpoint connection.
privateEndpointStateForBackup	string	Private endpoint state for backup. Known values are: "None" and "Enabled". (None, Enabled)
privateEndpointStateForSiteRecovery	string	Private endpoint state for site recovery. Known values are: "None" and "Enabled". (None, Enabled)
provisioningState	string	Provisioning State.
publicNetworkAccess	string	property to enable or disable resource provider inbound network traffic from public clients. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
redundancySettings	object	The redundancy Settings of a Vault.
resourceGuardOperationRequests	array	ResourceGuardOperationRequests on which LAC check will be performed.
restoreSettings	object	Restore Settings of the vault.
secureScore	string	Secure Score of Recovery Services Vault. Known values are: "None", "Minimum", "Adequate", and "Maximum". (None, Minimum, Adequate, Maximum)
securitySettings	object	Security Settings of the vault.
sku	object	Identifies the unique system identifier for each Azure resource.
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".
upgradeDetails	object	Details for upgrading vault.

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		Get the Vault details.
list_by_resource_group	select	resource_group_name, subscription_id		Retrieve a list of Vaults.
list_by_subscription_id	select	subscription_id		Fetches all the resources of the specified type in the subscription.
create_or_update	insert	resource_group_name, vault_name, subscription_id, location	x-ms-authorization-auxiliary	Creates or updates a Recovery Services vault.
update	update	resource_group_name, vault_name, subscription_id	x-ms-authorization-auxiliary	Updates the vault.
create_or_update	replace	resource_group_name, vault_name, subscription_id, location	x-ms-authorization-auxiliary	Creates or updates a Recovery Services vault.
delete	delete	resource_group_name, vault_name, subscription_id		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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
vault_name	string	The name of the Vault. Required.
x-ms-authorization-auxiliary	string	Default value is None.

SELECT examples

get

Get the Vault details.

SELECT
id,
name,
backupStorageVersion,
bcdrSecurityLevel,
encryption,
etag,
identity,
location,
monitoringSettings,
moveDetails,
moveState,
privateEndpointConnections,
privateEndpointStateForBackup,
privateEndpointStateForSiteRecovery,
provisioningState,
publicNetworkAccess,
redundancySettings,
resourceGuardOperationRequests,
restoreSettings,
secureScore,
securitySettings,
sku,
systemData,
tags,
type,
upgradeDetails
FROM azure.recovery_services.vaults
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vault_name = '{{ vault_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Retrieve a list of Vaults.

SELECT
id,
name,
backupStorageVersion,
bcdrSecurityLevel,
encryption,
etag,
identity,
location,
monitoringSettings,
moveDetails,
moveState,
privateEndpointConnections,
privateEndpointStateForBackup,
privateEndpointStateForSiteRecovery,
provisioningState,
publicNetworkAccess,
redundancySettings,
resourceGuardOperationRequests,
restoreSettings,
secureScore,
securitySettings,
sku,
systemData,
tags,
type,
upgradeDetails
FROM azure.recovery_services.vaults
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription_id

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

SELECT
id,
name,
backupStorageVersion,
bcdrSecurityLevel,
encryption,
etag,
identity,
location,
monitoringSettings,
moveDetails,
moveState,
privateEndpointConnections,
privateEndpointStateForBackup,
privateEndpointStateForSiteRecovery,
provisioningState,
publicNetworkAccess,
redundancySettings,
resourceGuardOperationRequests,
restoreSettings,
secureScore,
securitySettings,
sku,
systemData,
tags,
type,
upgradeDetails
FROM azure.recovery_services.vaults
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a Recovery Services vault.

INSERT INTO azure.recovery_services.vaults (
tags,
location,
properties,
identity,
sku,
etag,
resource_group_name,
vault_name,
subscription_id,
x-ms-authorization-auxiliary
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ sku }}',
'{{ etag }}',
'{{ resource_group_name }}',
'{{ vault_name }}',
'{{ subscription_id }}',
'{{ x-ms-authorization-auxiliary }}'
RETURNING
id,
name,
etag,
identity,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: vaults
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the vaults resource.
  - name: vault_name
    value: "{{ vault_name }}"
    description: Required parameter for the vaults resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the 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: |
      Properties of the vault.
    value:
      provisioningState: "{{ provisioningState }}"
      upgradeDetails:
        operationId: "{{ operationId }}"
        startTimeUtc: "{{ startTimeUtc }}"
        lastUpdatedTimeUtc: "{{ lastUpdatedTimeUtc }}"
        endTimeUtc: "{{ endTimeUtc }}"
        status: "{{ status }}"
        message: "{{ message }}"
        triggerType: "{{ triggerType }}"
        upgradedResourceId: "{{ upgradedResourceId }}"
        previousResourceId: "{{ previousResourceId }}"
      privateEndpointConnections:
        - id: "{{ id }}"
          properties:
            provisioningState: "{{ provisioningState }}"
            privateEndpoint:
              id: "{{ id }}"
            privateLinkServiceConnectionState:
              status: "{{ status }}"
              description: "{{ description }}"
              actionsRequired: "{{ actionsRequired }}"
            groupIds:
              - "{{ groupIds }}"
          name: "{{ name }}"
          type: "{{ type }}"
          location: "{{ location }}"
      privateEndpointStateForBackup: "{{ privateEndpointStateForBackup }}"
      privateEndpointStateForSiteRecovery: "{{ privateEndpointStateForSiteRecovery }}"
      encryption:
        keyVaultProperties:
          keyUri: "{{ keyUri }}"
        kekIdentity:
          useSystemAssignedIdentity: {{ useSystemAssignedIdentity }}
          userAssignedIdentity: "{{ userAssignedIdentity }}"
        infrastructureEncryption: "{{ infrastructureEncryption }}"
      moveDetails:
        operationId: "{{ operationId }}"
        startTimeUtc: "{{ startTimeUtc }}"
        completionTimeUtc: "{{ completionTimeUtc }}"
        sourceResourceId: "{{ sourceResourceId }}"
        targetResourceId: "{{ targetResourceId }}"
      moveState: "{{ moveState }}"
      backupStorageVersion: "{{ backupStorageVersion }}"
      publicNetworkAccess: "{{ publicNetworkAccess }}"
      monitoringSettings:
        azureMonitorAlertSettings:
          alertsForAllJobFailures: "{{ alertsForAllJobFailures }}"
          alertsForAllReplicationIssues: "{{ alertsForAllReplicationIssues }}"
          alertsForAllFailoverIssues: "{{ alertsForAllFailoverIssues }}"
        classicAlertSettings:
          alertsForCriticalOperations: "{{ alertsForCriticalOperations }}"
          emailNotificationsForSiteRecovery: "{{ emailNotificationsForSiteRecovery }}"
      restoreSettings:
        crossSubscriptionRestoreSettings:
          crossSubscriptionRestoreState: "{{ crossSubscriptionRestoreState }}"
      redundancySettings:
        standardTierStorageRedundancy: "{{ standardTierStorageRedundancy }}"
        crossRegionRestore: "{{ crossRegionRestore }}"
      securitySettings:
        immutabilitySettings:
          state: "{{ state }}"
        softDeleteSettings:
          softDeleteState: "{{ softDeleteState }}"
          softDeleteRetentionPeriodInDays: {{ softDeleteRetentionPeriodInDays }}
          enhancedSecurityState: "{{ enhancedSecurityState }}"
        multiUserAuthorization: "{{ multiUserAuthorization }}"
        sourceScanConfiguration:
          state: "{{ state }}"
          sourceScanIdentity:
            operationIdentityType: "{{ operationIdentityType }}"
            userAssignedIdentity: "{{ userAssignedIdentity }}"
      secureScore: "{{ secureScore }}"
      bcdrSecurityLevel: "{{ bcdrSecurityLevel }}"
      resourceGuardOperationRequests:
        - "{{ resourceGuardOperationRequests }}"
  - name: identity
    description: |
      Identity for the resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: sku
    description: |
      Identifies the unique system identifier for each Azure resource.
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"
      family: "{{ family }}"
      size: "{{ size }}"
      capacity: "{{ capacity }}"
  - name: etag
    value: "{{ etag }}"
    description: |
      etag for the resource.
  - name: x-ms-authorization-auxiliary
    value: "{{ x-ms-authorization-auxiliary }}"
    description: Default value is None.
    description: Default value is None.

UPDATE examples

update

Updates the vault.

UPDATE azure.recovery_services.vaults
SET 
location = '{{ location }}',
tags = '{{ tags }}',
etag = '{{ etag }}',
properties = '{{ properties }}',
sku = '{{ sku }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND vault_name = '{{ vault_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND x-ms-authorization-auxiliary = '{{ x-ms-authorization-auxiliary}}'
RETURNING
id,
name,
etag,
identity,
location,
properties,
sku,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a Recovery Services vault.

REPLACE azure.recovery_services.vaults
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}',
sku = '{{ sku }}',
etag = '{{ etag }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND vault_name = '{{ vault_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND x-ms-authorization-auxiliary = '{{ x-ms-authorization-auxiliary}}'
RETURNING
id,
name,
etag,
identity,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Deletes a vault.

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