Set-AzVMDscExtension
Configura a extensão DSC em uma máquina virtual.
Sintaxe
Default (Default)
Set-AzVMDscExtension
[-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>]
[-NoWait]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
O cmdlet Set-AzVMDscExtension 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
Set-AzVMDscExtension -ResourceGroupName "ResourceGroup001" -VMName "VM07" -ArchiveBlobName "Sample.ps1.zip" -ArchiveStorageAccountName "Stg" -ConfigurationName "ConfigName" -Version "1.10" -Location "West US"
Esse 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-AzVMDscConfiguration .
Set-AzVMDscExtension -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"
Esse 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 denominada ConfigName e especifica dados e argumentos de configuração.
O arquivo Sample.ps1.zip foi carregado anteriormente usando Publish-AzVMDscConfiguration .
Set-AzVMDscExtension -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
Esse 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.
Esse 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-AzVMDscConfiguration .
Parâmetros
-ArchiveBlobName
Especifica o nome do arquivo de configuração que foi carregado anteriormente pelo cmdlet Publish-AzVMDscConfiguration.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Aliases: ConfigurationArchiveBlob
Conjuntos de parâmetros
(All)
Cargo: 5
Obrigatório: True
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
-ArchiveContainerName
Nome da espécie do contêiner de armazenamento do Azure em que o arquivo de configuração está localizado.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Aliases: Nome do Contêiner
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
-ArchiveResourceGroupName
Especifica o nome do grupo de recursos que contém a conta de armazenamento que contém o arquivo de configuração.
Esse parâmetro será opcional se a conta de armazenamento e a máquina virtual estiverem no mesmo grupo de recursos.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
-ArchiveStorageAccountName
Especifica o nome da conta de armazenamento do Azure que é usado para baixar o ArchiveBlobName.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Aliases: NomeDaContaDeArmazenamento
Conjuntos de parâmetros
(All)
Cargo: 4
Obrigatório: True
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
-ArchiveStorageEndpointSuffix
Especifica o sufixo do ponto de extremidade de armazenamento.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Aliases: StorageEndpointSuffix
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: 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 é autenticado automaticamente.
Use o parâmetro AutoUpdate para habilitar a atualização automática do manipulador de extensão para a versão mais recente como e quando ela estiver disponível.
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-ConfigurationArgument
Especifica uma tabela de hash que contém os argumentos para a função de configuração.
Propriedades do parâmetro
Tipo: Hashtable
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
-ConfigurationData
Especifica o caminho de um arquivo .psd1 que especifica os dados para a configuração.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
-ConfigurationName
Especifica o nome da configuração invocada pela Extensão DSC.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
-Confirm
Solicita sua confirmação antes de executar o cmdlet.
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: False
Dá suporte a curingas: False
DontShow: False
Aliases: cf
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-DataCollection
Especifica o tipo de coleta de dados.
Os valores aceitáveis para esse parâmetro são: Habilitar e Desabilitar.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Valores aceitos: Enable, Disable
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
-DefaultProfile
As credenciais, a conta, o locatário e a assinatura usados para comunicação com o Azure.
Propriedades do parâmetro
Tipo: IAzureContextContainer
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Aliases: AzContext, AzureRmContext, AzureCredential
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-Force
Força o comando a ser executado sem solicitar a confirmação do usuário.
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-Location
Especifica o caminho da extensão de recurso.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
-Name
Especifica o nome do recurso do Azure Resource Manager que representa a extensão.
O valor padrão é Microsoft.Powershell.DSC.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
-NoWait
Inicia a operação e retorna imediatamente, antes que a operação seja concluída. Para determinar se a operação foi concluída com êxito, use algum outro mecanismo.
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-ResourceGroupName
Especifica o nome do grupo de recursos da máquina virtual.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Cargo: 2
Obrigatório: True
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
-Version
Especifica a versão da extensão DSC à qual Set-AzVMDscExtension aplica as configurações.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Aliases: HandlerVersion
Conjuntos de parâmetros
(All)
Cargo: 1
Obrigatório: True
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
-VMName
Especifica o nome da máquina virtual em que o manipulador de extensão DSC está instalado.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Cargo: 3
Obrigatório: True
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado.
O cmdlet não é executado.
Propriedades do parâmetro
Tipo: SwitchParameter
Valor padrão: False
Dá suporte a curingas: False
DontShow: False
Aliases: wi
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: False
Valor dos argumentos restantes: False
-WmfVersion
Especifica a versão do WMF.
Propriedades do parâmetro
Tipo: String
Valor padrão: None
Valores aceitos: 4.0, 5.0, 5.1, latest
Dá suporte a curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Cargo: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline pelo nome da propriedade: True
Valor dos argumentos restantes: False
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters .
Saídas