az scvmm vm extension

Note

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

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

コマンド

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

az scvmm vm extension create

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

az scvmm 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 scvmm vm extension create --name contoso-extension --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 contoso-vm --resource-group contoso-rg

必須のパラメーター

--location -l

Location。 値のソース: 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

拡張機能には、protected設定 または protected設定FromKeyVault、または保護された設定をまったく含めなくなります。 予期される値: 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 scvmm vm extension delete

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

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

例

VM 拡張機能を削除する

az scvmm vm extension delete --name contoso-extension --vm-name contoso-vm --resource-group contoso-rg

省略可能のパラメーター

--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 scvmm vm extension list

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

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

例

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

az scvmm vm extension list --vm-name contoso-vm --resource-group contoso-rg

必須のパラメーター

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

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

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

例

VM 拡張機能を取得する

az scvmm vm extension show --name contoso-extension --vm-name contoso-vm --resource-group contoso-rg

省略可能のパラメーター

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

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

az scvmm 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 scvmm vm extension update --name contoso-extension --type CustomScriptExtension --publisher Microsoft.Compute --settings "{\"commandToExecute\":\"powershell.exe -c \\\"Get-Process | Where-Object { $_.CPU -lt 100 }\\\"\"}" --type-handler-version 1.10 --vm-name contoso-vm --resource-group contoso-rg

必須のパラメーター

--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

拡張機能には、protected設定 または protected設定FromKeyVault、または保護された設定をまったく含めなくなります。 予期される値: 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 を使います。