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

vw_backup_vaults

Name	Datatype	Description
bcdr_security_level	text	field from the properties object
feature_settings	text	field from the properties object
identity	text	Identity details
is_vault_protected_by_resource_guard	text	field from the properties object
monitoring_settings	text	field from the properties object
provisioning_state	text	field from the properties object
replicated_regions	text	field from the properties object
resourceGroupName	text	field from the properties object
resource_guard_operation_requests	text	field from the properties object
resource_move_details	text	field from the properties object
resource_move_state	text	field from the properties object
secure_score	text	field from the properties object
security_settings	text	field from the properties object
storage_settings	text	field from the properties object
subscriptionId	text	field from the properties object
vaultName	text	field from the properties object

backup_vaults

Name	Datatype	Description
identity	object	Identity details
properties	object	Backup Vault

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, subscriptionId, 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	resourceGroupName, subscriptionId, vaultName, data__properties	Creates or updates a BackupVault resource belonging to a resource group.
delete	DELETE	resourceGroupName, subscriptionId, vaultName	Deletes a BackupVault resource from the resource group.
update	UPDATE	resourceGroupName, subscriptionId, vaultName	Updates a BackupVault resource belonging to a resource group. For example, updating tags for a resource.
check_name_availability	EXEC	location, resourceGroupName, subscriptionId

SELECT examples

Returns resource collection belonging to a subscription.

vw_backup_vaults

SELECT
bcdr_security_level,
feature_settings,
identity,
is_vault_protected_by_resource_guard,
monitoring_settings,
provisioning_state,
replicated_regions,
resourceGroupName,
resource_guard_operation_requests,
resource_move_details,
resource_move_state,
secure_score,
security_settings,
storage_settings,
subscriptionId,
vaultName
FROM azure.data_protection.vw_backup_vaults
WHERE subscriptionId = '{{ subscriptionId }}';

backup_vaults

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

INSERT example

Use the following StackQL query and manifest file to create a new backup_vaults resource.

All Properties

/*+ create */
INSERT INTO azure.data_protection.backup_vaults (
resourceGroupName,
subscriptionId,
vaultName,
data__properties,
identity,
properties
)
SELECT 
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ vaultName }}',
'{{ data__properties }}',
'{{ identity }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: string
        - name: userAssignedIdentities
          value: object
    - name: properties
      value:
        - name: monitoringSettings
          value:
            - name: azureMonitorAlertSettings
              value:
                - name: alertsForAllJobFailures
                  value: string
        - name: provisioningState
          value: string
        - name: resourceMoveState
          value: string
        - name: resourceMoveDetails
          value:
            - name: operationId
              value: string
            - name: startTimeUtc
              value: string
            - name: completionTimeUtc
              value: string
            - name: sourceResourcePath
              value: string
            - name: targetResourcePath
              value: string
        - name: securitySettings
          value:
            - name: softDeleteSettings
              value:
                - name: state
                  value: string
                - name: retentionDurationInDays
                  value: number
            - name: immutabilitySettings
              value:
                - name: state
                  value: string
            - name: encryptionSettings
              value:
                - name: state
                  value: string
                - name: keyVaultProperties
                  value:
                    - name: keyUri
                      value: string
                - name: kekIdentity
                  value:
                    - name: identityType
                      value: string
                    - name: identityId
                      value: string
                - name: infrastructureEncryption
                  value: string
        - name: storageSettings
          value:
            - - name: datastoreType
                value: string
              - name: type
                value: string
        - name: isVaultProtectedByResourceGuard
          value: boolean
        - name: featureSettings
          value:
            - name: crossSubscriptionRestoreSettings
              value:
                - name: state
                  value: string
            - name: crossRegionRestoreSettings
              value:
                - name: state
                  value: string
        - name: secureScore
          value: string
        - name: bcdrSecurityLevel
          value: string
        - name: resourceGuardOperationRequests
          value:
            - string
        - name: replicatedRegions
          value:
            - string

UPDATE example

Updates a backup_vaults resource.

/*+ update */
UPDATE azure.data_protection.backup_vaults
SET 
identity = '{{ identity }}',
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND vaultName = '{{ vaultName }}';

DELETE example

Deletes the specified backup_vaults resource.

/*+ delete */
DELETE FROM azure.data_protection.backup_vaults
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND vaultName = '{{ vaultName }}';