DSC-arkivresurs

  • Artikel

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

Arkivresursen i Windows PowerShell Desired State Configuration (DSC) tillhandahåller en mekanism för att packa upp arkivfiler (.zip) på en specifik sökväg.

Not

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 PSDscResources.

Syntax

Archive [string] #ResourceName
{
    Destination = [string]
    Path = [string]
    [ Checksum = [string] { CreatedDate | ModifiedDate | SHA-1 | SHA-256 | SHA-512 } ]
    [ Credential = [PSCredential] ]
    [ Force = [bool] ]
    [ Validate = [bool] ]
    [ Ensure = [string] { Absent | Present } ]
    [ DependsOn = [string[]] ]
    [ PsDscRunAsCredential = [PSCredential] ]
}

Egenskaper

Egenskap Beskrivning
Destination Anger den plats där du vill se till att arkivinnehållet extraheras.
Stig Anger källsökvägen för arkivfilen.
Kontrollsumma Definierar vilken typ som ska användas när du avgör om två filer är samma. Om Checksum inte anges används endast fil- eller katalognamnet för jämförelse. Giltiga värden är: SHA-1, SHA-256, SHA-512, createdDate, modifiedDate. Om du anger Kontrollsumma utan Verifieramisslyckas konfigurationen.
Referens Autentiseringsuppgifterna för ett användarkonto med behörighet att komma åt den angivna arkivsökvägen och målet om det behövs.
Kraft Vissa filåtgärder (till exempel att skriva över en fil eller ta bort en katalog som inte är tom) resulterar i ett fel. Om du använder egenskapen Force åsidosätts sådana fel. Standardvärdet är False.
Validera Använder egenskapen Checksum för att avgöra om arkivet matchar signaturen. Om du anger Kontrollsumma utan Verifieramisslyckas konfigurationen. Om du anger Verifiera utan Checksumanvänds en SHA-256Checksum som standard.

Vanliga 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 det resurskonfigurationsskriptblock som du vill köra först är ResourceName och dess typ är ResourceType, är syntaxen för att använda den här egenskapen DependsOn = "[ResourceType]ResourceName".
Se till Avgör om du vill kontrollera om innehållet i arkivet finns på Destination. Ange den här egenskapen till Presentera för att säkerställa att innehållet finns. Ställ in den på Frånvarande för att säkerställa att de inte finns. Standardvärdet är Present.
PsDscRunAsCredential Anger autentiseringsuppgifterna för att köra hela resursen som.

Not

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

Exempel

I följande exempel visas hur du använder arkivresursen för att säkerställa att innehållet i en arkivfil med namnet Test.zip finns och extraheras vid ett visst mål med hjälp av och auktoriseras.

Archive ArchiveExample {
    Ensure = "Present"
    Path = "C:\Users\Public\Documents\Test.zip"
    Destination = "C:\Users\Public\Documents\ExtractionPath"
}