Freigeben über

DSC-Archivressource

  • Artikel

Gilt für: Windows PowerShell 4.0, Windows PowerShell 5.x

Die Archivressource in der Windows PowerShell Desired State Configuration (DSC) bietet einen Mechanismus zum Entpacken von Archivdateien (.zip) in einem bestimmten Pfad.

Anmerkung

Diese Dokumentation dieser DSC-Ressource behandelt die Version, die in PowerShell vor Version 7.2 enthalten ist. Das PSDscResources Modul enthält neue und aktualisierte DSC-Ressourcen, die offiziell von Microsoft unterstützt werden. Das PSDscResources Modul ist im PowerShell-Katalog verfügbar.

Weitere Informationen und aktualisierte Dokumentation finden Sie in der PSDscResources-Referenzdokumentation.

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

Eigenschaften

Eigentum Beschreibung
Bestimmungsort Gibt den Speicherort an, an dem Sie sicherstellen möchten, dass die Archivinhalte extrahiert werden.
Pfad Gibt den Quellpfad der Archivdatei an.
Prüfsumme Definiert den Typ, der verwendet werden soll, wenn ermittelt wird, ob zwei Dateien identisch sind. Wenn Prüfsumme nicht angegeben ist, wird nur der Datei- oder Verzeichnisname für den Vergleich verwendet. Gültige Werte sind: SHA-1, SHA-256, SHA-512, createdDate, modifiedDate. Wenn Sie Prüfsummen- ohne Validateangeben, schlägt die Konfiguration fehl.
Berechtigungsnachweis Die Anmeldeinformationen eines Benutzerkontos mit Berechtigungen für den Zugriff auf den angegebenen Archivpfad und das angegebene Ziel bei Bedarf.
Kraft Bestimmte Dateivorgänge (z. B. das Überschreiben einer Datei oder das Löschen eines nicht leeren Verzeichnisses) führen zu einem Fehler. Die Verwendung der Force-Eigenschaft setzt solche Fehler außer Kraft. Der Standardwert ist False.
Validieren Bestimmt mithilfe der Checksum--Eigenschaft, ob das Archiv der Signatur entspricht. Wenn Sie Prüfsummen- ohne Validateangeben, schlägt die Konfiguration fehl. Wenn Sie Validate ohne Checksum-angeben, wird standardmäßig eine SHA-256-Checkum- verwendet.

Gemeingüter

Eigentum Beschreibung
DependsOn Gibt an, dass die Konfiguration einer anderen Ressource ausgeführt werden muss, bevor diese Ressource konfiguriert ist. Wenn beispielsweise die ID des Ressourcenkonfigurationsskriptblocks, den Sie zuerst ausführen möchten, "ResourceName" ist und der Typ "ResourceType" lautet, ist die Syntax für die Verwendung dieser Eigenschaft DependsOn = "[ResourceType]ResourceName".
Sicherstellen Bestimmt, ob der Inhalt des Archivs im Destinationvorhanden ist. Legen Sie diese Eigenschaft auf Present fest, um sicherzustellen, dass der Inhalt vorhanden ist. Legen Sie sie auf Nicht vorhanden fest, um sicherzustellen, dass sie nicht vorhanden sind. Der Standardwert ist Present.
PsDscRunAsCredential Legt die Anmeldeinformationen für die Ausführung der gesamten Ressource als fest.

Anmerkung

Die PsDscRunAsCredential gemeinsame Eigenschaft wurde in WMF 5.0 hinzugefügt, um das Ausführen einer DSC-Ressource im Kontext anderer Anmeldeinformationen zu ermöglichen. Weitere Informationen finden Sie unter Verwenden von Anmeldeinformationen mit DSC Resources.

Beispiel

Das folgende Beispiel zeigt, wie Sie mithilfe der Archivressource sicherstellen, dass der Inhalt einer Archivdatei mit dem Namen Test.zip vorhanden ist und an einem bestimmten Ziel extrahiert und autorisiert wird.

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