Delen via

Etiketten

  • Artikel

De labelresource wordt als volgt gedefinieerd:

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

Ondersteunt de volgende bewerkingen:

  • List

Voor alle bewerkingen name is een optionele filterparameter. Als u dit weglaat, impliceert dit een label.

Vereisten

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" deze 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

Antwoord:

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

name Filteren op wordt ondersteund.

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

Ondersteunde filters

Labelfilter 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 deze worden ontsnapt met behulp van \{Reserved Character}. Niet-gereserveerde tekens kunnen ook worden ontsnapt.

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

  • Alle

    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 queryreeksparameter en geef een door komma's gescheiden lijst met aangevraagde velden op. Als de $select parameter wordt weggelaten, bevat het antwoord de standaardset.

GET /labels?$select=name&api-version={api-version} HTTP/1.1

Toegang op basis van tijd

Verkrijg een weergave van het resultaat zoals het in het verleden was. Zie sectie 2.1.1

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

Antwoord:

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