vaults

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

Overview

Name	vaults
Type	Resource
Id	azure.key_vault.vaults

Fields

The following fields are returned by SELECT queries:

get

Retrieved vault

Name	Datatype	Description
id	string	Fully qualified identifier of the key vault resource.
name	string	Name of the key vault resource.
location	string	Azure location of the key vault resource.
properties	object	Properties of the vault
systemData	object	System metadata for the key vault.
tags	object	Tags assigned to the key vault resource.
type	string	Resource type of the key vault resource.

list_by_resource_group

Get information about all key vaults in the specified resource group.

Name	Datatype	Description
id	string	Fully qualified identifier of the key vault resource.
name	string	Name of the key vault resource.
location	string	Azure location of the key vault resource.
properties	object	Properties of the vault
systemData	object	System metadata for the key vault.
tags	object	Tags assigned to the key vault resource.
type	string	Resource type of the key vault resource.

list_by_subscription

Get information about all key vaults in the specified subscription.

Name	Datatype	Description
id	string	Fully qualified identifier of the key vault resource.
name	string	Name of the key vault resource.
location	string	Azure location of the key vault resource.
properties	object	Properties of the vault
systemData	object	System metadata for the key vault.
tags	object	Tags assigned to the key vault resource.
type	string	Resource type of the key vault resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, vaultName, subscriptionId		Gets the specified Azure key vault.
list_by_resource_group	select	resourceGroupName, subscriptionId	$top	The List operation gets information about the vaults associated with the subscription and within the specified resource group.
list_by_subscription	select	subscriptionId	$top	The List operation gets information about the vaults associated with the subscription.
create_or_update	insert	resourceGroupName, vaultName, subscriptionId, data__location, data__properties		Create or update a key vault in the specified subscription.
update	update	resourceGroupName, vaultName, subscriptionId		Update a key vault in the specified subscription.
delete	delete	resourceGroupName, vaultName, subscriptionId		Deletes the specified Azure key vault.
purge_deleted	exec	vaultName, location, subscriptionId		Permanently deletes the specified vault. aka Purges the deleted Azure key vault.
list	exec	$filter, subscriptionId	$top, api-version	The List operation gets information about the vaults associated with the subscription.
check_name_availability	exec	subscriptionId, name, type		Checks that the vault name is valid and is not already in use.

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
$filter	string	The filter to apply on the operation.
location	string	The location of the soft-deleted vault.
resourceGroupName	string	The name of the Resource Group to which the vault belongs.
subscriptionId	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
vaultName	string	The name of the soft-deleted vault.
$top	integer (int32)	Maximum number of results to return.
api-version	string	Azure Resource Manager Api Version.

SELECT examples

get

Gets the specified Azure key vault.

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

list_by_resource_group

The List operation gets information about the vaults associated with the subscription and within the specified resource group.

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

list_by_subscription

The List operation gets information about the vaults associated with the subscription.

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

INSERT examples

create_or_update

Create or update a key vault in the specified subscription.

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

Manifest

# Description fields are for documentation purposes
- name: vaults
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the vaults resource.
    - name: vaultName
      value: string
      description: Required parameter for the vaults resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the vaults resource.
    - name: location
      value: string
      description: |
        The supported Azure location where the key vault should be created.
    - name: tags
      value: object
      description: |
        The tags that will be assigned to the key vault.
    - name: properties
      value: object
      description: |
        Properties of the vault

UPDATE examples

update

Update a key vault in the specified subscription.

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

DELETE examples

delete

Deletes the specified Azure key vault.

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

Lifecycle Methods

purge_deleted

Permanently deletes the specified vault. aka Purges the deleted Azure key vault.

EXEC azure.key_vault.vaults.purge_deleted 
@vaultName='{{ vaultName }}' --required, 
@location='{{ location }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

list

The List operation gets information about the vaults associated with the subscription.

EXEC azure.key_vault.vaults.list 
@$filter='{{ $filter }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@$top='{{ $top }}', 
@api-version='{{ api-version }}'
;

check_name_availability

Checks that the vault name is valid and is not already in use.

EXEC azure.key_vault.vaults.check_name_availability 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;