Compartir a través de

Set-AzureVMDscExtension

  • Referencia
Módulo:
Azure

Configura la extensión DSC en una máquina virtual.

Nota:

Los cmdlets a los que se hace referencia en esta documentación son para administrar recursos heredados de Azure que usan las API de Azure Service Manager (ASM). Este módulo heredado de PowerShell no se recomienda al crear nuevos recursos, ya que ASM está programado para la retirada. Para más información, consulte Retirada de Azure Service Manager.

El módulo Az powerShell es el módulo de PowerShell recomendado para administrar recursos de Azure Resource Manager (ARM) con PowerShell.

Sintaxis

Set-AzureVMDscExtension
   [-ReferenceName <String>]
   [-ConfigurationArgument <Hashtable>]
   [-ConfigurationDataPath <String>]
   [-ConfigurationArchive] <String>
   [-ConfigurationName <String>]
   [-ContainerName <String>]
   [-Force]
   [-StorageContext <AzureStorageContext>]
   [-Version <String>]
   [-StorageEndpointSuffix <String>]
   [-WmfVersion <String>]
   [-DataCollection <String>]
   -VM <IPersistentVM>
   [-Profile <AzureSMProfile>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

El cmdlet Set-AzureVMDscExtension configura la extensión Desired State Configuration (DSC) en una máquina virtual.

Ejemplos

Ejemplo 1: Configuración de la extensión DSC en una máquina virtual

PS C:\> Set-AzureVMDscExtension -VM $VM -ConfigurationArchive MyConfiguration.ps1.zip  -ConfigurationName MyConfiguration -ConfigurationArgument @{ Path = 'C:\MyDirectory' }
DeploymentName              : my-vm-svc
Name                        : my-vm
Label                       :
VM                          : Microsoft.WindowsAzure.Commands.ServiceManagement.Model.PersistentVM
InstanceStatus              : ReadyRole
IpAddress                   : 10.10.10.10
InstanceStateDetails        :
PowerState                  : Started
InstanceErrorCode           :
InstanceFaultDomain         : 0
InstanceName                : my-vm
InstanceUpgradeDomain       : 0
InstanceSize                : Small
AvailabilitySetName         :
DNSName                     : http://my-vm-svc.cloudapp.net/
Status                      : ReadyRole
GuestAgentStatus            : Microsoft.WindowsAzure.Commands.ServiceManagement.Model.PersistentVMModel.GuestAgentStatus
ResourceExtensionStatusList : {Contoso.Compute.BGInfo}
PublicIPAddress             :
PublicIPName                :
ServiceName                 : my-vm-svc
OperationDescription        : Get-AzureVM
OperationId                 : a0217a7af900c1f8a212299a3333cdbd6
OperationStatus             : OK

Este comando configura la extensión DSC en una máquina virtual.

El paquete MyConfiguration.ps1.zip debe haberse cargado previamente en Azure Storage mediante el comando Publish-AzureVMDscConfiguration e incluye el script MyConfiguration.ps1 y los módulos de los que depende.

El argumento MyConfiguration indica la configuración específica de DSC dentro del script que se va a ejecutar. El parámetro -ConfigurationArgument especifica una tabla hash con los argumentos que se pasan a la función de configuración.

Ejemplo 2: Configuración de la extensión DSC en una máquina virtual mediante una ruta de acceso a los datos de configuración

PS C:\> $VM | Set-AzureVMDscExtension -ConfigurationArchive MyConfiguration.ps1.zip  -ConfigurationName MyConfiguration -ConfigurationArgument @{ Credential = Get-Credential } -ConfigurationDataPath MyConfigurationData.psd1
DeploymentName              : my-vm-svc
Name                        : my-vm
Label                       :
VM                          : Microsoft.WindowsAzure.Commands.ServiceManagement.Model.PersistentVM
InstanceStatus              : ReadyRole
IpAddress                   : 10.10.10.10
InstanceStateDetails        :
PowerState                  : Started
InstanceErrorCode           :
InstanceFaultDomain         : 0
InstanceName                : my-vm
InstanceUpgradeDomain       : 0
InstanceSize                : Small
AvailabilitySetName         :
DNSName                     : http://my-vm-svc.cloudapp.net/
Status                      : ReadyRole
GuestAgentStatus            : Microsoft.WindowsAzure.Commands.ServiceManagement.Model.PersistentVMModel.GuestAgentStatus
ResourceExtensionStatusList : {Microsoft.Compute.BGInfo, Microsoft.Powershell.DSC}
PublicIPAddress             :
PublicIPName                :
ServiceName                 : my-vm-svc
OperationDescription        : Get-AzureVM
OperationId                 : a0217a7af900c1f8a212299a3333cdbd7
OperationStatus             : OK

Este comando configura la extensión DSC en una máquina virtual mediante una ruta de acceso a los datos de configuración.

Parámetros

-ConfigurationArchive

Especifica el nombre del paquete de configuración (.zip archivo) que se cargó anteriormente mediante Publish-AzureVMDscConfiguration. Este parámetro debe especificar solo el nombre del archivo, sin ninguna ruta de acceso.

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

-ConfigurationArgument

Especifica una tabla hash que especifica los argumentos para la función de configuración. Las claves corresponden a los nombres de parámetro y a los valores de los parámetros.

Los valores permitidos para este parámetro son los siguientes:

  • tipos primitivos
  • string
  • array
  • PSCredential
Tipo:Hashtable
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-ConfigurationDataPath

Especifica la ruta de acceso de un archivo .psd1 que especifica los datos de la función de configuración. Este archivo debe contener una tabla hash tal y como se describe en Separación de datos de configuración y entornohttps://msdn.microsoft.com/en-us/PowerShell/DSC/configData.

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

-ConfigurationName

Especifica el nombre del script de configuración o el módulo invocado por la extensión DSC.

El valor de este parámetro debe ser el nombre de una de las funciones de configuración contenidas en los scripts o módulos empaquetados en ConfigurationArchive.

Este cmdlet tiene como valor predeterminado el nombre del archivo proporcionado por el parámetro ConfigurationArchive si se omite este parámetro, excepto cualquier extensión. Por ejemplo, si ConfigurationArchive es "SalesWebSite.ps1.zip", el valor predeterminado de ConfigurationName es "SalesWebSite".

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
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

-ContainerName

Especifica el nombre del contenedor de Azure Storage donde se encuentra ConfigurationArchive.

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

-DataCollection

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

-Force

Indica que este cmdlet sobrescribe los blobs existentes.

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

-InformationAction

Especifica cómo responde este cmdlet a un evento de información.

Los valores permitidos para este parámetro son los siguientes:

  • Continuar
  • Ignorar
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspender
Tipo:ActionPreference
Alias:infa
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-InformationVariable

Especifica una variable de información.

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

-Profile

Especifica el perfil de Azure del que lee este cmdlet. Si no especifica un perfil, este cmdlet lee del perfil predeterminado local.

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

-ReferenceName

Especifica una cadena definida por el usuario que se puede usar para hacer referencia a una extensión. Este parámetro se especifica cuando la extensión se agrega a la máquina virtual por primera vez. Para las actualizaciones posteriores, debe especificar el nombre de referencia usado anteriormente mientras actualiza la extensión. ReferenceName asignado a una extensión se devuelve mediante el cmdlet Get-AzureVM.

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

-StorageContext

Especifica el contexto de almacenamiento de Azure que proporciona la configuración de seguridad que se usa para acceder al script de configuración. Este contexto proporciona acceso de lectura al contenedor especificado por el parámetro ContainerName .

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

-StorageEndpointSuffix

Especifica el sufijo de punto de conexión DNS para todos los servicios de almacenamiento, por ejemplo, "core.contoso.net".

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

-Version

Especifica la versión específica de la extensión DSC que se va a usar. El valor predeterminado se establece en "1.*" si no se especifica este parámetro.

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

-VM

Especifica el objeto de máquina virtual persistente.

Tipo:IPersistentVM
Alias:InputObject
Posición:Named
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

-WmfVersion

Especifica la versión de Windows Management Framework (WMF) que se va a instalar en la máquina virtual. La extensión DSC depende de las características de DSC que solo están disponibles en las actualizaciones de WMF. Este parámetro especifica la versión de la actualización que se va a instalar en la máquina virtual. Los valores permitidos para este parámetro son los siguientes:

  • 4.0. Instala WMF 4.0 a menos que ya esté instalada una versión más reciente.
  • 5.0. Instala la versión más reciente de WMF 5.0.
  • último. Instala la versión más reciente de WMF, actualmente WMF 5.0.

El valor predeterminado es latest.

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