Risorsa Archive DSCDSC Archive Resource

Si applica a: Windows PowerShell 4.0, Windows PowerShell 5.xApplies To: Windows PowerShell 4.0, Windows PowerShell 5.x

La risorsa Archive in Windows PowerShell DSC (Desired State Configuration) fornisce un meccanismo per decomprimere file di archivio (ZIP) in un percorso specifico.The Archive resource in Windows PowerShell Desired State Configuration (DSC) provides a mechanism to unpack archive (.zip) files at a specific path.

Nota

La documentazione di questa risorsa DSC riguarda la versione inclusa in PowerShell.This documentation of this DSC resource covers the version that is included with PowerShell. Il modulo PSDscResources contiene elementi nuovi e aggiornati ufficialmente supportati da Microsoft.The PSDscResources module contains new and updated that are officially supported by Microsoft. Il modulo PSDscResources è disponibile da PowerShell Gallery.The PSDscResources module is available from the PowerShell Gallery.

Per altre informazioni e per la documentazione aggiornata, vedere il file LEGGIMI nel repository GitHub.For more information and updated documentation, see the README in the GitHub repository.

SintassiSyntax

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

ProprietàProperties

ProprietàProperty DescrizioneDescription
DestinationDestination Indica il percorso in cui si vuole specificare di estrarre il contenuto dell'archivio.Specifies the location where you want to ensure the archive contents are extracted.
PathPath Specifica il percorso di origine del file di archivio.Specifies the source path of the archive file.
ChecksumChecksum Definisce il tipo da usare per determinare se due file sono uguali.Defines the type to use when determining whether two files are the same. Se la proprietà Checksum non è specificata, per il confronto viene usato solo il nome del file o della directory.If Checksum is not specified, only the file or directory name is used for comparison. I valori validi includono: SHA-1 , SHA-256 , SHA-512 , createdDate , modifiedDate .Valid values include: SHA-1 , SHA-256 , SHA-512 , createdDate , modifiedDate . Se si specifica Checksum senza Validate , la configurazione non riesce.If you specify Checksum without Validate , the configuration will fail.
CredenzialeCredential Credenziali di un account utente con le autorizzazioni per accedere al percorso di archiviazione e alla destinazione specificati, se necessario.The credential of a user account with permissions to access the specified archive path and destination if needed.
ForceForce Determinate operazioni sui file, ad esempio quando si sovrascrive un file o si elimina una directory non vuota, generano un errore.Certain file operations (such as overwriting a file or deleting a directory that is not empty) will result in an error. Usando la proprietà Force , tali errori vengono ignorati.Using the Force property overrides such errors. Il valore predefinito è False .The default value is False .
ConvalidaValidate Usa la proprietà Checksum per determinare se l'archivio corrisponde alla firma.Uses the Checksum property to determine if the archive matches the signature. Se si specifica Checksum senza Validate , la configurazione non riesce.If you specify Checksum without Validate , the configuration will fail. Se si specifica Validate senza Checksum , per impostazione predefinita viene usato un checksum SHA-256 .If you specify Validate without Checksum , a SHA-256 Checksum is used by default.

Proprietà comuniCommon properties

ProprietàProperty DescrizioneDescription
DependsOnDependsOn Indica che prima di configurare la risorsa è necessario eseguire la configurazione di un'altra risorsa.Indicates that the configuration of another resource must run before this resource is configured. Ad esempio, se il valore di ID del blocco script di configurazione della risorsa che si vuole eseguire per primo è ResourceName e il tipo è ResourceType, la sintassi per usare questa proprietà è 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".
EnsureEnsure Determina se verificare l'esistenza del contenuto dell'archivio in Destination .Determines whether to check if the content of the archive exists at the Destination . Impostare questa proprietà su Present per specificare che il contenuto esiste.Set this property to Present to ensure the contents exist. Impostarla su Absent per specificare che il contenuto non esiste.Set it to Absent to ensure they do not exist. Il valore predefinito è Present .The default value is Present .
PsDscRunAsCredentialPsDscRunAsCredential Imposta le credenziali per l'esecuzione dell'intera risorsa.Sets the credential for running the entire resource as.

Nota

La proprietà comune PsDscRunAsCredential è stata aggiunta in WMF 5.0 per consentire l'esecuzione di qualsiasi risorsa DSC nel contesto di altre credenziali.The PsDscRunAsCredential common property was added in WMF 5.0 to allow running any DSC resource in the context of other credentials. Per altre informazioni, vedere Usare credenziali con risorse DSC.For more information, see Use Credentials with DSC Resources.

EsempioExample

L'esempio seguente mostra come usare la risorsa Archive per assicurarsi che il contenuto di un file di archivio denominato Test.zip esista e venga estratto in una determinata destinazione autorizzata.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"
}