Share via

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 de Azure heredados que usan Service Management API. Consulte el módulo de Az PowerShell para cmdlets para administrar recursos de Azure Resource Manager.

Syntax

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 (archivo .zip) que se cargó anteriormente mediante Publish-AzureVMDscConfiguration. Este parámetro debe especificar solo el nombre del archivo, sin ninguna ruta de acceso.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters: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
Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters: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.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters: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".

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

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

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ContainerName

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-DataCollection

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Force

Indica que este cmdlet sobrescribe los blobs existentes.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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
  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspender
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InformationVariable

Especifica una variable de información.

Type:String
Aliases:iv
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Profile

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

Type:AzureSMProfile
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters: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 .

Type:AzureStorageContext
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-StorageEndpointSuffix

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters: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.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-VM

Especifica el objeto de máquina virtual persistente.

Type:IPersistentVM
Aliases:InputObject
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters: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.
  • Últimos. Instala la versión más reciente de WMF, actualmente WMF 5.0.

El valor predeterminado es latest.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False