Zasób dsC PackageManagement

Dotyczy: Windows PowerShell 4.0, Windows PowerShell 5.0, Windows PowerShell 5.1

Zasób PackageManagement w Windows PowerShell Desired State Configuration (DSC) udostępnia mechanizm instalowania lub odinstalowywania pakietów zarządzania pakietami w węźle docelowym. Ten zasób wymaga modułu PackageManagement dostępnego w https://PowerShellGallery.comprogramie .

Ważne

Moduł PackageManagement powinien być co najmniej w wersji 1.1.7.0, aby następujące informacje o właściwościach było poprawne.

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

PackageManagement [string] #ResourceName
{
    Name = [string]
    [ AdditionalParameters = [HashTable] ]
    [ DependsOn = [string[]] ]
    [ Ensure = [string]{ Absent | Present } ]
    [ MaximumVersion = [string] ]
    [ MinimumVersion = [string] ]
    [ ProviderName = [string] ]
    [ PsDscRunAsCredential = [PSCredential] ]
    [ RequiredVersion = [string] ]
    [ Source = [string] ]
    [ SourceCredential = [PSCredential] ]
}

Właściwości

Właściwość Opis
Nazwa Określa nazwę pakietu do zainstalowania lub odinstalowania.
Dodatkowe parametryparametrów Tabela skrótowa dostawcy parametrów, które zostaną przekazane do Get-Package -AdditionalArgumentselementu . Na przykład dla dostawcy NuGet można przekazać dodatkowe parametry, takie jak Destination.
MaximumVersion Określa maksymalną dozwoloną wersję pakietu, którą chcesz znaleźć. Jeśli ten parametr nie zostanie dodany, zasób znajdzie najwyższą dostępną wersję pakietu.
Minimalna wersja Określa minimalną dozwoloną wersję pakietu, który chcesz znaleźć. Jeśli ten parametr nie zostanie dodany, zasób znajdzie najwyższą dostępną wersję pakietu, która spełnia również dowolną maksymalną określoną wersję określoną przez parametr MaximumVersion .
ProviderName Określa nazwę dostawcy pakietów, do której ma być ograniczone wyszukiwanie pakietów. Nazwy dostawców pakietów można uzyskać, uruchamiając Get-PackageProvider polecenie cmdlet.
RequiredVersion Określa dokładną wersję pakietu, który chcesz zainstalować. Jeśli nie określisz tego parametru, ten zasób DSC instaluje najnowszą dostępną wersję pakietu, która również spełnia wszelkie maksymalne wersje określone przez parametr MaximumVersion .
Element źródłowy Określa nazwę źródła pakietu, w którym można znaleźć pakiet. Może to być identyfikator URI lub źródło zarejestrowane Register-PackageSource przy użyciu zasobu PackageManagementSource DSC.
SourceCredential Określa konto użytkownika, które ma uprawnienia do instalowania pakietu dla określonego dostawcy lub źródła pakietów.

Dodatkowe parametry

W poniższej tabeli wymieniono opcje właściwości AdditionalParameters.

Parametr Opis
Element docelowy Używane przez dostawców, takich jak wbudowany dostawca Nuget. Określa lokalizację pliku, w której ma zostać zainstalowany pakiet.
InstalacjaZasady Używane przez dostawców, takich jak wbudowany dostawca Nuget. Określa, czy ufasz źródle pakietu. Jeden z: niezaufany lub zaufany.

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ć Określa, czy pakiet ma zostać zainstalowany, czy odinstalowany. 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

W tym przykładzie instalowany jest pakiet NuGet JQuery i moduł GistProvider programu PowerShell przy użyciu zasobu PackageManagement DSC. Ten przykład najpierw zapewnia dostępność wymaganych źródeł pakietów, a następnie definiuje oczekiwany stan pakietów JQuery i GistProvider (odpowiednio NuGet i PowerShell).

Configuration PackageTest
{
    Import-DscResource -ModuleName 'PackageManagement'

    PackageManagementSource SourceRepository
    {
        Ensure      = "Present"
        Name        = "MyNuget"
        ProviderName= "Nuget"
        SourceLocation   = "http://nuget.org/api/v2/"
        InstallationPolicy ="Trusted"
    }

    PackageManagementSource PSGallery
    {
        Ensure      = "Present"
        Name        = "psgallery"
        ProviderName= "PowerShellGet"
        SourceLocation   = "https://www.powershellgallery.com/api/v2"
        InstallationPolicy ="Trusted"
    }

    PackageManagement NugetPackage
    {
        Ensure               = "Present"
        Name                 = "JQuery"
        AdditionalParameters = "$env:HomeDrive\nuget"
        RequiredVersion      = "2.0.1"
        DependsOn            = "[PackageManagementSource]SourceRepository"
    }

    PackageManagement PSModule
    {
        Ensure               = "Present"
        Name                 = "gistprovider"
        Source               = "PSGallery"
        DependsOn            = "[PackageManagementSource]PSGallery"
    }
}