vaults

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

Overview

Name	vaults
Type	Resource
Id	azure.key_vault.vaults

Fields

vw_vaults

Name	Datatype	Description
id	text	Fully qualified identifier of the key vault resource.
name	text	Name of the key vault resource.
access_policies	text	field from the properties object
create_mode	text	field from the properties object
enable_purge_protection	text	field from the properties object
enable_rbac_authorization	text	field from the properties object
enable_soft_delete	text	field from the properties object
enabled_for_deployment	text	field from the properties object
enabled_for_disk_encryption	text	field from the properties object
enabled_for_template_deployment	text	field from the properties object
hsm_pool_resource_id	text	field from the properties object
location	text	Azure location of the key vault resource.
network_acls	text	field from the properties object
private_endpoint_connections	text	field from the properties object
provisioning_state	text	field from the properties object
public_network_access	text	field from the properties object
resourceGroupName	text	field from the properties object
sku	text	field from the properties object
soft_delete_retention_in_days	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
tags	text	Tags assigned to the key vault resource.
tenant_id	text	field from the properties object
type	text	Resource type of the key vault resource.
vaultName	text	field from the properties object
vault_uri	text	field from the properties object

vaults

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	Metadata pertaining to creation and last modification of the key vault resource.
tags	object	Tags assigned to the key vault resource.
type	string	Resource type of the key vault resource.

Methods

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

SELECT examples

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

vw_vaults

SELECT
id,
name,
access_policies,
create_mode,
enable_purge_protection,
enable_rbac_authorization,
enable_soft_delete,
enabled_for_deployment,
enabled_for_disk_encryption,
enabled_for_template_deployment,
hsm_pool_resource_id,
location,
network_acls,
private_endpoint_connections,
provisioning_state,
public_network_access,
resourceGroupName,
sku,
soft_delete_retention_in_days,
subscriptionId,
system_data,
tags,
tenant_id,
type,
vaultName,
vault_uri
FROM azure.key_vault.vw_vaults
WHERE subscriptionId = '{{ subscriptionId }}';

vaults

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

Manifest

- name: your_resource_model_name
  props:
    - name: location
      value: string
    - name: tags
      value: object
    - name: properties
      value:
        - name: tenantId
          value: string
        - name: sku
          value:
            - name: family
              value: string
            - name: name
              value: string
        - name: accessPolicies
          value:
            - - name: tenantId
                value: string
              - name: objectId
                value: string
              - name: applicationId
                value: string
              - name: permissions
                value:
                  - name: keys
                    value:
                      - string
                  - name: secrets
                    value:
                      - string
                  - name: certificates
                    value:
                      - string
                  - name: storage
                    value:
                      - string
        - name: vaultUri
          value: string
        - name: hsmPoolResourceId
          value: string
        - name: enabledForDeployment
          value: boolean
        - name: enabledForDiskEncryption
          value: boolean
        - name: enabledForTemplateDeployment
          value: boolean
        - name: enableSoftDelete
          value: boolean
        - name: softDeleteRetentionInDays
          value: integer
        - name: enableRbacAuthorization
          value: boolean
        - name: createMode
          value: string
        - name: enablePurgeProtection
          value: boolean
        - name: networkAcls
          value:
            - name: bypass
              value: string
            - name: defaultAction
              value: string
            - name: ipRules
              value:
                - - name: value
                    value: string
            - name: virtualNetworkRules
              value:
                - - name: id
                    value: string
                  - name: ignoreMissingVnetServiceEndpoint
                    value: boolean
        - name: provisioningState
          value: string
        - name: privateEndpointConnections
          value:
            - - name: id
                value: string
              - name: etag
                value: string
              - name: properties
                value:
                  - name: privateEndpoint
                    value:
                      - name: id
                        value: string
                  - name: privateLinkServiceConnectionState
                    value:
                      - name: status
                        value: []
                      - name: description
                        value: string
                      - name: actionsRequired
                        value: string
                  - name: provisioningState
                    value: []
        - name: publicNetworkAccess
          value: string

UPDATE example

Updates a vaults resource.

/*+ update */
UPDATE azure.key_vault.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.key_vault.vaults
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND vaultName = '{{ vaultName }}';