Set-AzVMRunCommand

Operación para crear o actualizar el comando run.

Sintaxis

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

Operación para crear o actualizar el comando run.

Ejemplos

Ejemplo 1: Creación o actualización del comando Ejecutar en una máquina virtual mediante una dirección URL de SAS de blob de almacenamiento

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

Cree o actualice Run Command en una máquina virtual Windows mediante una dirección URL de SAS de un blob de almacenamiento que contenga el script .ps1. Tenga en cuenta que la dirección URL de SAS debe proporcionar acceso de lectura al blob. Se recomienda un tiempo de expiración de 24 horas para la dirección URL de SAS. Las direcciones URL de SAS se pueden generar en Azure Portal mediante las opciones del blob o el token de SAS mediante New-AzStorageBlobSASToken. Si genera un token de SAS mediante New-AzStorageBlobSASToken, la dirección URL de SAS = dirección URL de blob base + "?" + token de SAS de New-AzStorageBlobSASToken.

Ejemplo 2: Crear o actualizar Ejecutar comando en una máquina virtual mediante un archivo 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

Cree o actualice una instancia de Ejecutar comando en una máquina virtual mediante un archivo de script local que se encuentra en la máquina cliente en la que se ejecuta el cmdlet.

Ejemplo 3: Creación o actualización del comando Ejecutar en una máquina virtual mediante texto 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

Cree o actualice una instancia de Ejecutar comando en una máquina virtual pasando el contenido del script directamente al parámetro -SourceScript. Use ';' para delimitar varios comandos.

Ejemplo 4: Crear o actualizar Ejecutar comando en una máquina virtual mediante commandId.

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

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

Cree o actualice una instancia de Ejecutar comando en una máquina virtual mediante un elemento commandId existente previamente. Los elementos commandId disponibles se pueden recuperar mediante Get-AzVMRunCommandDocument.

Ejemplo 5: Creación o actualización del comando Ejecutar en una máquina virtual y transmisión de mensajes de error estándar y salida estándar para la salida y el error Anexar blobs.

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

Cree o actualice una instancia de Ejecutar comando en una máquina virtual y transmita los mensajes de error estándar y la salida estándar a los blobs en anexos de salida y error. Tenga en cuenta que los blobs de salida y error deben ser de tipo AppendBlob y sus direcciones URL de SAS deben proporcionar acceso de lectura, anexión, creación y escritura al blob. Se recomienda un tiempo de expiración de 24 horas para la dirección URL de SAS. Si el blob de salida o de error no existen, se creará un blob de tipo AppendBlob. Las direcciones URL de SAS se pueden generar en Azure Portal mediante las opciones del blob o el token de SAS mediante New-AzStorageBlobSASToken. Si genera un token de SAS mediante New-AzStorageBlobSASToken, la dirección URL de SAS = dirección URL de blob base + "?" + token de SAS de New-AzStorageBlobSASToken.

Ejemplo 6: Crear o actualizar Ejecutar comando en una máquina virtual, ejecute run Command como un usuario diferente mediante los parámetros RunAsUser y 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

Cree o actualice Run Command en una máquina virtual, ejecute run Command como un usuario diferente mediante los parámetros RunAsUser y RunAsPassword. Para que RunAs funcione correctamente, póngase en contacto con el administrador de la máquina virtual y asegúrese de que el usuario se haya agregado en la máquina virtual, de que el usuario tenga acceso a los recursos a los que accede la instancia de Ejecutar comando (directorios, archivos, red, etc.) y, en el caso de una máquina virtual Windows, de que el servicio "Inicio de sesión secundario" esté en ejecución en la máquina virtual.

Parámetros

-AsJob

Ejecución del comando como trabajo

Tipo:SwitchParameter
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-AsyncExecution

Opcional. Si se establece en true, el aprovisionamiento se completará en cuanto se inicie el script y no esperará a que se complete el script.

Tipo:SwitchParameter
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-Confirm

Le solicita su confirmación antes de ejecutar el cmdlet.

Tipo:SwitchParameter
Alias:cf
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-DefaultProfile

El parámetro DefaultProfile no es funcional. Use el parámetro SubscriptionId cuando esté disponible si ejecuta el cmdlet en otra suscripción.

Tipo:PSObject
Alias:AzureRMContext, AzureCredential
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-ErrorBlobManagedIdentityClientId

Id. de cliente (valor GUID) de la identidad administrada asignada por el usuario. ObjectId no se debe usar si se proporciona.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-ErrorBlobManagedIdentityObjectId

Id. de objeto (valor GUID) de la identidad administrada asignada por el usuario. ClientId no debe usarse si se proporciona.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-ErrorBlobUri

Especifica el blob de Azure Storage donde se cargará el flujo de error del script. Use un URI de SAS con lectura, anexión, creación, creación, acceso de escritura O use la identidad administrada para proporcionar a la máquina virtual acceso al blob. Consulte el parámetro errorBlobManagedIdentity.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-Location

Ubicación del recurso

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-NoWait

Ejecutar el comando de forma asincrónica

Tipo:SwitchParameter
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-OutputBlobManagedIdentityClientId

Id. de cliente (valor GUID) de la identidad administrada asignada por el usuario. ObjectId no se debe usar si se proporciona.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-OutputBlobManagedIdentityObjectId

Id. de objeto (valor GUID) de la identidad administrada asignada por el usuario. ClientId no debe usarse si se proporciona.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-OutputBlobUri

Especifica el blob de Azure Storage donde se cargará el flujo de salida del script. Use un URI de SAS con lectura, anexión, creación, creación, acceso de escritura O use la identidad administrada para proporcionar a la máquina virtual acceso al blob. Consulte el parámetro outputBlobManagedIdentity.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-Parameter

Parámetros usados por el script. Para construir, consulte la sección NOTES para las propiedades PARAMETER y crear una tabla hash.

Tipo:IRunCommandInputParameter[]
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-ProtectedParameter

Parámetros usados por el script. Para construir, vea la sección NOTES para las propiedades PROTECTEDPARAMETER y crear una tabla hash.

Tipo:IRunCommandInputParameter[]
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-ResourceGroupName

Nombre del grupo de recursos.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-RunAsPassword

Especifica la contraseña de la cuenta de usuario en la máquina virtual al ejecutar el comando run.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-RunAsUser

Especifica la cuenta de usuario en la máquina virtual al ejecutar el comando run.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-RunCommandName

Nombre del comando run de la máquina virtual.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-ScriptLocalPath

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-ScriptUriManagedIdentityClientId

Id. de cliente (valor GUID) de la identidad administrada asignada por el usuario. ObjectId no se debe usar si se proporciona.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-ScriptUriManagedIdentityObjectId

Id. de objeto (valor GUID) de la identidad administrada asignada por el usuario. ClientId no debe usarse si se proporciona.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-SourceCommandId

Especifica un commandId de script integrado predefinido.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-SourceScript

Especifica el contenido del script que se va a ejecutar en la máquina virtual.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-SourceScriptUri

Especifica la ubicación de descarga del script. Puede ser un URI de SAS de un blob de Azure Storage con acceso de lectura o URI público.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-SubscriptionId

Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.

Tipo:String
Posición:Named
Valor predeterminado:(Get-AzContext).Subscription.Id
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-Tag

Etiquetas del recurso

Tipo:Hashtable
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-TimeoutInSecond

Tiempo de espera en segundos para ejecutar el comando run.

Tipo:Int32
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-TreatFailureAsDeploymentFailure

Opcional. Si se establece en true, cualquier error en el script producirá un error en la implementación y ProvisioningState se marcará como Error. Si se establece en false, ProvisioningState solo reflejaría si la plataforma de extensiones ejecutó o no el comando de ejecución, no indicaría si se produjo un error en el script en caso de errores de script. Consulte la vista de instancia del comando run en caso de errores de script para ver executionMessage, output, error: https://aka.ms/runcommandmanaged#get-execution-status-and-results

Tipo:SwitchParameter
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-VMName

Nombre de la máquina virtual donde se debe crear o actualizar el comando run.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-WhatIf

Muestra lo que sucedería si se ejecutara el cmdlet. El cmdlet no se ejecuta.

Tipo:SwitchParameter
Alias:wi
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

Salidas

IVirtualMachineRunCommand