az connectedvmware vm extension

注

このリファレンスは、Azure CLI (バージョン 2.0.67 以降) の connectedvmware 拡張機能の一部です。 拡張機能は、az connectedvmware vm extension コマンドを初めて実行すると自動的にインストールされます。 拡張機能の詳細については、 を参照してください。

connectedvmware を使用して VM 拡張機能を管理します。

コマンド

名前	説明	型	状態
az connectedvmware vm extension create	拡張機能を作成する操作。	拡張	GA
az connectedvmware vm extension delete	拡張機能を削除する操作。	拡張	GA
az connectedvmware vm extension list	Azure 以外の VM のすべての拡張機能を取得する操作。	拡張	GA
az connectedvmware vm extension show	拡張機能を取得する操作。	拡張	GA
az connectedvmware vm extension update	拡張機能を更新する操作。	拡張	GA

az connectedvmware vm extension create

拡張機能を作成する操作。

az connectedvmware vm extension create --location
                                       --name
                                       --resource-group
                                       --vm-name
                                       [--auto-upgrade-minor {false, true}]
                                       [--enable-auto-upgrade {false, true}]
                                       [--force-update-tag]
                                       [--no-wait]
                                       [--protected-settings]
                                       [--publisher]
                                       [--settings]
                                       [--tags]
                                       [--type]
                                       [--type-handler-version]

例

VM 拡張機能を作成する

az connectedvmware vm extension create --name "CustomScriptExtension" --location "eastus2euap" --type "CustomScriptExtension" --publisher "Microsoft.Compute" --settings "{\"commandToExecute\":\"powershell.exe -c \\\"Get-Process | Where-Object { $_.CPU -gt 10000 }\\\"\"}" --type-handler-version "1.10" --vm-name "vm name" --resource-group "myResourceGroup"

必須のパラメーター

--location -l

場所。 値のソース: az account list-locations az configure --defaults location=<location>を使用して、既定の場所を構成できます。

--name

VM 拡張機能の名前。

--resource-group -g

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

--vm-name

拡張機能を作成または更新する必要がある VM の名前。

省略可能のパラメーター

--auto-upgrade-minor

展開時に使用可能な場合に、拡張機能で新しいマイナー バージョンを使用する必要があるかどうかを示します。 ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能はマイナー バージョンをアップグレードしません。

指定可能な値: false, true

--enable-auto-upgrade

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

指定可能な値: false, true

--force-update-tag

拡張機能の構成が変更されていない場合でも、拡張機能ハンドラーを強制的に更新する方法。

--no-wait

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

規定値: False

--protected-settings

拡張機能には、protectedSettings または protectedSettingsFromKeyVault、または保護された設定をまったく含めなくなります。 予期される値: json-string/json-file/@json-file。

--publisher

拡張ハンドラーの発行元の名前。

--settings

拡張機能の Json 形式のパブリック設定。 予期される値: json-string/json-file/@json-file。

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--type

拡張機能の種類を指定します。たとえば、"CustomScriptExtension" です。

--type-handler-version

スクリプト ハンドラーのバージョンを指定します。

グローバル パラメーター

--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 connectedvmware vm extension delete

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

az connectedvmware vm extension delete [--ids]
                                       [--name]
                                       [--no-wait]
                                       [--resource-group]
                                       [--subscription]
                                       [--vm-name]
                                       [--yes]

例

VM 拡張機能を削除する

az connectedvmware vm extension delete --name "vm extension name" --vm-name "vm name" --resource-group "myResourceGroup"

省略可能のパラメーター

--ids

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

--name

VM 拡張機能の名前。

--no-wait

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

規定値: False

--resource-group -g

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

--subscription

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

--vm-name

拡張機能を削除する必要がある VM の名前。

--yes -y

確認を求めないでください。

規定値: 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 connectedvmware vm extension list

Azure 以外の VM のすべての拡張機能を取得する操作。

az connectedvmware vm extension list --resource-group
                                     --vm-name
                                     [--expand]

例

すべての VM 拡張機能を取得する

az connectedvmware vm extension list --vm-name "vm name" --resource-group "myResourceGroup"

必須のパラメーター

--resource-group -g

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

--vm-name

拡張機能を含む VM の名前。

省略可能のパラメーター

--expand

操作に適用する展開式。

グローバル パラメーター

--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 connectedvmware vm extension show

拡張機能を取得する操作。

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

例

VM 拡張機能を取得する

az connectedvmware vm extension show --name "CustomScriptExtension" --vm-name "vm name" --resource-group "myResourceGroup"

省略可能のパラメーター

--ids

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

--name

VM 拡張機能の名前。

--resource-group -g

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

--subscription

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

--vm-name

拡張機能を含む VM の名前。

グローバル パラメーター

--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 connectedvmware vm extension update

拡張機能を更新する操作。

az connectedvmware vm extension update --name
                                       --resource-group
                                       --vm-name
                                       [--auto-upgrade-minor {false, true}]
                                       [--enable-auto-upgrade {false, true}]
                                       [--force-update-tag]
                                       [--no-wait]
                                       [--protected-settings]
                                       [--publisher]
                                       [--settings]
                                       [--tags]
                                       [--type]
                                       [--type-handler-version]

例

VM 拡張機能を更新する

az connectedvmware vm extension update --name "CustomScriptExtension" --type "CustomScriptExtension" --publisher "Microsoft.Compute" --settings "{\"commandToExecute\":\"powershell.exe -c \\\"Get-Process | Where-Object { $_.CPU -lt 100 }\\\"\"}" --type-handler-version "1.10" --vm-name "vm name" --resource-group "myResourceGroup"

必須のパラメーター

--name

VM 拡張機能の名前。

--resource-group -g

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

--vm-name

拡張機能を作成または更新する必要がある VM の名前。

省略可能のパラメーター

--auto-upgrade-minor

展開時に使用可能な場合に、拡張機能で新しいマイナー バージョンを使用する必要があるかどうかを示します。 ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能はマイナー バージョンをアップグレードしません。

指定可能な値: false, true

--enable-auto-upgrade

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

指定可能な値: false, true

--force-update-tag

拡張機能の構成が変更されていない場合でも、拡張機能ハンドラーを強制的に更新する方法。

--no-wait

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

規定値: False

--protected-settings

拡張機能には、protectedSettings または protectedSettingsFromKeyVault、または保護された設定をまったく含めなくなります。 予期される値: json-string/json-file/@json-file。

--publisher

拡張ハンドラーの発行元の名前。

--settings

拡張機能の Json 形式のパブリック設定。 予期される値: json-string/json-file/@json-file。

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--type

拡張機能の種類を指定します。たとえば、"CustomScriptExtension" です。

--type-handler-version

スクリプト ハンドラーのバージョンを指定します。

グローバル パラメーター

--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 を使用します。