database_accounts_read_only_keys
Creates, updates, deletes, gets or lists a database_accounts_read_only_keys resource.
Overview
| Name | database_accounts_read_only_keys |
| Type | Resource |
| Id | azure.cosmos_db.database_accounts_read_only_keys |
Fields
The following fields are returned by SELECT queries:
- get
- list
The operation completed successfully.
| Name | Datatype | Description |
|---|---|---|
primaryReadonlyMasterKey | string | Base 64 encoded value of the primary read-only key. |
secondaryReadonlyMasterKey | string | Base 64 encoded value of the secondary read-only key. |
The operation completed successfully.
| Name | Datatype | Description |
|---|---|---|
primaryReadonlyMasterKey | string | Base 64 encoded value of the primary read-only 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 |
|---|---|---|---|---|
get | select | subscriptionId, resourceGroupName, accountName | Lists the read-only access keys for the specified Azure Cosmos DB database account. | |
list | select | subscriptionId, resourceGroupName, accountName | Lists the read-only 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
- get
- list
Lists the read-only access keys for the specified Azure Cosmos DB database account.
SELECT
primaryReadonlyMasterKey,
secondaryReadonlyMasterKey
FROM azure.cosmos_db.database_accounts_read_only_keys
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
;
Lists the read-only access keys for the specified Azure Cosmos DB database account.
SELECT
primaryReadonlyMasterKey,
secondaryReadonlyMasterKey
FROM azure.cosmos_db.database_accounts_read_only_keys
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
;