az connectedmachine extension
Note
このリファレンスは、Azure CLI (バージョン 2.57.0 以降) の connectedmachine 拡張機能の一部です。 拡張機能は、az connectedmachine extension コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細については、 を参照してください。
Azure Arc-Enabled Server で VM 拡張機能を管理します。
コマンド
名前 | 説明 | 型 | 状態 |
---|---|---|---|
az connectedmachine extension create |
拡張機能を作成または更新する操作を作成します。 |
Extension | GA |
az connectedmachine extension delete |
拡張機能を削除する削除操作。 |
Extension | GA |
az connectedmachine extension image |
Azure Arc-Enabled Servers で使用できる VM 拡張機能メタデータを管理します。 |
Extension | GA |
az connectedmachine extension image list |
場所、発行元、extensionType に基づいて、すべての拡張機能のバージョンを一覧表示します。 |
Extension | GA |
az connectedmachine extension image show |
場所、発行元、extensionType、バージョンに基づいて拡張メタデータを取得します。 |
Extension | GA |
az connectedmachine extension list |
Azure 以外のマシンのすべての拡張機能を取得します。 |
Extension | GA |
az connectedmachine extension show |
拡張機能を取得する操作を取得します。 |
Extension | GA |
az connectedmachine extension update |
拡張機能を作成または更新するための更新操作。 |
Extension | GA |
az connectedmachine extension wait |
条件が満たされるまで CLI を待機状態にします。 |
Extension | GA |
az connectedmachine extension create
拡張機能を作成または更新する操作を作成します。
az connectedmachine extension create --extension-name --name
--machine-name
--resource-group
[--auto-upgrade-min --auto-upgrade-minor-version {0, 1, f, false, n, no, t, true, y, yes}]
[--enable-auto-upgrade --enable-automatic-upgrade {0, 1, f, false, n, no, t, true, y, yes}]
[--force-update-tag]
[--instance-view]
[--___location]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--protected-settings]
[--publisher]
[--settings]
[--tags]
[--type]
[--type-handler-version]
例
拡張機能の作成のサンプル コマンド
az connectedmachine extension create --resource-group myResourceGroup --machine-name myMachine --extension-name CustomScriptExtension --___location eastus2euap --publisher Microsoft.Compute --type-handler-version 1.10 --type CustomScriptExtension --settings "{commandToExecute:'powershell.exe -c "Get-Process | Where-Object { $_.CPU -gt 10000 }"'}"
必須のパラメーター
マシン拡張機能の名前。
拡張機能を作成または更新するコンピューターの名前。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
展開時に使用可能な場合に、拡張機能で新しいマイナー バージョンを使用する必要があるかどうかを示します。 ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能はマイナー バージョンをアップグレードしません。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
使用可能な新しいバージョンがある場合に、プラットフォームによって拡張機能を自動的にアップグレードするかどうかを示します。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
拡張機能の構成が変更されていない場合でも、拡張機能ハンドラーを強制的に更新する方法。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
マシン拡張機能インスタンス ビュー。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
リソースが存在する地理的な場所 を指定しない場合は、リソース グループの場所が使用されます。
プロパティ | 値 |
---|---|
Parameter group: | ExtensionParameters Arguments |
実行時間の長い操作が完了するまで待つ必要はありません。
プロパティ | 値 |
---|---|
指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
拡張機能には、protectedSettings または protectedSettingsFromKeyVault、または保護された設定をまったく含めなくなります。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
拡張ハンドラーの発行元の名前。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
拡張機能の Json 形式のパブリック設定。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
リソース タグ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
プロパティ | 値 |
---|---|
Parameter group: | ExtensionParameters Arguments |
拡張機能の型を指定します。たとえば、"CustomScriptExtension" です。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
スクリプト ハンドラーのバージョンを指定します。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
出力フォーマット。
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az connectedmachine extension delete
拡張機能を削除する削除操作。
az connectedmachine extension delete [--extension-name --name]
[--ids]
[--machine-name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]
例
拡張機能の削除のサンプル コマンド
az connectedmachine extension delete --resource-group myResourceGroup --machine-name myMachine --extension-name MMA
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
マシン拡張機能の名前。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
拡張機能を削除するコンピューターの名前。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
実行時間の長い操作が完了するまで待つ必要はありません。
プロパティ | 値 |
---|---|
指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
確認を求めないでください。
プロパティ | 値 |
---|---|
規定値: | False |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
出力フォーマット。
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az connectedmachine extension list
Azure 以外のマシンのすべての拡張機能を取得します。
az connectedmachine extension list --machine-name
--resource-group
[--expand]
[--max-items]
[--next-token]
例
拡張機能リストのサンプル コマンド
az connectedmachine extension list --machine-name myMachine --resource-group myResourceGroup
必須のパラメーター
拡張機能を含むコンピューターの名前。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
操作に適用する展開式。
コマンドの出力で返される項目の合計数。 使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。 改ページ位置の変更を再開するには、後続のコマンドの引数 --next-token
トークン値を指定します。
プロパティ | 値 |
---|---|
Parameter group: | Pagination Arguments |
ページ分割を開始する場所を指定するトークン。 これは、以前に切り捨てられた応答からのトークン値です。
プロパティ | 値 |
---|---|
Parameter group: | Pagination Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
出力フォーマット。
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az connectedmachine extension show
拡張機能を取得する操作を取得します。
az connectedmachine extension show [--extension-name --name]
[--ids]
[--machine-name]
[--resource-group]
[--subscription]
例
拡張機能の表示のサンプル コマンド
az connectedmachine extension show --resource-group myResourceGroup --machine-name myMachine --extension-name CustomScriptExtension
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
マシン拡張機能の名前。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
拡張機能を含むコンピューターの名前。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
出力フォーマット。
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az connectedmachine extension update
拡張機能を作成または更新するための更新操作。
az connectedmachine extension update [--auto-upgrade-min --auto-upgrade-minor-version {0, 1, f, false, n, no, t, true, y, yes}]
[--enable-auto-upgrade --enable-automatic-upgrade {0, 1, f, false, n, no, t, true, y, yes}]
[--extension-name --name]
[--force-update-tag]
[--ids]
[--machine-name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--protected-settings]
[--publisher]
[--resource-group]
[--settings]
[--subscription]
[--tags]
[--type]
[--type-handler-version]
例
拡張機能の更新のサンプル コマンド
az connectedmachine extension update --name CustomScriptExtension --type CustomScriptExtension --publisher Microsoft.Compute --type-handler-version 1.10 --machine-name myMachine --resource-group myResourceGroup
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
展開時に使用可能な場合に、拡張機能で新しいマイナー バージョンを使用する必要があるかどうかを示します。 ただし、デプロイされると、このプロパティが true に設定されていても、再デプロイされない限り、拡張機能はマイナー バージョンをアップグレードしません。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
使用可能な新しいバージョンがある場合に、プラットフォームによって拡張機能を自動的にアップグレードするかどうかを示します。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
マシン拡張機能の名前。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
拡張機能の構成が変更されていない場合でも、拡張機能ハンドラーを強制的に更新する方法。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
拡張機能を作成または更新するコンピューターの名前。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
実行時間の長い操作が完了するまで待つ必要はありません。
プロパティ | 値 |
---|---|
指定可能な値: | 0, 1, f, false, n, no, t, true, y, yes |
拡張機能には、protectedSettings または protectedSettingsFromKeyVault、または保護された設定をまったく含めなくなります。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
拡張ハンドラーの発行元の名前。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
拡張機能の Json 形式のパブリック設定。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
リソース タグでは、短縮構文、json-file、yaml-file がサポートされます。 詳細を表示するには、"??" を試してください。
プロパティ | 値 |
---|---|
Parameter group: | ExtensionParameters Arguments |
拡張機能の型を指定します。たとえば、"CustomScriptExtension" です。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
スクリプト ハンドラーのバージョンを指定します。
プロパティ | 値 |
---|---|
Parameter group: | Properties Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
出力フォーマット。
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |
az connectedmachine extension wait
条件が満たされるまで CLI を待機状態にします。
az connectedmachine extension wait [--created]
[--custom]
[--deleted]
[--exists]
[--extension-name --name]
[--ids]
[--interval]
[--machine-name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
'provisioningState' が 'Succeeded' で作成されるまで待ちます。
プロパティ | 値 |
---|---|
Parameter group: | Wait Condition Arguments |
規定値: | False |
条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。
プロパティ | 値 |
---|---|
Parameter group: | Wait Condition Arguments |
削除されるまで待ちます。
プロパティ | 値 |
---|---|
Parameter group: | Wait Condition Arguments |
規定値: | False |
リソースが存在するまで待ちます。
プロパティ | 値 |
---|---|
Parameter group: | Wait Condition Arguments |
規定値: | False |
マシン拡張機能の名前。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
ポーリング間隔 (秒単位)。
プロパティ | 値 |
---|---|
Parameter group: | Wait Condition Arguments |
規定値: | 30 |
拡張機能を含むコンピューターの名前。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
プロパティ | 値 |
---|---|
Parameter group: | Resource Id Arguments |
最大待機時間 (秒単位)。
プロパティ | 値 |
---|---|
Parameter group: | Wait Condition Arguments |
規定値: | 3600 |
provisioningState が 'Succeeded' で更新されるまで待ちます。
プロパティ | 値 |
---|---|
Parameter group: | Wait Condition Arguments |
規定値: | False |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
プロパティ | 値 |
---|---|
規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
プロパティ | 値 |
---|---|
規定値: | False |
出力フォーマット。
プロパティ | 値 |
---|---|
規定値: | json |
指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
プロパティ | 値 |
---|---|
規定値: | False |