Invoke-AzVMRunCommand

構文

Invoke-AzVMRunCommand
      [-ResourceGroupName] <String>
      [-VMName] <String>
      -CommandId <String>
      [-ScriptPath <String>]
      [-ScriptString <String>]
      [-Parameter <Hashtable>]
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-AzVMRunCommand
      -CommandId <String>
      [-ScriptPath <String>]
      [-ScriptString <String>]
      [-Parameter <Hashtable>]
      [-ResourceId] <String>
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-AzVMRunCommand
      -CommandId <String>
      [-ScriptPath <String>]
      [-ScriptString <String>]
      [-Parameter <Hashtable>]
      [-VM] <PSVirtualMachine>
      [-AsJob]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

VM で実行コマンドを呼び出します。

例

例 1: Windows でコマンドを呼び出す - スクリプトがリモート Windows VM に存在する場合に ScriptPath パラメーターを使用する

Invoke-AzVMRunCommand -ResourceGroupName 'rgname' -VMName 'vmname' -CommandId 'RunPowerShellScript' -ScriptPath 'sample.ps1' -Parameter @{param1 = "var1"; param2 = "var2"}

リソース グループ 'rgname' の 'vmname' という名前の Windows VM でスクリプト 'sample.ps1' をオーバーライドして、実行コマンド 'RunPowerShellScript' を呼び出します。 Var1 と var2 は sample.ps1 のパラメーターとして定義されます。 パラメーター値には文字列型のみを指定でき、スクリプトは必要に応じて他の型に変換します。

例 2: Windows でコマンドを呼び出す - ScriptString パラメーターを使用して Windows VM でコマンドレットを実行する

Invoke-AzVMRunCommand -ResourceGroupName 'rgname' -VMName 'vmname' -CommandId 'RunPowerShellScript' -ScriptString "Set-TimeZone -Name 'Coordinated Universal Time' -PassThru"

このコマンドは、Set-TimeZone コマンドレットを関連付けられたパラメーターと共に実行する実行コマンド 'RunShellScript' を呼び出します。 この例は、Windows VM で短いコマンドを実行する場合に便利です。

例 3: Windows でコマンドを呼び出す - ScriptString パラメーターを使用して Windows VM でスクリプト ブロックを実行する

$ScriptBlock = {
    param(
        [string] $NewTimeZone,
        [string] $NewDate
        )
    Set-TimeZone -Id $NewTimeZone
    Set-Date -Date [DateTime]$NewDate
}

$Script = [scriptblock]::create($ScriptBlock)

Invoke-AzVMRunCommand -ResourceGroupName 'rgname' -VMName 'vmname' -CommandId 'RunPowerShellScript' -ScriptString $Script -Parameter @{'NewTimeZone' = "UTC"; 'NewDate' = "Dec-8"}

このコマンドは、"vmname" という名前のリモート Windows VM でスクリプト ブロックを実行する実行コマンド 'RunShellScript' を呼び出します。 スクリプト ブロックの方法を使用すると、1 回の呼び出しでパラメーターを使用して複数のコマンドレットを実行できます。また、異なるコマンドレットに対して複数の実行コマンドを呼び出す時間も節約できます。 パラメーター値には文字列型のみを指定できます。

例 4: Linux でコマンドを呼び出す

export param1=var1 param2=var2
set -- var1 var2 var3

Invoke-AzVMRunCommand -ResourceGroupName 'rgname' -Name 'vmname' -CommandId 'RunShellScript' -ScriptPath 'sample.bash' -Parameter @{"param1" = "var1";"param2" = "var2"}
echo This is a sample bash script
echo Usage 1: Ordered parameters: $0 $1
echo Usage 2: Named exports: $var1 $var2

このコマンドは、実行コマンド 'RunShellScript' を呼び出し、'vmname' という名前の Linux VM でスクリプト 'sample.bash' をオーバーライドします。 Var1 と var2 は、sample.bash のパラメーターとして定義されます。

パラメーター

-AsJob

-CommandId

-Confirm

-DefaultProfile

-Parameter

-ResourceGroupName

-ResourceId

-ScriptPath

-ScriptString

-VM

-VMName

-WhatIf

入力

String

PSVirtualMachine

出力

PSRunCommandResult