Recurso de Arquivo do DSC

Aplica-se a: Windows PowerShell 4.0, Windows PowerShell 5.x

O recurso Arquivo no Windows PowerShell Desired State Configuration (DSC) fornece um mecanismo para desempacotar ficheiros de arquivo (.zip) num caminho específico.

Nota

Esta documentação deste recurso do DSC abrange a versão incluída no PowerShell anterior à versão 7.2. O módulo PSDscResources contém recursos DSC novos e atualizados que são oficialmente suportados pela Microsoft. O módulo PSDscResources está disponível no Galeria do PowerShell.

Para obter mais informações e documentação atualizada, veja a documentação de referência PSDscResources.

Syntax

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

Propriedades

Propriedade	Descrição
Destino	Especifica a localização onde pretende garantir que os conteúdos de arquivo são extraídos.
Caminho	Especifica o caminho de origem do ficheiro de arquivo.
Soma de verificação	Define o tipo a utilizar ao determinar se dois ficheiros são iguais. Se a Soma de Verificação não for especificada, apenas o nome do ficheiro ou diretório é utilizado para comparação. Os valores válidos incluem : SHA-1, SHA-256, SHA-512, createdDate, modifiedDate. Se especificar Soma de Verificação sem Validar, a configuração falhará.
Credencial	A credencial de uma conta de utilizador com permissões para aceder ao caminho de arquivo e destino especificados, se necessário.
Force	Determinadas operações de ficheiro (como substituir um ficheiro ou eliminar um diretório que não está vazio) resultarão num erro. A utilização da propriedade Forçar substitui esses erros. O valor predefinido é Falso.
Validação	Utiliza a propriedade Soma de Verificação para determinar se o arquivo corresponde à assinatura. Se especificar Soma de Verificação sem Validar, a configuração falhará. Se especificar Validar sem Soma de Verificação, é utilizada uma Soma de Verificação SHA-256 por predefinição.

Common properties (Propriedades comuns)

Propriedade	Descrição
DependsOn	Indica que a configuração de outro recurso tem de ser executada antes de este recurso ser configurado. Por exemplo, se o ID do bloco de script de configuração de recursos que pretende executar primeiro for ResourceName e o respetivo tipo for ResourceType, a sintaxe para utilizar esta propriedade é DependsOn = "[ResourceType]ResourceName".
Certifique-se de que	Determina se o conteúdo do arquivo existe no Destino. Defina esta propriedade como Apresentar para garantir que os conteúdos existem. Defina-o como Ausente para garantir que não existem. O valor predefinido é Presente.
PsDscRunAsCredential	Define a credencial para executar todo o recurso como.

Nota

A propriedade comum PsDscRunAsCredential foi adicionada no WMF 5.0 para permitir a execução de qualquer recurso DSC no contexto de outras credenciais. Para obter mais informações, veja Utilizar Credenciais com Recursos do DSC.

Exemplo

O exemplo seguinte mostra como utilizar o recurso Arquivo para garantir que os conteúdos de um ficheiro de arquivo chamado Test.zip existem e são extraídos num determinado destino com e autorizado.

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