次の方法で共有


az vm extension

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

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

コマンド

名前 説明 状態
az vm extension delete

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

Core GA
az vm extension image

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

Core GA
az vm extension image list

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

Core GA
az vm extension image list-names

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

Core GA
az vm extension image list-versions

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

Core GA
az vm extension image show

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

Core GA
az vm extension list

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

Core GA
az vm extension set

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

Core GA
az vm extension show

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

Core GA
az vm extension wait

条件が満たされるまで CLI を待機状態にします。

Core GA

az vm extension delete

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

az vm extension delete [--ids]
                       [--name --vm-extension-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)

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

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

プロパティ
Parameter group: Resource Id Arguments
--name --vm-extension-name -n

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

プロパティ
Parameter group: Resource Id Arguments
--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

プロパティ
Parameter group: Resource Id Arguments
--subscription

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

プロパティ
Parameter group: Resource Id Arguments
--vm-name

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

プロパティ
Parameter group: Resource Id Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

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

--only-show-errors

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

プロパティ
規定値: False
--output -o

出力フォーマット。

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

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

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

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

プロパティ
Parameter group: Resource Id Arguments
--resource-group -g

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

プロパティ
Parameter group: Resource Id Arguments
--subscription

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

プロパティ
Parameter group: Resource Id Arguments
--vm-name

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

プロパティ
Parameter group: Resource Id Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

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

--only-show-errors

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

プロパティ
規定値: False
--output -o

出力フォーマット。

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

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

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

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--enable-auto-upgrade

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

プロパティ
指定可能な値: false, true
--extension-instance-name

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

--force-update

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

プロパティ
規定値: False
--ids

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

プロパティ
Parameter group: Resource Id Arguments
--no-auto-upgrade
非推奨

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

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

プロパティ
規定値: False
指定可能な値: false, true
--no-auto-upgrade-minor-version

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

プロパティ
規定値: False
指定可能な値: false, true
--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ
規定値: False
--protected-settings

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

--resource-group -g

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

プロパティ
Parameter group: Resource Id Arguments
--settings

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

--subscription

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

プロパティ
Parameter group: Resource Id Arguments
--version

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

--vm-name

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

プロパティ
Parameter group: Resource Id Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

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

--only-show-errors

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

プロパティ
規定値: False
--output -o

出力フォーマット。

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

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

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

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

プロパティ
Parameter group: Resource Id Arguments
--instance-view

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

プロパティ
規定値: False
--name -n

拡張機能の名前。

プロパティ
Parameter group: Resource Id Arguments
--resource-group -g

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

プロパティ
Parameter group: Resource Id Arguments
--subscription

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

プロパティ
Parameter group: Resource Id Arguments
--vm-name

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

プロパティ
Parameter group: Resource Id Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

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

--only-show-errors

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

プロパティ
規定値: False
--output -o

出力フォーマット。

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False

az vm extension wait

条件が満たされるまで CLI を待機状態にします。

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

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

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

プロパティ
Parameter group: Wait Condition Arguments
規定値: False
--custom

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

プロパティ
Parameter group: Wait Condition Arguments
--deleted

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

プロパティ
Parameter group: Wait Condition Arguments
規定値: False
--exists

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

プロパティ
Parameter group: Wait Condition Arguments
規定値: False
--expand

操作に適用する展開式。

--ids

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

プロパティ
Parameter group: Resource Id Arguments
--interval

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

プロパティ
Parameter group: Wait Condition Arguments
規定値: 30
--name --vm-extension-name -n

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

プロパティ
Parameter group: Resource Id Arguments
--resource-group -g

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

プロパティ
Parameter group: Resource Id Arguments
--subscription

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

プロパティ
Parameter group: Resource Id Arguments
--timeout

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

プロパティ
Parameter group: Wait Condition Arguments
規定値: 3600
--updated

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

プロパティ
Parameter group: Wait Condition Arguments
規定値: False
--vm-name

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

プロパティ
Parameter group: Resource Id Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ
規定値: False
--help -h

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

--only-show-errors

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

プロパティ
規定値: False
--output -o

出力フォーマット。

プロパティ
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ
規定値: False