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=2019-06-01

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

The ID of the target subscription.

resourceGroupName
path True
  • string

The name of the resource group within the user's subscription. The name is case insensitive.

Regex pattern: ^[-\w\._\(\)]+$

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.

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

StorageAccountRegenerateKerbKey
StorageAccountRegenerateKey

StorageAccountRegenerateKerbKey

Sample Request

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res4167/providers/Microsoft.Storage/storageAccounts/sto3539/regenerateKey?api-version=2019-06-01
{
  "keyName": "kerb1"
}

Sample Response

{
  "keys": [
    {
      "keyName": "key1",
      "permissions": "Full",
      "value": "7xl+yQ4MrVpZCHspveCfy4f8jgTY1wv42gHO8k4bAX+EPvN4hY5uPau/bpofgeye+K9FtgvjkadkLISPfOxlMw=="
    },
    {
      "keyName": "key2",
      "permissions": "Full",
      "value": "uC+kyJ9/gT81E/+9I1Go4xtOe8sW5rdIm3n6PNIyQ5kGO5OpFq69aWnrn3jLeFIyItzpln9P392U0353RYKvbg=="
    },
    {
      "keyName": "kerb1",
      "permissions": "Full",
      "value": "34EzDQuCw1lYBXCGioUybN9dCWSLLzQPdAbYRcLhM957Fy/6IlO/SkaeR9QXKhVgCt8anDq4wYmDcaZ5VXr2Tg=="
    }
  ]
}

StorageAccountRegenerateKey

Sample Request

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res4167/providers/Microsoft.Storage/storageAccounts/sto3539/regenerateKey?api-version=2019-06-01
{
  "keyName": "key2"
}

Sample Response

{
  "keys": [
    {
      "keyName": "key1",
      "permissions": "Full",
      "value": "7xl+yQ4MrVpZCHspveCfy4f8jgTY1wv42gHO8k4bAX+EPvN4hY5uPau/bpofgeye+K9FtgvjkadkLISPfOxlMw=="
    },
    {
      "keyName": "key2",
      "permissions": "Full",
      "value": "uC+kyJ9/gT81E/+9I1Go4xtOe8sW5rdIm3n6PNIyQ5kGO5OpFq69aWnrn3jLeFIyItzpln9P392U0353RYKvbg=="
    }
  ]
}

Definitions

KeyPermission

Permissions for the key -- read-only or full permissions.

StorageAccountKey

An access key for the storage account.

StorageAccountListKeysResult

The response from the ListKeys operation.

StorageAccountRegenerateKeyParameters

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
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.