Nycklar

Följande syntax representerar en nyckelresurs:

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

Operations

Nyckelresurser stöder följande åtgärd:

• List

För alla åtgärder name är en valfri filterparameter. Om det utelämnas innebär det vilken nyckel som helst .

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.

Listnycklar

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

Svaren:

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

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

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 /keys?api-version={api-version} HTTP/1.1

Svar:

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

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

Filtrering

Filtrering efter name stöds.

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

Följande filter stöds:

Nyckelfilter	Effekt
name utelämnas eller name=*	Matchar valfri nyckel
name=abc	Matchar en nyckel med namnet abc
name=abc*	Matchar nyckelnamn som börjar med abc
name=abc,xyz	Matchar nyckelnamn abc eller xyz (begränsat till 5 CSV)

Följande tecken är reserverade: *, \, ,

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

Vid ett filterverifieringsfel ä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 /keys?api-version={api-version}
  

• Nyckelnamnet börjar med abc

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

• Nyckelnamnet är antingen abc eller xyz

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

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