Lists the access keys or Kerberos keys (if active directory enabled) for the specified storage account.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/listKeys?api-version=2023-01-01
With optional parameters:
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/listKeys?api-version=2023-01-01&$expand=kerb
URI Parameters
| Name |
In |
Required |
Type |
Description |
|
accountName
|
path |
True
|
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.
Regex pattern: ^[a-z0-9]+$
|
|
resourceGroupName
|
path |
True
|
string
|
The name of the resource group within the user's subscription. The name is case insensitive.
Regex pattern: ^[-\w\._\(\)]+$
|
|
subscriptionId
|
path |
True
|
string
|
The ID of the target subscription.
|
|
api-version
|
query |
True
|
string
|
The API version to use for this operation.
|
|
$expand
|
query |
|
ListKeyExpand
|
Specifies type of the key to be listed. Possible value is kerb.
|
Responses
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name |
Description |
|
user_impersonation
|
impersonate your user account
|
Examples
StorageAccountListKeys
Sample Request
POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res418/providers/Microsoft.Storage/storageAccounts/sto2220/listKeys?api-version=2023-01-01&$expand=kerb
/** Samples for StorageAccounts ListKeys. */
public final class Main {
/*
* x-ms-original-file:
* specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountListKeys.json
*/
/**
* Sample code: StorageAccountListKeys.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void storageAccountListKeys(com.azure.resourcemanager.AzureResourceManager azure) {
azure.storageAccounts().manager().serviceClient().getStorageAccounts().listKeysWithResponse("res418", "sto2220",
null, com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.storage import StorageManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-storage
# USAGE
python storage_account_list_keys.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = StorageManagementClient(
credential=DefaultAzureCredential(),
subscription_id="{subscription-id}",
)
response = client.storage_accounts.list_keys(
resource_group_name="res418",
account_name="sto2220",
)
print(response)
# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountListKeys.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armstorage_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storage/armstorage"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/0baf811c3c76c87b3c127d098519bd97141222dd/specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountListKeys.json
func ExampleAccountsClient_ListKeys() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armstorage.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewAccountsClient().ListKeys(ctx, "res418", "sto2220", &armstorage.AccountsClientListKeysOptions{Expand: nil})
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.AccountListKeysResult = armstorage.AccountListKeysResult{
// Keys: []*armstorage.AccountKey{
// {
// KeyName: to.Ptr("key1"),
// Permissions: to.Ptr(armstorage.KeyPermissionFull),
// Value: to.Ptr("<value>"),
// },
// {
// KeyName: to.Ptr("key2"),
// Permissions: to.Ptr(armstorage.KeyPermissionFull),
// Value: to.Ptr("<value>"),
// }},
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { StorageManagementClient } = require("@azure/arm-storage");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Lists the access keys or Kerberos keys (if active directory enabled) for the specified storage account.
*
* @summary Lists the access keys or Kerberos keys (if active directory enabled) for the specified storage account.
* x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-01-01/examples/StorageAccountListKeys.json
*/
async function storageAccountListKeys() {
const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "res418";
const accountName = "sto2220";
const credential = new DefaultAzureCredential();
const client = new StorageManagementClient(credential, subscriptionId);
const result = await client.storageAccounts.listKeys(resourceGroupName, accountName);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Sample Response
{
"keys": [
{
"keyName": "key1",
"permissions": "Full",
"value": "<value>"
},
{
"keyName": "key2",
"permissions": "Full",
"value": "<value>"
}
]
}
Definitions
KeyPermission
Permissions for the key -- read-only or full permissions.
| Name |
Type |
Description |
|
Full
|
string
|
|
|
Read
|
string
|
|
ListKeyExpand
Specifies type of the key to be listed. Possible value is kerb.
| Name |
Type |
Description |
|
kerb
|
string
|
|
StorageAccountKey
An access key for the storage account.
| Name |
Type |
Description |
|
creationTime
|
string
|
Creation time of the key, in round trip date format.
|
|
keyName
|
string
|
Name of the key.
|
|
permissions
|
KeyPermission
|
Permissions for the key -- read-only or full permissions.
|
|
value
|
string
|
Base 64-encoded value of the key.
|
StorageAccountListKeysResult
The response from the ListKeys operation.
| Name |
Type |
Description |
|
keys
|
StorageAccountKey[]
|
Gets the list of storage account keys and their properties for the specified storage account.
|