Configuration Stores - Regenerate Key

Regenerates an access key for the specified configuration store.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/RegenerateKey?api-version=2019-10-01

URI Parameters

Name In Required Type Description
configStoreName
path True
  • string

The name of the configuration store.

Regex pattern: ^[a-zA-Z0-9_-]*$

resourceGroupName
path True
  • string

The name of the resource group to which the container registry belongs.

subscriptionId
path True
  • string

The Microsoft Azure subscription ID.

api-version
query True
  • string

The client API version.

Request Body

Name Type Description
id
  • string

The id of the key to regenerate.

Responses

Name Type Description
200 OK

The request was successful; the request was well-formed and received properly.

Other Status Codes

Error response describing why the operation failed

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

ConfigurationStores_RegenerateKey

Sample Request

POST https://management.azure.com/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso/RegenerateKey?api-version=2019-10-01
{
  "id": "439AD01B4BE67DB1"
}

Sample Response

{
  "id": "439AD01B4BE67DB1",
  "name": "Primary",
  "value": "000000000000000000000000000000000000000000000000000000",
  "connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "lastModified": "2018-04-26T22:59:24.2370906+00:00",
  "readOnly": false
}

Definitions

ApiKey

An API key used for authenticating with a configuration store endpoint.

Error

AppConfiguration error object.

RegenerateKeyParameters

The parameters used to regenerate an API key.

ApiKey

An API key used for authenticating with a configuration store endpoint.

Name Type Description
connectionString
  • string

A connection string that can be used by supporting clients for authentication.

id
  • string

The key ID.

lastModified
  • string

The last time any of the key's properties were modified.

name
  • string

A name for the key describing its usage.

readOnly
  • boolean

Whether this key can only be used for read operations.

value
  • string

The value of the key that is used for authentication purposes.

Error

AppConfiguration error object.

Name Type Description
code
  • string

Error code.

message
  • string

Error message.

RegenerateKeyParameters

The parameters used to regenerate an API key.

Name Type Description
id
  • string

The id of the key to regenerate.