Scripts uitvoeren in je Windows-VM met behulp van beheerde Uitvoeropdrachten

Artikel
08/24/2024

Van toepassing op: ✔️ Flexibele schaalsets voor Windows-VM's ✔️

Belangrijk

Managed Run Command is momenteel beschikbaar in Azure CLI, PowerShell en API. De portalfunctionaliteit is binnenkort beschikbaar.

De functie Opdracht uitvoeren maakt gebruik van de VM-agent (virtuele machine) om scripts uit te voeren binnen een Azure Windows-VM. U kunt deze scripts gebruiken voor algemeen machine- of toepassingsbeheer. Ze kunnen u helpen snel vm-toegang en netwerkproblemen vast te stellen en op te lossen en de VM weer in een goede staat te krijgen.

De bijgewerkte beheerde opdracht uitvoeren maakt gebruik van hetzelfde VM-agentkanaal om scripts uit te voeren en biedt de volgende verbeteringen ten opzichte van de oorspronkelijke actie georiënteerde run-opdracht:

Ondersteuning voor de bijgewerkte Uitvoeropdracht via een ARM-implementatiesjabloon
Parallelle uitvoering van meerdere scripts
Sequentiële uitvoering van scripts
Door de gebruiker opgegeven time-outs voor scripts
Ondersteuning voor langdurige scripts (uren/dagen)
Geheimen (parameters, wachtwoorden) worden op een veilige manier doorgeven

Vereisten

Ondersteund Windows-besturingssysteem

Windows-besturingssysteem	x64
Windows 10	Ondersteund
Windows 11	Ondersteund
Windows Server 2008 SP2	Ondersteund
Windows Server 2008 R2	Ondersteund
Windows Server 2012	Ondersteund
Windows Server 2012 R2	Ondersteund
Windows Server 2016	Ondersteund
Windows Server 2016 Core	Ondersteund
Windows Server 2019	Ondersteund
Windows Server 2019 Core	Ondersteund
Windows Server 2022	Ondersteund
Windows Server 2022 Core	Ondersteund

Toegang tot Opdracht uitvoeren beperken

Voor het weergeven van de uitvoeringsopdrachten of het weergeven van de details van een opdracht is de Microsoft.Compute/locations/runCommands/read machtiging op abonnementsniveau vereist. De ingebouwde lezerrol en hogere niveaus hebben deze machtiging.

Voor het uitvoeren van een opdracht is de Microsoft.Compute/virtualMachines/runCommand/write machtiging vereist. De rol Inzender voor virtuele machines en hogere niveaus hebben deze machtiging.

U kunt een van de ingebouwde rollen gebruiken of een aangepaste rol maken om de opdracht Uitvoeren te gebruiken.

Azure-CLI

In de volgende voorbeelden wordt az vm run-command gebruikt om een shell-script uit te voeren op een Azure Windows-VM.

Een script uitvoeren met de VM

Met deze opdracht wordt het script aan de VIRTUELE machine geleverd, uitgevoerd en wordt de vastgelegde uitvoer geretourneerd.

az vm run-command create --name "myRunCommand" --vm-name "myVM" --resource-group "myRG" --script "Write-Host Hello World!"

Een lijst weergeven van alle geïmplementeerde RunCommand-resources op een VIRTUELE machine

Met deze opdracht wordt een volledige lijst met eerder geïmplementeerde run-opdrachten geretourneerd, samen met de bijbehorende eigenschappen.

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

Uitvoeringsstatus en -resultaten ophalen

Met deze opdracht wordt de huidige uitvoeringsvoortgang opgehaald, inclusief de meest recente uitvoer, de begin-/eindtijd, de afsluitcode en de terminalstatus van de uitvoering.

az vm run-command show --name "myRunCommand" --vm-name "myVM" --resource-group "myRG" --expand instanceView

Notitie

De uitvoer- en foutvelden in instanceView zijn beperkt tot de laatste 4 kB. Als u toegang wilt krijgen tot de volledige uitvoer en fout, kunt u de uitvoer- en foutgegevens doorsturen naar toevoeg-blobs voor opslag met behulp van -outputBlobUri en parameters tijdens het uitvoeren van de opdracht Uitvoeren met of Set-AzVMRunCommand Set-AzVMssRunCommand.-errorBlobUri

RunCommand-resource verwijderen van de VM

Verwijder de RunCommand-resource die eerder op de VIRTUELE machine is geïmplementeerd. Als de uitvoering van het script nog wordt uitgevoerd, wordt de uitvoering beëindigd.

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

Powershell

Een script uitvoeren met de VM

Met deze opdracht wordt het script aan de VIRTUELE machine geleverd, uitgevoerd en wordt de vastgelegde uitvoer geretourneerd.

Set-AzVMRunCommand -ResourceGroupName "myRG" -VMName "myVM" -Location "EastUS" -RunCommandName "RunCommandName" –SourceScript "echo Hello World!"

Een script uitvoeren op de VM met de parameter SourceScriptUri

OutputBlobUri en ErrorBlobUri zijn optionele parameters.

Set-AzVMRunCommand -ResourceGroupName "myRg" `
-VMName "myVM" `
-RunCommandName "RunCommandName" `
-SourceScriptUri “<SAS_URI_of_a_storage_blob_with_read_access_or_public_URI>" `
-OutputBlobUri “<SAS_URI_of_a_storage_append_blob_with_read_add_create_write_access>" `
-ErrorBlobUri “<SAS_URI_of_a_storage_append_blob_with_read_add_create_write_access>”

Een lijst weergeven van alle geïmplementeerde RunCommand-resources op een VIRTUELE machine

Met deze opdracht wordt een volledige lijst met eerder geïmplementeerde run-opdrachten geretourneerd, samen met de bijbehorende eigenschappen.

Get-AzVMRunCommand -ResourceGroupName "myRG" -VMName "myVM"

Uitvoeringsstatus en -resultaten ophalen

Met deze opdracht wordt de huidige uitvoeringsvoortgang opgehaald, inclusief de meest recente uitvoer, de begin-/eindtijd, de afsluitcode en de terminalstatus van de uitvoering.

Get-AzVMRunCommand -ResourceGroupName "myRG" -VMName "myVM" -RunCommandName "RunCommandName" -Expand InstanceView

Opdracht Uitvoeren op een virtuele machine maken of bijwerken met behulp van SourceScriptUri (SAS-URL voor opslagblob)

Opdracht Uitvoeren op een Windows-VM maken of bijwerken met behulp van een SAS-URL van een opslagblob die een PowerShell-script bevat. SourceScriptUri kan de volledige SAS-URL of openbare URL van een opslagblob zijn.

Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVMEE -RunCommandName MyRunCommand -Location EastUS2EUAP -SourceScriptUri <SourceScriptUri>

Notitie

SAS-URL moet leestoegang bieden tot de blob. Er wordt een verlooptijd van 24 uur voorgesteld voor de SAS-URL. SAS-URL's kunnen worden gegenereerd in Azure Portal met behulp van de opties van blob of sas-token met behulp van New-AzStorageBlobSASToken. Als u een SAS-token genereert met behulp van New-AzStorageBlobSASToken, uw SAS-URL = "basis-blob-URL" + "?" + "SAS-token van New-AzStorageBlobSASToken"

Een opdrachtexemplarenweergave voor een VIRTUELE machine ophalen na het maken of bijwerken van de opdracht Uitvoeren

Haal een opdracht voor uitvoeren op voor vm's met exemplaarweergave. De exemplaarweergave bevat de uitvoeringsstatus van de opdracht Uitvoeren (Geslaagd, Mislukt, enzovoort), afsluitcode, standaarduitvoer en standaardfout die wordt gegenereerd door het script uit te voeren met behulp van De opdracht Uitvoeren. Een niet-nul ExitCode geeft een mislukte uitvoering aan.

$x = Get-AzVMRunCommand -ResourceGroupName MyRG -VMName MyVM -RunCommandName MyRunCommand -Expand InstanceView
$x.InstanceView

Voorbeelduitvoer

ExecutionState   : Succeeded
ExecutionMessage :
ExitCode         : 0
Output           :   
output       : uid=0(root) gid=0(root) groups=0(root)
                   HelloWorld

Error            :
StartTime        : 10/27/2022 9:10:52 PM
EndTime          : 10/27/2022 9:10:55 PM
Statuses         :

InstanceView.ExecutionState: Status van het script Opdracht uitvoeren van de gebruiker. Raadpleeg deze status om te weten of uw script al dan niet is geslaagd. ProvisioningState: Status van het inrichten van algemene extensies end-to-end (of het extensieplatform het uitvoeren van een opdrachtscript kon activeren of niet).

Opdracht Uitvoeren op een virtuele machine maken of bijwerken met ScriptLocalPath (lokaal scriptbestand)

Maak of werk de opdracht Uitvoeren op een VIRTUELE machine bij met behulp van een lokaal scriptbestand dat zich op de clientcomputer bevindt waarop de cmdlet wordt uitgevoerd.

Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVMEE -RunCommandName MyRunCommand -Location EastUS2EUAP -ScriptLocalPath "C:\MyScriptsDir\MyScript.ps1"

Opdracht Uitvoeren op een virtuele machine maken of bijwerken met behulp van SourceScript (scripttekst)

Maak of werk de opdracht Uitvoeren bij op een VIRTUELE machine die de scriptinhoud rechtstreeks doorgeeft aan de parameter -SourceScript. Gebruiken ; om meerdere opdrachten te scheiden

Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVML -RunCommandName MyRunCommand2 -Location EastUS2EUAP -SourceScript "id; echo HelloWorld"

Opdracht Uitvoeren op een virtuele machine maken of bijwerken met behulp van SourceCommandId

Maak of werk de opdracht Uitvoeren op een virtuele machine bij met behulp van een bestaande commandId. Beschikbare commandIds kunnen worden opgehaald met Get-AzVMRunCommandDocument.

Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVMEE -RunCommandName MyRunCommand -Location EastUS2EUAP -SourceCommandId DisableWindowsUpdate

Opdracht Uitvoeren op een VIRTUELE machine maken of bijwerken met behulp van OutputBlobUri, ErrorBlobUri om standaarduitvoer en standaardfoutberichten te streamen naar uitvoer en fout Toevoeg-blobs

Opdracht Uitvoeren maken of bijwerken op een virtuele machine en standaarduitvoer en standaardfoutberichten streamen naar uitvoer en fout Toevoeg-blobs.

Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVML -RunCommandName MyRunCommand3 -Location EastUS2EUAP -ScriptLocalPath "C:\MyScriptsDir\MyScript.ps1" -OutputBlobUri <OutPutBlobUrI> -ErrorBlobUri "ErrorBlobUri

Notitie

De uitvoer- en fout-blobs moeten het type AppendBlob zijn en de BIJBEHORENDE SAS-URL's moeten lees-, toevoeg-, create-, schrijftoegang tot de blob bieden. Er wordt een verlooptijd van 24 uur voorgesteld voor de SAS-URL. Als de uitvoer- of foutblob niet bestaat, wordt er een blob van het type AppendBlob gemaakt. SAS-URL's kunnen worden gegenereerd in Azure Portal met behulp van de opties van blob of sas-token van het gebruik New-AzStorageBlobSASToken.

Run Command maken of bijwerken op een virtuele machine als een andere gebruiker met behulp van RunAsUser- en RunAsPassword-parameters

Opdracht Uitvoeren op een virtuele machine maken of bijwerken als een andere gebruiker met behulp van RunAsUser en RunAsPassword parameters. Neem contact op met de beheerder van de VM en zorg ervoor dat de gebruiker op de VM wordt toegevoegd, heeft de gebruiker toegang tot resources die toegankelijk zijn via de opdracht Uitvoeren (mappen, bestanden, netwerk, enzovoort) en in het geval van windows-VM wordt de secundaire aanmeldingsservice op de VM uitgevoerd.

Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVMEE -RunCommandName MyRunCommand -Location EastUS2EUAP -ScriptLocalPath "C:\MyScriptsDir\MyScript.ps1" -RunAsUser myusername -RunAsPassword mypassword

Opdracht Uitvoeren maken of bijwerken op een virtuele-machineschaalsetresource met behulp van SourceScriptUri (SAS-URL voor opslagblob)

Maak of werk de opdracht Uitvoeren bij op een Windows Virtual Machine Scale Sets-resource met behulp van een SAS-URL van een opslagblob die een PowerShell-script bevat.

Set-AzVmssVMRunCommand -ResourceGroupName MyRG0 -VMScaleSetName MyVMSS -InstanceId 0 -RunCommandName MyRunCommand -Location EastUS2EUAP -SourceScriptUri <SourceScriptUri>

Notitie

SAS-URL moet leestoegang bieden tot de blob. Er wordt een verlooptijd van 24 uur voorgesteld voor de SAS-URL. SAS-URL's kunnen worden gegenereerd in Azure Portal met behulp van de opties van blob of sas-token met behulp van New-AzStorageBlobSASToken. Als u sas-token genereert met behulp van New-AzStorageBlobSASToken, is de SAS-URL-indeling: basis-blob-URL + "?" + het SAS-token van New-AzStorageBlobSASToken.

Opdracht Uitvoeren maken of bijwerken op een VM-exemplaar met parameter- en ProtectedParameter-parameters (openbare en beveiligde parameters voor script)

Gebruik ProtectedParameter om gevoelige invoer door te geven aan scripts, zoals wachtwoorden, sleutels, enzovoort.

$PublicParametersArray = @([Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20210701.IRunCommandInputParameter]@{name='publicParam1';value='publicParam1value'},
>> [Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20210701.IRunCommandInputParameter]@{name='publicParam2';value='publicParam2value'})

$ProtectedParametersArray = @([Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20210701.IRunCommandInputParameter]@{name='secret1';value='secret1value'},
>> [Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20210701.IRunCommandInputParameter]@{name='secret2';value='secret2value'})

Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVMEE -RunCommandName MyRunCommand -Location EastUS2EUAP -SourceScriptUri <SourceScriptUri> -Parameter $PublicParametersArray -ProtectedParameter $ProtectedParametersArray

Windows: Parameters en ProtectedParameters worden doorgegeven aan het script als argumenten worden doorgegeven aan het script en als volgt worden uitgevoerd - myscript.ps1 -publicParam1 publicParam1value -publicParam2 publicParam2value -secret1 secret1value -secret2 secret2value
Linux: Benoemde parameters en de bijbehorende waarden worden ingesteld op omgevingsconfiguratie, die toegankelijk moet zijn binnen het .sh script. Geef voor argumenten zonder naam een lege tekenreeks door om invoer een naam te geven. Naamloze argumenten worden doorgegeven aan scripts en worden als volgt uitgevoerd - myscript.sh publicParam1value publicParam2value secret1value secret2value

RunCommand-resource verwijderen van de VM

Verwijder de RunCommand-resource die eerder op de VIRTUELE machine is geïmplementeerd. Als de uitvoering van het script nog wordt uitgevoerd, wordt de uitvoering beëindigd.

Remove-AzVMRunCommand -ResourceGroupName "myRG" -VMName "myVM" -RunCommandName "RunCommandName"

REST-API

Als u een nieuwe run-opdracht wilt implementeren, voert u rechtstreeks een PUT uit op de virtuele machine en geeft u een unieke naam op voor het exemplaar van de opdracht Uitvoeren.

PUT /subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.Compute/virtualMachines/<vmName>/runcommands/<runCommandName>?api-version=2023-03-01

{ 
"location": "<location>", 
"properties": { 
    "source": { 
        "script": "Write-Host Hello World!", 
        "scriptUri": "<SAS URI of a storage blob with read access or public URI>",  
        "commandId": "<Id>"  
        }, 
    "parameters": [ 
        { 
            "name": "param1",
            "value": "value1" 
            }, 
        { 
            "name": "param2", 
            "value": "value2" 
            } 
        ], 
    "protectedParameters": [ 
        { 
            "name": "secret1", 
            "value": "value1" 
            }, 
        { 
            "name": "secret2", 
            "value": "value2" 
            } 
        ], 
    "runAsUser": "userName",
    "runAsPassword": "userPassword", 
    "timeoutInSeconds": 3600,
    "treatFailureAsDeploymentFailure": true,
    "outputBlobUri": "< SAS URI of a storage append blob with read, add, create, write access>", 
    "errorBlobUri": "< SAS URI of a storage append blob with read, add, create, write access >"  
    }
}

Opmerkingen

U kunt een inlinescript, een script-URI of een ingebouwde scriptopdracht-id opgeven als invoerbron. Script-URI is een SAS-URI voor opslagblob met leestoegang of openbare URI.
Er wordt slechts één type broninvoer ondersteund voor één opdrachtuitvoering.
Vanaf API-versie 2023-03-01 kunt u de eigenschap treatFailureAsDeploymentFailure instellen op waar , waardoor de implementatie mislukt wanneer er een fout in het script optreedt. Als deze optie is ingesteld op false, geeft ProvisioningState alleen weer of de run-opdracht al dan niet is uitgevoerd door het uitbreidingsplatform. Het geeft niet aan of het script is mislukt in het geval van scriptfouten.
Run Command ondersteunt het schrijven van uitvoer en fouten naar Opslag-blobs met behulp van de parameters outputBlobUri en errorBlobUri, die kunnen worden gebruikt voor het opslaan van grote scriptuitvoer. Gebruik de SAS-URI van een toevoeg-blob voor opslag met lees-, add-, create-, write-toegang. De blob moet van het type AppendBlob zijn. Het schrijven van de scriptuitvoer of fout-blob mislukt anders. De blob wordt overschreven als deze al bestaat. Deze wordt gemaakt als deze niet bestaat.

Actieve exemplaren van De opdracht Uitvoeren op een VIRTUELE machine weergeven

GET /subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.Compute/virtualMachines/<vmName>/runcommands?api-version=2023-03-01

Uitvoerdetails ophalen voor een specifieke implementatie van de opdracht Uitvoeren

GET /subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.Compute/virtualMachines/<vmName>/runcommands/<runCommandName>?$expand=instanceView&api-version=2023-03-01

Een specifieke implementatie van een opdracht uitvoeren verwijderen

U kunt ook het exemplaar van De opdracht Uitvoeren verwijderen.

DELETE /subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.Compute/virtualMachines/<vmName>/runcommands/<runCommandName>?api-version=2023-03-01

Scripts implementeren in een geordende volgorde

Als u scripts opeenvolgend wilt implementeren, gebruikt u een implementatiesjabloon en geeft u een dependsOn relatie op tussen sequentiële scripts.

{ 
    "type": "Microsoft.Compute/virtualMachines/runCommands", 
    "name": "secondRunCommand", 
    "apiVersion": "2019-12-01", 
    "location": "[parameters('location')]", 
    "dependsOn": <full resourceID of the previous other Run Command>, 
    "properties": { 
        "source": {  
            "script": "Write-Host Hello World!"  
        }, 
        "timeoutInSeconds": 60  
    }
}

Meerdere run-opdrachten sequentieel uitvoeren

Als u standaard meerdere RunCommand-resources implementeert met behulp van een implementatiesjabloon, worden deze gelijktijdig uitgevoerd op de virtuele machine. Als u afhankelijk bent van de scripts en een voorkeursvolgorde van uitvoering, kunt u de dependsOn eigenschap gebruiken om ze opeenvolgend uit te voeren.

In dit voorbeeld wordt secondRunCommand uitgevoerd na firstRunCommand.

{
   "$schema":"https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
   "contentVersion":"1.0.0.0",
   "resources":[
      {
         "type":"Microsoft.Compute/virtualMachines/runCommands",
         "name":"[concat(parameters('vmName'),'/firstRunCommand')]",
         "apiVersion":"2023-03-01",
         "location":"[parameters('location')]",
         "dependsOn":[
            "[concat('Microsoft.Compute/virtualMachines/', parameters('vmName'))]"
         ],
         "properties":{
            "source":{
               "script":"Write-Host First: Hello World!"
            },
            "parameters":[
               {
                  "name":"param1",
                  "value":"value1"
               },
               {
                  "name":"param2",
                  "value":"value2"
               }
            ],
            "timeoutInSeconds":20
         }
      },
      {
         "type":"Microsoft.Compute/virtualMachines/runCommands",
         "name":"[concat(parameters('vmName'),'/secondRunCommand')]",
         "apiVersion":"2019-12-01",
         "location":"[parameters('location')]",
         "dependsOn":[
            "[concat('Microsoft.Compute/virtualMachines/', parameters('vmName'),'runcommands/firstRunCommand')]"
         ],
         "properties":{
            "source":{
               "scriptUri":"http://github.com/myscript.ps1"
            },
            "timeoutInSeconds":60
         }
      }
   ]
}

Volgende stappen

Zie Scripts uitvoeren op uw Windows-VM voor meer informatie over andere manieren om scripts en opdrachten op afstand uit te voeren op uw virtuele machine.

Delen via

Scripts uitvoeren in je Windows-VM met behulp van beheerde Uitvoeropdrachten

Vereisten

Ondersteund Windows-besturingssysteem

Toegang tot Opdracht uitvoeren beperken

Azure-CLI

Een script uitvoeren met de VM

Een lijst weergeven van alle geïmplementeerde RunCommand-resources op een VIRTUELE machine

Uitvoeringsstatus en -resultaten ophalen

RunCommand-resource verwijderen van de VM

Powershell

Een script uitvoeren met de VM

Een script uitvoeren op de VM met de parameter SourceScriptUri

Een lijst weergeven van alle geïmplementeerde RunCommand-resources op een VIRTUELE machine

Uitvoeringsstatus en -resultaten ophalen

Opdracht Uitvoeren op een virtuele machine maken of bijwerken met behulp van SourceScriptUri (SAS-URL voor opslagblob)

Een opdrachtexemplarenweergave voor een VIRTUELE machine ophalen na het maken of bijwerken van de opdracht Uitvoeren

Opdracht Uitvoeren op een virtuele machine maken of bijwerken met ScriptLocalPath (lokaal scriptbestand)

Opdracht Uitvoeren op een virtuele machine maken of bijwerken met behulp van SourceScript (scripttekst)

Opdracht Uitvoeren op een virtuele machine maken of bijwerken met behulp van SourceCommandId

Opdracht Uitvoeren op een VIRTUELE machine maken of bijwerken met behulp van OutputBlobUri, ErrorBlobUri om standaarduitvoer en standaardfoutberichten te streamen naar uitvoer en fout Toevoeg-blobs

Run Command maken of bijwerken op een virtuele machine als een andere gebruiker met behulp van RunAsUser- en RunAsPassword-parameters

Opdracht Uitvoeren maken of bijwerken op een virtuele-machineschaalsetresource met behulp van SourceScriptUri (SAS-URL voor opslagblob)

Opdracht Uitvoeren maken of bijwerken op een VM-exemplaar met parameter- en ProtectedParameter-parameters (openbare en beveiligde parameters voor script)

RunCommand-resource verwijderen van de VM

REST-API

Opmerkingen

Actieve exemplaren van De opdracht Uitvoeren op een VIRTUELE machine weergeven

Uitvoerdetails ophalen voor een specifieke implementatie van de opdracht Uitvoeren

Een specifieke implementatie van een opdracht uitvoeren verwijderen

Scripts implementeren in een geordende volgorde

Meerdere run-opdrachten sequentieel uitvoeren

Volgende stappen

Feedback

Aanvullende resources