Risorsa Archive DSC

Si applica a: 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.

Nota

Questa documentazione di questa risorsa DSC illustra la versione inclusa in PowerShell prima della versione 7.2. Il modulo PSDscResources contiene risorse DSC nuove e aggiornate supportate ufficialmente da Microsoft. Il modulo PSDscResources è disponibile da PowerShell Gallery.

Per altre informazioni e documentazione aggiornata, vedere la documentazione di riferimento psDscResources.

Sintassi

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à

Proprietà Descrizione
Destination Indica il percorso in cui si vuole specificare di estrarre il contenuto dell'archivio.
Path Specifica il percorso di origine del file di archivio.
Checksum Definisce il tipo da usare per determinare se due file sono uguali. Se la proprietà Checksum non è specificata, per il confronto viene usato solo il nome del file o della directory. I valori validi includono: SHA-1, SHA-256, SHA-512, createdDate, modifiedDate. Se si specifica Checksum senza Validate, la configurazione non riesce.
Credenziale Credenziali di un account utente con le autorizzazioni per accedere al percorso di archiviazione e alla destinazione specificati, se necessario.
Force Determinate operazioni sui file, ad esempio quando si sovrascrive un file o si elimina una directory non vuota, generano un errore. Usando la proprietà Force, tali errori vengono ignorati. Il valore predefinito è False.
Convalida Usa la proprietà Checksum per determinare se l'archivio corrisponde alla firma. Se si specifica Checksum senza Validate, la configurazione non riesce. Se si specifica Validate senza Checksum, per impostazione predefinita viene usato un checksumSHA-256.

Proprietà comuni

Proprietà Descrizione
DependsOn Indica che prima di configurare la risorsa è necessario eseguire la configurazione di un'altra risorsa. 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".
Ensure Determina se verificare l'esistenza del contenuto dell'archivio in Destination. Impostare questa proprietà su Present per specificare che il contenuto esiste. Impostarla su Absent per specificare che il contenuto non esiste. Il valore predefinito è Present.
PsDscRunAsCredential Imposta le credenziali per l'esecuzione dell'intera risorsa.

Nota

La proprietà comune PsDscRunAsCredential è stata aggiunta in WMF 5.0 per consentire l'esecuzione di qualsiasi risorsa DSC nel contesto di altre credenziali. Per altre informazioni, vedere Usare credenziali con risorse DSC.

Esempio

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.

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