Recurso de arquivamento DSC

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

O recurso Arquivo morto na Configuração de Estado Desejado (DSC) do Windows PowerShell fornece um mecanismo para descompactar arquivos (.zip) em um caminho específico.

Observação

Esta documentação deste recurso 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 na Galeria do PowerShell.

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

Sintaxe

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 o local onde você deseja garantir que o conteúdo do arquivo morto seja extraído.
Caminho	Especifica o caminho de origem do arquivo morto.
Soma de verificação	Define o tipo a ser usado ao determinar se dois arquivos são iguais. Se de soma de verificação não for especificado, apenas o nome do arquivo ou diretório será usado para comparação. Os valores válidos incluem: SHA-1, SHA-256, SHA-512, createdDate, modifiedDate. Se você especificar de soma de verificação sem Validar, a configuração falhará.
Credencial	A credencial de uma conta de usuário com permissões para acessar o caminho e o destino de arquivamento especificados, se necessário.
Força	Determinadas operações de arquivo (como substituir um arquivo ou excluir um diretório que não está vazio) resultarão em um erro. O uso da propriedade Force substitui esses erros. O valor padrão é False.
Validar	Usa a propriedade Checksum para determinar se o arquivo corresponde à assinatura. Se você especificar de soma de verificação sem Validar, a configuração falhará. Se você especificar Validar sem de soma de verificação , um de soma de verificação deSHA-256 será usado por padrão.

Propriedades comuns

Propriedade	Descrição
DependeDe	Indica que a configuração de outro recurso deve ser executada antes que esse recurso seja configurado. Por exemplo, se a ID do bloco de script de configuração de recursos que você deseja executar primeiro for ResourceName e seu tipo for ResourceType, a sintaxe para usar essa propriedade será DependsOn = "[ResourceType]ResourceName".
Garantir	Determina se o conteúdo do arquivo morto deve ser verificado node destino. Defina essa propriedade como Presente para garantir que o conteúdo exista. Defina-o como Ausente para garantir que eles não existam. O valor padrão é Present.
PsDscRunAsCredential	Define a credencial para executar todo o recurso como.

Observação

O PsDscRunAsCredential propriedade comum foi adicionado no WMF 5.0 para permitir a execução de qualquer recurso DSC no contexto de outras credenciais. Para obter mais informações, consulte Usar credenciais com recursos DSC.

Exemplo

O exemplo a seguir mostra como usar o recurso Archive para garantir que o conteúdo de um arquivo chamado Test.zip exista e seja extraído em um determinado destino usando e autorizado.

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