Partager via

Set-AzVMRunCommand

  • Référence
Module:
Az.Compute

Opération de création ou de mise à jour de la commande d’exécution.

Syntaxe

Set-AzVMRunCommand
   -ResourceGroupName <String>
   -RunCommandName <String>
   -VMName <String>
   [-SubscriptionId <String>]
   -Location <String>
   [-AsyncExecution]
   [-ErrorBlobManagedIdentityClientId <String>]
   [-ErrorBlobManagedIdentityObjectId <String>]
   [-ErrorBlobUri <String>]
   [-OutputBlobManagedIdentityClientId <String>]
   [-OutputBlobManagedIdentityObjectId <String>]
   [-OutputBlobUri <String>]
   [-Parameter <IRunCommandInputParameter[]>]
   [-ProtectedParameter <IRunCommandInputParameter[]>]
   [-RunAsPassword <String>]
   [-RunAsUser <String>]
   [-ScriptUriManagedIdentityClientId <String>]
   [-ScriptUriManagedIdentityObjectId <String>]
   [-SourceCommandId <String>]
   [-SourceScript <String>]
   [-SourceScriptUri <String>]
   [-Tag <Hashtable>]
   [-TimeoutInSecond <Int32>]
   [-TreatFailureAsDeploymentFailure]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzVMRunCommand
   -ResourceGroupName <String>
   -RunCommandName <String>
   -VMName <String>
   [-SubscriptionId <String>]
   -Location <String>
   [-AsyncExecution]
   [-ErrorBlobManagedIdentityClientId <String>]
   [-ErrorBlobManagedIdentityObjectId <String>]
   [-ErrorBlobUri <String>]
   [-OutputBlobManagedIdentityClientId <String>]
   [-OutputBlobManagedIdentityObjectId <String>]
   [-OutputBlobUri <String>]
   [-Parameter <IRunCommandInputParameter[]>]
   [-ProtectedParameter <IRunCommandInputParameter[]>]
   [-RunAsPassword <String>]
   [-RunAsUser <String>]
   [-ScriptUriManagedIdentityClientId <String>]
   [-ScriptUriManagedIdentityObjectId <String>]
   [-Tag <Hashtable>]
   [-TimeoutInSecond <Int32>]
   [-TreatFailureAsDeploymentFailure]
   -ScriptLocalPath <String>
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Opération de création ou de mise à jour de la commande d’exécution.

Exemples

Exemple 1 : Créer ou mettre à jour une commande d’exécution sur une machine virtuelle à l’aide d’une URL SAP d’objet blob de stockage

Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVMEE -RunCommandName MyRunCommand -Location EastUS2EUAP -SourceScriptUri "https://myst.blob.core.windows.net/mycontainer/myscript.ps1?sp=r&st=2022-10-27T21:02:35Z&se=2022-10-28T05:02:35Z&spr=https&sv=2021-06-08&sr=b&sig=0I%2FIiYayRwHasfasasfdasdfasdeTsQjLnpZjA%3D"

Location      Name         Type
--------      ----         ----
eastus2euap   MyRunCommand Microsoft.Compute/virtualMachines/runCommands

Créez ou mettez à jour une commande d’exécution sur une machine virtuelle Windows à l’aide d’une URL SAP d’un objet blob de stockage qui contient un script .ps1. Remarque : L’URL SAP doit fournir un accès en lecture à l’objet blob. Un délai d’expiration de 24 heures est suggéré pour l’URL SAS. Les URL SAS peuvent être générées sur Portail Azure à l’aide des options de l’objet blob ou du jeton SAP à l’aide de New-AzStorageBlobSASToken. Si vous générez un jeton SAS à l’aide de New-AzStorageBlobSASToken, votre URL SAS = URL d’objet blob de base + « ? » + jeton SAS de New-AzStorageBlobSASToken.

Exemple 2 : Créer ou mettre à jour une commande d’exécution sur une machine virtuelle à l’aide d’un fichier de script local.

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

Location      Name         Type
--------      ----         ----
eastus2euap   MyRunCommand Microsoft.Compute/virtualMachines/runCommands

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.

Exemple 3 : Créer ou mettre à jour une commande d’exécution sur une machine virtuelle à l’aide du texte de script.

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

Location      Name          Type
--------      ----          ----
eastus2euap   MyRunCommand2 Microsoft.Compute/virtualMachines/runCommands

Créez ou mettez à jour Run Command sur une machine virtuelle en passant le contenu du script directement au paramètre -SourceScript. Utilisez « ; » pour délimiter plusieurs commandes.

Exemple 4 : Créer ou mettre à jour une commande d’exécution sur une machine virtuelle à l’aide de commandId.

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

Location      Name         Type
--------      ----         ----
eastus2euap   MyRunCommand Microsoft.Compute/virtualMachines/runCommands

Créez ou mettez à jour Run Command sur une machine virtuelle à l’aide de commandId. Les commandId disponibles peuvent être récupérés à l’aide de Get-AzVMRunCommandDocument.

Exemple 5 : Créer ou mettre à jour une commande d’exécution sur une machine virtuelle et diffuser des messages d’erreur standard et des messages d’erreur standard pour générer et ajouter des objets blob.

Set-AzVMRunCommand -ResourceGroupName MyRG0 -VMName MyVML -RunCommandName MyRunCommand3 -Location EastUS2EUAP -ScriptLocalPath "C:\MyScriptsDir\MyScript.ps1" -OutputBlobUri "https://vivst.blob.core.windows.net/vivcontainer/output.txt?sp=racw&st=2022-10-27T22:18:36Z&se=2022-10-28T06:18:36Z&spr=https&sv=2021-06-08&sr=b&sig=HQAu3Bl%2BKMofYTjMo8o5hasfadsfasdF4jIkRJra4S5FlEo%3D" -ErrorBlobUri "https://vivst.blob.core.windows.net/vivcontainer/error.txt?sp=racw&st=2022-10-27T22:18:36Z&se=2022-10-28T06:18:36Z&spr=https&sv=2021-06-08&sr=b&sig=HQAu3Bl%2BKMofYTjMo8o5h%asfasdfgdT%2F4jasfasdf5FlEo%3D"

Location      Name          Type
--------      ----         ----
eastus2euap   MyRunCommand3 Microsoft.Compute/virtualMachines/runCommands

Créez ou mettez à jour Run Command sur une machine virtuelle pour diffuser en continu des messages d’erreur standard vers des objets blob d’ajout de sortie et d’erreurs. Notez que les objets blob de sortie et d’erreur doivent être de type AppendBlob et leurs URL SAS doivent fournir un accès en lecture, ajout, création, écriture à l’objet blob. Un délai d’expiration de 24 heures est suggéré pour l’URL SAS. Si l’objet blob de sortie ou d’erreur n’existe pas, un objet blob de type AppendBlob est créé. Les URL SAS peuvent être générées sur Portail Azure à l’aide des options de l’objet blob ou du jeton SAP à l’aide de New-AzStorageBlobSASToken. Si vous générez un jeton SAS à l’aide de New-AzStorageBlobSASToken, votre URL SAS = URL d’objet blob de base + « ? » + jeton SAS de New-AzStorageBlobSASToken.

Exemple 6 : Créer ou mettre à jour une commande d’exécution sur une machine virtuelle, exécutez la commande Exécuter en tant qu’utilisateur différent à l’aide des paramètres RunAsUser et RunAsPassword.

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

Location      Name         Type
--------      ----         ----
eastus2euap   MyRunCommand Microsoft.Compute/virtualMachines/runCommands

Créez ou mettez à jour la commande d’exécution sur une machine virtuelle, exécutez la commande Run en tant qu’utilisateur différent à l’aide des paramètres RunAsUser et RunAsPassword. Pour que le compte d’identification 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.

Paramètres

-AsJob

Exécuter la commande en tant que travail

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-AsyncExecution

facultatif. Si la valeur est true, l’approvisionnement se termine dès que le script démarre et n’attend pas que le script se termine.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Confirm

Vous demande une confirmation avant d’exécuter la commande cmdlet.

Type:SwitchParameter
Alias:cf
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-DefaultProfile

Le paramètre DefaultProfile n’est pas fonctionnel. Utilisez le paramètre SubscriptionId lorsqu’il est disponible si vous exécutez l’applet de commande sur un autre abonnement.

Type:PSObject
Alias:AzureRMContext, AzureCredential
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ErrorBlobManagedIdentityClientId

ID client (valeur GUID) de l’identité managée affectée par l’utilisateur. ObjectId ne doit pas être utilisé si cela est fourni.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ErrorBlobManagedIdentityObjectId

ID d’objet (valeur GUID) de l’identité managée affectée par l’utilisateur. ClientId ne doit pas être utilisé si cela est fourni.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ErrorBlobUri

Spécifie l’objet blob de stockage Azure dans lequel le flux d’erreurs de script sera chargé. Utilisez un URI SAP avec lecture, ajout, création, accès en écriture OU utiliser l’identité managée pour fournir à la machine virtuelle l’accès à l’objet blob. Reportez-vous au paramètre errorBlobManagedIdentity.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Location

Emplacement de la ressource

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-NoWait

Exécuter la commande de manière asynchrone

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-OutputBlobManagedIdentityClientId

ID client (valeur GUID) de l’identité managée affectée par l’utilisateur. ObjectId ne doit pas être utilisé si cela est fourni.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-OutputBlobManagedIdentityObjectId

ID d’objet (valeur GUID) de l’identité managée affectée par l’utilisateur. ClientId ne doit pas être utilisé si cela est fourni.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-OutputBlobUri

Spécifie l’objet blob de stockage Azure dans lequel le flux de sortie de script sera chargé. Utilisez un URI SAP avec lecture, ajout, création, accès en écriture OU utiliser l’identité managée pour fournir à la machine virtuelle l’accès à l’objet blob. Reportez-vous au paramètre outputBlobManagedIdentity.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Parameter

Paramètres utilisés par le script. Pour construire, consultez la section NOTES pour les propriétés PARAMETER et créer une table de hachage.

Type:IRunCommandInputParameter[]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ProtectedParameter

Paramètres utilisés par le script. Pour construire, consultez la section NOTES pour les propriétés PROTECTEDPARAMETER et créer une table de hachage.

Type:IRunCommandInputParameter[]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ResourceGroupName

Nom du groupe de ressources.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-RunAsPassword

Spécifie le mot de passe du compte d’utilisateur sur la machine virtuelle lors de l’exécution de la commande d’exécution.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-RunAsUser

Spécifie le compte d’utilisateur sur la machine virtuelle lors de l’exécution de la commande d’exécution.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-RunCommandName

Nom de la commande d’exécution de la machine virtuelle.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ScriptLocalPath

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ScriptUriManagedIdentityClientId

ID client (valeur GUID) de l’identité managée affectée par l’utilisateur. ObjectId ne doit pas être utilisé si cela est fourni.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ScriptUriManagedIdentityObjectId

ID d’objet (valeur GUID) de l’identité managée affectée par l’utilisateur. ClientId ne doit pas être utilisé si cela est fourni.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-SourceCommandId

Spécifie un commandId de script intégré prédéfini.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-SourceScript

Spécifie le contenu du script à exécuter sur la machine virtuelle.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-SourceScriptUri

Spécifie l’emplacement de téléchargement du script. Il peut s’agir de l’URI SAP d’un objet blob de stockage Azure avec accès en lecture ou URI public.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-SubscriptionId

Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.

Type:String
Position:Named
Valeur par défaut:(Get-AzContext).Subscription.Id
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Tag

Balises de ressource

Type:Hashtable
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-TimeoutInSecond

Délai d’expiration en secondes pour exécuter la commande d’exécution.

Type:Int32
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-TreatFailureAsDeploymentFailure

facultatif. Si la valeur est true, tout échec dans le script échoue et ProvisioningState est marqué comme ayant échoué. Si la valeur est false, ProvisioningState indique uniquement si la commande d’exécution a été exécutée ou non par la plateforme d’extensions, elle n’indique pas si le script a échoué en cas d’échec de script. Consultez la vue d’instance de la commande d’exécution en cas d’échecs de script pour voir executionMessage, sortie, erreur : https://aka.ms/runcommandmanaged#get-execution-status-and-results

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-VMName

Nom de la machine virtuelle où la commande d’exécution doit être créée ou mise à jour.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-WhatIf

Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.

Type:SwitchParameter
Alias:wi
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Sorties

IVirtualMachineRunCommand