Köra skript på den virtuella Windows-datorn med hjälp av åtgärdsinriktade Kör kommando

Funktionen Kör kommando använder den virtuella datoragenten (VM) för att köra PowerShell-skript på en virtuell Azure Windows-dator. Du kan använda de här skripten till allmän hantering av datorer eller program. De kan hjälpa dig att snabbt diagnostisera och åtgärda problem med åtkomst till virtuella datorer och nätverk och få tillbaka den virtuella datorn till ett bra tillstånd.

Fördelar

Du kan komma åt dina virtuella datorer på flera olika sätt. Kör kommandot kan köra skript på dina virtuella datorer via fjärranslutning med hjälp av VM-agenten. Du använder Kör kommando via Azure Portal, REST API eller PowerShell för virtuella Windows-datorer.

Den här funktionen är användbar i alla scenarier där du vill köra ett skript på en virtuell dator. Det är ett av de enda sätten att felsöka och åtgärda en virtuell dator som inte har RDP- eller SSH-porten öppen på grund av felaktig nätverks- eller administrativ användarkonfiguration.

Förutsättningar

Windows OS stöds

Windows OS x64
Windows 10 Stöds
Windows 11 Stöds
Windows Server 2008 SP2 Stöds
Windows Server 2008 R2 Stöds
Windows Server 2012 Stöds
Windows Server 2012 R2 Stöds
Windows Server 2016 Stöds
Windows Server 2016 Core Stöds
Windows Server 2019 Stöds
Windows Server 2019 Core Stöds
Windows Server 2022 Stöds
Windows Server 2022 Core Stöds

Begränsningar

Följande begränsningar gäller när du använder Kör kommando:

  • Utdata är begränsade till de senaste 4 096 bytena.
  • Den minsta tiden för att köra ett skript är cirka 20 sekunder.
  • Skript körs som system på Windows.
  • Ett skript i taget kan köras.
  • Skript som frågar efter information (interaktivt läge) stöds inte.
  • Du kan inte avbryta ett skript som körs.
  • Den maximala tiden som ett skript kan köras är 90 minuter. Efter det tar tidsgränsen slut.
  • Utgående anslutning från den virtuella datorn krävs för att returnera resultatet av skriptet.
  • Vi rekommenderar inte att du kör ett skript som gör att vm-agenten stoppas eller uppdateras. Detta kan göra att tillägget hamnar i övergångstillstånd, vilket leder till en tidsgräns.

Anteckning

Kör kommandot för att fungera korrekt och kräver anslutning (port 443) till offentliga IP-adresser i Azure. Om tillägget inte har åtkomst till dessa slutpunkter kan skripten köras korrekt men inte returnera resultaten. Om du blockerar trafik på den virtuella datorn kan du använda tjänsttaggar för att tillåta trafik till offentliga IP-adresser i Azure med hjälp av taggen AzureCloud .

Funktionen Kör kommando fungerar inte om VM-agentens status inte är KLAR. Kontrollera agentstatusen i den virtuella datorns egenskaper i Azure Portal.

Tillgängliga kommandon

Den här tabellen visar listan över kommandon som är tillgängliga för virtuella Windows-datorer. Du kan använda RunPowerShellScript-kommandot för att köra alla anpassade skript som du vill. När du använder Azure CLI eller PowerShell för att köra ett kommando måste värdet som du anger för parametern --command-id eller -CommandId vara något av följande värden i listan. När du anger ett värde som inte är ett tillgängligt kommando får du följande fel:

The entity was not found in this Azure location

Namn Beskrivning
RunPowerShellScript Kör ett PowerShell-skript
DisableNLA Inaktivera autentisering på nätverksnivå
InaktiveraWindowsUpdate Inaktivera Windows Update automatisk Uppdateringar
EnableAdminAccount Kontrollerar om det lokala administratörskontot är inaktiverat och i så fall aktiverar det.
EnableEMS Aktiverar EMS
EnableRemotePS Konfigurerar datorn för att aktivera fjärr-PowerShell.
AktiveraWindowsUpdate Aktivera Windows Update automatisk Uppdateringar
Ipconfig Visar detaljerad information om IP-adressen, nätmasken och standardgatewayen för varje kort som är bundet till TCP/IP.
RDPSettings Kontrollerar registerinställningar och domänprincipinställningar. Föreslår principåtgärder om datorn är en del av en domän eller ändrar inställningarna till standardvärden.
ResetRDPCert Tar bort TLS/SSL-certifikatet som är kopplat till RDP-lyssnaren och återställer RDP-lyssnarsäkerheten till standard. Använd det här skriptet om du ser några problem med certifikatet.
SetRDPPort Anger standard- eller användardefinierad portnummer för fjärrskrivbordsanslutningar. Aktiverar brandväggsregler för inkommande åtkomst till porten.

Azure CLI

I följande exempel används kommandot az vm run-command för att köra ett gränssnittsskript på en virtuell Azure Windows-dator.

# 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"

Azure Portal

Gå till en virtuell dator i Azure Portal och välj Kör kommando på den vänstra menyn under Åtgärder. Du ser en lista över de tillgängliga kommandon som ska köras på den virtuella datorn.

Lista över kommandon

Välj ett kommando som ska köras. Vissa av kommandona kan ha valfria eller obligatoriska indataparametrar. För dessa kommandon visas parametrarna som textfält där du kan ange indatavärdena. För varje kommando kan du visa skriptet som körs genom att expandera Visa skript. RunPowerShellScript skiljer sig från de andra kommandona eftersom du kan ange ett eget anpassat skript.

Anteckning

De inbyggda kommandona kan inte redigeras.

När du har valt kommandot väljer du Kör för att köra skriptet. När skriptet har slutförts returneras utdata och eventuella fel i utdatafönstret. Följande skärmbild visar ett exempel på utdata från körning av RDPSettings-kommandot .

Köra kommandoskriptutdata

PowerShell

I följande exempel används cmdleten Invoke-AzVMRunCommand för att köra ett PowerShell-skript på en virtuell Azure-dator. Cmdleten förväntar sig att skriptet som refereras i parametern -ScriptPath ska vara lokalt där cmdleten körs.

Invoke-AzVMRunCommand -ResourceGroupName '<myResourceGroup>' -Name '<myVMName>' -CommandId 'RunPowerShellScript' -ScriptPath '<pathToScript>' -Parameter @{"arg1" = "var1";"arg2" = "var2"}

Anteckning

Parametervärden kan endast vara strängtyper och skriptet ansvarar för att konvertera dem till andra typer om det behövs.

Begränsa åtkomst till Run Command

Att visa körningskommandona eller visa information om ett kommando kräver behörighet på Microsoft.Compute/locations/runCommands/read prenumerationsnivå. Den inbyggda rollen Läsare och högre nivåer har den här behörigheten.

Det krävs behörighet för att Microsoft.Compute/virtualMachines/runCommands/write köra ett kommando. Rollen Virtuell datordeltagare och högre nivåer har den här behörigheten.

Du kan använda någon av de inbyggda rollerna eller skapa en anpassad roll för att använda Kör kommando.

Felsöka Windows-kommandot Action Run

När du felsöker åtgärdskörningskommandot för Windows-miljöer läser du loggfilen RunCommandExtension som vanligtvis finns i följande katalog: C:\WindowsAzure\Logs\Plugins\Microsoft.CPlat.Core.RunCommandWindows\<version>\RunCommandExtension.log för ytterligare information.

Kända problem

Kommandotillägget För åtgärdskörning kan inte köras i Windows-miljön om kommandot innehåller reserverade tecken. Exempel:

Om symbolen & skickas i parametern för kommandot, till exempel PowerShell-skriptet nedan, kan det misslyckas.

$paramm='abc&jj'
Invoke-AzVMRunCommand -ResourceGroupName AzureCloudService1 -Name test -CommandId 'RunPowerShellScript' -ScriptPath C:\data\228332902\PostAppConfig.ps1 -Parameter @{"Prefix" = $paramm}

^ Använd tecknet för att undkomma & i argumentet, till exempel$paramm='abc^&jj'

Körningskommandotillägget kan också misslyckas om kommandot som ska köras innehåller "\n" i sökvägen, eftersom det behandlas som en ny rad. Innehåller C:\Windows\notepad.exe\n till exempel i filsökvägen. Överväg att \n ersätta med \N i din sökväg.

Borttagning av kommando för åtgärdskörning

Om du behöver ta bort åtgärdskörningskommandots Windows-tillägg läser du stegen nedan för Azure PowerShell och CLI:

Ersätt rgname och vmname med ditt relevanta resursgruppsnamn och namn på den virtuella datorn i följande borttagningsexempel.

 Invoke-AzVMRunCommand -ResourceGroupName 'rgname' -VMName 'vmname' -CommandId 'RemoveRunCommandWindowsExtension'
az vm run-command invoke  --command-id RemoveRunCommandWindowsExtension --name vmname -g rgname

Anteckning

När du använder ett körkommando igen installeras tillägget automatiskt. Du kan använda borttagningskommandot för tillägg för att felsöka eventuella problem som rör tillägget.

Nästa steg

Mer information om andra sätt att fjärrköra skript och kommandon på den virtuella datorn finns i Köra skript på den virtuella Windows-datorn.