プロパティとは、gcloud CLI の動作を制御する設定のことです。
プロパティを使用して、プロダクトごとやサービスごとの設定を定義できます。たとえば、gcloud CLI で認証に使用するアカウント、Compute Engine リソースで作業するときに使用するデフォルト リージョン、gcloud CLI コンポーネントの自動更新チェックをオフにするオプションなどです。プロパティには gcloud CLI の設定も定義できます。たとえば、gcloud CLI コマンドの出力の詳細レベルやプロンプトの構成などです。
プロパティとフラグ
gcloud CLI では、gcloud CLI プロパティと同じ効果を持つグローバル フラグとコマンドフラグがいくつかサポートされています。たとえば gcloud CLI では、--project
フラグと project
プロパティを両方サポートしています。プロパティを使用すると、コマンドの実行中に同じ設定を維持できます。コマンドを呼び出すたびに、フラグによってコマンドの動作が制御されます。両方を設定すると、フラグによってプロパティがオーバーライドされます。
構成
構成とは、gcloud CLI のプロパティのセットに名前を付けたものです。gcloud CLI では、default
という名前の構成を最初の有効な構成として使用します。default
構成はほとんどのユースケースに適しています。追加の構成を作成して、必要に応じて切り替えることもできます。
プロパティのリスト表示
アクティブな構成の中のプロパティを一覧表示するには、gcloud config list
を実行します。
gcloud config list
gcloud CLI により、プロパティのリストが返されます。
[compute] region = us-east1 zone = us-east1-d [core] account = [email protected] disable_usage_reporting = False project = example-project [metrics] command_name = gcloud.config.list
プロパティの設定
アクティブな構成の中のプロパティを設定するには、gcloud config set
を実行します。次の例では、project
プロパティを設定します。ここで、PROJECT_ID はプロジェクトの一意の ID です。
gcloud config set project PROJECT_ID
core
プロパティ セクションに含まれていないプロパティを設定するには、セクションを指定し、続けてスラッシュとプロパティ名を指定する必要があります。次の例では、ゾーン名を us-east1-b
に設定します。
gcloud config set compute/zone us-east1-b
環境変数を使用してプロパティを設定する
プロパティは、環境変数を使用して設定することもできます。各プロパティには、その設定に使用できる対応する環境変数があります。環境変数の名前は CLOUDSDK_SECTION_NAME_PROPERTY_NAME
パターンに従います。たとえば、core/project
プロパティと compute/zone
プロパティは次のように設定できます。
CLOUDSDK_CORE_PROJECT=PROJECT_NAME
CLOUDSDK_COMPUTE_ZONE=ZONE_NAME
プロパティの設定解除
アクティブな構成の中のプロパティを設定解除するには、gcloud config unset
を使用します。
gcloud config unset disable_usage_reporting
使用可能なプロパティ
すべてのプロパティのリストを表示するには、gcloud topic configurations
またはgcloud config set --help
を実行して、[Available Properties] セクションを探します。
次のステップ
- 構成について詳しくは、gcloud CLI の構成をご覧ください。