Prostředek archivu DSC

Platí pro: Windows PowerShell 4.0, Windows PowerShell 5.x

Prostředek Archivovat v Windows PowerShell Desired State Configuration (DSC) poskytuje mechanismus pro rozbalení archivačních souborů (.zip) na konkrétní cestě.

Poznámka

Tato dokumentace k tomuto prostředku DSC se zabývá verzí, která je součástí PowerShellu před verzí 7.2. Modul PSDscResources obsahuje nové a aktualizované prostředky DSC, které jsou oficiálně podporovány Microsoftem. Modul PSDscResources je k dispozici v Galerie prostředí PowerShell.

Další informace a aktualizovanou dokumentaci najdete v referenční dokumentaci k 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] ]
}

Vlastnosti

Vlastnost Popis
Cíl Určuje umístění, kam chcete zajistit extrahování obsahu archivu.
Cesta Určuje cestu ke zdroji souboru archivu.
Kontrolní součet Definuje typ, který se má použít při určování, zda jsou dva soubory stejné. Pokud není zadaný kontrolní součet , použije se k porovnání pouze název souboru nebo adresáře. Platné hodnoty: SHA-1, SHA-256, SHA-512, createdDate, modifiedDate. Pokud zadáte Kontrolní součet bez ověření, konfigurace se nezdaří.
Přihlašovací údaj Přihlašovací údaje uživatelského účtu s oprávněními pro přístup k zadané cestě archivu a cíli v případě potřeby.
Force Některé operace se soubory (například přepsání souboru nebo odstranění adresáře, který není prázdný) způsobí chybu. Použitím vlastnosti Force tyto chyby přepíšete. Výchozí hodnota je Nepravda.
Ověření Používá kontrolní součet vlastnost k určení, zda archiv odpovídá podpisu. Pokud zadáte Kontrolní součet bez ověření, konfigurace se nezdaří. Pokud zadáte Ověřit bez kontrolního součtu, použije se ve výchozím nastavení kontrolní součetSHA-256.

Společné vlastnosti

Vlastnost Popis
DependsOn Označuje, že konfigurace jiného prostředku musí být spuštěna před konfigurací tohoto prostředku. Pokud je například ID bloku konfiguračního skriptu prostředku, který chcete spustit jako první, ResourceName a jeho typ je ResourceType, syntaxe pro použití této vlastnosti je DependsOn = "[ResourceType]ResourceName".
Zajištění Určuje, zda se má zkontrolovat, zda obsah archivu existuje v cíli. Nastavte tuto vlastnost na Prezentovat , aby obsah existoval. Nastavte ho na Chybějící , abyste zajistili, že neexistují. Výchozí hodnota je Present (Prezentovat).
PsDscRunAsCredential Nastaví přihlašovací údaje pro spuštění celého prostředku jako.

Poznámka

Společná vlastnost PsDscRunAsCredential byla přidána do WMF 5.0, aby bylo možné spustit jakýkoli prostředek DSC v kontextu jiných přihlašovacích údajů. Další informace najdete v tématu Použití přihlašovacích údajů s prostředky DSC.

Příklad

Následující příklad ukazuje, jak pomocí prostředku Archiv zajistit, že obsah archivního souboru s názvem Test.zip existuje a je extrahován v daném cíli pomocí a autorizován.

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