Set-AzVMExtension

  • Referencia
Módulo:
Az.Compute

Actualiza las propiedades de extensión o agrega una extensión a una máquina virtual.

Sintaxis

Set-AzVMExtension
   -Publisher <String>
   -ExtensionType <String>
   [-Settings <Hashtable>]
   [-ProtectedSettings <Hashtable>]
   [-EnableAutomaticUpgrade <Boolean>]
   [-AsJob]
   [-ResourceGroupName] <String>
   [-VMName] <String>
   -Name <String>
   [-TypeHandlerVersion <String>]
   [-Location <String>]
   [-DisableAutoUpgradeMinorVersion]
   [-ForceRerun <String>]
   [-NoWait]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzVMExtension
   -Publisher <String>
   -ExtensionType <String>
   [-SettingString <String>]
   [-ProtectedSettingString <String>]
   [-EnableAutomaticUpgrade <Boolean>]
   [-AsJob]
   [-ResourceGroupName] <String>
   [-VMName] <String>
   -Name <String>
   [-TypeHandlerVersion <String>]
   [-Location <String>]
   [-DisableAutoUpgradeMinorVersion]
   [-ForceRerun <String>]
   [-NoWait]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

El cmdlet Set-AzVMExtension actualiza las propiedades de las extensiones de máquina virtual existentes o agrega una extensión a una máquina virtual.

Ejemplos

Ejemplo 1: Modificación de la configuración mediante tablas hash

$Settings = @{"fileUris" = "[]"; "commandToExecute" = ""};
$ProtectedSettings = @{"storageAccountName" = $stoname; "storageAccountKey" = $stokey};
Set-AzVMExtension -ResourceGroupName "ResourceGroup11" -Location "West US" -VMName "VirtualMachine22" -Name "ContosoTest" -Publisher "Contoso.Compute" -ExtensionType "CustomScriptExtension" -TypeHandlerVersion "1.1" -Settings $Settings -ProtectedSettings $ProtectedSettings;

Los dos primeros comandos usan la sintaxis estándar de Windows PowerShell para crear tablas hash y, a continuación, almacenan esas tablas hash en las variables $Settings y $ProtectedSettings. Para obtener más información, escriba Get-Help about_Hash_Tables. El segundo comando incluye dos valores creados anteriormente y almacenados en variables. El comando final modifica una extensión de la máquina virtual denominada VirtualMachine22 en ResourceGroup11 según el contenido de $Settings y $ProtectedSettings. El comando especifica otra información necesaria que incluye el publicador y el tipo de extensión.

Ejemplo 2: Modificación de la configuración mediante cadenas

$SettingsString = '{"fileUris":[],"commandToExecute":""}';
$ProtectedSettingsString = '{"storageAccountName":"' + $stoname + '","storageAccountKey":"' + $stokey + '"}';
Set-AzVMExtension -ResourceGroupName "ResourceGroup11" -Location "West US" -VMName "VirtualMachine22" -Name "CustomScriptExtension" -Publisher "Contoso.Compute" -ExtensionType "CustomScriptExtension" -TypeHandlerVersion "1.1" -SettingString $SettingsString -ProtectedSettingString $ProtectedSettingsString ;

Los dos primeros comandos crean cadenas que contienen la configuración y, a continuación, las almacena en las variables $SettingsString y $ProtectedSettingsString. El comando final modifica una extensión de la máquina virtual denominada VirtualMachine22 en ResourceGroup11 según el contenido de $SettingsString y $ProtectedSettingsString. El comando especifica otra información necesaria que incluye el publicador y el tipo de extensión.

Parámetros

-AsJob

Ejecución del cmdlet en segundo plano

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:False
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-DefaultProfile

Las credenciales, la cuenta, el inquilino y la suscripción que se usan para la comunicación con Azure.

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

-DisableAutoUpgradeMinorVersion

Indica que este cmdlet impide que el agente invitado de Azure actualice automáticamente las extensiones a una versión secundaria más reciente. De forma predeterminada, este cmdlet permite al agente invitado actualizar las extensiones.

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

-EnableAutomaticUpgrade

Indica si la plataforma debe actualizar automáticamente la extensión si hay una versión más reciente de la extensión disponible.

Tipo:Nullable<T>[Boolean]
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-ExtensionType

Especifica el tipo de extensión.

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

-ForceRerun

Indica que este cmdlet fuerza una nueva ejecución de la misma configuración de extensión en la máquina virtual sin desinstalar y reinstalar la extensión. El valor puede ser cualquier cadena diferente del valor actual. Si forceUpdateTag no se cambia, el controlador sigue aplicando las actualizaciones a la configuración pública o protegida.

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

-Location

Especifica la ubicación de la máquina virtual.

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

-Name

Especifica el nombre de una extensión.

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

-NoWait

Inicia la operación y vuelve inmediatamente antes de que se complete la operación. Para determinar si la operación se ha completado correctamente, use algún otro mecanismo.

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

-ProtectedSettings

Especifica la configuración privada de la extensión, como una tabla hash. Este cmdlet cifra la configuración privada.

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

-ProtectedSettingString

Especifica la configuración privada de la extensión, como una cadena. Este cmdlet cifra la configuración privada.

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

-Publisher

Especifica el nombre del publicador de extensiones. El publicador proporciona un nombre cuando el publicador registra una extensión.

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

-ResourceGroupName

Especifica el nombre del grupo de recursos de la máquina virtual.

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

-Settings

Especifica la configuración pública de la extensión, como una tabla hash. Este cmdlet no cifra la configuración pública.

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

-SettingString

Especifica la configuración pública de la extensión, como una cadena. Este cmdlet no cifra la configuración pública.

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

-TypeHandlerVersion

Especifica la versión de la extensión que se va a usar para esta máquina virtual.

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

-VMName

Especifica el nombre de una máquina virtual. Este cmdlet modifica las extensiones de la máquina virtual que especifica este parámetro.

Tipo:String
Alias:ResourceName
Posición:1
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:True
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:False
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

Entradas

String

Hashtable

SwitchParameter

Salidas

PSAzureOperationResponse