az azurestackhci virtualmachine extension

  • 実験用
  • リファレンス

Note

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

コマンド グループ 'azurestackhci' は試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

azurestackhci を使用して virtualmachine 拡張機能を管理します。

コマンド

名前 説明 型 Status
az azurestackhci virtualmachine extension create

virtualmachine 拡張機能を作成します。

 拡張 Experimental
az azurestackhci virtualmachine extension delete

virtualmachine 拡張機能を削除します。

 拡張 Experimental
az azurestackhci virtualmachine extension list

virtualmachine のすべての拡張機能を一覧表示します。

 拡張 Experimental
az azurestackhci virtualmachine extension show

virtualmachine 拡張機能の詳細を取得します。

 拡張 Experimental
az azurestackhci virtualmachine extension update

virtualmachine 拡張機能を更新します。

 拡張 Experimental
az azurestackhci virtualmachine extension wait

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

 拡張 Experimental

az azurestackhci virtualmachine extension create

実験用

コマンド グループ 'azurestackhci' は試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

virtualmachine 拡張機能を作成します。

az azurestackhci virtualmachine extension create --name
                                                 --resource-group
                                                 --virtualmachine-name
                                                 [--auto-upgrade-minor {false, true}]
                                                 [--enable-auto-upgrade {false, true}]
                                                 [--extension-type]
                                                 [--force-update-tag]
                                                 [--inst-handler-version]
                                                 [--instance-view-type]
                                                 [--location]
                                                 [--protected-settings]
                                                 [--publisher]
                                                 [--settings]
                                                 [--status]
                                                 [--tags]
                                                 [--type-handler-version]

例

PutExtension

az azurestackhci virtualmachine extension create --resource-group "test-rg" --location "West US2" --name "test-extension" --extension-type "CustomScriptExtension" --publisher "Microsoft.Compute" --settings '{"commandToExecute":"hostname"}' --type-handler-version "1.10" --virtualmachine-name "test-virtualmachine"

必須のパラメーター

--name

拡張機能の名前です。

--resource-group -g

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

--virtualmachine-name

拡張機能を作成または更新する仮想マシンの名前。

省略可能のパラメーター

--auto-upgrade-minor

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

承認された値: false, true
--enable-auto-upgrade

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

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

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

--force-update-tag

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

--inst-handler-version

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

--instance-view-type

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

--location -l

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

--protected-settings

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

--publisher

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

--settings

仮想マシン拡張機能の Json 形式のパブリック設定。

--status

インスタンス ビューの状態。

--tags

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

--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 azurestackhci virtualmachine extension delete

実験用

コマンド グループ 'azurestackhci' は試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

virtualmachine 拡張機能を削除します。

az azurestackhci virtualmachine extension delete [--ids]
                                                 [--name]
                                                 [--resource-group]
                                                 [--subscription]
                                                 [--virtualmachine-name]
                                                 [--yes]

例

DeleteExtension

az azurestackhci virtualmachine extension delete --name "test-extension" --virtualmachine-name "test-virtualmachine" --resource-group "test-rg"

省略可能のパラメーター

--ids

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

--name

マシン拡張機能の名前。

--resource-group -g

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

--subscription

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

--virtualmachine-name

拡張機能の削除元となる仮想マシンの名前。

--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 azurestackhci virtualmachine extension list

実験用

コマンド グループ 'azurestackhci' は試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

virtualmachine のすべての拡張機能を一覧表示します。

az azurestackhci virtualmachine extension list --resource-group
                                               --virtualmachine-name

例

ListExtensions

az azurestackhci virtualmachine extension list --virtualmachine-name "test-virtualmachine" --resource-group "test-rg"

必須のパラメーター

--resource-group -g

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

--virtualmachine-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 azurestackhci virtualmachine extension show

実験用

コマンド グループ 'azurestackhci' は試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

virtualmachine 拡張機能の詳細を取得します。

az azurestackhci virtualmachine extension show [--ids]
                                               [--name]
                                               [--resource-group]
                                               [--subscription]
                                               [--virtualmachine-name]

例

GetExtension

az azurestackhci virtualmachine extension show --name "test-extension" --virtualmachine-name "test-virtualmachine" --resource-group "test-rg"

省略可能のパラメーター

--ids

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

--name

マシン拡張機能の名前。

--resource-group -g

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

--subscription

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

--virtualmachine-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 azurestackhci virtualmachine extension update

実験用

コマンド グループ 'azurestackhci' は試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

virtualmachine 拡張機能を更新します。

az azurestackhci virtualmachine extension update --name
                                                 [--auto-upgrade-minor {false, true}]
                                                 [--enable-auto-upgrade {false, true}]
                                                 [--extension-type]
                                                 [--force-update-tag]
                                                 [--ids]
                                                 [--protected-settings]
                                                 [--publisher]
                                                 [--resource-group]
                                                 [--settings]
                                                 [--subscription]
                                                 [--tags]
                                                 [--type-handler-version]
                                                 [--virtualmachine-name]

例

UpdateExtension

az azurestackhci virtualmachine extension update --resource-group "test-rg" --name "test-extension" --extension-type "CustomScriptExtension" --virtualmachine-name "test-virtualmachine" --publisher "Microsoft.Compute" --settings '{"commandToExecute":"hostname"}' --type-handler-version "1.10"

必須のパラメーター

--name

拡張機能の名前です。

省略可能のパラメーター

--auto-upgrade-minor

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

承認された値: false, true
--enable-auto-upgrade

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

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

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

--force-update-tag

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

--ids

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

--protected-settings

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

--publisher

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

--resource-group -g

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

--settings

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

--subscription

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

--tags

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

--type-handler-version

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

--virtualmachine-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 azurestackhci virtualmachine extension wait

実験用

コマンド グループ 'azurestackhci' は試験段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

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

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

例

virtualmachine 拡張機能が正常に作成されるまで、CLI スクリプトの次の行の実行を一時停止します。

az azurestackhci virtualmachine extension wait --name "test-extension" --virtualmachine-name "test-virtualmachine" --resource-group "test-rg" --created

virtualmachine 拡張機能が正常に更新されるまで、CLI スクリプトの次の行の実行を一時停止します。

az azurestackhci virtualmachine extension wait --name "test-extension" --virtualmachine-name "test-virtualmachine" --resource-group "test-rg" --updated

virtualmachine 拡張機能が正常に削除されるまで、CLI スクリプトの次の行の実行を一時停止します。

az azurestackhci virtualmachine extension wait --name "test-extension" --virtualmachine-name "test-virtualmachine" --resource-group "test-rg" --deleted

省略可能のパラメーター

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

マシン拡張機能の名前。

--resource-group -g

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

--subscription

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

--timeout

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

既定値: 3600
--updated

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

既定値: False
--virtualmachine-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 を使います。