DSC-Ressourcen „Archive“

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

Die Ressource „Archive“ in Windows PowerShell DSC bietet einen Mechanismus zum Entpacken von Archivdateien (.zip).

Hinweis

In dieser Dokumentation dieser DSC-Ressource wird die Version behandelt, 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 Modul PSDscResources 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

Eigenschaft	BESCHREIBUNG
Destination	Gibt den Speicherort an, an dem der Archivinhalt einer Datei extrahiert werden soll.
`Path`	Gibt den Quellpfad der Archivdatei an.
Checksum	Definiert den zu verwendenden Typ, wenn bestimmt wird, ob zwei Dateien identisch sind. Wenn Checksum nicht angegeben ist, wird nur der Datei- oder Verzeichnisnamen für den Vergleich verwendet. Gültige Werte: SHA-1, SHA-256, SHA-512, createdDate, modifiedDate. Wenn Sie Checksum ohne Validate angeben, schlägt die Konfiguration fehl.
Anmeldeinformationen	Die Anmeldeinformationen eines Benutzerkontos mit Zugriffsberechtigung (falls erforderlich) auf den angegebenen Archivpfad und das angegebene Ziel.
Force	Bestimmte Dateioperationen (z. B. das Überschreiben einer Datei oder Löschen eines Verzeichnisses, das nicht leer ist), führen zu einem Fehler. Bei Verwenden der Force-Eigenschaft werden solche Fehler überschrieben. Der Standardwert ist False.
Überprüfen	Verwendet die Eigenschaft Checksum, um zu bestimmen, ob das Archiv der Signatur entspricht. Wenn Sie Checksum ohne Validate angeben, schlägt die Konfiguration fehl. Wenn Sie Validate ohne Checksum angeben, wird standardmäßig eine SHA-256-Prüfsumme verwendet.

Allgemeine Eigenschaften

Eigenschaft	BESCHREIBUNG
DependsOn	Gibt an, dass die Konfiguration einer anderen Ressource ausgeführt werden muss, bevor diese Ressource konfiguriert wird. Wenn beispielsweise die ID des Skriptblocks mit der Ressourcenkonfiguration, den Sie zuerst ausführen möchten, „ResourceName“ und dessen Typ „ResourceType“ ist, lautet die Syntax für das Verwenden dieser Eigenschaft DependsOn = "[ResourceType]ResourceName".
Ensure	Bestimmt, ob geprüft wird, ob der Inhalt der Archivdatei am Ziel vorhanden ist. Legen Sie diese Eigenschaft auf Present fest, um sicherzustellen, dass der Inhalt vorhanden ist. Legen Sie sie auf Absent fest, um sicherzustellen, dass der Inhalt nicht vorhanden ist. Der Standardwert ist Present.
PsDscRunAsCredential	Legt die Anmeldeinformationen für die Ausführung der gesamten Ressource fest.

Hinweis

Die allgemeine Eigenschaft PsDscRunAsCredential wurde in WMF 5.0 hinzugefügt, um das Ausführen einer beliebigen DSC-Ressource in Verbindung mit anderen Anmeldeinformationen zu ermöglichen. Weitere Informationen finden Sie unter Use Credentials with DSC Resources (Verwenden von Anmeldeinformationen mit DSC-Ressourcen).

Beispiel

Im folgenden Beispiel wird veranschaulicht, wie Sie die Ressource „Archive“ verwenden, um sicherzustellen, dass der Inhalt einer Archivdatei mit dem Namen Test.zip vorhanden ist und an einem bestimmten Zielspeicherort extrahiert, verwendet und autorisiert wird.

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