Condividi tramite

Chiavi

  • Articolo

La sintassi seguente rappresenta una risorsa chiave:

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

Operazioni

Le risorse chiave supportano l'operazione seguente:

  • List

Per tutte le operazioni name è un parametro di filtro facoltativo. Se omesso, implica qualsiasi chiave.

Prerequisiti

  • Tutte le richieste HTTP devono essere autenticate. Vedere la sezione relativa all'autenticazione.
  • Tutte le richieste HTTP devono fornire esplicitamente api-version. Vedere la sezione relativa al controllo delle versioni.

Elenco delle chiavi

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

Risposte:

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

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

Impaginazione

Il risultato viene impaginato se il numero di elementi restituiti supera il limite di risposta. Seguire le intestazioni di risposta facoltative Link e usare rel="next" per lo spostamento. In alternativa, il contenuto fornisce un collegamento successivo sotto forma di @nextLink proprietà . Il collegamento successivo contiene api-version il parametro .

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

Risposta:

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

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

Filtri

Il filtro in name base a è supportato.

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

Sono supportati i filtri seguenti:

Filtro chiavi Effetto
name è omesso oppure name=* Trova la corrispondenza con qualsiasi chiave
name=abc Corrisponde a una chiave denominata abc
name=abc* Corrisponde ai nomi delle chiavi che iniziano con abc
name=abc,xyz Trova la corrispondenza con i nomi di chiave abc o xyz (limitato a 5 CSV)

I caratteri seguenti sono riservati: *, \, ,

Se un carattere riservato fa parte del valore , deve essere preceduto da un carattere di escape usando \{Reserved Character}. I caratteri non riservati possono anche essere preceduti da caratteri di escape.

Convalida dei filtri

Nel caso di un errore di convalida del filtro, la risposta è HTTP 400 con i dettagli dell'errore:

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
}

Esempi

  • Tutte le date

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

  • Il nome della chiave inizia con abc

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

  • Il nome della chiave è abc o xyz

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

Richiedi campi specifici

Usare il parametro facoltativo $select della stringa di query e fornire un elenco delimitato da virgole di campi richiesti. Se il $select parametro viene omesso, la risposta contiene il set predefinito.

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

Accesso basato sul tempo

Ottenere una rappresentazione del risultato come in passato. Vedere la sezione 2.1.1

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

Risposta:

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