accounts_keys
Creates, updates, deletes, gets or lists an accounts_keys resource.
Overview
| Name | accounts_keys |
| Type | Resource |
| Id | azure.storage.accounts_keys |
Fields
The following fields are returned by SELECT queries:
- list
OK -- list of keys retrieved and returned successfully.
| Name | Datatype | Description |
|---|---|---|
keys | array | Gets the list of storage account keys and their properties for the specified storage account. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | resourceGroupName, accountName, subscriptionId | $expand | Lists the access keys or Kerberos keys (if active directory enabled) for the specified storage 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 | The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. |
resourceGroupName | string | The name of the resource group within the user's subscription. The name is case insensitive. |
subscriptionId | string (uuid) | The ID of the target subscription. The value must be an UUID. |
$expand | string | Specifies type of the key to be listed. Possible value is kerb. |
SELECT examples
- list
Lists the access keys or Kerberos keys (if active directory enabled) for the specified storage account.
SELECT
keys
FROM azure.storage.accounts_keys
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;