secrets

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

Overview

Name	secrets
Type	Resource
Id	azure.key_vault.secrets

Fields

vw_secrets

Name	Datatype	Description
id	text	Fully qualified identifier of the key vault resource.
name	text	Name of the key vault resource.
attributes	text	field from the properties object
content_type	text	field from the properties object
location	text	Azure location of the key vault resource.
resourceGroupName	text	field from the properties object
secretName	text	field from the properties object
secret_uri	text	field from the properties object
secret_uri_with_version	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Tags assigned to the key vault resource.
type	text	Resource type of the key vault resource.
value	text	field from the properties object
vaultName	text	field from the properties object

secrets

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 secret
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, secretName, subscriptionId, vaultName	Gets the specified secret. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.
list	SELECT	resourceGroupName, subscriptionId, vaultName	The List operation gets information about the secrets in a vault. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.
create_or_update	INSERT	resourceGroupName, secretName, subscriptionId, vaultName, data__properties	Create or update a secret in a key vault in the specified subscription. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.
update	UPDATE	resourceGroupName, secretName, subscriptionId, vaultName	Update a secret in the specified subscription. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

SELECT examples

The List operation gets information about the secrets in a vault. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

vw_secrets

SELECT
id,
name,
attributes,
content_type,
location,
resourceGroupName,
secretName,
secret_uri,
secret_uri_with_version,
subscriptionId,
tags,
type,
value,
vaultName
FROM azure.key_vault.vw_secrets
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND vaultName = '{{ vaultName }}';

secrets

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.key_vault.secrets (
resourceGroupName,
secretName,
subscriptionId,
vaultName,
data__properties,
tags,
properties
)
SELECT 
'{{ resourceGroupName }}',
'{{ secretName }}',
'{{ subscriptionId }}',
'{{ vaultName }}',
'{{ data__properties }}',
'{{ tags }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: tags
      value: object
    - name: properties
      value:
        - name: value
          value: string
        - name: contentType
          value: string
        - name: attributes
          value:
            - name: enabled
              value: boolean
            - name: nbf
              value: integer
            - name: exp
              value: integer
            - name: created
              value: integer
            - name: updated
              value: integer
        - name: secretUri
          value: string
        - name: secretUriWithVersion
          value: string

UPDATE example

Updates a secrets resource.

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