DSC WindowsFeature Resource

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

O recurso WindowsFeature no Windows PowerShell Desired State Configuration (DSC) fornece um mecanismo para garantir que as funções e funcionalidades são adicionadas ou removidas num nó de destino.

Nota

Esta documentação deste recurso do DSC abrange a versão incluída no PowerShell anterior à versão 7.2. O módulo PSDscResources contém recursos DSC novos e atualizados que são oficialmente suportados pela Microsoft. O módulo PSDscResources está disponível no Galeria do PowerShell.

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

Syntax

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 funcionalidade que pretende garantir que é adicionada ou removida. Isto é o mesmo que a propriedade Nome do cmdlet Get-WindowsFeature e não o nome a apresentar da função ou funcionalidade.
Credencial	Indica as credenciais a utilizar para adicionar ou remover a função ou funcionalidade.
IncludeAllSubFeature	Defina esta propriedade como para $true garantir o estado de todas as subfuncionalidades necessárias com o estado da funcionalidade que especificar com a propriedade Nome .
LogPath	Indica o caminho para um ficheiro de registo onde pretende que o fornecedor de recursos registe a operação.

Common properties (Propriedades comuns)

Propriedade	Descrição
DependsOn	Indica que a configuração de outro recurso tem de ser executada antes de este recurso ser configurado. Por exemplo, se o ID do bloco de script de configuração de recursos que pretende executar primeiro for ResourceName e o respetivo tipo for ResourceType, a sintaxe para utilizar esta propriedade é DependsOn = "[ResourceType]ResourceName".
Certifique-se de que	Indica se a função ou funcionalidade foi adicionada. Para garantir que a função ou funcionalidade é adicionada, defina esta propriedade como Apresentar. Para garantir que a função ou funcionalidade é removida, defina a propriedade como Ausente. O valor predefinido é Presente.
PsDscRunAsCredential	Define a credencial para executar todo o recurso como.

Nota

A propriedade comum PsDscRunAsCredential foi adicionada no WMF 5.0 para permitir a execução de qualquer recurso DSC no contexto de outras credenciais. Para obter mais informações, veja Utilizar Credenciais com Recursos do 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
}