Klucze/wartości

Artykuł
06/01/2023

Klucz-wartość to zasób identyfikowany przez unikatową kombinację .key + label Parametr label jest opcjonalny. Aby jawnie odwołać się do wartości klucza bez etykiety, użyj ciągu "\0" (adres URL zakodowany jako %00). Zobacz szczegóły każdej operacji.

Ten artykuł dotyczy interfejsu API w wersji 1.0.

Operacje

Get
Wyświetlanie wielu list
Set
Usuń

Wymagania wstępne

Wszystkie żądania HTTP muszą być uwierzytelnione. Zobacz sekcję uwierzytelniania .
Wszystkie żądania HTTP muszą podać jawnie api-version. Zobacz sekcję przechowywanie wersji .

Składnia

{
  "etag": [string],
  "key": [string],
  "label": [string, optional],
  "content_type": [string, optional],
  "value": [string],
  "last_modified": [datetime ISO 8601],
  "locked": [boolean],
  "tags": [object with string properties, optional]
}

Uzyskiwanie wartości klucza

Wymagane: {key}, {api-version}
Opcjonalnie: label (Jeśli pominięto, oznacza to klucz-wartość bez etykiety).

GET /kv/{key}?label={label}&api-version={api-version}

Odpowiedzi:

HTTP/1.1 200 OK
Content-Type: application/vnd.microsoft.appconfig.kv+json; charset=utf-8;
Last-Modified: Tue, 05 Dec 2017 02:41:26 GMT
ETag: "4f6dd610dd5e4deebc7fbaef685fb903"

{
  "etag": "4f6dd610dd5e4deebc7fbaef685fb903",
  "key": "{key}",
  "label": "{label}",
  "content_type": null,
  "value": "example value",
  "last_modified": "2017-12-05T02:41:26+00:00",
  "locked": "false",
  "tags": {
    "t1": "value1",
    "t2": "value2"
  }
}

Jeśli klucz nie istnieje, zostanie zwrócona następująca odpowiedź:

HTTP/1.1 404 Not Found

Pobieranie (warunkowo)

Aby poprawić buforowanie klienta, użyj If-Match nagłówków lub If-None-Match żądań. Argument etag jest częścią reprezentacji klucza. Aby uzyskać więcej informacji, zobacz sekcje 14.24 i 14.26.

Następujące żądanie pobiera wartość klucza tylko wtedy, gdy bieżąca reprezentacja nie jest zgodna z określoną wartością etag:

GET /kv/{key}?api-version={api-version} HTTP/1.1
Accept: application/vnd.microsoft.appconfig.kv+json;
If-None-Match: "{etag}"

Odpowiedzi:

HTTP/1.1 304 NotModified

lub

HTTP/1.1 200 OK

Wyświetlanie listy klucz-wartości

Opcjonalnie: key (Jeśli nie zostanie określony, oznacza to dowolny klucz). Opcjonalnie: label (Jeśli nie zostanie określony, oznacza to dowolną etykietę).

GET /kv?label=*&api-version={api-version} HTTP/1.1

Odpowiedzi:

HTTP/1.1 200 OK
Content-Type: application/vnd.microsoft.appconfig.kvset+json; charset=utf-8

Aby uzyskać dodatkowe opcje, zobacz sekcję "Filtrowanie" w dalszej części tego artykułu.

Dzielenie na strony

Wynik jest podzielony na strony, jeśli liczba zwróconych elementów przekracza limit odpowiedzi. Postępuj zgodnie z opcjonalnymi Link nagłówkami odpowiedzi i użyj ich rel="next" do nawigacji. Alternatywnie zawartość udostępnia następny link w postaci @nextLink właściwości. Połączony identyfikator URI zawiera api-version argument.

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

Odpowiedzi:

HTTP/1.1 200 OK
Content-Type: application/vnd.microsoft.appconfig.kvs+json; charset=utf-8
Link: <{relative uri}>; rel="next"

{
    "items": [
        ...
    ],
    "@nextLink": "{relative uri}"
}

Filtrowanie

Obsługiwane jest połączenie i keylabel filtrowanie. Użyj opcjonalnych key i label parametrów ciągu zapytania.

GET /kv?key={key}&label={label}&api-version={api-version}

Obsługiwane filtry

Filtr klucza	Efekt
Element `key` jest pomijany lub `key=*`	Pasuje do dowolnego klucza
`key=abc`	Pasuje do klucza o nazwie abc
`key=abc*`	Pasuje do nazw kluczy rozpoczynających się od abc
`key=abc,xyz`	Pasuje do nazw kluczy abc lub xyz (ograniczony do 5 CSV)

Filtr etykiet	Efekt
Element `label` jest pomijany lub `label=*`	Pasuje do dowolnej etykiety
`label=%00`	Dopasowuje KV bez etykiety
`label=prod`	Pasuje do etykiety prod
`label=prod*`	Dopasuj etykiety rozpoczynające się od prod
`label=prod,test`	Pasuje do etykiet prod lub test (ograniczony do 5 CSV)

Zastrzeżone znaki

*, \, ,

Jeśli zastrzeżony znak jest częścią wartości, należy go uciec przy użyciu polecenia \{Reserved Character}. Znaki nieuwzwiązane z zarezerwowanymi mogą być również ucieczki.

Sprawdzanie poprawności filtru

W przypadku błędu walidacji filtru odpowiedź to HTTP 400 ze szczegółami błędu:

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 '{filter}'",
  "name": "{filter}",
  "detail": "{filter}(2): Invalid character",
  "status": 400
}

Przykłady

Wszystko
```
GET /kv?api-version={api-version}
```
Nazwa klucza zaczyna się od abc i zawiera wszystkie etykiety
```
GET /kv?key=abc*&label=*&api-version={api-version}
```
Nazwa klucza zaczyna się od abc i etykieta równa się 1 lub v2
```
GET /kv?key=abc*&label=v1,v2&api-version={api-version}
```

Żądanie określonych pól

Użyj opcjonalnego $select parametru ciągu zapytania i podaj rozdzielaną przecinkami listę żądanych pól. $select Jeśli parametr zostanie pominięty, odpowiedź zawiera zestaw domyślny.

GET /kv?$select=key,value&api-version={api-version} HTTP/1.1

Dostęp oparty na czasie

Uzyskaj reprezentację wyniku w przeszłości. Aby uzyskać więcej informacji, zobacz sekcję 2.1.1. Stronicowanie jest nadal obsługiwane zgodnie z definicją wcześniej w tym artykule.

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

Odpowiedzi:

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

{
    "items": [
        ....
    ]
}

Ustaw klucz

Wymagane: {key}
Opcjonalnie: label (Jeśli nie określono lub etykieta=%00, oznacza to klucz-wartość bez etykiety).

PUT /kv/{key}?label={label}&api-version={api-version} HTTP/1.1
Content-Type: application/vnd.microsoft.appconfig.kv+json

{
  "value": "example value",         // optional
  "content_type": "user defined",   // optional
  "tags": {                         // optional
    "tag1": "value1",
    "tag2": "value2",
  }
}

Odpowiedzi:

HTTP/1.1 200 OK
Content-Type: application/vnd.microsoft.appconfig.kv+json; charset=utf-8
Last-Modified: Tue, 05 Dec 2017 02:41:26 GMT
ETag: "4f6dd610dd5e4deebc7fbaef685fb903"

{
  "etag": "4f6dd610dd5e4deebc7fbaef685fb903",
  "key": "{key}",
  "label": "{label}",
  "content_type": "user defined",
  "value": "example value",
  "last_modified": "2017-12-05T02:41:26.4874615+00:00",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
  }
}

Jeśli element jest zablokowany, otrzymasz następującą odpowiedź:

HTTP/1.1 409 Conflict
Content-Type: application/problem+json; charset="utf-8"

{
    "type": "https://azconfig.io/errors/key-locked",
    "title": "Modifing key '{key}' is not allowed",
    "name": "{key}",
    "detail": "The key is read-only. To allow modification unlock it first.",
    "status": 409
}

Ustawianie klucza (warunkowo)

Aby zapobiec warunkom wyścigu, użyj If-Match nagłówków lub If-None-Match żądań. Argument etag jest częścią reprezentacji klucza. Jeśli If-Match operacja zostanie pominięta lub If-None-Match zostanie pominięta, operacja jest bezwarunkowa.

Następująca odpowiedź aktualizuje wartość tylko wtedy, gdy bieżąca reprezentacja jest zgodna z określoną wartością etag:

PUT /kv/{key}?label={label}&api-version={api-version} HTTP/1.1
Content-Type: application/vnd.microsoft.appconfig.kv+json
If-Match: "4f6dd610dd5e4deebc7fbaef685fb903"

Następująca odpowiedź aktualizuje wartość tylko wtedy, gdy bieżąca reprezentacja nie jest zgodna z określoną wartością etag:

PUT /kv/{key}?label={label}&api-version={api-version} HTTP/1.1
Content-Type: application/vnd.microsoft.appconfig.kv+json;
If-None-Match: "4f6dd610dd5e4deebc7fbaef685fb903"

Następujące żądanie dodaje wartość tylko wtedy, gdy reprezentacja już istnieje:

PUT /kv/{key}?label={label}&api-version={api-version} HTTP/1.1
Content-Type: application/vnd.microsoft.appconfig.kv+json;
If-Match: "*"

Następujące żądanie dodaje wartość tylko wtedy, gdy reprezentacja jeszcze nie istnieje:

PUT /kv/{key}?label={label}&api-version={api-version} HTTP/1.1
Content-Type: application/vnd.microsoft.appconfig.kv+json
If-None-Match: "*"

Odpowiedzi

HTTP/1.1 200 OK
Content-Type: application/vnd.microsoft.appconfig.kv+json; charset=utf-8
...

lub

HTTP/1.1 412 PreconditionFailed

Usuń

Wymagane: {key}, {api-version}
Opcjonalnie: {label} (Jeśli nie określono lub etykieta=%00, oznacza to klucz-wartość bez etykiety).

DELETE /kv/{key}?label={label}&api-version={api-version} HTTP/1.1

Odpowiedzi: Zwróć usuniętą wartość klucza lub brak, jeśli klucz-wartość nie istnieje.

HTTP/1.1 200 OK
Content-Type: application/vnd.microsoft.appconfig.kv+json; charset=utf-8
...

lub

HTTP/1.1 204 No Content

Usuwanie klucza (warunkowo)

Jest to podobne do sekcji "Ustaw klucz (warunkowo)" we wcześniejszej części tego artykułu.

Udostępnij za pośrednictwem

Klucze/wartości

Operacje

Wymagania wstępne

Składnia

Uzyskiwanie wartości klucza

Pobieranie (warunkowo)

Wyświetlanie listy klucz-wartości

Filtrowanie

Obsługiwane filtry

Żądanie określonych pól

Dostęp oparty na czasie

Ustaw klucz

Ustawianie klucza (warunkowo)

Usuń

Usuwanie klucza (warunkowo)

Opinia

Opinia

Dodatkowe zasoby