SDK のプロパティの管理

プロパティとは

プロパティとは、gcloud CLI などの SDK ツールの動作を制御する設定です。

プロパティを使用して、プロダクトやサービスの設定を定義できます。たとえば、gcloud CLI や他の Cloud SDK ツールが認証に使用するアカウントや Google Compute Engine リソースのデフォルト リージョンを指定できます。また、Cloud SDK コンポーネントの自動更新を無効にすることもできます。プロパティは、gcloud CLI コマンドの詳細レベルやプロンプトの構成など、gcloud コマンドライン ツールの設定を定義する際にも使用できます。

プロパティとフラグ

gcloud CLI では、SDK プロパティと同じ効果を持つグローバル フラグとコマンドフラグがいくつかサポートされています。たとえば gcloud CLI では、--project フラグと project プロパティを両方サポートしています。プロパティを使用すると、コマンドの実行中に同じ設定を維持できます。コマンドを呼び出すたびに、フラグによってコマンドの動作が制御されます。両方を設定すると、フラグによってプロパティがオーバーライドされます。

構成

構成とは、SDK の一連のプロパティに名前を付けたものです。gcloud CLI では、default という名前の構成が最初に有効になります。default は、ほとんどのユースケースに適した構成です。追加の構成を作成して、必要に応じて切り替えることもできます。

プロパティのリスト表示

アクティブな構成の中のプロパティを一覧表示するには、gcloud config list を実行します。

gcloud config list

gcloud CLI により、プロパティのリストが返されます。

[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

プロパティの設定

アクティブな構成の中のプロパティを設定するには、gcloud config set を実行します。

gcloud config set project [PROJECT]

core プロパティ セクションに含まれていないプロパティを設定するには、セクションを指定し、続けてスラッシュとプロパティ名を指定する必要があります。

gcloud config set compute/zone us-east1-b

環境変数でプロパティを設定する

環境変数を使用してプロパティを設定することもできます。各プロパティには対応する環境変数があり、それを使用してプロパティを設定できます。環境変数の名前は CLOUDSDK_SECTION_NAME_PROPERTY_NAME というパターンに従います。たとえば、core/project プロパティと compute/zone プロパティは次のように設定できます。

CLOUDSDK_CORE_PROJECT=[YOUR_PROJECT_NAME]
CLOUDSDK_COMPUTE_ZONE=[YOUR_ZONE_NAME]

プロパティの設定解除

アクティブな構成の中のプロパティを設定解除するには、gcloud config unset を使用します。

gcloud config unset disable_usage_reporting

使用可能なプロパティ

すべてのプロパティのリストを表示するには、gcloud topic configurationsまたはgcloud config set --helpを実行して、[Available Properties] セクションを探します。

次のステップ