Azure CLI の構成Azure CLI configuration

Azure CLI を使用すると、ログ記録、データ収集、既定の引数値などの設定をユーザーが構成できます。The Azure CLI allows for user configuration for settings such as logging, data collection, and default argument values. CLI には、いくつかの既定値を管理するための便利なコマンドとして、az configure が用意されています。The CLI offers a convenience command for managing some defaults, az configure. 他の値については、構成ファイルまたは環境変数を使用して設定できます。Other values can be set in a configuration file or with environment variables.

CLI で使用される構成値は、次の優先順位で上から順番に評価されます。Configuration values used by the CLI are evaluated in the following precedence, with items higher on the list taking priority.

  1. コマンドライン パラメーターCommand-line parameters
  2. 環境変数Environment variables
  3. 構成ファイルの値または az configure で設定された値Values in the configuration file or set with az configure

az configure での CLI 構成CLI configuration with az configure

CLI の既定値を az configure コマンドで設定します。You set defaults for the CLI with the az configure command. このコマンドは 1 つの引数 --defaults を取ります。この引数は、スペースで区切られた key=value ペアのリストです。This command takes one argument, --defaults, which is a space-separated list of key=value pairs. 指定した値は、必須の引数の代わりに、CLI によって使用されます。The provided values are used by the CLI in place of required arguments.

次の表に、使用可能な構成キーの一覧を示します。The following table contains a list of available configuration keys.

NameName 説明Description
groupgroup すべてのコマンドに使用する既定のリソース グループ。The default resource group to use for all commands.
locationlocation すべてのコマンドに使用する既定の場所。The default location to use for all commands.
webweb az webapp コマンドに使用する既定のアプリ名。The default app name to use for az webapp commands.
vmvm az vm コマンドに使用する既定の VM 名。The default VM name to use for az vm commands.
vmssvmss az vmss コマンドに使用する既定の仮想マシン スケール セット (VMSS) 名。The default virtual machine scale set (VMSS) name to use for az vmss commands.
acracr az acr コマンドに使用する既定のコンテナー レジストリ名。The default container registry name to use for az acr commands.

例として、すべてのコマンドの既定のリソース グループと場所を設定する方法を次に示します。As an example, here's how you would set the default resource group and location for all commands.

az configure --defaults location=westus2 group=MyResourceGroup

CLI 構成ファイルCLI configuration file

CLI 構成ファイルには、CLI の動作の管理に使用されるその他の設定が含まれています。The CLI configuration file contains other settings that are used for managing CLI behavior. 構成ファイル自体は $AZURE_CONFIG_DIR/config にあります。The configuration file itself is located at $AZURE_CONFIG_DIR/config. AZURE_CONFIG_DIR の既定値は、Linux と macOS の場合は $HOME/.azure、Windows の場合は %USERPROFILE%\.azure です。The default value of AZURE_CONFIG_DIR is $HOME/.azure on Linux and macOS, and %USERPROFILE%\.azure on Windows.

構成ファイルは、INI ファイル形式で記述されます。Configuration files are written in the INI file format. このファイルの形式は、セクション ヘッダーと、これに続くキーと値のエントリの一覧となります。This file format is defined by section headers, followed by a list of key-value entries.

  • セクション ヘッダーは、[section-name] のように記述されます。Section headers are written as [section-name]. セクション名は、大文字と小文字が区別されます。Section names are case-sensitive.
  • エントリは、key=value のように記述されます。Entries are written as key=value. キー名の大文字と小文字は、区別されません。Key names are not case-sensitive.
  • # または ; で始まる行はすべてコメントです。Comments are any line that begins with a # or ;. インライン コメントは許可されていません。Inline comments are not allowed.

ブール値は、大文字と小文字が区別されず、次の値によって表されます。Booleans are case-insensitive, and are represented by the following values.

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

次の例は、確認のプロンプトを無効にして、/var/log/azure ディレクトリへのログ記録を設定する CLI 構成ファイルです。Here's an example of a CLI configuration file that disables any confirmation prompts and sets up logging to the /var/log/azure directory.

[core]
disable_confirm_prompt=Yes

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

使用できる構成値とその意味の詳細については、次のセクションを参照してください。See the next section for details on all of the available configuration values and what they mean. INI ファイル形式の詳細については、INI に関する Python のドキュメントを参照してください。For the full details on the INI file format, see the Python documentation on INI.

CLI 構成値と環境変数CLI configuration values and environment variables

次の表は、構成ファイルで指定できるすべてのセクションとオプションの名前を示しています。The following table contains all of the sections and option names that can be placed in a configuration file. 対応する環境変数は、AZURE_{section}_{name} のようにすべて大文字で設定できます。Their corresponding environment variables are set as AZURE_{section}_{name}, in all caps. たとえば、batchai の既定値 storage_account は、AZURE_BATCHAI_STORAGE_ACCOUNT 変数で設定されます。For example, the storage_account default for batchai is set in the AZURE_BATCHAI_STORAGE_ACCOUNT variable.

既定値を指定すると、その引数は任意のコマンドで不要になります。When you provide a default value, that argument is no longer required by any command. 代わりに、その既定値が使用されます。Instead, the default value is used.

セクションSection NameName typeType 説明Description
corecore outputoutput stringstring 既定の出力形式。The default output format. jsonjsonctsvtable のいずれかを指定できます。Can be one of json, jsonc, tsv, or table.
disable_confirm_promptdisable_confirm_prompt ブール値boolean 確認のプロンプトをオン/オフにします。Turn confirmation prompts on/off.
collect_telemetrycollect_telemetry ブール値boolean Microsoft による、CLI の使用に関する匿名データの収集を許可します。Allow Microsoft to collect anonymous data on the usage of the CLI. プライバシー情報については、Azure CLI の使用条件に関するページをご覧ください。For privacy information, see the Azure CLI Terms of Use.
logginglogging enable_log_fileenable_log_file ブール値boolean ログ記録をオン/オフにします。Turn logging on/off.
log_dirlog_dir stringstring ログを書き込むディレクトリ。The directory to write logs to. この値の既定値は ${AZURE_CONFIG_DIR}/logs です。By default this value is ${AZURE_CONFIG_DIR}/logs.
storagestorage connection_stringconnection_string stringstring az storage コマンドに使用する既定の接続文字列。The default connection string to use for az storage commands.
アカウントaccount stringstring az storage コマンドに使用する既定のアカウント名。The default account name to use for az storage commands.
keykey stringstring az storage コマンドに使用する既定のアカウント キー。The default account key to use for az storage commands.
sas_tokensas_token stringstring az storage コマンドに使用する既定の SAS トークン。The default SAS token to use for az storage commands.
batchaibatchai storage_accountstorage_account stringstring az batchai コマンドに使用する既定のストレージ アカウント。The default storage account to use for az batchai commands.
storage_keystorage_key stringstring az batchai コマンドに使用する既定のストレージ キー。The default storage key to use for az batchai commands.
batchbatch アカウントaccount stringstring az batch コマンドに使用する既定の Azure Batch アカウント名。The default Azure Batch account name to use for az batch commands.
access_keyaccess_key stringstring az batch コマンドに使用する既定のアクセス キー。The default access key to use for az batch commands. aad 承認でのみ使用されます。Only used with aad authorization.
endpointendpoint stringstring az batch コマンドに対する既定の接続先エンドポイント。The default endpoint to connect to for az batch commands.
auth_modeauth_mode stringstring az batch コマンドに使用する承認モード。The authorization mode to use for az batch commands. shared_key または aad を指定できます。Can be shared_key or aad.

注意

構成ファイルに他の値が含まれる場合もありますが、その値は、az configure などの CLI コマンドで直接管理されます。You may see other values in your configuration file, but these are managed directly through CLI commands, including az configure. 上記の表は、自身で変更する必要がある値のみを示しています。The ones listed in the table above are the only values you should change yourself.