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=2023-03-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
config
|
path | True |
string |
The name of the configuration store. Regex pattern: |
resource
|
path | True |
string |
The name of the resource group to which the container registry belongs. |
subscription
|
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
Sample Response
{
"id": "439AD01B4BE67DB1",
"name": "Primary",
"value": "000000000000000000000000000000000000000000000000000000",
"connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"lastModified": "2018-04-26T22:59:24.2370906+00:00",
"readOnly": false
}
Definitions
Name | Description |
---|---|
Api |
An API key used for authenticating with a configuration store endpoint. |
Error |
The resource management error additional info. |
Error |
The details of the error. |
Error |
Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. |
Regenerate |
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. |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorDetails
The details of the error.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
Error code. |
message |
string |
Error message indicating why the operation failed. |
ErrorResponse
Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.
Name | Type | Description |
---|---|---|
error |
The details of the error. |
RegenerateKeyParameters
The parameters used to regenerate an API key.
Name | Type | Description |
---|---|---|
id |
string |
The id of the key to regenerate. |