DSC-paketresurs

Gäller för: Windows PowerShell 4.0 Windows PowerShell 5.x

Paketresursen i Windows PowerShell Desired State Configuration (DSC) tillhandahåller en mekanism för att installera eller avinstallera paket, till exempel Windows Installer och setup.exe paket, på en målnod.

Anteckning

Den här dokumentationen för den här DSC-resursen omfattar den version som ingår i PowerShell före version 7.2. Modulen PSDscResources innehåller nya och uppdaterade DSC-resurser som stöds officiellt av Microsoft. Modulen PSDscResources är tillgänglig från PowerShell-galleriet.

Mer information och uppdaterad dokumentation finns i referensdokumentationen för PSDscResources.

Syntax

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] ]
}

Egenskaper

Egenskap	Beskrivning
Name	Anger namnet på paketet som du vill säkerställa ett visst tillstånd för.
Sökväg	Anger sökvägen där paketet finns.
ProductId	Anger det produkt-ID som unikt identifierar paketet.
Argument	Visar en sträng med argument som skickas till paketet exakt som det tillhandahålls.
Autentiseringsuppgift	Ger åtkomst till paketet på en fjärrkälla. Den här egenskapen används inte för att installera paketet. Paketet installeras alltid på det lokala systemet.
LogPath	Anger den fullständiga sökvägen där du vill att providern ska spara en loggfil för att installera eller avinstallera paketet.
Returkod	Anger förväntad returkod. Om den faktiska returkoden inte matchar det förväntade värdet som anges här returnerar konfigurationen ett fel.

Gemensamma egenskaper

Egenskap	Beskrivning
DependsOn	Anger att konfigurationen av en annan resurs måste köras innan den här resursen har konfigurerats. Om till exempel ID:t för resurskonfigurationsskriptblocket som du vill köra först är ResourceName och dess typ är ResourceType är DependsOn = "[ResourceType]ResourceName"syntaxen för att använda den här egenskapen .
Säkerställa	Anger om paketet är installerat. Ställ in den här egenskapen på Frånvarande för att säkerställa att paketet inte är installerat (eller avinstallera paketet om det är installerat). Ställ in den på Presentera för att se till att paketet är installerat. Standardvärdet är Present.
PsDscRunAsCredential	Anger autentiseringsuppgifterna för att köra hela resursen som.

Anteckning

Den vanliga egenskapen PsDscRunAsCredential lades till i WMF 5.0 för att tillåta körning av valfri DSC-resurs i kontexten för andra autentiseringsuppgifter. Mer information finns i Använda autentiseringsuppgifter med DSC-resurser.

Exempel

Det här exemplet kör det .msi installationsprogrammet som finns på den angivna sökvägen och har det angivna produkt-ID:t.

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"
    }
}