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
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.
bcdrSecurityLevel	string	Security Level of Backup Vault. Known values are: "Poor", "Fair", "Good", "Excellent", and "NotSupported". (Poor, Fair, Good, Excellent, NotSupported)
eTag	string	Optional ETag.
featureSettings	object	Feature Settings.
identity	object	Input Managed Identity Details.
isVaultProtectedByResourceGuard	boolean	Is vault protected by resource guard.
location	string	The geo-location where the resource lives. Required.
monitoringSettings	object	Monitoring Settings.
provisioningState	string	Provisioning state of the BackupVault resource. Known values are: "Failed", "Provisioning", "Succeeded", "Unknown", and "Updating". (Failed, Provisioning, Succeeded, Unknown, Updating)
replicatedRegions	array	List of replicated regions for Backup Vault.
resourceGuardOperationRequests	array	ResourceGuardOperationRequests on which LAC check will be performed.
resourceMoveDetails	object	Resource move details for backup vault.
resourceMoveState	string	Resource move state for backup vault. Known values are: "Unknown", "InProgress", "PrepareFailed", "CommitFailed", "Failed", "PrepareTimedout", "CommitTimedout", "CriticalFailure", "PartialSuccess", and "MoveSucceeded". (Unknown, InProgress, PrepareFailed, CommitFailed, Failed, PrepareTimedout, CommitTimedout, CriticalFailure, PartialSuccess, MoveSucceeded)
secureScore	string	Secure Score of Backup Vault. Known values are: "None", "Minimum", "Adequate", "Maximum", and "NotSupported". (None, Minimum, Adequate, Maximum, NotSupported)
securitySettings	object	Security Settings.
storageSettings	array	Storage Settings.
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".

check_name_availability

Name	Datatype	Description
message	string	Gets or sets the message.
nameAvailable	boolean	Gets or sets a value indicating whether [name available].
reason	string	Gets or sets the reason.

get_in_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.
bcdrSecurityLevel	string	Security Level of Backup Vault. Known values are: "Poor", "Fair", "Good", "Excellent", and "NotSupported". (Poor, Fair, Good, Excellent, NotSupported)
eTag	string	Optional ETag.
featureSettings	object	Feature Settings.
identity	object	Input Managed Identity Details.
isVaultProtectedByResourceGuard	boolean	Is vault protected by resource guard.
location	string	The geo-location where the resource lives. Required.
monitoringSettings	object	Monitoring Settings.
provisioningState	string	Provisioning state of the BackupVault resource. Known values are: "Failed", "Provisioning", "Succeeded", "Unknown", and "Updating". (Failed, Provisioning, Succeeded, Unknown, Updating)
replicatedRegions	array	List of replicated regions for Backup Vault.
resourceGuardOperationRequests	array	ResourceGuardOperationRequests on which LAC check will be performed.
resourceMoveDetails	object	Resource move details for backup vault.
resourceMoveState	string	Resource move state for backup vault. Known values are: "Unknown", "InProgress", "PrepareFailed", "CommitFailed", "Failed", "PrepareTimedout", "CommitTimedout", "CriticalFailure", "PartialSuccess", and "MoveSucceeded". (Unknown, InProgress, PrepareFailed, CommitFailed, Failed, PrepareTimedout, CommitTimedout, CriticalFailure, PartialSuccess, MoveSucceeded)
secureScore	string	Secure Score of Backup Vault. Known values are: "None", "Minimum", "Adequate", "Maximum", and "NotSupported". (None, Minimum, Adequate, Maximum, NotSupported)
securitySettings	object	Security Settings.
storageSettings	array	Storage Settings.
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".

get_in_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.
bcdrSecurityLevel	string	Security Level of Backup Vault. Known values are: "Poor", "Fair", "Good", "Excellent", and "NotSupported". (Poor, Fair, Good, Excellent, NotSupported)
eTag	string	Optional ETag.
featureSettings	object	Feature Settings.
identity	object	Input Managed Identity Details.
isVaultProtectedByResourceGuard	boolean	Is vault protected by resource guard.
location	string	The geo-location where the resource lives. Required.
monitoringSettings	object	Monitoring Settings.
provisioningState	string	Provisioning state of the BackupVault resource. Known values are: "Failed", "Provisioning", "Succeeded", "Unknown", and "Updating". (Failed, Provisioning, Succeeded, Unknown, Updating)
replicatedRegions	array	List of replicated regions for Backup Vault.
resourceGuardOperationRequests	array	ResourceGuardOperationRequests on which LAC check will be performed.
resourceMoveDetails	object	Resource move details for backup vault.
resourceMoveState	string	Resource move state for backup vault. Known values are: "Unknown", "InProgress", "PrepareFailed", "CommitFailed", "Failed", "PrepareTimedout", "CommitTimedout", "CriticalFailure", "PartialSuccess", and "MoveSucceeded". (Unknown, InProgress, PrepareFailed, CommitFailed, Failed, PrepareTimedout, CommitTimedout, CriticalFailure, PartialSuccess, MoveSucceeded)
secureScore	string	Secure Score of Backup Vault. Known values are: "None", "Minimum", "Adequate", "Maximum", and "NotSupported". (None, Minimum, Adequate, Maximum, NotSupported)
securitySettings	object	Security Settings.
storageSettings	array	Storage Settings.
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, vault_name, subscription_id		Returns a resource belonging to a resource group.
check_name_availability	select	resource_group_name, location, subscription_id		API to check for resource name availability. API to check for resource name availability.
get_in_resource_group	select	resource_group_name, subscription_id		Returns resource collection belonging to a resource group.
get_in_subscription	select	subscription_id		Returns resource collection belonging to a subscription.
create_or_update	insert	resource_group_name, vault_name, subscription_id, location, properties	x-ms-authorization-auxiliary, x-ms-deleted-vault-id	Creates or updates a BackupVault resource belonging to a resource group.
update	update	resource_group_name, vault_name, subscription_id	x-ms-authorization-auxiliary	Updates a BackupVault resource belonging to a resource group. For example, updating tags for a resource.
create_or_update	replace	resource_group_name, vault_name, subscription_id, location, properties	x-ms-authorization-auxiliary, x-ms-deleted-vault-id	Creates or updates a BackupVault resource belonging to a resource group.
delete	delete	resource_group_name, vault_name, subscription_id		Deletes a BackupVault resource from the resource group.

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 name of the Azure region. Required.
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 BackupVaultResource. Required.
x-ms-authorization-auxiliary	string	Default value is None.
x-ms-deleted-vault-id	string	The ID of the deleted backup vault to restore from during undelete flow. Default value is None.

SELECT examples

get

Returns a resource belonging to a resource group.

SELECT
id,
name,
bcdrSecurityLevel,
eTag,
featureSettings,
identity,
isVaultProtectedByResourceGuard,
location,
monitoringSettings,
provisioningState,
replicatedRegions,
resourceGuardOperationRequests,
resourceMoveDetails,
resourceMoveState,
secureScore,
securitySettings,
storageSettings,
systemData,
tags,
type
FROM azure.data_protection.backup_vaults
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vault_name = '{{ vault_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

check_name_availability

API to check for resource name availability. API to check for resource name availability.

SELECT
message,
nameAvailable,
reason
FROM azure.data_protection.backup_vaults
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND location = '{{ location }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_in_resource_group

Returns resource collection belonging to a resource group.

SELECT
id,
name,
bcdrSecurityLevel,
eTag,
featureSettings,
identity,
isVaultProtectedByResourceGuard,
location,
monitoringSettings,
provisioningState,
replicatedRegions,
resourceGuardOperationRequests,
resourceMoveDetails,
resourceMoveState,
secureScore,
securitySettings,
storageSettings,
systemData,
tags,
type
FROM azure.data_protection.backup_vaults
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_in_subscription

Returns resource collection belonging to a subscription.

SELECT
id,
name,
bcdrSecurityLevel,
eTag,
featureSettings,
identity,
isVaultProtectedByResourceGuard,
location,
monitoringSettings,
provisioningState,
replicatedRegions,
resourceGuardOperationRequests,
resourceMoveDetails,
resourceMoveState,
secureScore,
securitySettings,
storageSettings,
systemData,
tags,
type
FROM azure.data_protection.backup_vaults
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

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

INSERT INTO azure.data_protection.backup_vaults (
tags,
location,
properties,
identity,
eTag,
resource_group_name,
vault_name,
subscription_id,
x-ms-authorization-auxiliary,
x-ms-deleted-vault-id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ identity }}',
'{{ eTag }}',
'{{ resource_group_name }}',
'{{ vault_name }}',
'{{ subscription_id }}',
'{{ x-ms-authorization-auxiliary }}',
'{{ x-ms-deleted-vault-id }}'
RETURNING
id,
name,
eTag,
identity,
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: vault_name
    value: "{{ 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: |
      BackupVaultResource properties. Required.
    value:
      monitoringSettings:
        azureMonitorAlertSettings:
          alertsForAllJobFailures: "{{ alertsForAllJobFailures }}"
      provisioningState: "{{ provisioningState }}"
      resourceMoveState: "{{ resourceMoveState }}"
      resourceMoveDetails:
        operationId: "{{ operationId }}"
        startTimeUtc: "{{ startTimeUtc }}"
        completionTimeUtc: "{{ completionTimeUtc }}"
        sourceResourcePath: "{{ sourceResourcePath }}"
        targetResourcePath: "{{ targetResourcePath }}"
      securitySettings:
        softDeleteSettings:
          state: "{{ state }}"
          retentionDurationInDays: {{ retentionDurationInDays }}
        immutabilitySettings:
          state: "{{ state }}"
        encryptionSettings:
          state: "{{ state }}"
          keyVaultProperties:
            keyUri: "{{ keyUri }}"
          kekIdentity:
            identityType: "{{ identityType }}"
            identityId: "{{ identityId }}"
          infrastructureEncryption: "{{ infrastructureEncryption }}"
      storageSettings:
        - datastoreType: "{{ datastoreType }}"
          type: "{{ type }}"
      isVaultProtectedByResourceGuard: {{ isVaultProtectedByResourceGuard }}
      featureSettings:
        crossSubscriptionRestoreSettings:
          state: "{{ state }}"
        crossRegionRestoreSettings:
          state: "{{ state }}"
      secureScore: "{{ secureScore }}"
      bcdrSecurityLevel: "{{ bcdrSecurityLevel }}"
      resourceGuardOperationRequests:
        - "{{ resourceGuardOperationRequests }}"
      replicatedRegions:
        - "{{ replicatedRegions }}"
  - name: identity
    description: |
      Input Managed Identity Details.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: eTag
    value: "{{ eTag }}"
    description: |
      Optional ETag.
  - name: x-ms-authorization-auxiliary
    value: "{{ x-ms-authorization-auxiliary }}"
    description: Default value is None.
    description: Default value is None.
  - name: x-ms-deleted-vault-id
    value: "{{ x-ms-deleted-vault-id }}"
    description: The ID of the deleted backup vault to restore from during undelete flow. Default value is None.
    description: The ID of the deleted backup vault to restore from during undelete flow. Default value is None.

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 
identity = '{{ identity }}',
properties = '{{ properties }}',
tags = '{{ tags }}'
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,
systemData,
tags,
type;

REPLACE examples

create_or_update

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

REPLACE azure.data_protection.backup_vaults
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}',
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 properties = '{{ properties }}' --required
AND x-ms-authorization-auxiliary = '{{ x-ms-authorization-auxiliary}}'
AND x-ms-deleted-vault-id = '{{ x-ms-deleted-vault-id}}'
RETURNING
id,
name,
eTag,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a BackupVault resource from the resource group.

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