Compartilhar via

Compress-Archive

  • Referência
Módulo:
Microsoft.PowerShell.Archive

Cria um arquivo compactado, ou compactado, a partir de arquivos e diretórios especificados.

Syntax

Compress-Archive
        [-Path] <String[]>
        [-DestinationPath] <String>
        [-CompressionLevel <String>]
        [-PassThru]
        [-WhatIf]
        [-Confirm]
        [<CommonParameters>]
Compress-Archive
        [-Path] <String[]>
        [-DestinationPath] <String>
        [-CompressionLevel <String>]
        -Update
        [-PassThru]
        [-WhatIf]
        [-Confirm]
        [<CommonParameters>]
Compress-Archive
        [-Path] <String[]>
        [-DestinationPath] <String>
        [-CompressionLevel <String>]
        -Force
        [-PassThru]
        [-WhatIf]
        [-Confirm]
        [<CommonParameters>]
Compress-Archive
        -LiteralPath <String[]>
        [-DestinationPath] <String>
        [-CompressionLevel <String>]
        -Update
        [-PassThru]
        [-WhatIf]
        [-Confirm]
        [<CommonParameters>]
Compress-Archive
        -LiteralPath <String[]>
        [-DestinationPath] <String>
        [-CompressionLevel <String>]
        -Force
        [-PassThru]
        [-WhatIf]
        [-Confirm]
        [<CommonParameters>]
Compress-Archive
        -LiteralPath <String[]>
        [-DestinationPath] <String>
        [-CompressionLevel <String>]
        [-PassThru]
        [-WhatIf]
        [-Confirm]
        [<CommonParameters>]

Description

O Compress-Archive cmdlet cria um arquivo compactado ou compactado de um ou mais arquivos ou diretórios especificados. Um arquivo compacta vários arquivos, com compactação opcional, em um único arquivo compactado para facilitar a distribuição e o armazenamento. Um arquivo morto pode ser compactado usando o algoritmo de compactação especificado pelo parâmetro CompressionLevel .

O Compress-Archive cmdlet usa a API System.IO.Compression.ZipArchive para compactar arquivos. A API limita o tamanho máximo do arquivo a 2 GB. Para obter mais informações, consulte System.IO.Compression.ZipArchive.

Observação

O Compress-Archive cmdlet ignora arquivos e pastas ocultos ao criar ou atualizar o arquivo morto. Em computadores que não sejam Windows, isso inclui arquivos e pastas com nome que começa com o caractere ponto (.).

Para garantir que arquivos e pastas ocultos sejam compactados no arquivo, use a API do .NET.

Alguns exemplos usam o splatting para reduzir o comprimento da linha dos exemplos de código. Para obter mais informações, consulte about_Splatting.

Exemplos

Exemplo 1: Compactar arquivos para criar um arquivo morto

Este exemplo compacta arquivos de diretórios diferentes e cria um arquivo morto. Um curinga é usado para obter todos os arquivos com uma extensão de arquivo específica. Não há estrutura de diretório no arquivo morto porque o caminho especifica apenas nomes de arquivo.

$compress = @{
  Path = "C:\Reference\Draftdoc.docx", "C:\Reference\Images\*.vsd"
  CompressionLevel = "Fastest"
  DestinationPath = "C:\Archives\Draft.zip"
}
Compress-Archive @compress

O parâmetro Path aceita nomes de arquivo específicos e nomes de arquivo com curingas, *.vsd. O caminho usa uma lista separada por vírgulas para obter arquivos de diretórios diferentes. O nível de compactação é mais rápido para reduzir o tempo de processamento. O parâmetro DestinationPath especifica o local do Draft.zip arquivo. O Draft.zip arquivo contém Draftdoc.docx e todos os arquivos com uma .vsd extensão.

Exemplo 2: Compactar arquivos usando um LiteralPath

Este exemplo compacta arquivos nomeados específicos e cria um novo arquivo morto. Não há estrutura de diretório no arquivo morto porque o caminho especifica apenas nomes de arquivo.

$compress = @{
LiteralPath= "C:\Reference\Draft Doc.docx", "C:\Reference\Images\diagram2.vsd"
CompressionLevel = "Fastest"
DestinationPath = "C:\Archives\Draft.zip"
}
Compress-Archive @compress

O caminho absoluto e os nomes de arquivo são usados porque o parâmetro LiteralPath não aceita curingas. O caminho usa uma lista separada por vírgulas para obter arquivos de diretórios diferentes. O nível de compactação é mais rápido para reduzir o tempo de processamento. O parâmetro DestinationPath especifica o local do Draft.zip arquivo. O Draft.zip arquivo contém Draftdoc.docx apenas e diagram2.vsd.

Exemplo 3: Compactar um diretório que inclui o diretório raiz

Este exemplo compacta um diretório e cria um arquivo morto que inclui o diretório raiz e todos os seus arquivos e subdiretórios. O arquivo morto tem uma estrutura de diretórios porque o caminho especifica um diretório raiz.

Compress-Archive -Path C:\Reference -DestinationPath C:\Archives\Draft.zip

Compress-Archive usa o parâmetro Path para especificar o diretório raiz, C:\Reference. O parâmetro DestinationPath especifica o local do arquivo morto. O Draft.zip arquivo inclui o Reference diretório raiz e todos os seus arquivos e subdiretórios.

Exemplo 4: Compactar um diretório que exclui o diretório raiz

Este exemplo compacta um diretório e cria um arquivo morto que exclui o diretório raiz porque o Caminho usa um curinga asterisco (*). O arquivo contém uma estrutura de diretórios que contém os arquivos e subdiretórios do diretório raiz.

Compress-Archive -Path C:\Reference\* -DestinationPath C:\Archives\Draft.zip

Compress-Archive usa o parâmetro Path para especificar o diretório raiz, C:\Reference com um curinga asterisco (*). O parâmetro DestinationPath especifica o local do arquivo morto. O Draft.zip arquivo contém os arquivos e subdiretórios do diretório raiz. O Reference diretório raiz é excluído do arquivo.

Exemplo 5: Compactar somente os arquivos em um diretório raiz

Este exemplo compacta somente os arquivos em um diretório raiz e cria um arquivo morto. Não há estrutura de diretórios no arquivo morto porque apenas os arquivos são compactados.

Compress-Archive -Path C:\Reference\*.* -DestinationPath C:\Archives\Draft.zip

Compress-Archive usa o parâmetro Path para especificar o diretório raiz, C:\Reference com um curinga star-dot-star (*.*). O parâmetro DestinationPath especifica o local do arquivo morto. O Draft.zip arquivo contém apenas os Reference arquivos do diretório raiz e o diretório raiz é excluído.

Exemplo 6: Usar o pipeline para arquivar arquivos

Este exemplo envia arquivos pelo pipeline para criar um arquivo. Não há estrutura de diretório no arquivo morto porque o caminho especifica apenas nomes de arquivo.

Get-ChildItem -Path C:\Reference\Afile.txt, C:\Reference\Images\Bfile.txt |
  Compress-Archive -DestinationPath C:\Archives\PipelineFiles.zip

Get-ChildItem usa o parâmetro Path para especificar dois arquivos de diretórios diferentes. Cada arquivo é representado por um objeto FileInfo e é enviado pelo pipeline para Compress-Archive. Os dois arquivos especificados são arquivados no PipelineFiles.zip.

Exemplo 7: Usar o pipeline para arquivar um diretório

Este exemplo envia um diretório para baixo do pipeline para criar um arquivo. Os arquivos são enviados como objetos FileInfo e diretórios como objetos DirectoryInfo. A estrutura de diretórios do arquivo não inclui o diretório raiz, mas seus arquivos e subdiretórios são incluídos no arquivo.

Get-ChildItem -Path C:\LogFiles | Compress-Archive -DestinationPath C:\Archives\PipelineDir.zip

Get-ChildItem usa o parâmetro Path para especificar o C:\LogFiles diretório raiz. Cada objeto FileInfo e DirectoryInfo é enviado pelo pipeline.

Compress-Archive adiciona cada objeto ao PipelineDir.zip arquivo. O parâmetro Path não é especificado porque os objetos de pipeline são recebidos na posição de parâmetro 0.

Exemplo 8: Como a recursão pode afetar arquivos

Este exemplo mostra como a recursão pode duplicar arquivos em seu arquivo. Por exemplo, se você usar Get-ChildItem com o parâmetro Recurse . Como processos de recursão, cada objeto FileInfo e DirectoryInfo é enviado pelo pipeline e adicionado ao arquivo.

Get-ChildItem -Path C:\TestLog -Recurse |
  Compress-Archive -DestinationPath C:\Archives\PipelineRecurse.zip

O C:\TestLog diretório não contém nenhum arquivo. Ele contém um subdiretório chamado testsub que contém o testlog.txt arquivo.

Get-ChildItem usa o parâmetro Path para especificar o diretório raiz, C:\TestLog. O parâmetro Recurse processa os arquivos e diretórios. Um objeto DirectoryInfo é criado para testsub e um objeto testlog.txtFileInfo .

Cada objeto é enviado pelo pipeline para Compress-Archive. O DestinationPath especifica o local do arquivo morto. O parâmetro Path não é especificado porque os objetos de pipeline são recebidos na posição de parâmetro 0.

O resumo a seguir descreve o PipelineRecurse.zip conteúdo do arquivo que contém um arquivo duplicado:

  • O objeto DirectoryInfo cria o testsub diretório e contém o testlog.txt arquivo, que reflete a estrutura de diretório original.
  • O objeto FileInfo cria uma duplicata testlog.txt na raiz do arquivo. O arquivo duplicado é criado porque a recursão enviou um objeto de arquivo para Compress-Archive. Esse comportamento é esperado porque cada objeto enviado pelo pipeline é adicionado ao arquivo.

Exemplo 9: Atualizar um arquivo morto existente

Este exemplo atualiza um arquivo morto existente, Draft.zip, no C:\Archives diretório. Neste exemplo, o arquivo morto existente contém o diretório raiz e seus arquivos e subdiretórios.

Compress-Archive -Path C:\Reference -Update -DestinationPath C:\Archives\Draft.zip

O comando é atualizado Draft.zip com versões mais recentes de arquivos existentes no C:\Reference diretório e seus subdiretórios. Além disso, novos arquivos que foram adicionados ou C:\Reference seus subdiretórios são incluídos no arquivo atualizado Draft.zip .

Parâmetros

-CompressionLevel

Especifica a quantidade de compactação a ser aplicada ao criar o arquivo morto. A compactação mais rápida requer menos tempo para criar o arquivo, mas pode resultar em tamanhos de arquivo maiores.

Se esse parâmetro não for especificado, o comando usará o valor padrão, Optimal.

A seguir estão os valores aceitáveis para esse parâmetro:

  • Mais rápido. Use o método de compactação mais rápido disponível para reduzir o tempo de processamento. A compactação mais rápida pode resultar em tamanhos de arquivo maiores.
  • NãoCompressão. Não compacta os arquivos de origem.
  • Ideal. O tempo de processamento depende do tamanho do arquivo.
Type:String
Accepted values:Optimal, NoCompression, Fastest
Position:Named
Default value:Optimal
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DestinationPath

Esse parâmetro é necessário e especifica o caminho para o arquivo de saída do arquivo. O DestinationPath deve incluir o nome do arquivo compactado e o caminho absoluto ou relativo para o arquivo compactado.

Se o nome do arquivo no DestinationPath não tiver uma .zip extensão de nome de arquivo, o cmdlet adicionará a extensão de nome de .zip arquivo.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Force

Use esse parâmetro para substituir um arquivo morto existente.

Type:SwitchParameter
Position:Named
Default value:False
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-LiteralPath

Especifica o caminho ou caminhos para os arquivos que você deseja adicionar ao arquivo compactado. Ao contrário do parâmetro Path , o valor de LiteralPath é usado exatamente como é digitado. Nenhum caractere é interpretado como caractere curinga. Se o caminho incluir caracteres de escape, coloque cada caractere de escape entre aspas simples para instruir o PowerShell a não interpretar nenhum caractere como sequências de escape. Para especificar vários caminhos e incluir arquivos em vários locais no arquivo compactado de saída, use vírgulas para separar os caminhos.

Type:String[]
Aliases:PSPath
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PassThru

Faz com que o cmdlet produza um objeto de arquivo que representa o arquivo morto criado.

Esse parâmetro foi introduzido no PowerShell 6.0.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Path

Especifica o caminho ou caminhos para os arquivos que você deseja adicionar ao arquivo compactado. Para especificar vários caminhos e incluir arquivos em vários locais, use vírgulas para separar os caminhos.

Esse parâmetro aceita caracteres curinga. Os caracteres curinga permitem que você adicione todos os arquivos em um diretório ao arquivo morto.

O uso de curingas com um diretório raiz afeta o conteúdo do arquivo:

  • Para criar um arquivo que inclua o diretório raiz e todos os seus arquivos e subdiretórios, especifique o diretório raiz no Caminho sem curingas. Por exemplo: -Path C:\Reference
  • Para criar um arquivo que exclui o diretório raiz, mas compacta todos os seus arquivos e subdiretórios, use o curinga asterisco (*). Por exemplo: -Path C:\Reference\*
  • Para criar um arquivo compactado que compacta apenas os arquivos no diretório raiz, use o curinga star-dot-star (*.*). Os subdiretórios da raiz não são incluídos no arquivo. Por exemplo: -Path C:\Reference\*.*
Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:True

-Update

Atualiza o arquivo especificado substituindo versões de arquivo mais antigas no arquivo morto por versões de arquivo mais recentes que têm os mesmos nomes. Você também pode adicionar esse parâmetro para adicionar arquivos a um arquivo existente.

Type:SwitchParameter
Position:Named
Default value:False
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entradas

String

Você pode canalizar uma cadeia de caracteres que contém um caminho para um ou mais arquivos.

Saídas

None

Por padrão, esse cmdlet não retorna nenhuma saída.

FileInfo

Quando você usa o parâmetro PassThru , esse cmdlet retorna um objeto FileInfo .

Observações

Usar a recursão e enviar objetos pelo pipeline pode duplicar arquivos em seu arquivo. Por exemplo, se você usar Get-ChildItem com o parâmetro Recurse , cada objeto FileInfo e DirectoryInfo enviado pelo pipeline será adicionado ao arquivo.

O Compress-Archive cmdlet usa codificação UTF-8. Outras ferramentas de arquivo ZIP podem usar um esquema de codificação diferente. Ao extrair arquivos com nomes de arquivos não armazenados usando a codificação UTF-8, Expand-Archive usa o valor bruto encontrado no arquivo. Isso pode resultar em um nome de arquivo diferente do nome de arquivo de origem armazenado no arquivo.