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

La fonctionnalité Run Command utilise l’agent de machine virtuelle pour exécuter des scripts PowerShell au sein d’une machine virtuelle Windows Azure. Vous pouvez utiliser ces scripts pour la gestion générale des ordinateurs ou des applications. Ils peuvent vous aider à diagnostiquer et corriger rapidement les problèmes de réseau et d’accès aux machines virtuelles et à rétablir l’état de la machine virtuelle.

Avantages

Vous pouvez accéder à vos machines virtuelles de plusieurs façons. Run Command peut exécuter à distance des scripts sur vos machines virtuelles à l’aide de l’agent de machine virtuelle. Vous utilisez Run Command par le biais du Portail Azure, de l’API REST ou de PowerShell pour machines virtuelles Windows.

Cette fonctionnalité est utile dans tous les scénarios où vous souhaitez exécuter un script sur une machine virtuelle. C’est l’une des seules manières de détecter et de corriger un problème sur une machine virtuelle qui n’a pas de port RDP ou SSH ouvert en raison d’une configuration incorrecte du réseau ou de l’utilisateur administratif.

Prérequis

Systèmes d’exploitation Windows pris en charge

Restrictions

Les restrictions suivantes s’appliquent lorsque vous utilisez Run Command :

• La sortie est limitée aux derniers 4 096 octets.
• La durée minimale d’exécution d’un script est d’environ 20 secondes.
• Les scripts s’exécutent en tant que système sous Windows.
• Vous ne pouvez exécuter qu’un script à la fois.
• Les scripts qui demandent des informations (mode interactif) ne sont pas pris en charge.
• Vous ne pouvez pas annuler un script en cours d’exécution.
• La durée maximale d’exécution d’un script est de 90 minutes. Le script expire après ce délai.
• Une connectivité sortante à partir de la machine virtuelle est nécessaire pour retourner les résultats du script.
• Il n’est pas recommandé d’exécuter un script qui provoquera l’arrêt ou la mise à jour de l’agent de machine virtuelle. Cela peut maintenir l’extension dans un état de transition, ce qui peut entraîner une expiration du délai d’attente.

Commandes disponibles

Ce tableau affiche la liste des commandes disponibles pour les machines virtuelles Windows. Vous pouvez utiliser la commande RunPowerShellScript pour exécuter n’importe quel script personnalisé de votre choix. Quand vous utilisez Azure CLI ou PowerShell pour exécuter une commande, la valeur que vous fournissez pour le paramètre --command-id ou -CommandId doit être l’une des valeurs listées ci-dessous. Quand vous spécifiez une valeur qui n’est pas une commande disponible, vous recevez cette erreur :

The entity was not found in this Azure location

Commandes disponibles

Limitation de l’accès à la commande Run

Le listage des commandes d’exécution ou l’affichage des détails d’une commande nécessite l’autorisation Microsoft.Compute/locations/runCommands/read au niveau de l’abonnement. Le rôle intégré Lecteur et les niveaux supérieurs disposent de cette autorisation.

L’exécution d’une commande nécessite l’autorisation Microsoft.Compute/virtualMachines/runCommand/action. Le rôle Contributeur de machines virtuelles et les niveaux supérieurs disposent de cette autorisation.

Vous pouvez utiliser un des rôles intégrés ou créer un rôle personnalisé afin d’exécuter Run Command.

Utilisation des commandes d’exécution

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

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

Résolution des problèmes rencontrés avec Action Run Command dans Windows

Pour résoudre des problèmes rencontrés avec Action Run Command dans les environnements Windows, examinez les détails du fichier journal RunCommandExtension, qui se trouve généralement dans le répertoire suivant : C:\WindowsAzure\Logs\Plugins\Microsoft.CPlat.Core.RunCommandWindows\<version>\RunCommandExtension.log

Problèmes connus

• L’extension Action Run Command peut échouer à s’exécuter dans votre environnement Windows si la commande contient des caractères réservés. Exemple :

  Si le symbole & est passé dans le paramètre de la commande, comme dans le script PowerShell ci-dessous, l’exécution peut échouer.

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

  Utilisez le caractère ^ pour placer & en échappement dans l’argument. Par exemple : $paramm='abc^&jj'

• L’extension Run Command peut également ne pas s’exécuter si la commande à exécuter contient « \n » dans le chemin. Dans ce cas, elle sera traitée comme une nouvelle ligne. Par exemple, C:\Windows\notepad.exe contient \n dans le chemin du fichier. Prévoyez de remplacer \n par \N dans le chemin.

• Vérifiez que vous n’avez pas de paramètre personnalisé dans la de clé de Registre HKLM\SOFTWARE\Microsoft\Command Processor\AutoRun (détaillée ici). Cela peut se déclencher pendant l’installation de l’extension RunCommand ou activer des phases et provoquer une erreur telle que « XYZ n’est pas reconnu comme une commande interne ou externe, un programme opérable ou un fichier batch ».

Suppression de l’extension Run Command orientée action

Si vous devez supprimer l’extension Windows Action Run Command, reportez-vous aux étapes ci-dessous pour la procédure avec Azure PowerShell et l’interface CLI :

Dans les exemples de suppression suivants, remplacez rgname et vmname par le nom de votre groupe de ressources et celui de votre machine virtuelle, respectivement.

 Invoke-AzVMRunCommand -ResourceGroupName 'rgname' -VMName 'vmname' -CommandId 'RemoveRunCommandWindowsExtension'

az vm run-command invoke  --command-id RemoveRunCommandWindowsExtension --name vmname -g rgname

Étapes suivantes

Pour en savoir plus sur les autres méthodes pour exécuter à distance des commandes et des scripts dans votre machine virtuelle, consultez Exécuter des scripts dans votre machine virtuelle Windows.