Etykiety
wersja interfejsu API: 1.0
Zasób Etykieta jest zdefiniowany w następujący sposób:
{
"name": [string] // Name of the label
}
Obsługuje następujące operacje:
- Lista
Dla wszystkich operacji name
jest opcjonalnym parametrem filtru. Jeśli pominięto, oznacza to dowolną etykietę.
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}"
}
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 . Następny link zawiera api-version
parametr .
GET /labels?api-version={api-version} HTTP/1.1
Odpowiedzi:
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 klucza | Efekt |
---|---|
Element name jest pomijany lub name=* |
Dopasuje dowolną etykietę |
name=abc |
Dopasuje etykietę o nazwie abc |
name=abc* |
Pasuje do nazw etykiet rozpoczynających się od abc |
name=abc,xyz |
Dopasuje nazwy etykiet abc lub xyz (ograniczone do 5 CSV) |
Zastrzeżone znaki
*
, \
, ,
Jeśli zastrzeżony znak jest częścią wartości, należy go uniknić przy użyciu elementu \{Reserved Character}
. Znaki nieuwzwiązane z zarezerwowaną można również stosować jako znaki ucieczki.
Sprawdzanie poprawności 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
Wszystko
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}
Żą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
Time-Based Access
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
Odpowiedzi:
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": [
....
]
}
Opinia
https://aka.ms/ContentUserFeedback.
Dostępne już wkrótce: W 2024 r. będziemy stopniowo wycofywać zgłoszenia z serwisu GitHub jako mechanizm przesyłania opinii na temat zawartości i zastępować go nowym systemem opinii. Aby uzyskać więcej informacji, sprawdź:Prześlij i wyświetl opinię dla