Cette page a été traduite par l'API Cloud Translation.

Créer et gérer des libellés

Cette page présente brièvement les libellés et explique comment les créer et les gérer à l'aide de l'API Resource Manager et de Google Cloud Console.

Qu'est-ce qu'un libellé ?

Une étiquette est une paire clé/valeur qui vous aide à organiser vos ressources Google Cloud. Vous pouvez associer un libellé à chaque ressource, puis filtrer les ressources par libellé. Les informations sur les étiquettes sont transmises au système de facturation afin que vous puissiez consulter le détail des frais apparaissant sur votre facture en fonction des étiquettes.

Pour les ressources, les libellés peuvent être utilisés comme des annotations qu'il est possible d'interroger. Cependant, ils ne peuvent pas être utilisés pour définir des conditions dans le cadre de vos stratégies. Les tags permettent d'autoriser ou de refuser des règles de manière conditionnelle selon qu'une ressource possède un tag spécifique ou non. Pour en savoir plus, consultez la présentation des tags.

Libellés et tags

Les tags constituent un outil distinct permettant de contrôler avec précision les règles. Pour en savoir plus sur les tags, consultez la page Présentation des tags.

Cas d'utilisation courants des libellés

Nous vous recommandons de ne pas créer de grands nombres de libellés uniques, tels que pour des horodatages ou des valeurs individuelles pour chaque appel d'API. Voici quelques cas d'utilisation courants des étiquettes :

Étiquettes d'équipe ou de centre de coûts : ajoutez des étiquettes basées sur l'équipe ou le centre de coûts pour distinguer les ressources appartenant à différentes équipes (par exemple, team:research et team:analytics). Vous pouvez utiliser ce type d'étiquette pour la comptabilité analytique ou la budgétisation.
Étiquettes de composant : par exemple, component:redis, component:frontend, component:ingest et component:dashboard.
Libellés d'environnement ou d'étape : par exemple, environment:production et environment:test.
Libellés d'état : par exemple, state:active, state:readytodelete et state:archive.

Libellés de machine virtuelle : un libellé peut être associé à une machine virtuelle. Les tags de machine virtuelle que vous avez définis précédemment apparaissent sous la forme d'un libellé sans valeur.

Exigences applicables aux libellés

Les libellés appliqués à une ressource doivent répondre aux exigences suivantes :

Chaque ressource peut posséder plusieurs libellés, jusqu'à un maximum de 64.
Chaque libellé doit correspondre à une paire clé/valeur.
Les clés doivent comporter un (1) caractère au minimum et 63 au maximum, et ne peuvent pas être vides. Les valeurs peuvent être vides et comporter 63 caractères au maximum.
Les clés et les valeurs ne peuvent contenir que des lettres minuscules, des chiffres, des traits de soulignement et des tirets. Tous les caractères doivent être au format d'encodage UTF-8. Les caractères internationaux sont autorisés.
La partie clé d'un libellé doit être unique. Cependant, vous pouvez utiliser la même clé avec plusieurs ressources.
Les clés doivent commencer par une lettre minuscule ou un caractère international.

Ces limites s'appliquent à la clé et à la valeur de chaque libellé, ainsi qu'aux ressources Google Cloud individuelles associées à des libellés. Vous pouvez appliquer autant de libellés que vous le souhaitez à toutes les ressources d'un projet.

Autorisations

Vous pouvez ajouter ou modifier un libellé en appelant la méthode projects.projects.patch(). Pour ce faire, vous devez disposer de l'autorisation resourcemanager.projects.update.

Vous pouvez afficher le libellé d'un projet en appelant la méthode projects.get(). Pour ce faire, vous devez disposer de l'autorisation resourcemanager.projects.get.

Créer des libellés

Console

Pour ajouter des libellés à un seul projet, procédez comme suit :

Ouvrez la page Libellés dans Cloud Console.

Ouvrir la page "Libellés"
Sélectionnez le projet dans la liste déroulante Sélectionner un projet.
Pour ajouter une nouvelle entrée de libellé, cliquez sur + Ajouter un libellé et saisissez une clé de libellé et une valeur pour chaque libellé à ajouter.
Lorsque vous avez terminé, cliquez sur Enregistrer.

Pour ajouter des libellés à plusieurs projets en même temps, procédez comme suit :

Ouvrez la page Gérer les ressources de Cloud Console.

Ouvrir la page "Gérer les ressources"
Sur la page Gérer les ressources, sélectionnez les projets auxquels vous souhaitez ajouter des libellés.
Dans le panneau d'informations, dans l'onglet Libellés, cliquez sur + Ajouter un libellé, puis saisissez une clé et une valeur pour chaque libellé à ajouter.
Lorsque vous avez terminé, cliquez sur Enregistrer.

Après avoir ajouté des libellés, vous pouvez filtrer les projets en saisissant une clé de libellé ou une valeur dans la zone de filtre au-dessus de la liste des projets. La zone de filtre propose des clés et des valeurs afin que vous puissiez prévisualiser les résultats.

REST

Pour créer un projet doté d'un libellé, définissez le champ labels lors de la création du projet.

Requête :

POST https://cloudresourcemanager.googleapis.com/v3/projects

{
 "labels": {
  "color": "red"
 },
 "name": "myproject",
 "projectId": "our-project-123"
}

Réponse :


{
 "projectNumber": "333197460082",
 "projectId": "our-project-123",
 "lifecycleState": "ACTIVE",
 "name": "myproject",
 "labels": {
  "color": "red"
 },
 "createTime": "2016-01-12T22:18:28.633Z",
}

Pour ajouter des libellés à des projets existants, procédez comme suit :

Obtenez le projet à l'aide de la méthode projects.get().
Modifiez le champ labels.
Mettez à jour le projet à l'aide de la méthode projects.patch().

Une fois les libellés ajoutés, vous pouvez filtrer les projets en fonction de ces libellés. Pour en savoir plus sur l'utilisation des libellés pour filtrer les projets, consultez la section Répertorier des projets.

Python

Pour créer un projet doté d'un libellé, définissez le champ labels lorsque vous créez le projet à l'aide de la méthode projects.create().

Pour ajouter des libellés à un projet existant, procédez comme suit :

Récupérez l'objet project à l'aide de la méthode projects.get().
Modifiez le champ labels.
Appelez la méthode projects.patch().

Mettre à jour les étiquettes

Console

Pour mettre à jour les libellés d'un seul projet, procédez comme suit :

Ouvrez la page Libellés dans Cloud Console.

Ouvrir la page "Libellés"
Sélectionnez le projet dans la liste déroulante Sélectionner un projet.
Mettez à jour les libellés de votre projet :
1. Pour modifier un libellé, cliquez sur la clé ou la valeur que vous souhaitez modifier, puis apportez les modifications souhaitées.
2. Pour supprimer un libellé, maintenez le pointeur sur la clé ou la valeur, puis cliquez sur .
Lorsque vous avez terminé, cliquez sur Enregistrer.

Pour mettre à jour des libellés dans plusieurs projets en même temps, procédez comme suit :

Ouvrez la page Gérer les ressources de Cloud Console.

Ouvrir la page "Gérer les ressources"
Sur la page Gérer les ressources, sélectionnez les projets dans lesquels vous souhaitez mettre à jour des libellés.
Dans le panneau d'informations, cliquez sur l'onglet Libellés et mettez à jour les libellés des projets sélectionnés :
1. Pour modifier un libellé, cliquez sur la clé ou la valeur que vous souhaitez modifier, puis apportez les modifications souhaitées.
2. Pour supprimer un libellé, maintenez le pointeur sur la clé ou la valeur, puis cliquez sur .
Lorsque vous avez terminé, cliquez sur Enregistrer.

REST

Pour mettre à jour les libellés d'un projet, procédez comme suit :

Récupérez l'objet project à l'aide de la méthode projects.get().
Modifiez les libellés que vous souhaitez mettre à jour.
Appelez la méthode projects.patch.

L'exemple suivant met à jour le libellé color:blue :

L'extrait de code suivant remplace la valeur du libellé color blue par red.

Requête :

PATCH https://cloudresourcemanager.googleapis.com/v3/{project.name=PROJECT_NAME}
{
  updateMask=labels
}

PROJECT_NAME correspond au nom du projet que vous souhaitez mettre à jour.

Corps JSON de la requête :

{
    "labels":
      {
        "color": "red"
      }
}

Réponse :

{
    "projects": [
    {
        "name": "projects/123456789012",
        "parent": "folders/123456789012",
        "projectId": "my-project",
        "state": "ACTIVE",
        "displayName": "PROJECT_NAME"
        "createTime": "2013-11-13T20:31:53.308Z"
        "updateTime": "2013-11-13T20:35:42.308Z"
        "etag": "BwWUlZ6XEfY="
        "labels": {
            "color": "red"
        },
    }
    ]
}

Python

Pour mettre à jour les libellés d'un projet, procédez comme suit :

Récupérez l'objet project à l'aide de la méthode projects.get().
Modifiez les libellés que vous souhaitez mettre à jour.
Appelez la méthode projects.patch().

Services compatibles avec les libellés

Les libellés sont compatibles avec les services Google Cloud suivants :

AI Platform
App Engine (environnements flexible et standard)
Artifact Registry
BigQuery
Certificate Authority Service
Cloud Bigtable
Cloud Composer
Cloud Deployment Manager
Cloud Functions
API Cloud Healthcare
Cloud Key Management Service
Cloud Run
Cloud Spanner
Cloud SQL
Cloud Storage
Cloud Translation
Compute Engine
Dataflow
Dataproc
Filestore
Google Kubernetes Engine
Memorystore
Mise en réseau
Pub/Sub
reCAPTCHA Enterprise
Resource Manager (projets uniquement)