Set-AzureRmVMDscExtension
Configura a extensão DSC em uma máquina virtual.
Aviso
O módulo AzureRM do PowerShell foi oficialmente preterido a partir de 29 de fevereiro de 2024. Os usuários são aconselhados a migrar do AzureRM para o módulo Az PowerShell para garantir suporte e atualizações contínuos.
Embora o módulo AzureRM ainda possa funcionar, ele não é mais mantido ou suportado, colocando qualquer uso continuado a critério e risco do usuário. Consulte nossos recursos de migração para obter orientação sobre a transição para o módulo Az.
Sintaxe
Set-AzureRmVMDscExtension
[-ResourceGroupName] <String>
[-VMName] <String>
[-Name <String>]
[-ArchiveBlobName] <String>
[-ArchiveStorageAccountName] <String>
[-ArchiveResourceGroupName <String>]
[-ArchiveStorageEndpointSuffix <String>]
[-ArchiveContainerName <String>]
[-ConfigurationName <String>]
[-ConfigurationArgument <Hashtable>]
[-ConfigurationData <String>]
[-Version] <String>
[-Force]
[-Location <String>]
[-AutoUpdate]
[-WmfVersion <String>]
[-DataCollection <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
O cmdlet Set-AzureRmVMDscExtension configura a extensão DSC (Configuração de Estado Desejado) do Windows PowerShell em uma máquina virtual em um grupo de recursos.
Exemplos
Exemplo 1: Definir uma extensão DSC
PS C:\> Set-AzureRmVMDscExtension -ResourceGroupName "ResourceGroup001" -VMName "VM07" -ArchiveBlobName "Sample.ps1.zip" -ArchiveStorageAccountName "Stg" -ConfigurationName "ConfigName" -Version "1.10" -Location "West US"
Este comando define a extensão DSC na máquina virtual chamada VM07 para baixar Sample.ps1.zip da conta de armazenamento chamada Stg e do contêiner padrão. O comando invoca a configuração chamada ConfigName. O arquivo Sample.ps1.zip foi carregado anteriormente usando Publish-AzureRmVMDscConfiguration.
Exemplo 2: Definir uma extensão DSC com dados de configuração
PS C:\> Set-AzureRmVMDscExtension -ResourceGroupName "ResourceGroup001" -VMName "VM13" -ArchiveBlobName "Sample.ps1.zip" -ArchiveStorageAccountName "Stg" -ConfigurationName "ConfigName" -ConfigurationArgument "@{arg="val"}" -ArchiveContainerName "WindowsPowerShellDSC" -ConfigurationData "SampleData.psd1" -Version "1.10" -Location "West US"
Este comando define a extensão na máquina virtual chamada VM13 para baixar Sample.ps1.zip da conta de armazenamento chamada Stg e do contêiner chamado WindowsPowerShellDSC. O comando a configuração chamado ConfigName e especifica dados de configuração e argumentos. O arquivo Sample.ps1.zip foi carregado anteriormente usando Publish-AzureRmVMDscConfiguration.
Exemplo 3: Definir uma extensão DSC com dados de configuração com atualização automática
PS C:\> Set-AzureRmVMDscExtension -ResourceGroupName "ResourceGroup001" -VMName "VM22" -ArchiveBlobName "Sample.ps1.zip" -ArchiveStorageAccountName "Stg" -ConfigurationName "ConfigName" -ConfigurationArgument "@{arg="val"}" -ArchiveContainerName WindowsPowerShellDSC -ConfigurationData "SampleData.psd1" -Version "1.10" -Location "West US" -AutoUpdate
Este comando define a extensão na máquina virtual chamada VM22 para baixar Sample.ps1.zip da conta de armazenamento chamada Stg e do contêiner chamado WindowsPowerShellDSC. O comando invoca a configuração chamada ConfigName e especifica dados e argumentos de configuração. Este comando também permite a atualização automática do manipulador de extensão para a versão mais recente. O Sample.ps1.zip foi carregado anteriormente usando Publish-AzureRmVMDscConfiguration.
Parâmetros
-ArchiveBlobName
Especifica o nome do arquivo de configuração que foi carregado anteriormente pelo cmdlet Publish-AzureRmVMDscConfiguration.
Tipo: | String |
Aliases: | ConfigurationArchiveBlob |
Position: | 5 |
Default value: | None |
Necessário: | True |
Aceitar entrada de pipeline: | True |
Aceitar carateres universais: | False |
-ArchiveContainerName
Nome da espécie do contêiner de armazenamento do Azure onde o arquivo de configuração está localizado.
Tipo: | String |
Aliases: | ContainerName |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | True |
Aceitar carateres universais: | False |
-ArchiveResourceGroupName
Especifica o nome do grupo de recursos que contém a conta de armazenamento que contém o arquivo de configuração. Este parâmetro é opcional se a conta de armazenamento e a máquina virtual estiverem ambas no mesmo grupo de recursos.
Tipo: | String |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | True |
Aceitar carateres universais: | False |
-ArchiveStorageAccountName
Especifica o nome da conta de armazenamento do Azure que é usado para baixar o ArchiveBlobName.
Tipo: | String |
Aliases: | StorageAccountName |
Position: | 4 |
Default value: | None |
Necessário: | True |
Aceitar entrada de pipeline: | True |
Aceitar carateres universais: | False |
-ArchiveStorageEndpointSuffix
Especifica o sufixo do ponto de extremidade de armazenamento.
Tipo: | String |
Aliases: | StorageEndpointSuffix |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | True |
Aceitar carateres universais: | False |
-AutoUpdate
Especifica a versão do manipulador de extensão especificada pelo parâmetro Version . Por padrão, o manipulador de extensão não é atualizado automaticamente. Use o parâmetro AutoUpdate para habilitar a atualização automática do manipulador de extensão para a versão mais recente à medida que estiver disponível.
Tipo: | SwitchParameter |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-ConfigurationArgument
Especifica uma tabela de hash que contém os argumentos para a função de configuração.
Tipo: | Hashtable |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | True |
Aceitar carateres universais: | False |
-ConfigurationData
Especifica o caminho de um arquivo .psd1 que especifica os dados para a configuração.
Tipo: | String |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | True |
Aceitar carateres universais: | False |
-ConfigurationName
Especifica o nome da configuração que a extensão DSC invoca.
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 |
-DataCollection
Especifica o tipo de coleta de dados. Os valores aceitáveis para este parâmetro são: Ativar e Desativar.
Tipo: | String |
Valores aceites: | Enable, Disable |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | True |
Aceitar carateres universais: | False |
-DefaultProfile
As credenciais, a conta, o locatário e a assinatura usados para comunicação com o azure.
Tipo: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-Force
Força o comando a ser executado sem pedir a confirmação do usuário.
Tipo: | SwitchParameter |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-Location
Especifica o caminho da extensão de recurso.
Tipo: | String |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | True |
Aceitar carateres universais: | False |
-Name
Especifica o nome do recurso do Azure Resource Manager que representa a extensão. O valor padrão é Microsoft.Powershell.DSC.
Tipo: | String |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | True |
Aceitar carateres universais: | False |
-ResourceGroupName
Especifica o nome do grupo de recursos da máquina virtual.
Tipo: | String |
Position: | 2 |
Default value: | None |
Necessário: | True |
Aceitar entrada de pipeline: | True |
Aceitar carateres universais: | False |
-Version
Especifica a versão da extensão DSC à qual Set-AzureRmVMDscExtension aplica as configurações.
Tipo: | String |
Aliases: | HandlerVersion |
Position: | 1 |
Default value: | None |
Necessário: | True |
Aceitar entrada de pipeline: | True |
Aceitar carateres universais: | False |
-VMName
Especifica o nome da máquina virtual onde o manipulador de extensão DSC está instalado.
Tipo: | String |
Position: | 3 |
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 WMF.
Tipo: | String |
Valores aceites: | 4.0, 5.0, 5.1, latest |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | True |
Aceitar carateres universais: | False |