Zasób pakietu DSC

Dotyczy: Windows PowerShell 4.0, Windows PowerShell 5.x

Zasób Pakiet w Windows PowerShell Desired State Configuration (DSC) udostępnia mechanizm instalowania lub odinstalowywania pakietów, takich jak Instalator Windows i pakiety setup.exe, na węźle docelowym.

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

Package [string] #ResourceName
{
    Name = [string]
    Path = [string]
    ProductId = [string]
    [ Arguments = [string] ]
    [ Credential = [PSCredential] ]
    [ LogPath = [string] ]
    [ ReturnCode = [UInt32[]] ]
    [ DependsOn = [string[]] ]
    [ Ensure = [string] { Absent | Present }  ]
    [ PsDscRunAsCredential = [PSCredential] ]
}

Właściwości

Właściwość Opis
Nazwa Wskazuje nazwę pakietu, dla którego chcesz zapewnić określony stan.
Ścieżka Wskazuje ścieżkę, w której znajduje się pakiet.
ProductId Wskazuje identyfikator produktu, który jednoznacznie identyfikuje pakiet.
Argumenty Wyświetla ciąg argumentów, które zostaną przekazane do pakietu dokładnie tak, jak podano.
Poświadczenie Zapewnia dostęp do pakietu w źródle zdalnym. Ta właściwość nie jest używana do instalowania pakietu. Pakiet jest zawsze instalowany w systemie lokalnym.
Ścieżka dziennika Wskazuje pełną ścieżkę, w której dostawca ma zapisać plik dziennika w celu zainstalowania lub odinstalowania pakietu.
Kod zwrotny Wskazuje oczekiwany kod powrotny. Jeśli rzeczywisty kod zwracany nie jest zgodny z oczekiwaną wartością podaną tutaj, konfiguracja zwróci błąd.

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 pakiet jest zainstalowany. Ustaw tę właściwość na Brak , aby upewnić się, że pakiet nie jest zainstalowany (lub odinstaluj pakiet, jeśli został zainstalowany). Ustaw go na Wartość Prezent , aby upewnić się, że pakiet jest zainstalowany. Wartość domyślna to Present (Obecny).
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

W tym przykładzie jest uruchamiany instalator .msi, który znajduje się w określonej ścieżce i ma określony identyfikator produktu.

Configuration PackageTest
{
    Import-DscResource -ModuleName 'PSDesiredStateConfiguration'

    Package PackageExample
    {
        Ensure      = "Present"  # You can also set Ensure to "Absent"
        Path        = "$Env:SystemDrive\TestFolder\TestProject.msi"
        Name        = "TestPackage"
        ProductId   = "ACDDCDAF-80C6-41E6-A1B9-8ABD8A05027E"
    }
}