Share via


az vm extension

VM 上の拡張機能を管理します。

拡張機能は、デプロイ後の構成と Azure 仮想マシン上の自動化タスクを提供する小規模なアプリケーションです。 たとえば、仮想マシンでソフトウェアのインストール、ウイルス対策保護、または Docker 構成が必要な場合、VM 拡張機能を使用して、これらのタスクを実行できます。 拡張機能は、新しい仮想マシンの展開にバンドルすることも、既存の任意のシステムに対して実行することもできます。

コマンド

名前 説明 Status
az vm extension delete

拡張機能を削除する削除操作。

コア GA
az vm extension image

サブスクリプションとリージョンで使用可能な VM 拡張機能を見つけます。

コア GA
az vm extension image list

使用可能な拡張機能に関する情報を一覧表示します。

コア GA
az vm extension image list-names

使用可能な拡張機能の名前を一覧表示します。

コア GA
az vm extension image list-versions

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

コア GA
az vm extension image show

拡張機能の情報を表示します。

コア GA
az vm extension list

VM に接続されている拡張機能を一覧表示します。

コア GA
az vm extension set

VM の拡張機能を設定します。

コア GA
az vm extension show

VM にアタッチされている拡張機能に関する情報を表示します。

コア GA
az vm extension wait

仮想マシン拡張機能の条件が満たされるまで、CLI を待機状態にします。

コア GA

az vm extension delete

拡張機能を削除する削除操作。

az vm extension delete [--ids]
                       [--name]
                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                       [--resource-group]
                       [--subscription]
                       [--vm-name]

VM 名と拡張機能を使用して、VM から拡張機能を削除します。

az vm extension delete -g MyResourceGroup --vm-name MyVm -n MyExtensionName

"MyExtension" という文字列を含む ID を持つ拡張機能を VM から削除します。

az vm extension delete --ids $(az resource list --query "[?contains(name, 'MyExtension')].id" -o tsv)

省略可能のパラメーター

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name --vm-extension-name -n

仮想マシン拡張機能の名前。

--no-wait

実行時間の長い操作の終了を待機しません。

承認された値: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

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

--vm-name

仮想マシンの名前。 を使用して az configure --defaults vm=<name>既定値を構成できます。

グローバル パラメーター
--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 vm extension list

VM に接続されている拡張機能を一覧表示します。

az vm extension list [--ids]
                     [--resource-group]
                     [--subscription]
                     [--vm-name]

名前付き VM にアタッチされている拡張機能を一覧表示します。

az vm extension list -g MyResourceGroup --vm-name MyVm

省略可能のパラメーター

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

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

--vm-name

仮想マシンの名前。 を使用して az configure --defaults vm=<name>既定値を構成できます。

グローバル パラメーター
--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 vm extension set

VM の拡張機能を設定します。

から拡張機能の詳細を az vm extension image list取得します。

az vm extension set --name
                    --publisher
                    [--enable-auto-upgrade {false, true}]
                    [--extension-instance-name]
                    [--force-update]
                    [--ids]
                    [--no-auto-upgrade {false, true}]
                    [--no-auto-upgrade-minor-version {false, true}]
                    [--no-wait]
                    [--protected-settings]
                    [--resource-group]
                    [--settings]
                    [--subscription]
                    [--version]
                    [--vm-name]

Linux VM にユーザー アカウントを追加します。

az vm extension set -n VMAccessForLinux --publisher Microsoft.OSTCExtensions --version 1.4 \
    --vm-name MyVm --resource-group MyResourceGroup \
    --protected-settings '{"username":"user1", "ssh_key":"ssh_rsa ..."}'

--ids で指定された VM に customScript 拡張機能を追加します。

az vm extension set -n customScript --publisher Microsoft.Azure.Extensions --ids {vm_id}

新しいバージョンの拡張機能が使用可能な場合は、拡張機能を追加し、プラットフォームによる自動アップグレードを有効にします。

az vm extension set -n extName --publisher publisher --vm-name MyVM -g MyResourceGroup \
--enable-auto-upgrade true

必須のパラメーター

--name -n

拡張機能の名前。

開始値: az vm extension image list
--publisher

拡張機能の発行元の名前。

省略可能のパラメーター

--enable-auto-upgrade

使用可能な拡張機能の新しいバージョンがある場合は、プラットフォームによって拡張機能を自動的にアップグレードする必要があることを示します。

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

カスタマイズ可能な拡張インスタンスの名前。 既定値: 拡張機能の名前。

--force-update

拡張機能の構成が変更されていない場合でも、強制的に更新します。

既定値: False
--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--no-auto-upgrade
非推奨

オプション '--no-auto-upgrade' は非推奨となり、今後のリリースで削除される予定です。 代わりに '--no-auto-upgrade-minor-version' を使用してください。

設定した場合、拡張機能が再デプロイされた場合でも、拡張機能サービスは自動的に最新のマイナー バージョンを選択またはアップグレードしません。

承認された値: false, true
既定値: False
--no-auto-upgrade-minor-version

設定した場合、拡張機能が再デプロイされた場合でも、拡張機能サービスは自動的に最新のマイナー バージョンを選択またはアップグレードしません。

承認された値: false, true
既定値: False
--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False
--protected-settings

資格情報などの機密情報の保護された設定 (JSON 形式)。 JSON ファイル パスも受け入れられます。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--settings

JSON 形式の拡張機能の設定。 JSON ファイル パスも受け入れられます。

--subscription

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

--version

拡張機能のバージョン。 拡張機能のバージョンをこの値にピン留めするには、--no-auto-upgrade-minor-version を指定してください。

--vm-name

仮想マシンの名前。 を使用して az configure --defaults vm=<name>既定値を構成できます。

グローバル パラメーター
--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 vm extension show

VM にアタッチされている拡張機能に関する情報を表示します。

az vm extension show [--ids]
                     [--instance-view]
                     [--name]
                     [--resource-group]
                     [--subscription]
                     [--vm-name]

VM 名と拡張機能名を使用して、VM に接続されている拡張機能を表示します。

az vm extension show -g MyResourceGroup --vm-name MyVm -n extension_name

省略可能のパラメーター

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--instance-view

仮想マシン拡張機能のインスタンス ビュー。

既定値: False
--name -n

拡張機能の名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

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

--vm-name

仮想マシンの名前。 を使用して az configure --defaults vm=<name>既定値を構成できます。

グローバル パラメーター
--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 vm extension wait

仮想マシン拡張機能の条件が満たされるまで、CLI を待機状態にします。

az vm extension wait [--created]
                     [--custom]
                     [--deleted]
                     [--exists]
                     [--ids]
                     [--interval]
                     [--name]
                     [--resource-group]
                     [--subscription]
                     [--timeout]
                     [--updated]
                     [--vm-name]

仮想マシン拡張機能の条件が満たされるまで、CLI を待機状態にします。 (自動生成)

az vm extension wait --created --name MyExtension --resource-group MyResourceGroup --vm-name MyVm

仮想マシン拡張機能の条件が満たされるまで、CLI を待機状態にします。 (自動生成)

az vm extension wait --exists --name MyExtension --resource-group MyResourceGroup --vm-name MyVm

仮想マシン拡張機能の条件が満たされるまで、CLI を待機状態にします。 (自動生成)

az vm extension wait --ids @- --name MyExtension --subscription MySubscription --updated --vm-name MyVm

省略可能のパラメーター

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

既定値: False
--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

--deleted

削除されるまで待ちます。

既定値: False
--exists

リソースが存在するまで待ちます。

既定値: False
--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--interval

ポーリング間隔 (秒単位)。

既定値: 30
--name -n

拡張機能の名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--subscription

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

--timeout

最大待機時間 (秒単位)。

既定値: 3600
--updated

provisioningState が 'Succeeded' で更新されるまで待ちます。

既定値: False
--vm-name

仮想マシンの名前。 を使用して az configure --defaults vm=<name>既定値を構成できます。

グローバル パラメーター
--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 を使います。