Etykiety

Zasób Etykieta jest definiowany w następujący sposób:

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

Obsługuje następujące operacje:

• List

Dla wszystkich operacji name jest opcjonalny parametr filtru. Jeśli pominięto, oznacza to dowolną etykietę.

Użyj opcjonalnego parametru resourceType do filtrowania etykiet według powiązanego typu zasobu. Ustaw resourceType na dla kv etykiet klucz-wartość lub ff dla etykiet rozszerzonych funkcji flag.

Wymagania wstępne

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

Etykiety listy

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

Odpowiedzi:

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

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

Etykiety listy według typu zasobu

Następujące żądanie zawiera etykiety powiązane z rozszerzonymi flagami funkcji:

GET /labels?resourceType=ff&api-version={api-version} HTTP/1.1

Aby wypisać etykiety powiązane z wartościami klucza, ustaw resourceType na .kv

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 /labels?api-version={api-version} HTTP/1.1

Odpowiedź:

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

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

Filtrowanie

Filtrowanie według name jest obsługiwane.

GET /labels?name={label-name}&api-version={api-version}

Obsługiwane filtry

Filtr typu zasobu

Zastrzeżone 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

Jeśli wystąpi błąd 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 /labels?api-version={api-version}
  

• Nazwa etykiety zaczyna się od abc

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

• Nazwa etykiety to abc lub xyz

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

• Rozszerzona funkcja etykiety flagi zaczyna się na abc

  GET /labels?resourceType=ff&name=abc*&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 /labels?$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 /labels&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.labelset+json"
Memento-Datetime: Sat, 12 May 2018 02:10:00 GMT
Link: <{relative uri}>; rel="original"

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