Etiketter

Etikettresursen definieras på följande sätt:

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

Stöder följande åtgärder:

• List

För alla åtgärder name är en valfri filterparameter. Om det utelämnas innebär det någon etikett.

Använd den valfria resourceType parametern för att filtrera etiketter efter deras associerade resurstyp. Ställ resourceType in på kv för nyckel-värde-etiketter eller ff för förbättrade funktionsflaggmärken.

Förutsättningar

• Alla HTTP-begäranden måste autentiseras. Se avsnittet autentisering.
• Alla HTTP-begäranden måste ange explicit api-version. Se avsnittet versionshantering.

Listetiketter

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

Svaren:

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

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

Lista etiketter efter resurstyp

Följande begäran listar etiketter kopplade till förbättrade funktionsflaggor:

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

För att lista etiketter kopplade till nyckelvärden, sätt resourceType till kv.

Sidnumrering

Resultatet sidnumreras om antalet returnerade objekt överskrider svarsgränsen. Följ de valfria Link svarshuvudena och använd rel="next" för navigering. Alternativt innehåller innehållet en nästa länk i form av @nextLink egenskapen. Nästa länk innehåller api-version parametern .

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

Svar:

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

Filtrering

Filtrering efter name stöds.

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

Filter som stöds

Resurstypfilter

Reserverade tecken

*, , \,

Om ett reserverat tecken är en del av värdet måste det undantagas med hjälp av \{Reserved Character}. Icke-reserverade tecken kan också undantagas.

Filterverifiering

Om ett filterverifieringsfel inträffar är svaret HTTP 400 med felinformation:

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
}

Exempel

• Alla

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

• Etikettnamnet börjar med abc

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

• Etikettnamnet är antingen abc eller xyz

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

• Namnet på flaggan med förbättrad funktion börjar med abc

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

Begär specifika fält

Använd den valfria frågesträngsparametern $select och ange kommaavgränsad lista över begärda fält. Om parametern $select utelämnas innehåller svaret standarduppsättningen.

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

Tidsbaserad åtkomst

Hämta en representation av resultatet som det var vid en tidigare tidpunkt. Se avsnitt 2.1.1

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

Svar:

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