Recurso do WindowsFeatureSet DSC

Aplica-se a: Windows PowerShell 5.x

O recurso WindowsFeatureSet na Configuração de Estado Desejado (DSC) do Windows PowerShell fornece um mecanismo para garantir que funções e recursos sejam adicionados ou removidos em um nó de destino. Esse recurso é um recurso composto que chama o recurso WindowsFeature para cada recurso especificado na propriedade Name.

Use esse recurso quando desejar configurar vários Recursos do Windows para o mesmo estado.

Observação

Esta documentação desse recurso DSC aborda a versão incluída no PowerShell antes da versão 7.2. O módulo PSDscResources contém recursos de DSC novos e atualizados com suporte oficial da Microsoft. O módulo PSDscResources está disponível na Galeria do PowerShell.

Para obter mais informações e documentação atualizada, consulte a documentação de referência PSDscResources.

Sintaxe

WindowsFeatureSet [string] #ResourceName
{
    Name = [string[]]
    [ Source = [string] ]
    [ IncludeAllSubFeature = [Boolean] ]
    [ Credential = [PSCredential] ]
    [ LogPath = [string] ]
    [ DependsOn = [string[]] ]
    [ Ensure = [string] { Absent | Present }  ]
    [ PsDscRunAsCredential = [PSCredential] ]
}

Propriedades

Propriedade	Descrição
Nome	Os nomes de funções ou recursos que você deseja garantir são adicionados ou removidos. É igual à propriedade Name do cmdlet Get-WindowsFeature, e não o nome de exibição das funções ou recursos.
Fonte	Indica o local do arquivo de origem que deve ser usado para a instalação, se necessário.
IncludeAllSubFeature	Defina essa propriedade como $true para incluir todos os sub-recursos com os recursos especificados com a propriedade Name.
Credencial	As credenciais que devem ser usadas para adicionar ou remover as funções ou os recursos.
LogPath	O caminho até um arquivo de log em que você deseja que o provedor de recursos registre a operação.

Propriedades comuns

Propriedade	Descrição
DependsOn	Indica que a configuração de outro recurso deve ser executada antes de ele ser configurado. Por exemplo, se a ID do bloco de script de configuração do recurso que você deseja executar primeiro for ResourceName e seu tipo for ResourceType, a sintaxe para usar essa propriedade será DependsOn = "[ResourceType]ResourceName".
Ensure	Indica se as funções ou os recursos são adicionados. Para garantir que as funções e os recursos sejam adicionados, defina essa propriedade como Present. Para garantir que as funções e os recursos sejam removidos, defina essa propriedade como Absent. O valor padrão é Present.
PsDscRunAsCredential	Define a credencial para executar todo o recurso.

Observação

A propriedade comum PsDscRunAsCredential foi adicionada ao WMF 5.0 para permitir a execução de qualquer recurso de DSC no contexto de outras credenciais. Para saber mais, confira Usar credenciais com recursos de DSC.

Exemplo

A configuração a seguir garante que os recursos do Servidor Web (IIS) e do Servidor SMTP e todas as subfeaturas de cada um estejam instalados.

configuration FeatureSetTest
{
    Import-DscResource -ModuleName PSDesiredStateConfiguration

    Node localhost
    {

        WindowsFeatureSet WindowsFeatureSetExample
        {
            Name                    = @("SMTP-Server", "Web-Server")
            Ensure                  = 'Present'
            IncludeAllSubFeature    = $true
        }
    }
}