client_encryption_keys

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

Overview

Name	client_encryption_keys
Type	Resource
Id	azure.cosmos_db.client_encryption_keys

Fields

The following fields are returned by SELECT queries:

get

The ClientEncryptionKey was retrieved successfully.

Name	Datatype	Description
id	string	The unique resource identifier of the database account.
name	string	The name of the database account.
properties	object	The properties of a ClientEncryptionKey
type	string	The type of Azure resource.

list

The ClientEncryptionKeys were retrieved successfully.

Name	Datatype	Description
id	string	The unique resource identifier of the database account.
name	string	The name of the database account.
properties	object	The properties of a ClientEncryptionKey
type	string	The type of Azure resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, accountName, databaseName, clientEncryptionKeyName		Gets the ClientEncryptionKey under an existing Azure Cosmos DB SQL database.
list	select	subscriptionId, resourceGroupName, accountName, databaseName		Lists the ClientEncryptionKeys under an existing Azure Cosmos DB SQL database.
create_update	insert	subscriptionId, resourceGroupName, accountName, databaseName, clientEncryptionKeyName, data__properties		Create or update a ClientEncryptionKey. This API is meant to be invoked via tools such as the Azure Powershell (instead of directly).

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
accountName	string	Cosmos DB database account name.
clientEncryptionKeyName	string	Cosmos DB ClientEncryptionKey name.
databaseName	string	Cosmos DB database name.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets the ClientEncryptionKey under an existing Azure Cosmos DB SQL database.

SELECT
id,
name,
properties,
type
FROM azure.cosmos_db.client_encryption_keys
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND clientEncryptionKeyName = '{{ clientEncryptionKeyName }}' -- required
;

list

Lists the ClientEncryptionKeys under an existing Azure Cosmos DB SQL database.

SELECT
id,
name,
properties,
type
FROM azure.cosmos_db.client_encryption_keys
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
;

INSERT examples

create_update

Create or update a ClientEncryptionKey. This API is meant to be invoked via tools such as the Azure Powershell (instead of directly).

INSERT INTO azure.cosmos_db.client_encryption_keys (
data__properties,
subscriptionId,
resourceGroupName,
accountName,
databaseName,
clientEncryptionKeyName
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ databaseName }}',
'{{ clientEncryptionKeyName }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: client_encryption_keys
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the client_encryption_keys resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the client_encryption_keys resource.
    - name: accountName
      value: string
      description: Required parameter for the client_encryption_keys resource.
    - name: databaseName
      value: string
      description: Required parameter for the client_encryption_keys resource.
    - name: clientEncryptionKeyName
      value: string
      description: Required parameter for the client_encryption_keys resource.
    - name: properties
      value: object
      description: |
        Properties to create and update ClientEncryptionKey.