Ressource d’archive DSC

S’applique à : Windows PowerShell 4.0, Windows PowerShell 5.x

La ressource Archive dans Windows PowerShell Desired State Configuration (DSC) fournit un mécanisme permettant de décompresser les fichiers d’archivage (.zip) à un chemin spécifique.

Note

Cette documentation de cette ressource DSC couvre la version incluse avec PowerShell antérieure à la version 7.2. Le module PSDscResources contient des ressources DSC nouvelles et mises à jour qui sont officiellement prises en charge par Microsoft. Le module PSDscResources est disponible à partir de PowerShell Gallery.

Pour plus d’informations et la documentation mise à jour, consultez la documentation de référence PSDscResources.

Syntaxe

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

Propriétés

Propriété	Description
Destination	Spécifie l’emplacement où vous souhaitez vous assurer que le contenu de l’archive est extrait.
Chemin	Spécifie le chemin d’accès source du fichier d’archivage.
Somme de contrôle	Définit le type à utiliser pour déterminer si deux fichiers sont identiques. Si somme de contrôle n’est pas spécifiée, seul le nom du fichier ou du répertoire est utilisé pour la comparaison. Les valeurs valides sont les suivantes : SHA-1 , SHA-256, SHA-512, createdDate, modifiedDate. Si vous spécifiez somme de contrôle sans Valider, la configuration échoue.
Credential	Informations d’identification d’un compte d’utilisateur disposant des autorisations nécessaires pour accéder au chemin d’archivage et à la destination spécifiés.
Force	Certaines opérations de fichier (telles que le remplacement d’un fichier ou la suppression d’un répertoire qui n’est pas vide) entraînent une erreur. L’utilisation de la propriété Force remplace ces erreurs. La valeur par défaut est False.
Valider	Utilise la propriété Checksum pour déterminer si l’archive correspond à la signature. Si vous spécifiez somme de contrôle sans Valider, la configuration échoue. Si vous spécifiez Valider sans de somme de contrôle, une somme de contrôle SHA-256 est utilisée par défaut.

Propriétés communes

Propriété	Description
DependsOn	Indique que la configuration d’une autre ressource doit s’exécuter avant la configuration de cette ressource. Par exemple, si l’ID du bloc de script de configuration de ressource que vous souhaitez exécuter en premier est ResourceName et que son type est ResourceType, la syntaxe d’utilisation de cette propriété est DependsOn = "[ResourceType]ResourceName".
Assurer	Détermine s’il faut vérifier si le contenu de l’archive existe au Destination. Définissez cette propriété sur Present pour vous assurer que le contenu existe. Définissez-le sur absent pour s’assurer qu’ils n’existent pas. La valeur par défaut est Present.
PsDscRunAsCredential	Définit les informations d’identification pour l’exécution de la ressource entière en tant que.

Note

La propriété commune PsDscRunAsCredential a été ajoutée dans WMF 5.0 pour autoriser l’exécution de n’importe quelle ressource DSC dans le contexte d’autres informations d’identification. Pour plus d’informations, consultez Utiliser des informations d’identification avec des ressources DSC.

Exemple

L’exemple suivant montre comment utiliser la ressource Archive pour vous assurer que le contenu d’un fichier d’archivage appelé Test.zip existe et qu’il est extrait à une destination donnée à l’aide et à l’autorisation.

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