database_accounts_keys

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

Overview

Name	database_accounts_keys
Type	Resource
Id	azure.cosmos_db.database_accounts_keys

Fields

The following fields are returned by SELECT queries:

list

The operation completed successfully.

Name	Datatype	Description
primaryMasterKey	string	Base 64 encoded value of the primary read-write key.
primaryReadonlyMasterKey	string	Base 64 encoded value of the primary read-only key.
secondaryMasterKey	string	Base 64 encoded value of the secondary read-write key.
secondaryReadonlyMasterKey	string	Base 64 encoded value of the secondary read-only key.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	subscriptionId, resourceGroupName, accountName		Lists the access keys for the specified Azure Cosmos DB database account.

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.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

list

Lists the access keys for the specified Azure Cosmos DB database account.

SELECT
primaryMasterKey,
primaryReadonlyMasterKey,
secondaryMasterKey,
secondaryReadonlyMasterKey
FROM azure.cosmos_db.database_accounts_keys
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
;