Kulcs-érték változatok

A kulcs-érték változat határozza meg egy kulcs-érték erőforrás előzményképét. A változatok 7 nap után lejárnak az ingyenes szintű áruházak esetében, illetve 30 nap a Standard szintű áruházak esetében. A változatok támogatják a List műveletet.

Minden művelethez key választható paraméter. Ha nincs megadva, az bármilyen kulcsot jelent.

Minden művelethez label választható paraméter. Ha nincs megadva, az bármilyen címkét jelent.

Ez a cikk az API 1.0-s verziójára vonatkozik.

Előfeltételek

• Minden HTTP-kérést hitelesíteni kell. Tekintse meg a hitelesítés szakaszt.
• Minden HTTP-kérésnek explicitnek api-versionkell lennie. Lásd a verziószámozás szakaszt .

Korrektúrák listázása

GET /revisions?label=*&api-version={api-version} HTTP/1.1

Válaszok:

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

{
    "items": [
        {
          "etag": "4f6dd610dd5e4deebc7fbaef685fb903",
          "key": "{key}",
          "label": "{label}",
          "content_type": null,
          "value": "example value",
          "last_modified": "2017-12-05T02:41:26.4874615+00:00",
          "tags": []
        },
        ...
    ],
    "@nextLink": "{relative uri}"
}

Oldalra tördelés

Az eredmény lapszámozott, ha a visszaadott elemek száma meghaladja a válaszkorlátot. Kövesse az opcionális Link válaszfejlécet, és használja rel="next" a navigációhoz. Másik lehetőségként a tartalom egy következő hivatkozást is tartalmaz a @nextLink tulajdonság formájában.

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

Válasz:

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

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

A korrektúrák listájának részhalmaza

Használja a kérelem fejlécét Range . A válasz tartalmaz egy Content-Range fejlécet. Ha a kiszolgáló nem tudja kielégíteni a kért tartományt, HTTP-vel 416 (RangeNotSatisfiable) válaszol.

GET /revisions?api-version={api-version} HTTP/1.1
Range: items=0-2

Válasz

HTTP/1.1 206 Partial Content
Content-Type: application/vnd.microsoft.appconfig.revs+json; charset=utf-8
Content-Range: items 0-2/80

Szűrés

A és label a key szűrés kombinációja támogatott. Használja a választható key és label a lekérdezési sztring paramétereit.

GET /revisions?key={key}&label={label}&api-version={api-version}

Támogatott szűrők

Kulcsszűrő	Hatás
key ki van hagyva, vagy key=*	Bármely kulcsnak megfelel
key=abc	Egy abc nevű kulcsnak felel meg
key=abc*	Az abc-vel kezdődő kulcsnevek egyezése
key=*abc	Az abc végződésű kulcsnevek egyezése
key=*abc*	Az abc-t tartalmazó kulcsnevek egyezése
key=abc,xyz	Az abc vagy xyz kulcsneveknek felel meg (legfeljebb 5 CSV)

Címkeszűrő	Hatás
label ki van hagyva, vagy label=	Címke nélküli bejegyzés egyezése
label=*	Bármely címkének megfelel
label=prod	Megegyezik a prod címkével
label=prod*	A hirdetéssel kezdődő címkék egyezése
label=*prod	A prod végződésű címkék egyezése
label=*prod*	A prod címkét tartalmazó címkék egyezése
label=prod,test	Megfelel a prod vagy a tesztcímkéinek (legfeljebb 5 CSV)

Fenntartott karakterek

A fenntartott karakterek a következők:

*, \, ,

Ha egy fenntartott karakter az érték része, akkor a használatával \{Reserved Character}kell feloldani. A nem fenntartott karakterek is feloldhatók.

Szűrés ellenőrzése

Szűrőérvényesítési hiba esetén a válasz HTTP 400 , a hiba részleteivel:

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 '{filter}'",
  "name": "{filter}",
  "detail": "{filter}(2): Invalid character",
  "status": 400
}

Példák

• Minden:

  GET /revisions
  

• Elemek, ahol a kulcs neve abc-vel kezdődik:

  GET /revisions?key=abc*&api-version={api-version}
  

• Azok az elemek, amelyekben a kulcs neve abc vagy xyz, és a címkék prod értéket tartalmaznak:

  GET /revisions?key=abc,xyz&label=*prod*&api-version={api-version}
  

Adott mezők kérése

Használja a választható $select lekérdezési sztring paramétert, és adja meg a kért mezők vesszővel tagolt listáját. Ha a $select paraméter nincs megadva, a válasz tartalmazza az alapértelmezett készletet.

GET /revisions?$select=value,label,last_modified&api-version={api-version} HTTP/1.1

Időalapú hozzáférés

Szerezze be az eredménynek az előző időpontban való ábrázolását. További információ: HTTP-keretrendszer Time-Based erőforrás-állapotokhoz való hozzáféréshez – Memento, 2.1.1. szakasz.

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

Válasz:

HTTP/1.1 200 OK
Content-Type: application/vnd.microsoft.appconfig.revs+json"
Memento-Datetime: Sat, 12 May 2018 02:10:00 GMT
Link: <{relative uri}>; rel="original"

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