Étiquettes

La ressource Étiquette est définie comme suit :

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

Prend en charge les opérations suivantes :

• List

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

Utilisez le paramètre optionnel resourceType pour filtrer les étiquettes par leur type de ressource associé. Définissez resourceType pour kv les labels clé-valeur ou ff pour les étiquettes de drapeaux de fonctionnalité améliorées.

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.

Répertorier les étiquettes

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

Réponses :

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

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

Étiquettes de liste par type de ressource

La requête suivante liste les étiquettes associées aux indicateurs de fonctionnalités améliorées :

GET /labels?resourceType=ff&api-version={api-version} HTTP/1.1

Pour lister les étiquettes associées aux valeurs clés, on règle resourceType à kv.

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 forme de la propriété @nextLink. Le lien suivant contient le paramètre api-version.

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

Réponse :

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

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

Filtrage

Le filtrage par name est pris en charge.

GET /labels?name={label-name}&api-version={api-version}

Filtres pris en charge

Filtre de type de ressource

Caractères 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 /labels?api-version={api-version}
  

• Le nom d’étiquette commence par abc

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

• Le nom d’étiquette est abc ou xyz

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

• Le nom de l’étiquette de drapeau de fonctionnalité amélioré commence par abc

  GET /labels?resourceType=ff&name=abc*&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 /labels?$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 /labels&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.labelset+json"
Memento-Datetime: Sat, 12 May 2018 02:10:00 GMT
Link: <{relative uri}>; rel="original"

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