Recurso Archive da DSCDSC Archive Resource

Aplica-se a: Windows PowerShell 4.0, Windows PowerShell 5.0Applies To: Windows PowerShell 4.0, Windows PowerShell 5.0

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.The Archive resource in Windows PowerShell Desired State Configuration (DSC) provides a mechanism to unpack archive (.zip) files at a specific path.

SintaxeSyntax

Archive [string] #ResourceName
{
    Destination = [string]
    Path = [string]
    [ Checksum = [string] { CreatedDate | ModifiedDate | SHA-1 | SHA-256 | SHA-512 } ]
    [ DependsOn = [string[]] ]
    [ Ensure = [string] { Absent | Present } ]
    [ Force = [bool] ]
    [ Validate = [bool] ]
}

PropriedadesProperties

PropriedadeProperty DescriçãoDescription
DestinationDestination Especifica o local onde você deseja garantir que o conteúdo do arquivo seja extraído.Specifies the location where you want to ensure the archive contents are extracted.
CaminhoPath Especifica o caminho de origem do arquivo morto.Specifies the source path of the archive file.
ChecksumChecksum Define o tipo que deve ser usado para determinar se dois arquivos são iguais.Defines the type to use when determining whether two files are the same. Se Checksum não for especificado, somente o nome de arquivo ou diretório será usado para comparação.If Checksum is not specified, only the file or directory name is used for comparison. Os valores válidos incluem: SHA-1, SHA-256, SHA-512, createdDate, modifiedDate e none (padrão).Valid values include: SHA-1, SHA-256, SHA-512, createdDate, modifiedDate, none (default). Se você especificar Checksum sem Validate, ocorrerá uma falha na configuração.If you specify Checksum without Validate, the configuration will fail.
EnsureEnsure Determina se é necessário verificar se o conteúdo do arquivo existe em Destination.Determines whether to check if the content of the archive exists at the Destination. Defina essa propriedade como Present para garantir que o conteúdo exista.Set this property to Present to ensure the contents exist. Defina-a como Absent para garantir que não exista.Set it to Absent to ensure they do not exist. O valor padrão é Present.The default value is Present.
DependsOnDependsOn Indica que a configuração de outro recurso deve ser executada antes de ele ser configurado.Indicates that the configuration of another resource must run before this resource is configured. 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".For example, if the ID of the resource configuration script block that you want to run first is ResourceName and its type is ResourceType, the syntax for using this property is DependsOn = "[ResourceType]ResourceName".
ValidarValidate Usa a propriedade Checksum para determinar se o arquivo corresponde à assinatura.Uses the Checksum property to determine if the archive matches the signature. Se você especificar Checksum sem Validate, ocorrerá uma falha na configuração.If you specify Checksum without Validate, the configuration will fail. Se você especificar Validate sem Checksum, uma soma de verificação SHA-256 será usada por padrão.If you specify Validate without Checksum, a SHA-256 checksum is used by default.
ForceForce 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.Certain file operations (such as overwriting a file or deleting a directory that is not empty) will result in an error. O uso da propriedade Force substitui esses erros.Using the Force property overrides such errors. O valor padrão é False.The default value is False.

ExemploExample

O exemplo a seguir mostra como usar o recurso Archive para garantir que o conteúdo de um arquivo morto chamado Test.zip exista e seja extraído em um destino específico.The following example shows how to use the Archive resource to ensure that the contents of an archive file called Test.zip exist and are extracted at a given destination.

Archive ArchiveExample {
    Ensure = "Present"  # You can also set Ensure to "Absent"
    Path = "C:\Users\Public\Documents\Test.zip"
    Destination = "C:\Users\Public\Documents\ExtractionPath"
}