Zasób DSC WindowsFeature

Dotyczy: Windows PowerShell 4.0, Windows PowerShell 5.x

Zasób WindowsFeature w Windows PowerShell Desired State Configuration (DSC) zapewnia mechanizm zapewniający, że role i funkcje są dodawane lub usuwane w węźle docelowym.

Uwaga

Ta dokumentacja tego zasobu DSC obejmuje wersję dołączoną do programu PowerShell w wersji 7.2. Moduł PSDscResources zawiera nowe i zaktualizowane zasoby DSC, które są oficjalnie obsługiwane przez firmę Microsoft. Moduł PSDscResources jest dostępny w Galeria programu PowerShell.

Aby uzyskać więcej informacji i zaktualizować dokumentację, zobacz dokumentację referencyjną usługi PSDscResources.

Składnia

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

Właściwości

Właściwość Opis
Nazwa Wskazuje nazwę roli lub funkcji, którą chcesz upewnić się, że została dodana lub usunięta. Jest to taka sama jak właściwość Name z polecenia cmdlet Get-WindowsFeature , a nie nazwa wyświetlana roli lub funkcji.
Poświadczenie Wskazuje poświadczenia używane do dodawania lub usuwania roli lub funkcji.
IncludeAllSubFeature Ustaw tę właściwość, aby $true zapewnić stan wszystkich wymaganych podfeatur ze stanem funkcji określonej za pomocą właściwości Name .
Ścieżka dziennika Wskazuje ścieżkę do pliku dziennika, w którym dostawca zasobów ma rejestrować operację.

Wspólne właściwości

Właściwość Opis
Dependson Wskazuje, że konfiguracja innego zasobu musi zostać uruchomiona przed skonfigurowaniem tego zasobu. Jeśli na przykład identyfikator bloku skryptu konfiguracji zasobu, który chcesz uruchomić jako pierwszy, to ResourceName, a jego typ to ResourceType, składnia użycia tej właściwości to DependsOn = "[ResourceType]ResourceName".
Zapewnić Wskazuje, czy rola lub funkcja jest dodawana. Aby upewnić się, że rola lub funkcja została dodana, ustaw tę właściwość na Wartość Prezent. Aby upewnić się, że rola lub funkcja została usunięta, ustaw właściwość na Nieobecny. Wartość domyślna to Obecny.
PsDscRunAsCredential Ustawia poświadczenie na potrzeby uruchamiania całego zasobu jako.

Uwaga

Właściwość pospolita PsDscRunAsCredential została dodana w programie WMF 5.0, aby umożliwić uruchamianie dowolnego zasobu DSC w kontekście innych poświadczeń. Aby uzyskać więcej informacji, zobacz Use Credentials with DSC Resources (Używanie poświadczeń z zasobami DSC).

Przykład

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
}