Partilhar via

Set-AzureVMDscExtension

  • Referência
Módulo:
Azure

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

Nota

Os cmdlets mencionados nesta documentação são para gerenciar recursos herdados do Azure que usam APIs do Azure Service Manager (ASM). Este módulo do PowerShell herdado não é recomendado ao criar novos recursos, uma vez que o ASM está agendado para desativação. Para obter mais informações, consulte Aposentadoria do Azure Service Manager.

O módulo Az PowerShell é o módulo PowerShell recomendado para gerenciar recursos do Azure Resource Manager (ARM) com o PowerShell.

Sintaxe

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 hashtable 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. Este parâmetro deve especificar apenas o nome do arquivo, sem qualquer caminho.

Tipo:String
Position:1
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-ConfigurationArgument

Especifica uma hashtable 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 este parâmetro são:

  • tipos primitivos
  • string
  • matriz
  • PSCredential
Tipo:Hashtable
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais: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 hashtable conforme descrito em Separando dados de configuração e ambientehttps://msdn.microsoft.com/en-us/PowerShell/DSC/configData.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-ConfigurationName

Especifica o nome do script ou módulo de configuração que é invocado 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 em ConfigurationArchive.

Este cmdlet assume 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".

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-Confirm

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

Tipo:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-ContainerName

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

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-DataCollection

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-Force

Indica que esse cmdlet substitui blobs existentes.

Tipo:SwitchParameter
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-InformationAction

Especifica como esse cmdlet responde a um evento de informação.

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

  • Continuar
  • Ignorar
  • Informe-se
  • SilenciosamenteContinue
  • Parar
  • Suspender
Tipo:ActionPreference
Aliases:infa
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-InformationVariable

Especifica uma variável de informação.

Tipo:String
Aliases:iv
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Profile

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

Tipo:AzureSMProfile
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais: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 .

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais: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 .

Tipo:AzureStorageContext
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-StorageEndpointSuffix

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

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-Version

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

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-VM

Especifica o objeto de máquina virtual persistente.

Tipo:IPersistentVM
Aliases:InputObject
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-WhatIf

Apresenta o que aconteceria mediante a execução do cmdlet. O cmdlet não é executado.

Tipo:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais: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 DSC que só estão disponíveis nas atualizações WMF. Este parâmetro especifica qual versão da atualização deve ser instalada na máquina virtual. Os valores aceitáveis para este 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 é mais recente.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False