Recurso de arquivo morto do DSC

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

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

Nota

Esta documentação deste recurso DSC aborda a versão incluída no PowerShell antes da versão 7.2. O módulo PSDscResources contém recursos DSC novos e atualizados que têm suporte oficial da 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 do 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.
Checksum	Define o tipo a ser usado ao determinar se dois arquivos são iguais. Se soma de verificação não for especificado, somente 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 do arquivo morto 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. Usar a 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 semde Soma de Verificação , um de Soma de VerificaçãoSHA-256 será usado por padrão.

Propriedades comuns

Propriedade	Descrição
DependsOn	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 recurso que você deseja executar primeiro for ResourceName e seu tipo for ResourceType, a sintaxe para usar essa propriedade será DependsOn = "[ResourceType]ResourceName".
Assegurar	Determina se o conteúdo do arquivo morto existe no Destination. Defina essa propriedade como Present para garantir que o conteúdo exista. Defina-o como Absent para garantir que eles não existam. O valor padrão é Present.
PsDscRunAsCredential	Define a credencial para executar todo o recurso como.

Nota

A propriedade comum PsDscRunAsCredential foi adicionada ao 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 Arquivar para garantir que o conteúdo de um arquivo morto chamado Test.zip exista e sejam extraídos em um determinado destino usando e autorizado.

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