az connectedmachine extension

Note

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

Azure Arc 対応サーバーで VM 拡張機能を管理します。

コマンド

名前	説明	型	Status
az connectedmachine extension create	拡張機能を作成する操作。	拡張子	GA
az connectedmachine extension delete	拡張機能を削除する操作。	拡張子	GA
az connectedmachine extension image	Azure Arc 対応サーバーで使用できる VM 拡張機能メタデータを管理します。	拡張子	GA
az connectedmachine extension image list	場所、発行元、extensionType に基づいて、すべての拡張機能のバージョンを一覧表示します。	拡張子	GA
az connectedmachine extension image show	場所、発行元、extensionType、バージョンに基づいて拡張メタデータを取得します。	拡張子	GA
az connectedmachine extension list	Azure 以外のマシンのすべての拡張機能を取得する操作。	拡張子	GA
az connectedmachine extension show	拡張機能を作成または更新する操作。	拡張子	GA
az connectedmachine extension update	拡張機能を更新する更新操作。	拡張子	GA
az connectedmachine extension wait	条件が満たされるまで CLI を待機状態にします。	拡張子	GA

az connectedmachine extension create

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

az connectedmachine extension create --extension-name
                                     --machine-name
                                     --resource-group
                                     [--auto-upgrade {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--auto-upgrade-minor {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 --name CustomScriptExtension --location eastus2euap --type CustomScriptExtension --publisher Microsoft.Compute --type-handler-version 1.10 --machine-name myMachine --resource-group myResourceGroup

必須のパラメーター

--extension-name --name -n

マシン拡張機能の名前。

--machine-name

拡張機能を作成または更新するコンピューターの名前。

--resource-group -g

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

省略可能のパラメーター

--auto-upgrade --enable-auto-upgrade --enable-automatic-upgrade

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

承認された値: 0, 1, f, false, n, no, t, true, y, yes

--auto-upgrade-minor --auto-upgrade-minor-version --upgrade-minor-ver

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

承認された値: 0, 1, f, false, n, no, t, true, y, yes

--force-update-tag

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

--instance-view

マシン拡張機能インスタンス ビュー。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--location -l

リソースが存在する地理的な場所 を指定しない場合は、リソース グループの場所が使用されます。

--no-wait

実行時間の長い操作の終了を待機しません。

承認された値: 0, 1, f, false, n, no, t, true, y, yes

--protected-settings

拡張機能には、protected設定 または protected設定FromKeyVault、または保護された設定をまったく含めなくなります。 json-file と yaml-file をサポートします。

--publisher

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

--settings

拡張機能の Json 形式のパブリック設定。 json-file と yaml-file をサポートします。

--tags

リソース タグ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--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 connectedmachine extension delete

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

az connectedmachine extension delete [--extension-name]
                                     [--ids]
                                     [--machine-name]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--resource-group]
                                     [--subscription]
                                     [--yes]

例

拡張機能の削除のサンプル コマンド

az connectedmachine extension delete --name myName --machine-name myMachine --resource-group myResourceGroup

省略可能のパラメーター

--extension-name --name -n

マシン拡張機能の名前。

--ids

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

--machine-name

拡張機能を削除するコンピューターの名前。

--no-wait

実行時間の長い操作の終了を待機しません。

承認された値: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

--subscription

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

--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 connectedmachine extension list

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

az connectedmachine extension list --machine-name
                                   --resource-group
                                   [--expand]

例

拡張機能リストのサンプル コマンド

az connectedmachine extension list --machine-name myMachine --resource-group myResourceGroup

必須のパラメーター

--machine-name

拡張機能を含むコンピューターの名前。

--resource-group -g

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

省略可能のパラメーター

--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 connectedmachine extension show

拡張機能を作成または更新する操作。

az connectedmachine extension show [--extension-name]
                                   [--ids]
                                   [--machine-name]
                                   [--resource-group]
                                   [--subscription]

例

拡張機能の表示のサンプル コマンド

az connectedmachine extension show --name CustomScriptExtension --machine-name myMachine --resource-group myResourceGroup

省略可能のパラメーター

--extension-name --name -n

マシン拡張機能の名前。

--ids

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

--machine-name

拡張機能を含むコンピューターの名前。

--resource-group -g

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

--subscription

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

グローバル パラメーター

--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 connectedmachine extension update

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

az connectedmachine extension update [--add]
                                     [--auto-upgrade {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--auto-upgrade-minor {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--extension-name]
                                     [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--force-update-tag]
                                     [--ids]
                                     [--instance-view]
                                     [--machine-name]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--protected-settings]
                                     [--publisher]
                                     [--remove]
                                     [--resource-group]
                                     [--set]
                                     [--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

省略可能のパラメーター

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value、string、または JSON 文字列>。

--auto-upgrade --enable-auto-upgrade --enable-automatic-upgrade

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

承認された値: 0, 1, f, false, n, no, t, true, y, yes

--auto-upgrade-minor --auto-upgrade-minor-version --upgrade-minor-ver

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

承認された値: 0, 1, f, false, n, no, t, true, y, yes

--extension-name --name -n

マシン拡張機能の名前。

--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

承認された値: 0, 1, f, false, n, no, t, true, y, yes

--force-update-tag

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

--ids

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

--instance-view

マシン拡張機能インスタンス ビュー。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--machine-name

拡張機能を含むコンピューターの名前。

--no-wait

実行時間の長い操作の終了を待機しません。

承認された値: 0, 1, f, false, n, no, t, true, y, yes

--protected-settings

拡張機能には、protected設定 または protected設定FromKeyVault、または保護された設定をまったく含めなくなります。 json-file と yaml-file をサポートします。

--publisher

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

--remove

リストからプロパティまたは要素を削除します。 例: --remove property.list OR --remove propertyToRemove。

--resource-group -g

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

--set

設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=。

--settings

拡張機能の Json 形式のパブリック設定。 json-file と yaml-file をサポートします。

--subscription

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

--tags

リソース タグ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--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 connectedmachine extension wait

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

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

省略可能のパラメーター

--created

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

既定値: False

--custom

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

--deleted

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

既定値: False

--exists

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

既定値: False

--extension-name --name -n

マシン拡張機能の名前。

--ids

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

--interval

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

既定値: 30

--machine-name

拡張機能を含むコンピューターの名前。

--resource-group -g

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

--subscription

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

--timeout

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

既定値: 3600

--updated

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

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