vaults

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

Overview

Name	vaults
Type	Resource
Id	azure.data_replication.vaults

Fields

vw_vaults

Name	Datatype	Description
id	text	Gets or sets the Id of the resource.
name	text	Gets or sets the name of the resource.
location	text	Gets or sets the location of the vault.
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
service_resource_id	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
tags	text	Gets or sets the resource tags.
type	text	Gets or sets the type of the resource.
vaultName	text	field from the properties object
vault_type	text	field from the properties object

vaults

Name	Datatype	Description
id	string	Gets or sets the Id of the resource.
name	string	Gets or sets the name of the resource.
location	string	Gets or sets the location of the vault.
properties	object	Vault properties.
systemData	object	System data required to be defined for Azure resources.
tags	object	Gets or sets the resource tags.
type	string	Gets or sets the type of the resource.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, subscriptionId, vaultName	Gets the details of the vault.
list	SELECT	resourceGroupName, subscriptionId	Gets the list of vaults in the given subscription and resource group.
list_by_subscription	SELECT	subscriptionId	Gets the list of vaults in the given subscription.
create	INSERT	resourceGroupName, subscriptionId, vaultName, data__location	Creates the vault.
delete	DELETE	resourceGroupName, subscriptionId, vaultName	Removes the vault.
update	UPDATE	resourceGroupName, subscriptionId, vaultName	Performs update on the vault.

SELECT examples

Gets the list of vaults in the given subscription.

vw_vaults

SELECT
id,
name,
location,
provisioning_state,
resourceGroupName,
service_resource_id,
subscriptionId,
system_data,
tags,
type,
vaultName,
vault_type
FROM azure.data_replication.vw_vaults
WHERE subscriptionId = '{{ subscriptionId }}';

vaults

SELECT
id,
name,
location,
properties,
systemData,
tags,
type
FROM azure.data_replication.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.data_replication.vaults (
resourceGroupName,
subscriptionId,
vaultName,
data__location,
location,
tags,
properties
)
SELECT 
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ vaultName }}',
'{{ data__location }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: location
      value: string
    - name: tags
      value: object
    - name: properties
      value:
        - name: provisioningState
          value: string
        - name: serviceResourceId
          value: string
        - name: vaultType
          value: string
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: systemData
      value: string

UPDATE example

Updates a vaults resource.

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

DELETE example

Deletes the specified vaults resource.

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