次の方法で共有

Azure CLI の構成

Azure CLI では、ログ記録、データ収集、既定の引数値などの設定をユーザーが構成できます。 CLI には、いくつかの既定値を管理するための便利なコマンドである az config と、az init を通じた対話型のオプションが用意されています。 他の値については、構成ファイルまたは環境変数を使用して設定できます。 この記事では、これらのユーザー構成設定と、Azure CLI の構成方法に関する追加情報を紹介します。

CLI で使用される構成値は、次の優先順位で上から順番に評価されます。

  1. コマンド ライン パラメーター
  2. 環境変数
  3. az config または az init を使用して設定された構成ファイルの値

az init を使用して設定を構成する

Azure CLI 構成を設定する最も簡単な方法は、対話型の az init コマンドを使用することです。 "相互作用" や "自動化" などの一般的な構成を選択するか、個々の構成の手順を選択します。 この方法が特に役立つのは、az init により、ある構成オプションを別の構成オプションの代わりに選択する理由が示されるためです。

az init

az config を使用して設定を構成する

az config set コマンドを使用して CLI の既定値を設定できます。 このコマンドは、引数としてスペースで区切られた key=value ペアのリストを取ります。 指定した値は、必須の引数の代わりに、Azure CLI によって使用されます。

次の表に、使用可能な構成キーの一覧を示します。

名前 説明
デフォルト設定グループ すべてのコマンドに使用する既定のリソース グループ。
デフォルトの場所 すべてのコマンドに使用する既定の場所。
defaults.web az webapp コマンドに使用する既定のアプリ名。
デフォルト.vm az vm コマンドに使用する既定の VM 名。
defaults.vmss az vmss コマンドに使用する既定の仮想マシン スケール セット (VMSS) 名。
defaults.acr az acr コマンドに使用する既定のコンテナー レジストリ名。

例として、すべてのコマンドの既定のリソース グループと場所を設定する方法を次に示します。

az config set defaults.location=westus2 defaults.group=MyResourceGroup

次のコマンドは、Azure CLI コマンドの実行中にアンケート リンクをオフにします。

az config set core.survey_message=no

CLI 構成ファイル

CLI 構成ファイルには、CLI の動作の管理に使用されるその他の設定が含まれています。 構成ファイル自体は $AZURE_CONFIG_DIR/config にあります。 AZURE_CONFIG_DIR の既定値は、Linux と macOS の場合は $HOME/.azure、Windows の場合は %USERPROFILE%\.azure です。

構成ファイルは、INI ファイル形式で記述されます。 セクション ヘッダーではファイル形式が定義され、その後にキーと値のエントリのリストが続きます。

  • セクション ヘッダーは、[section-name] のように記述されます。 セクション名は大文字と小文字を区別します。
  • エントリは、key=value のように記述されます。 キー名は大文字小文字が区別されません。
  • # または ; で始まる行はすべてコメントです。 インライン コメントは許可されていません。

ブール値は大文字と小文字が区別されません。 次の値はブール値を表します。

  • True: 1、 yes、 true、 on
  • False: 0、 no、 false、 off

次の例は、確認のプロンプトを無効にして、/var/log/azure ディレクトリへのログ記録を設定する CLI 構成ファイルです。

[core]
disable_confirm_prompt=Yes

[logging]
enable_log_file=yes
log_dir=/var/log/azure

使用できる構成値とその意味の詳細については、次のセクションを参照してください。 INI ファイル形式の詳細については、INI に関する Python のドキュメントを参照してください。

CLI 構成値と環境変数

次の表は、構成ファイルで指定できるすべてのセクションとオプションの名前を示しています。 対応する環境変数は、AZURE_{section}_{name} のようにすべて大文字で設定できます。 たとえば、output の core 既定値は AZURE_CORE_OUTPUT 変数に設定され、storage_account の batchai 既定値は AZURE_BATCHAI_STORAGE_ACCOUNT 変数に設定され、location の既定値は AZURE_DEFAULTS_LOCATION に設定されています。

既定値を指定すると、その引数は任意のコマンドで不要になります。 代わりに、その既定値が使用されます。

セクション 名前 タイプ 説明
コア アウトプット ひも 既定の出力形式。 使用できる値: json (既定値)、 jsonc、 yaml、 yamlc、 table、 tsv、 none。 詳細については、「Azure CLI コマンドの出力形式」をご覧ください。
確認プロンプトを無効にする ブーリアン 確認のプロンプトをオン/オフにします。
表示領域識別済み ブーリアン Azure のお客様は、多数の異なるリージョンにリソースをデプロイすることを選択できます。 場合によっては、同じサービスを提供する近くのリージョンを選択することで、コストを削減できる場合があります。 近くのリージョンが特定されると、今後のデプロイ用に選択するリージョンがメッセージに表示されます。 この設定は、メッセージを表示するかどうかを制御します。
テレメトリ収集 ブーリアン Microsoft による、CLI の使用に関する匿名データの収集を許可します。 プライバシー情報については、Azure CLI の MIT l ライセンスに関するページをご覧ください。
エラーのみ表示 ブーリアン コマンドの呼び出し中にエラーのみを表示します。 つまり、エラーのみが stderr に書き込まれます。 プレビュー、非推奨、および試験的なコマンドからの警告は抑制されます。 また、--only-show-errors パラメータを使用して個々のコマンドに対して使用することもできます。
ウィンドウズでブローカーを有効にする ブーリアン az login コマンドを使用して Azure に対して認証するには、Web アカウント マネージャー (WAM) を使用します。
ログイン体験_v2 ブーリアン az login サブスクリプション セレクターのオン/オフを切り替えます。
無色 ブーリアン 色を無効にします。 もともと色分けされたメッセージには、DEBUG、INFO、WARNING、および ERROR がプレフィックスとして付けられます。 このブール値により、ターミナルの色を stdout リダイレクト後に戻すことができないという、サードパーティ製ライブラリの問題が回避されます。
クライアント 秘密の警告を表示 ブーリアン 機密情報の出力に関する警告をオン/オフにします。
ログ ログファイルを有効化する ブーリアン ログ記録をオン/オフにします。
ログディレクトリ (log_dir) ひも ログを書き込むディレクトリ。 この値の既定値は ${AZURE_CONFIG_DIR}/logs* です。
デフォルト グループ ひも すべてのコマンドに使用する既定のリソース グループ。
ロケーション ひも すべてのコマンドに使用する既定の場所。
ウェブ ひも az webapp コマンドに使用する既定のアプリ名。
仮想マシン (VM) ひも az vm コマンドに使用する既定の VM 名。
vmss ひも az vmss コマンドに使用する既定の仮想マシン スケール セット (VMSS) 名。
ACR（エーシーアール） ひも az acr コマンドに使用する既定のコンテナー レジストリ名。
ストレージ アカウント ひも データプレーン コマンド (たとえば、https://mystorageaccount.blob.core.windows.net) に使用する既定のストレージ アカウント名 (たとえば、az storage の az storage container list)。
鍵 ひも az storage データプレーン コマンドに使用する既定のアクセス キー。
sas_token ひも az storage データプレーン コマンドに使用する既定の SAS トークン。
接続文字列 ひも az storage データプレーン コマンドに使用する既定の接続文字列。
batchai ストレージアカウント ひも az batchai コマンドに使用する既定のストレージ アカウント。
ストレージキー ひも az batchai コマンドに使用する既定のストレージ キー。
バッチ アカウント ひも az batch コマンドに使用する既定の Azure Batch アカウント名。
アクセスキー ひも az batch コマンドに使用する既定のアクセス キー。 aad 承認でのみ使用されます。
エンドポイント ひも az batch コマンドに対する既定の接続先エンドポイント。
認証モード ひも az batch コマンドに使用する承認モード。 使用できる値: shared_key、aad。
雲 名前 ひも すべての az コマンドの既定のクラウド。 使用できる値: AzureCloud (既定値)、 AzureChinaCloud、 AzureUSGovernment。 クラウドを変更するには、az cloud set -–name コマンドを使用します。 例については、Azure CLI を使用したクラウドの管理に関するページを参照してください。
拡張 動的インストールを使用する ひも コマンドを拡張機能から実行する場合に、その拡張機能がまだ追加されていない場合はインストールします。 使用できる値: no (既定値)、 yes_prompt、 yes_without_prompt。
動的インストール後に実行する ブーリアン 拡張機能が動的にインストールされると、コマンドの実行を続行します。 既定値は False です。
index_url ひも index.json の形式に従うプライベート拡張機能インデックス ファイルの URL。 指定すると、az extension add --name <extension-name> を実行したときそのファイルを使用して、追加する拡張機能が検索されます。

注

構成ファイルに他の値が表示される場合がありますが、これらは、 az configを含む CLI コマンドを使用して直接管理されます。 前述の表では、自身で変更する必要がある値のみを示しています。