Configuration Stores - List Key Value

Reference

Service:: App Configuration

API Version:: 2020-06-01

Lists a configuration store key-value.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/listKeyValue?api-version=2020-06-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	Required	Type	Description
key	True	string	The key to retrieve.
label		string	The label of the key.

Responses

Name	Type	Description
200 OK	KeyValue	The request was successful; the request was well-formed and received properly.
Other Status Codes	Error	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_ListKeyValue

Sample Request

HTTP

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

{
  "key": "MaxRequests",
  "label": "dev"
}

Sample Response

Status code:: 200

{
  "key": "MaxRequests",
  "label": "dev",
  "value": "100",
  "contentType": "",
  "eTag": "4f6dd610dd5e4deebc7fbaef685fb903",
  "lastModified": "2017-12-05T02:41:26+00:00",
  "locked": false,
  "tags": {
    "t1": "value1",
    "t2": "value2"
  }
}

Definitions

Name	Description
Error	AppConfiguration error object.
KeyValue	The result of a request to retrieve a key-value from the specified configuration store.
ListKeyValueParameters	The parameters used to list a configuration store key-value

Error

AppConfiguration error object.

Name	Type	Description
code	string	Error code.
message	string	Error message.

KeyValue

The result of a request to retrieve a key-value from the specified configuration store.

Name	Type	Description
contentType	string	The content type of the key-value's value. Providing a proper content-type can enable transformations of values when they are retrieved by applications.
eTag	string	An ETag indicating the state of a key-value within a configuration store.
key	string	The primary identifier of a key-value. The key is used in unison with the label to uniquely identify a key-value.
label	string	A value used to group key-values. The label is used in unison with the key to uniquely identify a key-value.
lastModified	string	The last time a modifying operation was performed on the given key-value.
locked	boolean	A value indicating whether the key-value is locked. A locked key-value may not be modified until it is unlocked.
tags	object	A dictionary of tags that can help identify what a key-value may be applicable for.
value	string	The value of the key-value.

ListKeyValueParameters

The parameters used to list a configuration store key-value

Name	Type	Description
key	string	The key to retrieve.
label	string	The label of the key.