Recurso Archive da DSC
Aplica-se a: Windows PowerShell 4.0, Windows PowerShell 5.x
O recurso Archive na Configuração de Estado Desejado (DSC) do Windows PowerShell fornece um mecanismo para descompactar arquivos mortos (.zip) em um caminho específico.
Observação
Esta documentação desse recurso DSC aborda a versão incluída no PowerShell antes da versão 7.2. O módulo PSDscResources contém recursos de DSC novos e atualizados com 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 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 seja extraído. |
Caminho | Especifica o caminho de origem do arquivo morto. |
Checksum (soma de verificação) | Define o tipo que deve ser usado para determinar se dois arquivos são iguais. Se Checksum não for especificado, somente o nome de 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 Checksum sem Validate, ocorrerá uma falha na configuração. |
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. |
Force | Determinadas operações de arquivo (como substituição de um arquivo ou exclusão de um diretório que não esteja vazio) resultarão em erro. O uso da propriedade Force substitui esses erros. O valor padrão é Falso. |
Validar | Usa a propriedade Checksum para determinar se o arquivo corresponde à assinatura. Se você especificar Checksum sem Validate, ocorrerá uma falha na configuração. Se você especificar Validate sem Checksum, uma soma de verificação de SHA-256 será usada por padrão. |
Propriedades comuns
Propriedade | Descrição |
---|---|
DependsOn | Indica que a configuração de outro recurso deve ser executada antes de ele ser configurado. Por exemplo, se a ID do bloco de script de configuração do recurso que você deseja executar primeiro for ResourceName e seu tipo for ResourceType, a sintaxe para usar essa propriedade será DependsOn = "[ResourceType]ResourceName" . |
Ensure | Determina se é necessário verificar se o conteúdo do arquivo existe em Destination. Defina essa propriedade como Present para garantir que o conteúdo exista. Defina-a como Absent para garantir que não exista. O valor padrão é Present. |
PsDscRunAsCredential | Define a credencial para executar todo o recurso. |
Observação
A propriedade comum PsDscRunAsCredential foi adicionada ao WMF 5.0 para permitir a execução de qualquer recurso de DSC no contexto de outras credenciais. Para saber mais, confira Usar credenciais com recursos de 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 destino específico usado e autorizado.
Archive ArchiveExample {
Ensure = "Present"
Path = "C:\Users\Public\Documents\Test.zip"
Destination = "C:\Users\Public\Documents\ExtractionPath"
}
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de