az extension

  • リファレンス

CLI 拡張機能を管理および更新します。

コマンド

名前 説明 型 Status
az extension add

拡張機能を追加します。

 コア GA
az extension list

インストールされている拡張機能を一覧表示します。

 コア GA
az extension list-available

一般公開されている拡張機能を一覧表示します。

 コア GA
az extension list-versions

拡張機能で使用可能なバージョンを一覧表示します。

 コア GA
az extension remove

拡張機能を削除します。

 コア GA
az extension show

拡張機能を表示します。

 コア GA
az extension update

拡張機能を更新します。

 コア GA

az extension add

編集

拡張機能を追加します。

拡張機能を自動的にインストールする方法については、https://aka.ms/AzExtDynamicInstall

az extension add [--allow-preview {false, true}]
                 [--name]
                 [--pip-extra-index-urls]
                 [--pip-proxy]
                 [--source]
                 [--system]
                 [--upgrade]
                 [--version]
                 [--yes]

例

名前による拡張機能の追加

az extension add --name anextension

URL から拡張機能を追加する

az extension add --source https://contoso.com/anextension-0.0.1-py2.py3-none-any.whl

ローカル ディスクから拡張機能を追加する

az extension add --source ~/anextension-0.0.1-py2.py3-none-any.whl

ローカル ディスクから拡張機能を追加し、依存関係に pip プロキシを使用する

az extension add --source ~/anextension-0.0.1-py2.py3-none-any.whl --pip-proxy https://user:pass@proxy.server:8080

システム ディレクトリに拡張機能を追加する

az extension add --name anextension --system

特定のバージョンの拡張機能を追加する

az extension add --name anextension --version 1.0.0

既にインストールされている場合は拡張機能をアップグレードする

az extension add --upgrade --name anextension

省略可能のパラメーター

--allow-preview

拡張機能のインストール用のプレビュー パッケージ (存在する場合) を含めます。

承認された値: false, true
--name -n

拡張機能の名前。

--pip-extra-index-urls

使用するパッケージ インデックスの追加 URL のスペース区切りの一覧です。 これは、PEP 503 (simple repository API) に準拠しているリポジトリ、または同じ形式でレイアウトされたローカル ディレクトリを指している必要があります。

--pip-proxy

[user:passwd@]proxy.server:port の形式で拡張機能の依存関係に使用する pip のプロキシ。

--source -s

拡張子のファイルパスまたは URL。

--system

拡張機能にはシステム ディレクトリを使用します。

既定のパスは、python 環境 lib パスを実行している CLI の下にある azure-cli-extensions フォルダーであり、環境変数AZURE_EXTENSION_SYS_DIRで構成できます。 Windows では、適切なアクセス許可で実行するために、シェルを 管理istrator として開く必要がある場合があります。

--upgrade

既にインストールされている場合は拡張機能を更新します。それ以外の場合は、拡張機能をインストールします。

--version

拡張機能の特定のバージョン。

既定値: latest
--yes -y

確認のダイアログを表示しません。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az extension list

編集

インストールされている拡張機能を一覧表示します。

az extension list
グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az extension list-available

編集

一般公開されている拡張機能を一覧表示します。

az extension list-available [--show-details]

例

一般公開されているすべての拡張機能を一覧表示する

az extension list-available

特定の拡張機能の詳細を一覧表示する

az extension list-available --show-details --query anextension

省略可能のパラメーター

--show-details -d

拡張インデックスの生データを表示します。

既定値: False
グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az extension list-versions

編集

拡張機能で使用可能なバージョンを一覧表示します。

az extension list-versions --name

例

拡張機能で使用可能なバージョンを一覧表示する

az extension list-versions --name anextension

必須のパラメーター

--name -n

拡張機能の名前。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az extension remove

編集

拡張機能を削除します。

az extension remove --name

例

拡張機能を削除します。 (自動生成)

az extension remove --name MyExtension

必須のパラメーター

--name -n

拡張機能の名前。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az extension show

編集

拡張機能を表示します。

az extension show --name

例

拡張機能を表示します。 (自動生成)

az extension show --name MyExtension

必須のパラメーター

--name -n

拡張機能の名前。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az extension update

編集

拡張機能を更新します。

az extension update --name
                    [--allow-preview {false, true}]
                    [--pip-extra-index-urls]
                    [--pip-proxy]

例

名前で拡張機能を更新する

az extension update --name anextension

名前で拡張機能を更新し、依存関係に pip プロキシを使用する

az extension update --name anextension --pip-proxy https://user:pass@proxy.server:8080

必須のパラメーター

--name -n

拡張機能の名前。

省略可能のパラメーター

--allow-preview

拡張機能のインストール用のプレビュー パッケージ (存在する場合) を含めます。

承認された値: false, true
--pip-extra-index-urls

使用するパッケージ インデックスの追加 URL のスペース区切りの一覧です。 これは、PEP 503 (simple repository API) に準拠しているリポジトリ、または同じ形式でレイアウトされたローカル ディレクトリを指している必要があります。

--pip-proxy

[user:passwd@]proxy.server:port の形式で拡張機能の依存関係に使用する pip のプロキシ。

グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。