vaults

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

Overview

Name	vaults
Type	Resource
Id	azure.data_replication.vaults

Fields

The following fields are returned by SELECT queries:

get

Returns Vault Model on success.

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.

list

Returns Vault Model Collection on success.

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.

list_by_subscription

Returns Vault Model Collection on success.

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

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, vaultName		Gets the details of the vault.
list	select	subscriptionId, resourceGroupName	continuationToken	Gets the list of vaults in the given subscription and resource group.
list_by_subscription	select	subscriptionId	continuationToken	Gets the list of vaults in the given subscription.
create	insert	subscriptionId, resourceGroupName, vaultName, data__location		Creates the vault.
update	update	subscriptionId, resourceGroupName, vaultName		Performs update on the vault.
delete	delete	subscriptionId, resourceGroupName, vaultName		Removes the 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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
vaultName	string	The vault name.
continuationToken	string	Continuation token from the previous call.

SELECT examples

get

Gets the details of the vault.

SELECT
id,
name,
location,
properties,
systemData,
tags,
type
FROM azure.data_replication.vaults
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND vaultName = '{{ vaultName }}' -- required
;

list

Gets the list of vaults in the given subscription and resource group.

SELECT
id,
name,
location,
properties,
systemData,
tags,
type
FROM azure.data_replication.vaults
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND continuationToken = '{{ continuationToken }}'
;

list_by_subscription

Gets the list of vaults in the given subscription.

SELECT
id,
name,
location,
properties,
systemData,
tags,
type
FROM azure.data_replication.vaults
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND continuationToken = '{{ continuationToken }}'
;

INSERT examples

create

Creates the vault.

INSERT INTO azure.data_replication.vaults (
data__location,
data__tags,
data__properties,
subscriptionId,
resourceGroupName,
vaultName
)
SELECT 
'{{ location }}' /* required */,
'{{ tags }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ vaultName }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: vaults
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the vaults resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the vaults resource.
    - name: vaultName
      value: string
      description: Required parameter for the vaults resource.
    - name: location
      value: string
      description: |
        Gets or sets the location of the vault.
    - name: tags
      value: object
      description: |
        Gets or sets the resource tags.
    - name: properties
      value: object
      description: |
        Vault properties.

UPDATE examples

update

Performs update on the vault.

UPDATE azure.data_replication.vaults
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND vaultName = '{{ vaultName }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Removes the vault.

DELETE FROM azure.data_replication.vaults
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND vaultName = '{{ vaultName }}' --required
;