Labels
api-versie: 1.0
De labelresource wordt als volgt gedefinieerd:
{
"name": [string] // Name of the label
}
Ondersteunt de volgende bewerkingen:
- Lijst
Voor alle bewerkingen name
is een optionele filterparameter. Als u dit weglaat, impliceert dit elk label.
Vereisten
- Alle HTTP-aanvragen moeten worden geverifieerd. Zie de sectie verificatie .
- Alle HTTP-aanvragen moeten expliciet
api-version
bevatten. Zie de sectie versiebeheer .
Lijstlabels
GET /labels?api-version={api-version} HTTP/1.1
Reacties:
HTTP/1.1 200 OK
Content-Type: application/vnd.microsoft.appconfig.labelset+json; charset=utf-8"
{
"items": [
{
"name": "{label-name}"
},
...
],
"@nextLink": "{relative uri}"
}
Paginering
Het resultaat wordt gepagineerd als het aantal geretourneerde items de antwoordlimiet overschrijdt. Volg de optionele Link
antwoordheaders en gebruik rel="next"
voor navigatie.
De inhoud biedt ook een volgende koppeling in de vorm van de @nextLink
eigenschap. De volgende koppeling bevat api-version
de parameter .
GET /labels?api-version={api-version} HTTP/1.1
Reactie:
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}"
}
Filteren
Filteren op name
wordt ondersteund.
GET /labels?name={label-name}&api-version={api-version}
Ondersteunde filters
Sleutelfilter | Effect |
---|---|
name wordt weggelaten of name=* |
Komt overeen met elk label |
name=abc |
Komt overeen met een label met de naam abc |
name=abc* |
Komt overeen met labelnamen die beginnen met abc |
name=abc,xyz |
Komt overeen met labelnamen abc of xyz (beperkt tot 5 CSV) |
Gereserveerde tekens
*
, \
, ,
Als een gereserveerd teken deel uitmaakt van de waarde, moet het worden escaped met behulp van \{Reserved Character}
. Niet-gereserveerde tekens kunnen ook worden ge escaped.
Filtervalidatie
Als er een filtervalidatiefout optreedt, is het antwoord HTTP 400
met foutdetails:
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
}
Voorbeelden
Alles
GET /labels?api-version={api-version}
Labelnaam begint met abc
GET /labels?name=abc*&api-version={api-version}
Labelnaam is abc of xyz
GET /labels?name=abc,xyz&api-version={api-version}
Specifieke velden aanvragen
Gebruik de optionele $select
querytekenreeksparameter en geef door komma's gescheiden lijst met aangevraagde velden op. Als u de $select
parameter weglaat, bevat het antwoord de standaardset.
GET /labels?$select=name&api-version={api-version} HTTP/1.1
Time-Based Access
Verkrijg een weergave van het resultaat zoals het zich in het verleden bevond. Zie sectie 2.1.1
GET /labels&api-version={api-version} HTTP/1.1
Accept-Datetime: Sat, 12 May 2018 02:10:00 GMT
Reactie:
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": [
....
]
}