az vm run-command

  • リファレンス

仮想マシンで実行コマンドを管理します。

詳細については、https://docs.microsoft.com/azure/virtual-machines/linux/run-commandhttps://docs.microsoft.com/azure/virtual-machines/windows/run-command」または」を参照してください。

コマンド

名前 説明 型 Status
az vm run-command create

実行コマンドを作成する操作。

 コア GA
az vm run-command delete

実行コマンドを削除する操作。

 コア GA
az vm run-command invoke

VM で特定の実行コマンドを実行します。

 コア GA
az vm run-command list

VM または場所からの実行コマンドを一覧表示します。

 コア GA
az vm run-command show

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

 コア GA
az vm run-command update

実行コマンドを更新する操作。

 コア GA
az vm run-command wait

res virtual-machine-run-command の条件が満たされるまで、CLI を待機状態にします。

 コア GA

az vm run-command create

編集

実行コマンドを作成する操作。

az vm run-command create --name
                         --resource-group
                         --vm-name
                         [--async-execution {false, true}]
                         [--command-id]
                         [--error-blob-uri]
                         [--location]
                         [--no-wait]
                         [--output-blob-uri]
                         [--parameters]
                         [--protected-parameters]
                         [--run-as-password]
                         [--run-as-user]
                         [--script]
                         [--script-uri]
                         [--tags]
                         [--timeout-in-seconds]

例

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

az vm run-command create --resource-group "myResourceGroup" --location "West US" --async-execution false --parameters arg1=param1 arg2=value1 --run-as-password "<runAsPassword>" --run-as-user "user1" --script "Write-Host Hello World!" --timeout-in-seconds 3600 --run-command-name "myRunCommand" --vm-name "myVM"

スクリプト出力ストリームを Azure Storage BLOB (SAS URI) にアップロードして実行コマンドを作成します。

az vm run-command create --resource-group "myResourceGroup" --location "West US" --script "Write-Host Hello World!" --run-command-name "myRunCommand" --vm-name "myVM" --output-blob-uri "https://mystorageaccount.blob.core.windows.net/mycontainer/RuncommandOutput.txt?sp=racw&st=2022-10-17T19:02:15Z&se=2022-10-18T03:02:15Z&spr=https&sv=2021-06-08&sr=b&sig=3BxtEasfdasdfasdfdYki9yvYsqc60V0%3D"

必須のパラメーター

--name --run-command-name

仮想マシンの実行コマンドの名前。

--resource-group -g

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

--vm-name

仮想マシンの名前。

省略可能のパラメーター

--async-execution

オプション。 true に設定すると、スクリプトが開始されるとすぐにプロビジョニングが完了し、スクリプトが完了するまで待機しません。

承認された値: false, true
--command-id

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

--error-blob-uri

スクリプト エラー ストリームをアップロードする Azure Storage BLOB を指定します。

--location -l

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

--no-wait

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

既定値: False
--output-blob-uri

スクリプト出力ストリームをアップロードする Azure Storage BLOB (SAS URI) を指定します。

--parameters

スクリプトで使用されるパラメーター。

使用法: --parameters arg1=XX arg2=XX。

--protected-parameters

スクリプトで使用されるパラメーター。

使用法: --protected-parameters credentials=somefoo secret=somebar。

--run-as-password

ユーザーとしての実行パラメーターを使用するために必要な場合はパスワード。 暗号化され、ログに記録されません。

--run-as-user

既定では、スクリプト プロセスはシステム/ルート ユーザーで実行されます。 プロセスをホストするカスタム ユーザーを指定します。

--script

VM で実行するスクリプトコンテンツを指定します。

--script-uri

スクリプトのダウンロード場所を指定します。

--tags

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

--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 vm run-command delete

編集

実行コマンドを削除する操作。

az vm run-command delete --name
                         [--ids]
                         [--no-wait]
                         [--resource-group]
                         [--subscription]
                         [--vm-name]
                         [--yes]

例

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

az vm run-command delete --resource-group "myResourceGroup" --run-command-name "myRunCommand" --vm-name "myVM"

必須のパラメーター

--name --run-command-name

仮想マシンの実行コマンドの名前。

省略可能のパラメーター

--ids

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

--no-wait

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

既定値: False
--resource-group -g

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

--subscription

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

--vm-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 vm run-command invoke

編集

VM で特定の実行コマンドを実行します。

az vm run-command show は、各実行コマンドに関する有用な情報を返します。 Discover Run command-id's via az vmss run-command list.

az vm run-command invoke --command-id
                         [--ids]
                         [--name]
                         [--no-wait]
                         [--parameters]
                         [--resource-group]
                         [--scripts]
                         [--subscription]

例

Linux VM に nginx をインストールします。

az vm run-command invoke -g MyResourceGroup -n MyVm --command-id RunShellScript --scripts "sudo apt-get update && sudo apt-get install -y nginx"

パラメーターを使用して Linux VM でシェル コマンドを実行します。

az vm run-command invoke -g MyResourceGroup -n MyVm --command-id RunShellScript --scripts 'echo $1 $2' --parameters hello world

パラメーターを使用して Windows VM で PowerShell スクリプトを実行します。 インラインで提供されるスクリプト。 CMD.exe での単一引用符の使用に注意してください。

az vm run-command invoke  --command-id RunPowerShellScript --name win-vm -g my-resource-group  \
    --scripts 'param([string]$arg1,[string]$arg2)' \
    'Write-Host This is a sample script with parameters $arg1 and $arg2' \
    --parameters 'arg1=somefoo' 'arg2=somebar'

パラメーターを使用して Windows VM で PowerShell スクリプトを実行します。 ファイルから提供されるスクリプト。

# script.ps1
#   param(
#       [string]$arg1,
#       [string]$arg2
#   )
#   Write-Host This is a sample script with parameters $arg1 and $arg2

az vm run-command invoke  --command-id RunPowerShellScript --name win-vm -g my-resource-group \
    --scripts @script.ps1 --parameters "arg1=somefoo" "arg2=somebar"

必須のパラメーター

--command-id

コマンド ID。

開始値: az vm run-command list

省略可能のパラメーター

--ids

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

--name -n

仮想マシンの名前。 を使用して az configure --defaults vm=<name>既定値を構成できます。

--no-wait

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

既定値: False
--parameters

'[name=]value' の形式のスペース区切りパラメーター。

--resource-group -g

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

--scripts

スペース区切りのスクリプト行。 ファイルからスクリプトを読み込むには、@{file} を使用します。

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

編集

VM または場所からの実行コマンドを一覧表示します。

"--resource-group" と "--vm-name" を指定して、仮想マシンのすべての実行コマンドを取得できます。 または、"--location" を指定して、ある場所のサブスクリプションで使用可能なすべての実行コマンドを一覧表示することもできます。

az vm run-command list [--expand]
                       [--location]
                       [--resource-group]
                       [--vm-name]

例

仮想マシンの実行コマンドを一覧表示します。

az vm run-command list --resource-group "myResourceGroup" --vm-name "myVM"

ある場所のサブスクリプションで使用可能なすべての実行コマンドを一覧表示します。

az vm run-command list --location "SoutheastAsia"

省略可能のパラメーター

--expand

操作に適用する展開式。

--location -l

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

--resource-group -g

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

--vm-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 vm run-command show

編集

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

"--resource-group"、"--run-command-name"、および "--vm-name" を指定して、仮想マシンで実行コマンドを取得できます。 または、"--command-id" と "--location" を指定して、ある場所のサブスクリプションの実行コマンドを取得することもできます。

az vm run-command show [--command-id]
                       [--ids]
                       [--instance-view]
                       [--location]
                       [--name]
                       [--resource-group]
                       [--subscription]
                       [--vm-name]

例

仮想マシンで実行コマンドを取得します。

az vm run-command show --resource-group "myResourceGroup" --run-command-name "myRunCommand" --vm-name "myVM"

ある場所にあるサブスクリプションの特定の実行コマンドを取得します。

az vm run-command show --command-id "RunPowerShellScript" --location "SoutheastAsia"

省略可能のパラメーター

--command-id

コマンド ID。

--ids

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

--instance-view

実行コマンドのインスタンス ビュー。

既定値: False
--location -l

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

--name --run-command-name

仮想マシンの実行コマンドの名前。

--resource-group -g

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

--subscription

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

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

編集

実行コマンドを更新する操作。

az vm run-command update --name
                         [--async-execution {false, true}]
                         [--command-id]
                         [--error-blob-uri]
                         [--ids]
                         [--location]
                         [--no-wait]
                         [--output-blob-uri]
                         [--parameters]
                         [--protected-parameters]
                         [--resource-group]
                         [--run-as-password]
                         [--run-as-user]
                         [--script]
                         [--script-uri]
                         [--subscription]
                         [--tags]
                         [--timeout-in-seconds]
                         [--vm-name]

例

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

az vm run-command update --resource-group "myResourceGroup" --location "West US" --async-execution false --parameters arg1=param1 arg2=value1 --run-as-password "<runAsPassword>" --run-as-user "user1" --script "Write-Host Hello World!" --timeout-in-seconds 3600 --run-command-name "myRunCommand" --vm-name "myVM"

スクリプト出力ストリームを Azure Storage BLOB (SAS URI) にアップロードして実行コマンドを更新します。

az vm run-command update --resource-group "myResourceGroup" --location "West US" --script "Write-Host Hello World!" --run-command-name "myRunCommand" --vm-name "myVM" --output-blob-uri "https://mystorageaccount.blob.core.windows.net/mycontainer/RuncommandOutput.txt?sp=racw&st=2022-10-17T19:02:15Z&se=2022-10-18T03:02:15Z&spr=https&sv=2021-06-08&sr=b&sig=3BxtEasfdasdfasdfdYki9yvYsqc60V0%3D"

必須のパラメーター

--name --run-command-name

仮想マシンの実行コマンドの名前。

省略可能のパラメーター

--async-execution

オプション。 true に設定すると、スクリプトが開始されるとすぐにプロビジョニングが完了し、スクリプトが完了するまで待機しません。

承認された値: false, true
--command-id

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

--error-blob-uri

スクリプト エラー ストリームをアップロードする Azure Storage BLOB を指定します。

--ids

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

--location -l

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

--no-wait

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

既定値: False
--output-blob-uri

スクリプト出力ストリームをアップロードする Azure Storage BLOB (SAS URI) を指定します。

--parameters

スクリプトで使用されるパラメーター。

使用法: --parameters arg1=XX arg2=XX。

--protected-parameters

スクリプトで使用されるパラメーター。

使用法: --protected-parameters credentials=somefoo secret=somebar。

--resource-group -g

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

--run-as-password

ユーザーとしての実行パラメーターを使用するために必要な場合はパスワード。 暗号化され、ログに記録されません。

--run-as-user

既定では、スクリプト プロセスはシステム/ルート ユーザーで実行されます。 プロセスをホストするカスタム ユーザーを指定します。

--script

VM で実行するスクリプトコンテンツを指定します。

--script-uri

スクリプトのダウンロード場所を指定します。

--subscription

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

--tags

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

--timeout-in-seconds

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

--vm-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 vm run-command wait

編集

res virtual-machine-run-command の条件が満たされるまで、CLI を待機状態にします。

az vm run-command wait [--command-id]
                       [--created]
                       [--custom]
                       [--deleted]
                       [--exists]
                       [--ids]
                       [--instance-view]
                       [--interval]
                       [--location]
                       [--name]
                       [--resource-group]
                       [--subscription]
                       [--timeout]
                       [--updated]
                       [--vm-name]

省略可能のパラメーター

--command-id

コマンド ID。

--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' 引数を指定する必要があります。

--instance-view

実行コマンドのインスタンス ビュー。

既定値: False
--interval

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

既定値: 30
--location -l

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

--name --run-command-name

仮想マシンの実行コマンドの名前。

--resource-group -g

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

--subscription

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

--timeout

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

既定値: 3600
--updated

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

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