Keys

La syntaxe suivante représente une ressource de clé :

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

Opérations

Les ressources de clé prennent en charge l’opération suivante :

• List

Pour toutes les opérations, name est un paramètre de filtre facultatif. Son omission implique toute clé.

Prérequis

• Toutes les requêtes HTTP doivent être authentifiées. Consultez la section Authentification.
• Toutes les requêtes HTTP doivent fournir des api-version explicites. Consultez la section Contrôle de version.

Afficher la liste des clés

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

Réponses :

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

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

Pagination

Le résultat est paginé si le nombre d’éléments retournés dépasse le nombre limite de réponses. Suivez les en-têtes de réponse Link facultatifs et utilisez rel="next" pour la navigation. Le contenu fournit également un lien suivant sous la forme de la propriété @nextLink. Le lien suivant contient le paramètre api-version.

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

Réponse :

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

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

Filtrage

Le filtrage par name est pris en charge.

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

Les filtres suivants sont pris en charge :

Filtre de clé	Résultat
name est omis ou name=*	Correspond à toute clé
name=abc	Correspond à une clé nommée abc
name=abc*	Correspond aux noms de clé qui commencent par abc
name=abc,xyz	Correspond aux noms de clé abc ou xyz (limités à 5 valeurs séparées par des virgules)

Les caractères suivants sont réservés : *, \, ,

Si un caractère réservé fait partie de la valeur, il doit être placé dans une séquence d’échappement à l’aide de \{Reserved Character}. Les caractères non réservés peuvent également être placés dans une séquence d’échappement.

Validation de filtre

Si une erreur de validation de filtre se produit, la réponse est HTTP 400 avec les détails de l’erreur :

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
}

Exemples

• Tous

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

• Le nom de clé commence par abc

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

• Le nom de clé est abc ou xyz

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

Champs spécifiques de la demande

Utilisez le paramètre de chaîne de requête facultatif $select et fournissez une liste séparée par des virgules des champs demandés. Si le paramètre $select est omis, la réponse contient l’ensemble par défaut.

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

Accès basé sur le temps

Obtenez une représentation du résultat tel qu’il était à un moment passé. Voir la section 2.1.1

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

Réponse :

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