Skip to content

rest-api-keys.md

Latest commit

 

History

History
180 lines (131 loc) · 3.74 KB

rest-api-keys.md

File metadata and controls

180 lines (131 loc) · 3.74 KB
title Azure App Configuration REST API - Keys
description Reference pages for working with keys using the Azure App Configuration REST API
author maud-lv
ms.author malev
ms.service azure-app-configuration
ms.topic reference
ms.date 08/02/2024
zone_pivot_groups appconfig-data-plane-api-version

:::zone target="docs" pivot="v1,v23-10,v23-11"

Keys

The following syntax represents a key resource:

{
    "name": [string]             // Name of the key
}

Operations

Key resources support the following operation:

  • List

For all operations name is an optional filter parameter. If omitted, it implies any key.

Prerequisites

[!INCLUDE azure-app-configuration-create]

List Keys

GET /keys?api-version={api-version} HTTP/1.1

Responses:

HTTP/1.1 200 OK
Content-Type: application/vnd.microsoft.appconfig.keyset+json; charset=utf-8"
{
    "items": [
        {
          "name": "{key-name}"
        },
        ...
    ],
    "@nextLink": "{relative uri}"
}

Pagination

The result is paginated if the number of items returned exceeds the response limit. Follow the optional Link response headers and use rel="next" for navigation. Alternatively the content provides a next link in the form of the @nextLink property. The next link contains api-version parameter.

GET /keys?api-version={api-version} HTTP/1.1

Response:

HTTP/1.1 OK
Content-Type: application/vnd.microsoft.appconfig.keyset+json; charset=utf-8
Link: <{relative uri}>; rel="next"
{
    "items": [
        ...
    ],
    "@nextLink": "{relative uri}"
}

Filtering

Filtering by name is supported.

GET /keys?name={key-name}&api-version={api-version}

The following filters are supported:

Key Filter Effect
name is omitted or name=* Matches any key
name=abc Matches a key named abc
name=abc* Matches key names that start with abc
name=abc,xyz Matches key names abc or xyz (limited to 5 CSV)

The following characters are reserved: *, \, ,

If a reserved character is part of the value, then it must be escaped using \{Reserved Character}. Non-reserved characters can also be escaped.

Filter validation

In the case of a filter validation error, the response is HTTP 400 with error details:

HTTP/1.1 400 Bad Request
Content-Type: application/problem+json; charset=utf-8
{
  "type": "https://azconfig.io/errors/invalid-argument",
  "title": "Invalid request parameter 'name'",
  "name": "name",
  "detail": "name(2): Invalid character",
  "status": 400
}

Examples

  • All

    GET /keys?api-version={api-version}

  • Key name starts with abc

    GET  /keys?name=abc*&api-version={api-version}

  • Key name is either abc or xyz

    GET /keys?name=abc,xyz&api-version={api-version}

Request specific fields

Use the optional $select query string parameter and provide comma separated list of requested fields. If the $select parameter is omitted, the response contains the default set.

GET /keys?$select=name&api-version={api-version} HTTP/1.1

Time-Based Access

Obtain a representation of the result as it was at a past time. See section 2.1.1

GET /keys&api-version={api-version} HTTP/1.1
Accept-Datetime: Sat, 12 May 2018 02:10:00 GMT

Response:

HTTP/1.1 200 OK
Content-Type: application/vnd.microsoft.appconfig.keyset+json"
Memento-Datetime: Sat, 12 May 2018 02:10:00 GMT
Link: <relative uri>; rel="original"
{
    "items": [
        ....
    ]
}

:::zone-end