Exécuter des scripts dans votre machine virtuelle Windows à l’aide de commandes d’exécution managées

Exécuter un script avec la machine virtuelle

Cette commande remet le script à la machine virtuelle, l’exécute et retourne la sortie capturée.

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

Exécuter un script sur la machine virtuelle à l’aide du paramètre SourceScriptUri

OutputBlobUri et ErrorBlobUri sont des paramètres facultatifs.

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>”

Exécuter Run Command en exécution durable sur une machine virtuelle

Le temps d’exécution doit être supérieur au délai d’expiration par défaut de 90 minutes. Il doit s’exécuter pendant 100 minutes (voir le paramètre TimeoutInSecond défini sur 6000 secondes) à condition que le script s’exécute aussi longtemps. Après 100 minutes, l’exécution du script doit s’arrêter.

Set-AzVMRunCommand -ResourceGroupName MyRG -VMName MyVM -RunCommandName MyRunCommand -Location EastUS2EUAP -SourceScriptUri <SourceScriptUri> -AsyncExecution -TimeoutInSecond 6000

Répertorier toutes les ressources RunCommand déployées sur une machine virtuelle

Cette commande retourne une liste complète des commandes Run Command précédemment déployées, ainsi que leurs propriétés.

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

Obtenir l’état et les résultats de l’exécution

Cette commande permet de récupérer la progression de l’exécution actuelle, y compris la dernière sortie, l’heure de début/fin, le code de sortie et l’état terminal de l’exécution.

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

Créer ou mettre à jour Run Command sur une machine virtuelle à l’aide de SourceScriptUri (URL SAS d’objet blob de stockage)

Créez ou mettez à jour Run Command sur une machine virtuelle Windows à l’aide d’une URL SAP d’un objet blob de stockage qui contient un script PowerShell. SourceScriptUri peut être l’URL SAP complète ou l’URL publique d’un objet blob de stockage.

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

Obtenir une vue d’instance Run Command pour une machine virtuelle après la création ou la mise à jour de Run Command

Obtenir une Run Command pour une machine virtuelle avec la vue Instance. La vue d’instance contient l’état d’exécution de la commande d’exécution (Réussite, Échec, etc.), le code de sortie, la sortie standard et l’erreur standard générées en exécutant le script à l’aide de la commande Exécuter. Un code d’arrêt (ExitCode) différent de zéro indique une exécution échouée.

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

Exemple de sortie

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 : État du script Run Command de l’utilisateur. Reportez-vous à cet état pour savoir si votre script a réussi ou non. ProvisioningState : état de l’approvisionnement général des extensions de bout en bout (si la plateforme d’extension a pu déclencher ou non le script Run Command).

Créer ou mettre à jour Run Command sur une machine virtuelle à l’aide de ScriptLocalPath (fichier de script local)

Créez ou mettez à jour Run Command sur une machine virtuelle à l’aide d’un fichier de script local qui se trouve sur l’ordinateur client où la cmdlet est exécutée.

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

Créer ou mettre à jour Run Command exécution sur une machine virtuelle à l’aide de SourceScript (texte de script)

Créez ou mettez à jour Run Command sur une machine virtuelle en passant le contenu du script directement au paramètre -SourceScript. Utiliser ; pour séparer plusieurs commandes

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

Créer ou mettre à jour Run Command sur une machine virtuelle à l’aide de SourceCommandId

Créez ou mettez à jour une commande d’exécution sur une machine virtuelle à l’aide de commandId préexistant. Les commandId disponibles peuvent être récupérés à l’aide de Get-AzVMRunCommandDocument.

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

Créer ou mettre à jour Run Command sur une machine virtuelle à l’aide de OutputBlobUri, ErrorBlobUri pour diffuser en continu des messages d’erreur standard et de sortie standard vers des objets blob Ajouter de sortie et d’erreurs

Créez ou mettez à jour Run Command sur une machine virtuelle pour diffuser en continu des messages d’erreur standard vers des objets blob Ajouter de sortie et d’erreurs.

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

Créer ou mettre à jour Run Command sur une machine virtuelle en tant qu’utilisateur différent à l’aide des paramètres RunAsUser et RunAsPassword

Créez ou mettez à jour Run Command sur une machine virtuelle en tant qu’utilisateur différent à l’aide des paramètres RunAsUser et RunAsPassword. Pour que RunAs fonctionne correctement, contactez l’administrateur de la machine virtuelle et vérifiez que l’utilisateur est ajouté sur la machine virtuelle, qu’il a accès aux ressources accessibles par Run Command (répertoires, fichiers, réseau, etc.) et, dans le cas d’une machine virtuelle Windows, que le service « Ouverture de session secondaire » est en cours d’exécution sur la machine virtuelle.

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

Créer ou mettre à jour Run Command sur une ressource Virtual Machine Scale Sets à l’aide de SourceScriptUri (URL SAS d’objet blob de stockage)

Créez ou mettez à jour Run Command sur une ressource Virtual Machine Scale Sets Windows à l’aide d’une URL SAP d’un objet blob de stockage qui contient un script PowerShell.

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

Créer ou mettre à jour Run Command sur une instance de machine virtuelle à l’aide des paramètres Parameter et ProtectedParameter (paramètres publics et protégés pour le script)

Utilisez ProtectedParameter pour passer toutes les entrées sensibles au script, comme les mots de passe, les clés, etc.

$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 et ProtectedParameters sont passés au script en tant qu’arguments et s’exécutent comme suit : myscript.ps1 -publicParam1 publicParam1value -publicParam2 publicParam2value -secret1 secret1value -secret2 secret2value

• Linux : Les paramètres nommés et leurs valeurs sont définis sur la configuration de l’environnement, qui doit être accessible dans le script .sh. Pour les arguments sans nom, passez une chaîne vide pour nommer l’entrée. Les arguments sans nom sont passés au script et s’exécutent comme suit : myscript.sh publicParam1value publicParam2value secret1value secret2value

Supprimer la ressource RunCommand de la machine virtuelle

Supprimez la ressource RunCommand précédemment déployée sur la machine virtuelle. Si l’exécution du script est toujours en cours, l’exécution se termine.

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

Les exemples suivants utilisent la commande az vm run-command pour exécuter un script d’environnement d’exécution sur une machine virtuelle Windows Azure.

Exécuter un script avec la machine virtuelle

Cette commande remet le script à la machine virtuelle, l’exécute et retourne la sortie capturée.

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

Répertorier toutes les ressources RunCommand déployées sur une machine virtuelle

Cette commande retourne une liste complète des commandes Run Command précédemment déployées, ainsi que leurs propriétés.

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

Obtenir l’état et les résultats de l’exécution

Cette commande permet de récupérer la progression de l’exécution actuelle, y compris la dernière sortie, l’heure de début/fin, le code de sortie et l’état terminal de l’exécution.

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

Supprimer la ressource RunCommand de la machine virtuelle

Supprimez la ressource RunCommand précédemment déployée sur la machine virtuelle. Si l’exécution du script est toujours en cours, l’exécution se termine.

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

Pour déployer une nouvelle commande Run Command, exécutez une commande PUT directement sur la machine virtuelle et spécifiez un nom unique pour l’instance Run Command.

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

Remarques

• Vous pouvez fournir un script inline, un URI de script ou un ID de commande de script intégré en tant que source d’entrée. L'URI de script est soit un URI SAS d'un objet blob de stockage avec accès en lecture, soit un URI public.
• Un seul type d’entrée source est pris en charge pour une exécution de commande.
• À partir de l'API version 2023-03-01, vous pouvez définir la propriété treatFailureAsDeploymentFailure sur true, provoquant l'échec du déploiement en cas d'échec dans le script. S'il est défini sur faux, ProvisioningState indique uniquement si la commande d'exécution a été exécutée ou non par la plate-forme d'extensions. Il n'indiquerait pas si le script a échoué en cas d'échecs de script.
• Run Command prend en charge l’écriture de la sortie et de l’erreur dans les objets blob de stockage à l’aide des paramètres outputBlobUri et errorBlobUri, qui permettent de stocker les sorties de script volumineuses. Utilisez l’URI SAS d’un objet blob d’ajout au stockage disposant d’un accès pour les opérations de lecture, d’ajout, de création et d’écriture. L’objet blob doit être de type AppendBlob. Sinon, l’écriture de la sortie du script ou de l’objet blob d’erreur échoue. L’objet blob est remplacé, s’il existe déjà. Il sera créé s'il n'existe pas.

Répertorier les instances en cours d’exécution de la commande Run Command sur une machine virtuelle

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

Obtenir les détails de sortie d’un déploiement Run Command spécifique

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

Supprimer un déploiement Run Command spécifique

Vous pouvez également supprimer l’instance Run Command.

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

Déployer des scripts dans une séquence ordonnée

Pour déployer des scripts de manière séquentielle, utilisez un modèle de déploiement, en spécifiant une relation dependsOn entre les scripts séquentiels.

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