DSC archiválási erőforrásDSC Archive Resource

A következőkre vonatkozik: Windows PowerShell 4,0, Windows PowerShell 5. xApplies To: Windows PowerShell 4.0, Windows PowerShell 5.x

A Windows PowerShell kívánt állapot-konfigurációjában (DSC) található archív erőforrás egy mechanizmust biztosít az archív (. zip) fájlok egy adott elérési úton való kicsomagolásához.The Archive resource in Windows PowerShell Desired State Configuration (DSC) provides a mechanism to unpack archive (.zip) files at a specific path.

SyntaxSyntax

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

TulajdonságokProperties

TulajdonságProperty LeírásDescription
CélDestination Meghatározza azt a helyet, ahol biztosítani szeretné az Archívum tartalmának kibontását.Specifies the location where you want to ensure the archive contents are extracted.
Elérési útPath Megadja az archív fájl forrásának elérési útját.Specifies the source path of the archive file.
EllenőrzőösszegChecksum Meghatározza azt a típust, amelyet akkor kell használni, ha a két fájl azonos.Defines the type to use when determining whether two files are the same. Ha nincs megadva ellenőrzőösszeg , a rendszer csak a fájl-vagy könyvtárnév-nevet használja az összehasonlításhoz.If Checksum is not specified, only the file or directory name is used for comparison. Az érvényes értékek a következők: SHA-1, SHA-256, SHA-512, createdDate, modifiedDate.Valid values include: SHA-1, SHA-256, SHA-512, createdDate, modifiedDate. Ha az ellenőrzőösszeget Érvényesítésnélkül adja meg, a konfiguráció sikertelen lesz.If you specify Checksum without Validate, the configuration will fail.
Hitelesítő adatCredential A megadott archiválási útvonal és célhely elérésére jogosult felhasználói fiók hitelesítő adatai, ha szükséges.The credential of a user account with permissions to access the specified archive path and destination if needed.
ForceForce Bizonyos fájlokra vonatkozó műveletek (például egy fájl felülírása vagy egy nem üres könyvtár törlése) hibaüzenetet eredményeznek.Certain file operations (such as overwriting a file or deleting a directory that is not empty) will result in an error. A Force tulajdonság használata felülbírálja az ilyen hibákat.Using the Force property overrides such errors. Az alapértelmezett érték false (hamis).The default value is False.
ÉrvényesítésValidate Az ellenőrzőösszeg tulajdonság használatával határozza meg, hogy az Archívum megfelel-e az aláírásnak.Uses the Checksum property to determine if the archive matches the signature. Ha az ellenőrzőösszeget Érvényesítésnélkül adja meg, a konfiguráció sikertelen lesz.If you specify Checksum without Validate, the configuration will fail. Ha ellenőrzőösszegnélküli érvényesítést ad meg, a rendszer alapértelmezés szerint az SHA-256 ellenőrzőösszeget használja.If you specify Validate without Checksum, a SHA-256 Checksum is used by default.

Közös tulajdonságokCommon properties

TulajdonságProperty LeírásDescription
DependsOnDependsOn Azt jelzi, hogy egy másik erőforrás konfigurációjának futnia kell az erőforrás konfigurálása előtt.Indicates that the configuration of another resource must run before this resource is configured. Ha például az az erőforrás-konfigurációs parancsfájl blokkja, amelyet először szeretne futtatni, ResourceName, és a típusa ResourceType, a tulajdonság használatának szintaxisa a következő: 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".
BiztosításaEnsure Meghatározza, hogy meg kell-e vizsgálni, hogy az archívum tartalma létezik-e a célhelyen.Determines whether to check if the content of the archive exists at the Destination. Állítsa be a tulajdonságot úgy, hogy a tartalom létezése megtörténjen.Set this property to Present to ensure the contents exist. Állítsa a hiányzó értékre, és győződjön meg róla, hogy nem léteznek.Set it to Absent to ensure they do not exist. Az alapértelmezett érték jelenvan.The default value is Present.
PsDscRunAsCredentialPsDscRunAsCredential Beállítja a teljes erőforrás futtatásához használt hitelesítő adatokat.Sets the credential for running the entire resource as.

Megjegyzés

A PsDscRunAsCredential Common tulajdonsága a WMF 5,0-ben lett hozzáadva, hogy bármely DSC-erőforrást más hitelesítő adatok kontextusában futtasson.The PsDscRunAsCredential common property was added in WMF 5.0 to allow running any DSC resource in the context of other credentials. További információ: a hitelesítő adatok használata a DSC-erőforrásokkal.For more information, see Use Credentials with DSC Resources.

PéldaExample

Az alábbi példa azt mutatja be, hogyan használható az archív erőforrás annak biztosítására, hogy az archív fájl tartalma Test.zip létezik, és egy adott célhelyre legyen kibontva a és az engedélyezésével.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"
}