Get Key Value - Get Key Value

Service:

App Configuration

API Version:

2024-09-01

Gets a single key-value.

GET {endpoint}/kv/{key}?api-version=2024-09-01

With optional parameters:

GET {endpoint}/kv/{key}?api-version=2024-09-01&label={label}&$Select={$Select}&tags={tags}

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string (uri)
key	path	True	string	The key of the key-value.
api-version	query	True	string minLength: 1	The API version to use for this operation.
$Select	query		KeyValueFields[]	Used to select what fields are present in the returned resource(s).
label	query		string	The label of the key-value to retrieve.
tags	query		string[]	A filter used to query by tags. Syntax reference: https://aka.ms/azconfig/docs/keyvaluefiltering

Request Header

Name	Required	Type	Description
Sync-Token		string	Used to guarantee real-time consistency between requests.
Accept-Datetime		string	Requests the server to respond with the state of the resource at the specified time.
If-Match		string	Used to perform an operation only if the targeted resource's etag matches the value provided.
If-None-Match		string	Used to perform an operation only if the targeted resource's etag does not match the value provided.
x-ms-client-request-id		string (uuid)	An opaque, globally-unique, client-generated string identifier for the request.

Responses

Name	Type	Description
200 OK	KeyValue	The request has succeeded. Media Types: "application/vnd.microsoft.appconfig.kv+json", "application/problem+json", "application/json" Headers ETag: string Sync-Token: string x-ms-request-id: string
Other Status Codes	Error	An unexpected error response. Media Types: "application/vnd.microsoft.appconfig.kv+json", "application/problem+json", "application/json"

Security

Connection String

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://azconfig.io/.default

Examples

Gets a single key-value using the If-Match header.

Gets a single key-value using the If-None-Match header.

Gets a single key-value.

Gets a single key-value using the If-Match header.

Sample request

HTTP

GET https://{exampleAppConfigurationName}.azconfig.io/kv/Message?api-version=2024-09-01

Sample response

Status code:

200

Content-Type: application/vnd.microsoft.appconfig.kv+json
ETag: W/"L10qpBghN693OaxydgTkLmrBbV5"
Last-Modified: Tue, 27 Aug 2019 16:52:32 GMT
Sync-Token: zAJw6V16=NjotMSM3ODk3NjM=;sn=789763

{
  "etag": "L10qpBghN693OaxydgTkLmrBbV5",
  "key": "Message",
  "label": null,
  "content_type": null,
  "value": "Hello World!",
  "tags": {},
  "locked": false,
  "last_modified": "2019-08-27T16:52:32+00:00"
}

Gets a single key-value using the If-None-Match header.

Sample request

HTTP

GET https://{exampleAppConfigurationName}.azconfig.io/kv/Message?api-version=2024-09-01

Sample response

Status code:

200

Content-Type: application/vnd.microsoft.appconfig.kv+json
ETag: W/"7XpB48ET4VAlB9068ft6fKMyA3m"
Last-Modified: Tue, 27 Aug 2019 16:52:32 GMT
Sync-Token: zAJw6V16=NjotMSM3ODk3NjM=;sn=789763

{
  "etag": "7XpB48ET4VAlB9068ft6fKMyA3m",
  "key": "Message",
  "label": null,
  "content_type": null,
  "value": "Hello World!",
  "tags": {},
  "locked": false,
  "last_modified": "2019-08-27T16:52:32+00:00"
}

Gets a single key-value.

Sample request

HTTP

GET https://{exampleAppConfigurationName}.azconfig.io/kv/Message?api-version=2024-09-01

Sample response

Status code:

200

Content-Type: application/vnd.microsoft.appconfig.kv+json
ETag: W/"7XpB48ET4VAlB9068ft6fKMyA3m"
Last-Modified: Tue, 27 Aug 2019 16:52:32 GMT
Sync-Token: zAJw6V16=NjotMSM3ODk3NjM=;sn=789763

{
  "etag": "7XpB48ET4VAlB9068ft6fKMyA3m",
  "key": "Message",
  "label": null,
  "content_type": null,
  "value": "Hello World!",
  "tags": {},
  "locked": false,
  "last_modified": "2019-08-27T16:52:32+00:00"
}

Definitions

Name	Description
Error	Azure App Configuration error object.
KeyValue	A key-value pair representing application settings.
KeyValueFields	Key-value fields.

Error

Object

Azure App Configuration error object.

Name	Type	Description
detail	string	A detailed description of the error.
name	string	The name of the parameter that resulted in the error.
status	integer (int32)	The HTTP status code that the error maps to.
title	string	A brief summary of the error.
type	string	The type of the error.

KeyValue

Object

A key-value pair representing application settings.

Name	Type	Description
content_type	string	The content type of the value stored within the key-value.
etag	string	A value representing the current state of the resource.
key	string	The key of the key-value.
label	string	The label the key-value belongs to.
last_modified	string (date-time)	A date representing the last time the key-value was modified.
locked	boolean	Indicates whether the key-value is locked.
tags	object	The tags of the key-value
value	string	The value of the key-value.

KeyValueFields

Enumeration

Key-value fields.

Value	Description
key	Key field.
label	Label field.
content_type	Content type field.
value	Value field.
last_modified	Last modified field.
tags	Tags field.
locked	Locked field.
etag	Etag field.