Share via

Configuration Stores - List Keys

Service:
App Configuration
API Version:
2024-06-01

Lists the access key for the specified configuration store.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/listKeys?api-version=2024-06-01
With optional parameters: 
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/listKeys?api-version=2024-06-01&$skipToken={$skipToken}

URI Parameters

Name In Required Type Description
configStoreName
 path True

string

minLength: 5
maxLength: 50
pattern: ^[a-zA-Z0-9_-]*$

The name of the configuration store.
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.
$skipToken
 query

string

A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.

Responses

Name Type Description
200 OK

ApiKeyListResult

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

ErrorResponse

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_ListKeys

Sample request

POST https://management.azure.com/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso/listKeys?api-version=2024-06-01

Sample response

Status code:
200 
{
  "value": [
    {
      "id": "439AD01B4BE67DB1",
      "name": "Primary",
      "value": "000000000000000000000000000000000000000000000000000000",
      "connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "lastModified": "2018-04-24T16:30:54+00:00",
      "readOnly": false
    },
    {
      "id": "CB45E100456857B9",
      "name": "Secondary",
      "value": "000000000000000000000000000000000000000000000000000000",
      "connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "lastModified": "2018-04-24T16:30:54+00:00",
      "readOnly": false
    },
    {
      "id": "B3AC55B7E71431A9",
      "name": "Primary Read Only",
      "value": "000000000000000000000000000000000000000000000000000000",
      "connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "lastModified": "2018-04-24T16:30:54+00:00",
      "readOnly": true
    },
    {
      "id": "E2AF6A9A89DCC177",
      "name": "Secondary Read Only",
      "value": "000000000000000000000000000000000000000000000000000000",
      "connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "lastModified": "2018-04-24T16:30:54+00:00",
      "readOnly": true
    }
  ]
}

Definitions

Name Description
ApiKey

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

The result of a request to list API keys.
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetails

The details of the error.
ErrorResponse

Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.

ApiKey

Object

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 (date-time)

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.

ApiKeyListResult

Object

The result of a request to list API keys.

Name Type Description
nextLink

string

The URI that can be used to request the next set of paged results.
value

ApiKey[]

The collection value.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetails

Object

The details of the error.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

Error code.
message

string

Error message indicating why the operation failed.

ErrorResponse

Object

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

ErrorDetails

The details of the error.