Klucze

Następująca składnia reprezentuje zasób klucza:

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

Operacje

Kluczowe zasoby obsługują następującą operację:

• List

Dla wszystkich operacji name jest opcjonalny parametr filtru. Jeśli pominięto, oznacza to dowolny klucz.

Wymagania wstępne

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

Klucze listy

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

Odpowiedzi:

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

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

Podział na strony

Wynik jest podzielony na strony, jeśli liczba zwracanych 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. Następny link zawiera api-version parametr.

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

Odpowiedź:

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

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

Filtrowanie

Filtrowanie według name jest obsługiwane.

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

Obsługiwane są następujące filtry:

Filtr klucza	Efekt
Element name jest pomijany lub name=*	Pasuje do dowolnego klucza
name=abc	Pasuje do klucza o nazwie abc
name=abc*	Pasuje do nazw kluczy, które zaczynają się od ciągu abc
name=abc,xyz	Pasuje do nazw kluczy abc lub xyz (ograniczone do 5 CSV)

Zastrzeżone są następujące znaki: *, , \,

Jeśli zastrzeżony znak jest częścią wartości, należy go uniknąć przy użyciu metody \{Reserved Character}. Znaki inne niż zastrzeżone mogą być również ucieczki.

Walidacja filtru

W przypadku błędu sprawdzania poprawności 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 'name'",
  "name": "name",
  "detail": "name(2): Invalid character",
  "status": 400
}

Przykłady

• wszystkie

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

• Nazwa klucza zaczyna się od abc

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

• Nazwa klucza to abc lub xyz

  GET /keys?name=abc,xyz&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 /keys?$select=name&api-version={api-version} HTTP/1.1

Dostęp oparty na czasie

Uzyskaj reprezentację wyniku w przeszłości. Zobacz sekcję 2.1.1

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

Odpowiedź:

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": [
        ....
    ]
}