vaults

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

Overview

Name	vaults
Type	Resource
Id	azure.recovery_services.vaults

Fields

vw_vaults

Name	Datatype	Description
backup_storage_version	text	field from the properties object
bcdr_security_level	text	field from the properties object
encryption	text	field from the properties object
identity	text	Identity for the resource.
location	text	The geo-location where the resource lives
monitoring_settings	text	field from the properties object
move_details	text	field from the properties object
move_state	text	field from the properties object
private_endpoint_connections	text	field from the properties object
private_endpoint_state_for_backup	text	field from the properties object
private_endpoint_state_for_site_recovery	text	field from the properties object
provisioning_state	text	field from the properties object
public_network_access	text	field from the properties object
redundancy_settings	text	field from the properties object
resourceGroupName	text	field from the properties object
resource_guard_operation_requests	text	field from the properties object
restore_settings	text	field from the properties object
secure_score	text	field from the properties object
security_settings	text	field from the properties object
sku	text	The resource model definition representing SKU
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
tags	text	Resource tags.
upgrade_details	text	field from the properties object
vaultName	text	field from the properties object

vaults

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

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, subscriptionId, vaultName	Get the Vault details.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	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	resourceGroupName, subscriptionId, vaultName	Creates or updates a Recovery Services vault.
delete	DELETE	resourceGroupName, subscriptionId, vaultName	Deletes a vault.
update	UPDATE	resourceGroupName, subscriptionId, vaultName	Updates the vault.

SELECT examples

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

vw_vaults

SELECT
backup_storage_version,
bcdr_security_level,
encryption,
identity,
location,
monitoring_settings,
move_details,
move_state,
private_endpoint_connections,
private_endpoint_state_for_backup,
private_endpoint_state_for_site_recovery,
provisioning_state,
public_network_access,
redundancy_settings,
resourceGroupName,
resource_guard_operation_requests,
restore_settings,
secure_score,
security_settings,
sku,
subscriptionId,
system_data,
tags,
upgrade_details,
vaultName
FROM azure.recovery_services.vw_vaults
WHERE subscriptionId = '{{ subscriptionId }}';

vaults

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.recovery_services.vaults (
resourceGroupName,
subscriptionId,
vaultName,
tags,
location,
identity,
properties,
sku,
systemData
)
SELECT 
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ vaultName }}',
'{{ tags }}',
'{{ location }}',
'{{ identity }}',
'{{ properties }}',
'{{ sku }}',
'{{ systemData }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: tags
      value: object
    - name: location
      value: string
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: string
        - name: userAssignedIdentities
          value: object
    - name: properties
      value:
        - name: provisioningState
          value: string
        - name: upgradeDetails
          value:
            - name: operationId
              value: string
            - name: startTimeUtc
              value: string
            - name: lastUpdatedTimeUtc
              value: string
            - name: endTimeUtc
              value: string
            - name: status
              value: string
            - name: message
              value: string
            - name: triggerType
              value: string
            - name: upgradedResourceId
              value: string
            - name: previousResourceId
              value: string
        - name: privateEndpointConnections
          value:
            - - name: id
                value: string
              - name: properties
                value:
                  - name: provisioningState
                    value: string
                  - name: privateEndpoint
                    value:
                      - name: id
                        value: string
                  - name: privateLinkServiceConnectionState
                    value:
                      - name: status
                        value: string
                      - name: description
                        value: string
                      - name: actionsRequired
                        value: string
                  - name: groupIds
                    value:
                      - string
              - name: name
                value: string
              - name: type
                value: string
              - name: location
                value: string
        - name: privateEndpointStateForBackup
          value: string
        - name: privateEndpointStateForSiteRecovery
          value: string
        - name: encryption
          value:
            - name: keyVaultProperties
              value:
                - name: keyUri
                  value: string
            - name: kekIdentity
              value:
                - name: useSystemAssignedIdentity
                  value: boolean
                - name: userAssignedIdentity
                  value: string
            - name: infrastructureEncryption
              value: string
        - name: moveDetails
          value:
            - name: operationId
              value: string
            - name: startTimeUtc
              value: string
            - name: completionTimeUtc
              value: string
            - name: sourceResourceId
              value: string
            - name: targetResourceId
              value: string
        - name: moveState
          value: string
        - name: backupStorageVersion
          value: string
        - name: publicNetworkAccess
          value: string
        - name: monitoringSettings
          value:
            - name: azureMonitorAlertSettings
              value:
                - name: alertsForAllJobFailures
                  value: string
                - name: alertsForAllReplicationIssues
                  value: string
                - name: alertsForAllFailoverIssues
                  value: string
            - name: classicAlertSettings
              value:
                - name: alertsForCriticalOperations
                  value: string
                - name: emailNotificationsForSiteRecovery
                  value: string
        - name: restoreSettings
          value:
            - name: crossSubscriptionRestoreSettings
              value:
                - name: crossSubscriptionRestoreState
                  value: string
        - name: redundancySettings
          value:
            - name: standardTierStorageRedundancy
              value: string
            - name: crossRegionRestore
              value: string
        - name: securitySettings
          value:
            - name: immutabilitySettings
              value:
                - name: state
                  value: string
            - name: softDeleteSettings
              value:
                - name: softDeleteState
                  value: string
                - name: softDeleteRetentionPeriodInDays
                  value: integer
                - name: enhancedSecurityState
                  value: string
            - name: multiUserAuthorization
              value: []
        - name: secureScore
          value: string
        - name: bcdrSecurityLevel
          value: string
        - name: resourceGuardOperationRequests
          value:
            - string
    - name: sku
      value:
        - name: name
          value: string
        - name: tier
          value: []
        - name: size
          value: string
        - name: family
          value: string
        - name: capacity
          value: integer
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string

UPDATE example

Updates a vaults resource.

/*+ update */
UPDATE azure.recovery_services.vaults
SET 
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}',
sku = '{{ sku }}',
identity = '{{ identity }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND vaultName = '{{ vaultName }}';

DELETE example

Deletes the specified vaults resource.

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