Storage Accounts - Regenerate Key
Regenerates one of the access keys or Kerberos keys for the specified storage account.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/regenerateKey?api-version=2023-05-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
account
|
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: |
resource
|
path | True |
string |
The name of the resource group within the user's subscription. The name is case insensitive. Regex pattern: |
subscription
|
path | True |
string |
The ID of the target subscription. |
api-version
|
query | True |
string |
The API version to use for this operation. |
Request Body
Name | Required | Type | Description |
---|---|---|---|
keyName | True |
string |
The name of storage keys that want to be regenerated, possible values are key1, key2, kerb1, kerb2. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK -- specified key regenerated successfully. |
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
Storage |
Storage |
StorageAccountRegenerateKerbKey
Sample request
Sample response
{
"keys": [
{
"keyName": "key1",
"permissions": "Full",
"value": "<value>"
},
{
"keyName": "key2",
"permissions": "Full",
"value": "<value>"
},
{
"keyName": "kerb1",
"permissions": "Full",
"value": "<value>"
}
]
}
StorageAccountRegenerateKey
Sample request
Sample response
{
"keys": [
{
"keyName": "key1",
"permissions": "Full",
"value": "<value>"
},
{
"keyName": "key2",
"permissions": "Full",
"value": "<value>"
}
]
}
Definitions
Name | Description |
---|---|
Key |
Permissions for the key -- read-only or full permissions. |
Storage |
An access key for the storage account. |
Storage |
The response from the ListKeys operation. |
Storage |
The parameters used to regenerate the storage account key. |
KeyPermission
Permissions for the key -- read-only or full permissions.
Name | Type | Description |
---|---|---|
Full |
string |
|
Read |
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 |
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 |
Gets the list of storage account keys and their properties for the specified storage account. |
StorageAccountRegenerateKeyParameters
The parameters used to regenerate the storage account key.
Name | Type | Description |
---|---|---|
keyName |
string |
The name of storage keys that want to be regenerated, possible values are key1, key2, kerb1, kerb2. |