Udostępnij za pośrednictwem

Zasób archiwum DSC

  • Artykuł

Dotyczy: Windows PowerShell 4.0, Windows PowerShell 5.x

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

Nuta

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 galerii programu PowerShell.

Aby uzyskać więcej informacji i zaktualizować 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łasność Opis
Cel Określa lokalizację, w której chcesz upewnić się, ż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 nie określono sumy kontrolnej, 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 Weryfikuj, konfiguracja zakończy się niepowodzeniem.
Poświadczeń Poświadczenie konta użytkownika z uprawnieniami dostępu do określonej ścieżki archiwum i miejsca docelowego w razie potrzeby.
Siła 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.
Walidować Używa właściwości sumy kontrolnej , aby określić, czy archiwum jest zgodne z podpisem. Jeśli określisz sumę kontrolną bez Weryfikuj, konfiguracja zakończy się niepowodzeniem. Jeśli określisz Validate without Checksum, domyślnie jest używana SHA-256sum kontrolnych.

Typowe właściwości

Własność Opis
DependsOn Wskazuje, że konfiguracja innego zasobu musi zostać uruchomiona przed skonfigurowaniem tego zasobu. Jeśli na przykład identyfikator bloku skryptu konfiguracji zasobu, który chcesz uruchomić jako pierwszy, to ResourceName, a jego typ to ResourceType, składnia używania tej właściwości jest DependsOn = "[ResourceType]ResourceName".
Zapewniać Określa, czy zawartość archiwum istnieje w Destination. 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.
PsDscRunAsCredential Ustawia poświadczenie na potrzeby uruchamiania całego zasobu jako.

Nuta

Właściwość wspólna 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.

Przykład

W poniższym przykładzie pokazano, jak używać zasobu Archiwum, aby 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"
}