secrets

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

Overview

Name	secrets
Type	Resource
Id	azure.key_vault.secrets

Fields

The following fields are returned by SELECT queries:

get

Retrieved secret

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.

list

Get information about secrets in the specified 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 secret
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, secretName, subscriptionId		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, vaultName, subscriptionId	$top	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, vaultName, secretName, subscriptionId, 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, vaultName, secretName, subscriptionId		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.

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 to which the vault belongs.
secretName	string	Name of the secret
subscriptionId	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
vaultName	string	Name of the vault
$top	integer (int32)	Maximum number of results to return.

SELECT examples

get

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.

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

list

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.

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

INSERT examples

create_or_update

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.

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

Manifest

# Description fields are for documentation purposes
- name: secrets
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the secrets resource.
    - name: vaultName
      value: string
      description: Required parameter for the secrets resource.
    - name: secretName
      value: string
      description: Required parameter for the secrets resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the secrets resource.
    - name: tags
      value: object
      description: |
        The tags that will be assigned to the secret.
    - name: properties
      value: object
      description: |
        Properties of the secret

UPDATE examples

update

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.

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