Zasób archiwum DSCDSC Archive Resource

Dotyczy: Windows PowerShell 4,0, Windows PowerShell 5. xApplies To: Windows PowerShell 4.0, Windows PowerShell 5.x

Zasób Archiwum w programie Windows PowerShell Konfiguracja żądanego stanu (DSC) zawiera mechanizm do rozpakowywania plików archiwalnych (zip) w określonej ścieżce.The Archive resource in Windows PowerShell Desired State Configuration (DSC) provides a mechanism to unpack archive (.zip) files at a specific path.

SkładniaSyntax

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ściProperties

WłaściwośćProperty OpisDescription
Element docelowyDestination Określa lokalizację, w której chcesz upewnić się, że zawartość archiwum zostanie wyodrębniona.Specifies the location where you want to ensure the archive contents are extracted.
ŚcieżkaPath Określa ścieżkę źródłową pliku archiwum.Specifies the source path of the archive file.
Suma kontrolnaChecksum Definiuje typ, który ma być używany podczas określania, czy dwa pliki są takie same.Defines the type to use when determining whether two files are the same. Jeśli sum kontrolnych nie zostanie określona, tylko nazwa pliku lub katalogu jest używana do porównania.If Checksum is not specified, only the file or directory name is used for comparison. Prawidłowe wartości to: SHA-1, SHA-256, SHA-512, createdDate, modifiedDate.Valid values include: SHA-1, SHA-256, SHA-512, createdDate, modifiedDate. Jeśli określisz sumę kontrolną bez sprawdzania poprawności, konfiguracja zakończy się niepowodzeniem.If you specify Checksum without Validate, the configuration will fail.
PoświadczenieCredential W razie potrzeby poświadczenia konta użytkownika z uprawnieniami dostępu do określonej ścieżki i miejsca docelowego archiwum.The credential of a user account with permissions to access the specified archive path and destination if needed.
ForceForce Niektóre operacje na plikach (takie jak zastąpienie pliku lub usunięcie niepustego katalogu) spowodują wystąpienie błędu.Certain file operations (such as overwriting a file or deleting a directory that is not empty) will result in an error. Użycie właściwości Force zastępuje takie błędy.Using the Force property overrides such errors. Wartość domyślna to false.The default value is False.
WalidacjaValidate Używa właściwości Checksum , aby określić, czy archiwum pasuje do sygnatury.Uses the Checksum property to determine if the archive matches the signature. Jeśli określisz sumę kontrolną bez sprawdzania poprawności, konfiguracja zakończy się niepowodzeniem.If you specify Checksum without Validate, the configuration will fail. Jeśli określisz polecenie Weryfikuj bez sumy kontrolnej, domyślnie zostanie użyta suma kontrolna SHA-256 .If you specify Validate without Checksum, a SHA-256 Checksum is used by default.

Wspólne właściwościCommon properties

WłaściwośćProperty OpisDescription
DependsOnDependsOn Wskazuje, że konfiguracja innego zasobu musi być uruchomiona przed skonfigurowaniem tego zasobu.Indicates that the configuration of another resource must run before this resource is configured. Na przykład, jeśli identyfikator bloku skryptu konfiguracji zasobu, który ma zostać uruchomiony jako pierwszy jest resourceName, a jego typ to ResourceType, Składnia służąca do użycia tej właściwości to DependsOn = "[ResourceType]ResourceName" .For example, if the ID of the resource configuration script block that you want to run first is ResourceName and its type is ResourceType, the syntax for using this property is DependsOn = "[ResourceType]ResourceName".
Upewnij się żeEnsure Określa, czy zawartość archiwum istnieje w miejscu docelowym.Determines whether to check if the content of the archive exists at the Destination. Ustaw tę właściwość na obecną , aby upewnić się, że zawartość istnieje.Set this property to Present to ensure the contents exist. Ustaw na Brak , aby upewnić się, że nie istnieją.Set it to Absent to ensure they do not exist. Wartość domyślna jest obecna.The default value is Present.
PsDscRunAsCredentialPsDscRunAsCredential Ustawia poświadczenia do uruchamiania całego zasobu jako.Sets the credential for running the entire resource as.

Uwaga

Właściwość PsDscRunAsCredential Common została dodana w programie WMF 5,0, aby umożliwić uruchamianie dowolnego zasobu DSC w kontekście innych poświadczeń.The PsDscRunAsCredential common property was added in WMF 5.0 to allow running any DSC resource in the context of other credentials. Aby uzyskać więcej informacji, zobacz Korzystanie z poświadczeń z zasobami DSC.For more information, see Use Credentials with DSC Resources.

PrzykładExample

Poniższy przykład pokazuje, jak używać zasobu archiwum, aby upewnić się, że zawartość pliku archiwum Test.zip istnieje i jest wyodrębniana w danym miejscu docelowym przy użyciu i autoryzowany.The following example shows how to use the Archive resource to ensure that the contents of an archive file called Test.zip exist and are extracted at a given destination using and authorized.

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