Recurso WindowsFeature de DSC

Aplica-se a: Windows PowerShell 4.0, Windows PowerShell 5.x

O recurso WindowsFeature 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.

Observação

Esta documentação desse recurso de DSC abrange 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 que têm suporte oficial da Microsoft. O módulo PSDscResources está disponível na Galeria do PowerShell.

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

Sintaxe

WindowsFeature [string] #ResourceName
{
    Name = [string]
    [ Credential = [PSCredential] ]
    [ IncludeAllSubFeature = [bool] ]
    [ LogPath = [string] ]
    [ DependsOn = [string[]] ]
    [ Ensure = [string] { Absent | Present }  ]
    [ PsDscRunAsCredential = [PSCredential] ]
}

Propriedades

Propriedade	Descrição
Nome	Indica o nome da função ou recurso que você deseja garantir que seja adicionado ou removido. É igual à propriedade Name do cmdlet Get-WindowsFeature, não o nome de exibição da função ou recurso.
Credencial	Indica as credenciais que devem ser usadas para adicionar ou remover a função ou recurso.
IncludeAllSubFeature	Defina essa propriedade como $true para garantir o estado de todos os sub-recursos necessários com o estado do recurso especificado com a propriedade Name.
LogPath	Indica 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 a função ou o recurso foi adicionado. Para garantir que a função ou o recurso sejam adicionados, defina essa propriedade como Present. Para garantir que a função ou o recurso 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

WindowsFeature RoleExample
{
    Ensure = "Present"
    # Alternatively, to ensure the role is uninstalled, set Ensure to "Absent"
    Name = "Web-Server" # Use the Name property from Get-WindowsFeature
}