Sdílet prostřednictvím

Invoke-AzVMRunCommand

Modul:
Az.Compute Module

Na virtuálním počítači spusťte příkaz.

Syntax

DefaultParameter (Výchozí) 

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

ResourceIdParameter 

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

VMParameter 

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

Description

Vyvolejte na virtuálním počítači příkaz spustit.

Příklady

Příklad 1: Vyvolání příkazu ve Windows – použití parametru ScriptPath, když se skript nachází na vzdáleném virtuálním počítači s Windows

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

Vyvolejte příkaz run RunPowerShellScript s přepsáním skriptusample.ps1na virtuálním počítači s Windows s názvem vmname ve skupině prostředků rgname. Var1 a var2 jsou definovány jako parametry v sample.ps1. Hodnota parametru může být pouze typ řetězce a skript je v případě potřeby zodpovědný za jejich převod na jiné typy.

Příklad 2: Vyvolání příkazu ve Windows – Spuštění rutiny na virtuálním počítači s Windows pomocí parametru ScriptString

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

Tento příkaz vyvolá příkaz run RunShellScript, který spustí rutinu Set-TimeZone s přidruženými parametry. Tento příklad je užitečný, když chcete na virtuálním počítači s Windows spouštět krátké příkazy.

Příklad 3: Vyvolání příkazu ve Windows – Spuštění bloků skriptu na virtuálním počítači s Windows pomocí parametru ScriptString

$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"}

Tento příkaz vyvolá příkaz run RunShellScript, který spustí blok skriptu na vzdáleném virtuálním počítači s Windows s názvem vmname. Blok skriptu umožňuje spouštět více rutin s parametry v jediném vyvolání a také šetří čas při vyvolání více příkazů spuštění pro různé rutiny. Hodnoty parametrů můžou být pouze typu řetězce.

Příklad 4: Vyvolání příkazu v Linuxu

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

Tento příkaz vyvolá příkaz run RunShellScript s přepsáním skriptu sample.bash na virtuálním počítači s Linuxem s názvem vmname. Var1 a var2 jsou definovány jako parametry v sample.bash.

Parametry

-AsJob

Spusťte rutinu na pozadí a vraťte objekt úlohy ke sledování průběhu.

Vlastnosti parametru

Typ:SwitchParameter
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-CommandId

ID příkazu spustit.

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:True
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-Confirm

Před spuštěním cmdletu vás vyzve k potvrzení.

Vlastnosti parametru

Typ:SwitchParameter
Default value:None
Podporuje zástupné znaky:False
DontShow:False
Aliasy:viz

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-DefaultProfile

Přihlašovací údaje, účet, tenant a předplatné používané ke komunikaci s Azure.

Vlastnosti parametru

Typ:IAzureContextContainer
Default value:None
Podporuje zástupné znaky:False
DontShow:False
Aliasy:AzContext, AzureRmContext, AzureCredential

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-Parameter

Parametry příkazu spustit. Zadejte parametry jako páry klíč/hodnota, které se mají předat při spuštění skriptu.

Vlastnosti parametru

Typ:Hashtable
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-ResourceGroupName

Název skupiny prostředků.

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

DefaultParameter
Position:0
Povinné:True
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

-ResourceId

ID prostředku pro virtuální počítač.

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

ResourceIdParameter
Position:0
Povinné:True
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

-ScriptPath

Cesta ke skriptu, který se má spustit. Pokud je tato hodnota zadaná, daný skript přepíše výchozí skript příkazu. Cesta by měla odkazovat na soubor z místního systému souborů. Příkaz ho načte a odešle ho ke spuštění.

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-ScriptString

Skript, který se má spustit jako řetězec.

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-VM

Objekt virtuálního počítače PS.

Vlastnosti parametru

Typ:PSVirtualMachine
Default value:None
Podporuje zástupné znaky:False
DontShow:False
Aliasy:VMProfile

Sady parametrů

VMParameter
Position:0
Povinné:True
Hodnota z kanálu:True
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

-VMName

Název virtuálního počítače.

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False
Aliasy:Název

Sady parametrů

DefaultParameter
Position:1
Povinné:True
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

-WhatIf

Ukazuje, co se stane, když se příkaz spustí. Příkazový modul nebyl spuštěn.

Vlastnosti parametru

Typ:SwitchParameter
Default value:None
Podporuje zástupné znaky:False
DontShow:False
Aliasy:Wi

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

CommonParameters

Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters.

Vstupy

String

PSVirtualMachine

Výstupy

PSRunCommandResult