Gérer les propriétés de gcloud CLI

Les propriétés sont des paramètres qui régissent le comportement de gcloud CLI.

Vous pouvez utiliser des propriétés pour définir un paramètre par produit ou service, comme le compte utilisé par la gcloud CLI pour l'autorisation, la région par défaut à utiliser avec les ressources Compute Engine ou l'option permettant de désactiver les vérifications automatiques de mise à jour des composants de la gcloud CLI. Les propriétés peuvent également être utilisées pour définir les préférences de gcloud CLI, telles que le niveau de verbosité et la configuration des invites pour les commandes de gcloud CLI.

Propriétés et options

La gcloud CLI accepte des indicateurs globaux et des indicateurs de commande qui ont le même effet que les propriétés de la gcloud CLI. Par exemple, la CLI gcloud accepte aussi bien l'option --project que la propriété project. Les propriétés permettent de conserver les mêmes paramètres lors de l'exécution des commandes, tandis que les indicateurs affectent le comportement des commandes appel par appel. Notez que les indicateurs remplacent les propriétés lorsque les deux sont définis.

Configurations

Une configuration est un ensemble nommé de propriétés de gcloud CLI. La gcloud CLI utilise une configuration nommée default comme configuration active initiale. La configuration default convient à la plupart des cas d'utilisation. Cependant, vous pouvez également créer des configurations supplémentaires et basculer entre elles selon vos besoins.

Répertorier les propriétés

Pour répertorier les propriétés de la configuration active, exécutez gcloud config list :

gcloud config list

La CLI gcloud renvoie la liste des propriétés :

[compute]
region = us-east1
zone = us-east1-d
[core]
account = user@google.com
disable_usage_reporting = False
project = example-project
[metrics]
command_name = gcloud.config.list

Définir des propriétés

Pour définir une propriété dans la configuration active, exécutez gcloud config set. L'exemple suivant définit la propriété project, où PROJECT_ID est l'ID unique de votre projet.

gcloud config set project PROJECT_ID

Pour définir des propriétés qui ne figurent pas dans la section des propriétés core, vous devez spécifier la section suivie d'une barre oblique avant le nom de la propriété. L'exemple suivant définit le nom de la zone sur us-east1-b.

gcloud config set compute/zone us-east1-b

Définir des propriétés à l'aide de variables d'environnement

Vous pouvez également définir des propriétés à l'aide de variables d'environnement. Chaque propriété est associée à une variable d'environnement que vous pouvez utiliser pour la définir. Le nom de la variable d'environnement suit le modèle CLOUDSDK_SECTION_NAME_PROPERTY_NAME. Par exemple, vous pouvez définir les propriétés core/project et compute/zone comme suit :

CLOUDSDK_CORE_PROJECT=PROJECT_NAME

CLOUDSDK_COMPUTE_ZONE=ZONE_NAME

Annuler la définition de propriétés

Pour annuler la définition d'une propriété dans la configuration active, utilisez gcloud config unset :

gcloud config unset disable_usage_reporting

Propriétés disponibles

Pour obtenir la liste de toutes les propriétés, exécutez la commande gcloud topic configurations ou gcloud config set --help et recherchez la section "Available Properties" (propriétés disponibles).

Étapes suivantes