Zasób archiwum DSC

Dotyczy: Windows PowerShell 4.0, Windows PowerShell 5.x

Zasób Archiwum w Windows PowerShell Desired State Configuration (DSC) udostępnia mechanizm rozpakowywania plików archiwum (.zip) w określonej ścieżce.

Uwaga

Ta dokumentacja tego zasobu DSC obejmuje wersję dołączoną do programu PowerShell przed wersją 7.2. Moduł PSDscResources zawiera nowe i zaktualizowane zasoby DSC, które są oficjalnie obsługiwane przez firmę Microsoft. Moduł PSDscResources jest dostępny w Galeria programu PowerShell.

Aby uzyskać więcej informacji i zaktualizowaną dokumentację, zobacz dokumentację referencyjną psDscResources.

Składnia

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

Właściwości

Właściwość	Opis
Element docelowy	Określa lokalizację, w której chcesz mieć pewność, że zawartość archiwum jest wyodrębniona.
Ścieżka	Określa ścieżkę źródłową pliku archiwum.
Suma kontrolna	Definiuje typ, który ma być używany podczas określania, czy dwa pliki są takie same. Jeśli suma kontrolna nie jest określona, do porównania jest używana tylko nazwa pliku lub katalogu. Prawidłowe wartości to: SHA-1, SHA-256, SHA-512, createdDate, modifiedDate. Jeśli określisz sumę kontrolnąbez weryfikacji, konfiguracja zakończy się niepowodzeniem.
Poświadczenie	Poświadczenie konta użytkownika z uprawnieniami dostępu do określonej ścieżki archiwum i miejsca docelowego w razie potrzeby.
Force	Niektóre operacje na plikach (takie jak zastępowanie pliku lub usuwanie katalogu, który nie jest pusty), spowodują błąd. Użycie właściwości Force zastępuje takie błędy. Wartość domyślna to False.
Walidacja	Używa właściwości Sumy kontrolnej , aby określić, czy archiwum jest zgodne z podpisem. Jeśli określisz sumę kontrolnąbez weryfikacji, konfiguracja zakończy się niepowodzeniem. Jeśli określisz opcję Weryfikuj bez sumy kontrolnej, domyślnie jest używana suma kontrolnaSHA-256.

Wspólne właściwości

Właściwość	Opis
Dependson	Wskazuje, że przed skonfigurowaniem tego zasobu należy uruchomić konfigurację innego zasobu. Jeśli na przykład identyfikator bloku skryptu konfiguracji zasobu, który chcesz uruchomić jako pierwszy, to ResourceName, a jego typem jest ResourceType, składnia użycia tej właściwości to DependsOn = "[ResourceType]ResourceName".
Zapewnić	Określa, czy zawartość archiwum istnieje w lokalizacji docelowej. Ustaw tę właściwość na wartość Present , aby upewnić się, że zawartość istnieje. Ustaw go na Wartość Nieobecny , aby upewnić się, że nie istnieją. Wartość domyślna to Present (Obecny).
PsDscRunAsCredential	Ustawia poświadczenie do uruchamiania całego zasobu jako.

Uwaga

Właściwość pospolita PsDscRunAsCredential została dodana w programie WMF 5.0, aby umożliwić uruchamianie dowolnego zasobu DSC w kontekście innych poświadczeń. Aby uzyskać więcej informacji, zobacz Use Credentials with DSC Resources (Używanie poświadczeń z zasobami DSC).

Przykład

W poniższym przykładzie pokazano, jak za pomocą zasobu Archiwum upewnić się, że zawartość pliku archiwum o nazwie Test.zip istnieje i są wyodrębniane w danym miejscu docelowym przy użyciu i autoryzowane.

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