Zasób środowiska DSC

Dotyczy: Windows PowerShell 4.0, Windows PowerShell 5.x

Zasób środowiska w Windows PowerShell Desired State Configuration (DSC) udostępnia mechanizm zarządzania zmiennymi środowiskowymi systemu.

Uwaga

Ta dokumentacja tego zasobu DSC obejmuje wersję dołączoną do programu PowerShell przed wersją 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 zaktualizowaną dokumentację, zobacz dokumentację referencyjną psDscResources.

Składnia

Environment [string] #ResourceName
{
    Name = [string]
    [ Path = [bool] ]
    [ Value = [string] ]
    [ DependsOn = [string[]] ]
    [ Ensure = [string] { Absent | Present }  ]
    [ PsDscRunAsCredential = [PSCredential] ]
}

Właściwości

Właściwość	Opis
Nazwa	Wskazuje nazwę zmiennej środowiskowej, dla której chcesz zapewnić określony stan.
Ścieżka	Definiuje konfigurowaną zmienną środowiskową. Ustaw tę właściwość na $true wartość , jeśli zmienna jest zmienną Path . W przeciwnym razie ustaw ją na $falsewartość . Wartość domyślna to $false. Jeśli skonfigurowana zmienna jest zmienną Path , wartość podana za pośrednictwem właściwości Value zostanie dołączona do istniejącej wartości.
Wartość	Wartość, która ma zostać przypisana do zmiennej środowiskowej.

Wspólne właściwości

Właściwość	Opis
Dependson	Wskazuje, że przed skonfigurowaniem tego zasobu należy uruchomić konfigurację innego zasobu. Jeśli na przykład identyfikator bloku skryptu konfiguracji zasobu, który chcesz uruchomić jako pierwszy, to ResourceName, a jego typem jest ResourceType, składnia użycia tej właściwości to DependsOn = "[ResourceType]ResourceName".
Zapewnić	Wskazuje, czy zmienna istnieje. Ustaw tę właściwość na Present , aby utworzyć zmienną środowiskową, jeśli nie istnieje lub upewnić się, że jej wartość jest zgodna z wartością podaną za pomocą właściwości Value , jeśli zmienna już istnieje. Ustaw dla niej wartość Nieobecny , aby usunąć zmienną, jeśli istnieje.
PsDscRunAsCredential	Ustawia poświadczenie do 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

Poniższy przykład zapewnia, że element TestEnvironmentVariable jest obecny i ma wartość TestValue. Jeśli nie jest obecny, tworzy go.

Environment EnvironmentExample
{
    Ensure = "Present"  # You can also set Ensure to "Absent"
    Name = "TestEnvironmentVariable"
    Value = "TestValue"
}