Set-AzureVMDscExtension

  • Referência
Módulo:
Azure

Configura a extensão DSC em uma máquina virtual.

Observação

Os cmdlets mostrados nesta documentação são usados para gerenciar recursos herdados do Azure que usam APIs de Gerenciamento de Serviços. Confira o módulo Az PowerShell para usar cmdlets a fim de gerenciar recursos do 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

O cmdlet Set-AzureVMDscExtension configura a extensão DSC (Configuração de Estado Desejado) em uma máquina virtual.

Exemplos

Exemplo 1: Configurar a extensão DSC em uma 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 a extensão DSC em uma máquina virtual.

O pacote MyConfiguration.ps1.zip deve ter sido carregado anteriormente no armazenamento do Azure usando o comando Publish-AzureVMDscConfiguration e inclui o script MyConfiguration.ps1 e os módulos dos quais ele depende.

O argumento MyConfiguration indica a configuração DSC específica dentro do script a ser executado. O parâmetro -ConfigurationArgument especifica uma tabela de hash com os argumentos que são passados para a função de configuração.

Exemplo 2: Configurar a extensão DSC em uma máquina virtual usando um caminho para os dados de configuração

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 a extensão DSC em uma máquina virtual usando um caminho para os dados de configuração.

Parâmetros

-ConfigurationArchive

Especifica o nome do pacote de configuração (arquivo .zip) que foi carregado anteriormente por Publish-AzureVMDscConfiguration. Esse parâmetro deve especificar apenas o nome do arquivo, sem nenhum caminho.

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

-ConfigurationArgument

Especifica uma tabela de hash especificando os argumentos para a função de configuração. As chaves correspondem aos nomes dos parâmetros e os valores aos valores dos parâmetros.

Os valores aceitáveis para esse parâmetro são:

  • tipos primitivos
  • string
  • array
  • PSCredential
Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ConfigurationDataPath

Especifica o caminho de um arquivo .psd1 que especifica os dados para a função de configuração. Esse arquivo deve conter uma tabela de hash conforme descrito em Separando dados de configuração e ambientehttps://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 o nome do script de configuração ou módulo que é chamado pela extensão DSC.

O valor desse parâmetro deve ser o nome de uma das funções de configuração contidas nos scripts ou módulos empacotados no ConfigurationArchive.

Esse cmdlet adotará como padrão o nome do arquivo fornecido pelo parâmetro ConfigurationArchive se você omitir esse parâmetro, excluindo qualquer extensão. Por exemplo, se ConfigurationArchive for "SalesWebSite.ps1.zip", o valor padrão para ConfigurationName será "SalesWebSite".

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

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

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

-ContainerName

Especifica o nome do contêiner de armazenamento do Azure onde o ConfigurationArchive está localizado.

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 esse cmdlet substitui blobs existentes.

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

-InformationAction

Especifica como esse cmdlet responde a um evento de informações.

Os valores aceitáveis para esse parâmetro são:

  • Continuar
  • Ignorar
  • Perguntar
  • SilentlyContinue
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InformationVariable

Especifica uma variável de informação.

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

-Profile

Especifica o perfil do Azure a partir do qual este cmdlet lê. Se você não especificar um perfil, esse cmdlet será lido a partir do perfil padrão local.

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

-ReferenceName

Especifica uma cadeia de caracteres definida pelo usuário que pode ser usada para fazer referência a uma extensão. Esse parâmetro é especificado quando a extensão é adicionada à máquina virtual pela primeira vez. Para atualizações subsequentes, você deve especificar o nome de referência usado anteriormente enquanto atualiza a extensão. O ReferenceName atribuído a uma extensão é retornado usando o cmdlet Get-AzureVM .

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

-StorageContext

Especifica o contexto de armazenamento do Azure que fornece as configurações de segurança usadas para acessar o script de configuração. Esse contexto fornece acesso de leitura ao contêiner especificado pelo parâmetro ContainerName .

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

-StorageEndpointSuffix

Especifica o sufixo de ponto de extremidade DNS para todos os serviços de armazenamento, por exemplo, "core.contoso.net".

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

-Version

Especifica a versão específica da extensão DSC a ser usada. O valor padrão será definido como "1.*" se esse parâmetro não for especificado.

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

-VM

Especifica o 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

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

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

-WmfVersion

Especifica a versão do Windows Management Framework (WMF) a ser instalada na máquina virtual. A extensão DSC depende dos recursos do DSC que só estão disponíveis nas atualizações do WMF. Este parâmetro especifica qual versão da atualização deve ser instalada na máquina virtual. Os valores aceitáveis para esse parâmetro são:

  • 4.0. Instala o WMF 4.0 a menos que uma versão mais recente já esteja instalada.
  • 5.0. Instala a versão mais recente do WMF 5.0.
  • mais recente. Instala o WMF mais recente, atualmente WMF 5.0.

O valor padrão é latest.

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