次の方法で共有

az connectedmachine run-command

  • プレビュー
  • リファレンス

Note

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

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

Azure Arc 対応サーバーで実行コマンドを管理します。

コマンド

名前 説明 型 状態
az connectedmachine run-command create

実行コマンドを作成します。

 拡張子 プレビュー
az connectedmachine run-command delete

実行コマンドを削除します。

 拡張子 プレビュー
az connectedmachine run-command list

Azure 以外のマシンのすべての実行コマンドを取得します。

 拡張子 プレビュー
az connectedmachine run-command show

実行コマンドを取得します。

 拡張子 プレビュー
az connectedmachine run-command update

実行コマンドを更新します。

 拡張子 プレビュー
az connectedmachine run-command wait

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

 拡張子 プレビュー

az connectedmachine run-command create

プレビュー

コマンド グループ 'az connectedmachine run-command' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

実行コマンドを作成します。

az connectedmachine run-command create --machine-name
                                       --name
                                       --resource-group
                                       [--async-execution {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--command-id]
                                       [--error-blob-id]
                                       [--error-blob-uri]
                                       [--location]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--output-blob-id]
                                       [--output-blob-uri]
                                       [--parameters]
                                       [--protected-parameters]
                                       [--run-as-password]
                                       [--run-as-user]
                                       [--script]
                                       [--script-uri]
                                       [--script-uri-id]
                                       [--tags]
                                       [--timeout-in-seconds]

例

run-command create のサンプル コマンド

az connectedmachine run-command create --resource-group myResourceGroup --location "WestUS" --async false --parameters "[{"name":"param1","value":"value1"}]" --password "<runAsPassword>" --user "user1" --script "Write-Host Hello World!" --timeout 3600 --name myRunCommand --machine-name myMachine --subscription mySubscription
az connectedmachine run-command create --resource-group myResourceGroup --location "WestUS" --script "Write-Host Hello World!" --name myRunCommand --machine-name myMachine --output-uri "outputuri" --subscription mySubscription

必須のパラメーター

--machine-name

ハイブリッド マシンの名前。

--name --run-command-name -n

実行コマンドの名前。

--resource-group -g

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

省略可能のパラメーター

--async-execution

省略可能。 true に設定すると、スクリプトが開始されるとすぐにプロビジョニングが完了し、スクリプトの完了を待機しません。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
規定値: False
--command-id

定義済みの組み込みスクリプトの commandId を指定します。

--error-blob-id --error-blob-managed-identity

errorBlobUri ストレージ BLOB にアクセスできるユーザー割り当てマネージド ID。 システム割り当て ID の場合は、空のオブジェクトを使用します。 "ストレージ BLOB データ共同作成者" ロールの割り当てを使用して、マネージド ID に BLOB のコンテナーへのアクセス権が付与されていることを確認します。 ユーザー割り当て ID の場合は、必ず VM の ID の下に追加してください。 マネージド ID と実行コマンドの詳細については、「 https://aka.ms/ManagedIdentity およびサポート https://aka.ms/RunCommandManaged 短縮構文、json-file、yaml-file」を参照してください。 詳細を表示するには、"??" を試してください。

--error-blob-uri

スクリプト エラー ストリームをアップロードする Azure Storage BLOB を指定します。 読み取り、追加、作成、書き込みアクセス権を持つ SAS URI を使用するか、マネージド ID を使用して VM に BLOB へのアクセスを提供します。 errorBlobManagedIdentity パラメーターを参照します。

--location -l

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

--no-wait

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

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--output-blob-id --output-blob-managed-identity

outputBlobUri ストレージ BLOB にアクセスできるユーザー割り当てマネージド ID。 システム割り当て ID の場合は、空のオブジェクトを使用します。 "ストレージ BLOB データ共同作成者" ロールの割り当てを使用して、マネージド ID に BLOB のコンテナーへのアクセス権が付与されていることを確認します。 ユーザー割り当て ID の場合は、必ず VM の ID の下に追加してください。 マネージド ID と実行コマンドの詳細については、「 https://aka.ms/ManagedIdentity およびサポート https://aka.ms/RunCommandManaged 短縮構文、json-file、yaml-file」を参照してください。 詳細を表示するには、"??" を試してください。

--output-blob-uri

スクリプト出力ストリームをアップロードする Azure Storage BLOB を指定します。 読み取り、追加、作成、書き込みアクセス権を持つ SAS URI を使用するか、マネージド ID を使用して VM に BLOB へのアクセスを提供します。 outputBlobManagedIdentity パラメーターを参照します。

--parameters

スクリプトで使用されるパラメーター。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--protected-parameters

スクリプトで使用されるパラメーター。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--run-as-password

実行コマンドの実行時に、コンピューター上のユーザー アカウント のパスワードを指定します。

--run-as-user

実行コマンドの実行時にマシン上のユーザー アカウントを指定します。

--script

コンピューター上で実行するスクリプトコンテンツを指定します。

--script-uri

スクリプトのダウンロード場所を指定します。 読み取りアクセス権を持つ Azure ストレージ BLOB の SAS URI またはパブリック URI のいずれかを指定できます。

--script-uri-id --script-uri-managed-identity

Azure Storage BLOB の場合に scriptUri にアクセスできるユーザー割り当てマネージド ID。 システム割り当て ID の場合は、空のオブジェクトを使用します。 Azure ストレージ BLOB が存在し、マネージド ID に "ストレージ BLOB データ閲覧者" ロールの割り当てで BLOB のコンテナーへのアクセス権が付与されていることを確認します。 ユーザー割り当て ID の場合は、必ず VM の ID の下に追加してください。 マネージド ID と実行コマンドの詳細については、「 https://aka.ms/ManagedIdentity と https://aka.ms/RunCommandManaged」を参照してください。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--tags

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

--timeout-in-seconds

run コマンドを実行するためのタイムアウト (秒単位)。

グローバル パラメーター
--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 run-command delete

プレビュー

コマンド グループ 'az connectedmachine run-command' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

実行コマンドを削除します。

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

例

run-command delete のサンプル コマンド

az connectedmachine run-command delete --resource-group myResourceGroup --machine-name myMachine --name myRunCommand

省略可能のパラメーター

--ids

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

--machine-name

ハイブリッド マシンの名前。

--name --run-command-name -n

実行コマンドの名前。

--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 run-command list

プレビュー

コマンド グループ 'az connectedmachine run-command' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

Azure 以外のマシンのすべての実行コマンドを取得します。

az connectedmachine run-command list --machine-name
                                     --resource-group
                                     [--expand]
                                     [--max-items]
                                     [--next-token]

例

run-command list のサンプル コマンド

az connectedmachine run-command list --resource-group myResourceGroup --machine-name myMachine --subscription mySubscription

必須のパラメーター

--machine-name

ハイブリッド マシンの名前。

--resource-group -g

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

省略可能のパラメーター

--expand

操作に適用する展開式。

--max-items

コマンドの出力で返される項目の合計数。 使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。 改ページ位置の変更を再開するには、後続のコマンドの引数 --next-token トークン値を指定します。

--next-token

ページ分割を開始する場所を指定するトークン。 これは、以前に切り捨てられた応答からのトークン値です。

グローバル パラメーター
--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 run-command show

プレビュー

コマンド グループ 'az connectedmachine run-command' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

実行コマンドを取得します。

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

例

run-command show のサンプル コマンド

az connectedmachine run-command show --resource-group myResourceGroup --machine-name myMachine --name myRunCommand

省略可能のパラメーター

--ids

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

--machine-name

ハイブリッド マシンの名前。

--name --run-command-name -n

実行コマンドの名前。

--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 run-command update

プレビュー

コマンド グループ 'az connectedmachine run-command' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

実行コマンドを更新します。

az connectedmachine run-command update [--add]
                                       [--async-execution {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--command-id]
                                       [--error-blob-id]
                                       [--error-blob-uri]
                                       [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--ids]
                                       [--machine-name]
                                       [--name]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--output-blob-id]
                                       [--output-blob-uri]
                                       [--parameters]
                                       [--protected-parameters]
                                       [--remove]
                                       [--resource-group]
                                       [--run-as-password]
                                       [--run-as-user]
                                       [--script]
                                       [--script-uri]
                                       [--script-uri-id]
                                       [--set]
                                       [--subscription]
                                       [--tags]
                                       [--timeout-in-seconds]

例

run-command update のサンプル コマンド

az connetcedmachine run-command update --resource-group myResourceGroup --name myRunCommand --machine-name myMachine --subscription mySubscription --tags Tag1=Value1

省略可能のパラメーター

--add

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

--async-execution

省略可能。 true に設定すると、スクリプトが開始されるとすぐにプロビジョニングが完了し、スクリプトの完了を待機しません。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--command-id

定義済みの組み込みスクリプトの commandId を指定します。

--error-blob-id --error-blob-managed-identity

errorBlobUri ストレージ BLOB にアクセスできるユーザー割り当てマネージド ID。 システム割り当て ID の場合は、空のオブジェクトを使用します。 "ストレージ BLOB データ共同作成者" ロールの割り当てを使用して、マネージド ID に BLOB のコンテナーへのアクセス権が付与されていることを確認します。 ユーザー割り当て ID の場合は、必ず VM の ID の下に追加してください。 マネージド ID と実行コマンドの詳細については、「 https://aka.ms/ManagedIdentity およびサポート https://aka.ms/RunCommandManaged 短縮構文、json-file、yaml-file」を参照してください。 詳細を表示するには、"??" を試してください。

--error-blob-uri

スクリプト エラー ストリームをアップロードする Azure Storage BLOB を指定します。 読み取り、追加、作成、書き込みアクセス権を持つ SAS URI を使用するか、マネージド ID を使用して VM に BLOB へのアクセスを提供します。 errorBlobManagedIdentity パラメーターを参照します。

--force-string

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

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--ids

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

--machine-name

ハイブリッド マシンの名前。

--name --run-command-name -n

実行コマンドの名前。

--no-wait

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

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--output-blob-id --output-blob-managed-identity

outputBlobUri ストレージ BLOB にアクセスできるユーザー割り当てマネージド ID。 システム割り当て ID の場合は、空のオブジェクトを使用します。 "ストレージ BLOB データ共同作成者" ロールの割り当てを使用して、マネージド ID に BLOB のコンテナーへのアクセス権が付与されていることを確認します。 ユーザー割り当て ID の場合は、必ず VM の ID の下に追加してください。 マネージド ID と実行コマンドの詳細については、「 https://aka.ms/ManagedIdentity およびサポート https://aka.ms/RunCommandManaged 短縮構文、json-file、yaml-file」を参照してください。 詳細を表示するには、"??" を試してください。

--output-blob-uri

スクリプト出力ストリームをアップロードする Azure Storage BLOB を指定します。 読み取り、追加、作成、書き込みアクセス権を持つ SAS URI を使用するか、マネージド ID を使用して VM に BLOB へのアクセスを提供します。 outputBlobManagedIdentity パラメーターを参照します。

--parameters

スクリプトで使用されるパラメーター。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--protected-parameters

スクリプトで使用されるパラメーター。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--remove

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

--resource-group -g

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

--run-as-password

実行コマンドの実行時に、コンピューター上のユーザー アカウント のパスワードを指定します。

--run-as-user

実行コマンドの実行時にマシン上のユーザー アカウントを指定します。

--script

コンピューター上で実行するスクリプトコンテンツを指定します。

--script-uri

スクリプトのダウンロード場所を指定します。 読み取りアクセス権を持つ Azure ストレージ BLOB の SAS URI またはパブリック URI のいずれかを指定できます。

--script-uri-id --script-uri-managed-identity

Azure Storage BLOB の場合に scriptUri にアクセスできるユーザー割り当てマネージド ID。 システム割り当て ID の場合は、空のオブジェクトを使用します。 Azure ストレージ BLOB が存在し、マネージド ID に "ストレージ BLOB データ閲覧者" ロールの割り当てで BLOB のコンテナーへのアクセス権が付与されていることを確認します。 ユーザー割り当て ID の場合は、必ず VM の ID の下に追加してください。 マネージド ID と実行コマンドの詳細については、「 https://aka.ms/ManagedIdentity と https://aka.ms/RunCommandManaged」を参照してください。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--set

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

--subscription

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

--tags

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

--timeout-in-seconds

run コマンドを実行するためのタイムアウト (秒単位)。

グローバル パラメーター
--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 run-command wait

プレビュー

コマンド グループ 'az connectedmachine run-command' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

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

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

省略可能のパラメーター

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

ハイブリッド マシンの名前。

--name --run-command-name -n

実行コマンドの名前。

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