Kulcsok

api-version: 1.0

A következő szintaxis egy kulcserőforrást jelöl:

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

Üzemeltetés

A fő erőforrások a következő műveletet támogatják:

• Lista

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

Előfeltételek

• Minden HTTP-kérést hitelesíteni kell. Lásd a hitelesítés szakaszt.
• Minden HTTP-kérésnek explicit api-versionmódon kell megadnia a elemet. Lásd a verziószámozási szakaszt .

Listakulcsok

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

Válaszok:

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

{
    "items": [
        {
          "name": "{key-name}"
        },
        ...
    ],
    "@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éceket, é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. A következő hivatkozás paramétert tartalmaz api-version .

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

Válasz:

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

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

Szűrés

name A szűrés támogatott.

GET /keys?name={key-name}&api-version={api-version}

A következő szűrők támogatottak:

Kulcsszűrő	Hatás
name nincs megadva, vagy name=*	Bármely kulcsra illeszkedik
name=abc	Megfelel az abc nevű kulcsnak
name=abc*	Az abc-vel kezdődő kulcsnevek egyezése
name=abc,xyz	Megfelel az abc vagy xyz kulcsneveknek (legfeljebb 5 CSV-ig)

A következő karakterek vannak fenntartva: *, , \,

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

Példák

• Mind

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

• A kulcsnév az abc betűvel kezdődik

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

• A kulcs neve abc vagy xyz

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

Adott mezők kérése

Használja a nem kötelező $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 /keys?$select=name&api-version={api-version} HTTP/1.1

Time-Based Access

Szerezze be az eredménynek az előző időponthoz hasonlóan történő ábrázolását. Lásd a 2.1.1 szakaszt

GET /keys&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.keyset+json"
Memento-Datetime: Sat, 12 May 2018 02:10:00 GMT
Link: <relative uri>; rel="original"

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