Export-Csv
Converte objetos em uma série de cadeias de caracteres de valor separado por caracteres (CSV) e salva as cadeias de caracteres em um arquivo.
Sintaxe
Export-Csv
[[-Path] <string>]
[[-Delimiter] <char>]
-InputObject <psobject>
[-LiteralPath <string>]
[-Force]
[-NoClobber]
[-Encoding <string>]
[-Append]
[-NoTypeInformation]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Export-Csv
[[-Path] <string>]
-InputObject <psobject>
[-LiteralPath <string>]
[-Force]
[-NoClobber]
[-Encoding <string>]
[-Append]
[-UseCulture]
[-NoTypeInformation]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
O cmdlet Export-CSV
cria um arquivo CSV dos objetos enviados. Cada objeto é uma linha que inclui uma lista separada por caracteres dos valores de propriedade do objeto. Você pode usar o cmdlet Export-CSV
para criar planilhas e compartilhar dados com programas que aceitam arquivos CSV como entrada.
Não formate objetos antes de enviá-los para o cmdlet Export-CSV
. Se Export-CSV
receber objetos formatados, o arquivo CSV conterá as propriedades de formato em vez das propriedades do objeto. Para exportar apenas propriedades selecionadas de um objeto, use o cmdlet Select-Object
.
Exemplos
Exemplo 1: Exportar propriedades do processo para um arquivo CSV
Este exemplo seleciona Process objetos com propriedades específicas, exporta os objetos para um arquivo CSV.
Get-Process -Name WmiPrvSE |
Select-Object -Property BasePriority,Id,SessionId,WorkingSet |
Export-Csv -Path .\WmiData.csv -NoTypeInformation
Import-Csv -Path .\WmiData.csv
BasePriority Id SessionId WorkingSet
------------ -- --------- ----------
8 976 0 20267008
8 2292 0 36786176
8 3816 0 30351360
8 8604 0 15011840
8 10008 0 8830976
8 11764 0 14237696
8 54632 0 9502720
O cmdlet Get-Process
obtém o Process objetos. O parâmetro Name filtra a saída para incluir apenas os objetos de processo WmiPrvSE. Os objetos de processo são enviados pelo pipeline para o cmdlet Select-Object
.
Select-Object
usa o parâmetro Property para selecionar um subconjunto de propriedades de objeto de processo. Os objetos de processo são enviados pelo pipeline para o cmdlet Export-Csv
.
Export-Csv
converte os objetos de processo em uma série de cadeias de caracteres CSV. O parâmetro Path especifica que o arquivo WmiData.csv
é salvo no diretório atual. O parâmetro NoTypeInformation remove o cabeçalho de informações #TYPE da saída CSV e não é necessário no PowerShell 6. O cmdlet Import-Csv
usa o parâmetro Path para exibir o arquivo localizado no diretório atual.
Exemplo 2: Exportar processos para um arquivo delimitado por vírgulas
Este exemplo obtém Process objetos e exporta os objetos para um arquivo CSV.
Get-Process | Export-Csv -Path .\Processes.csv -NoTypeInformation
Get-Content -Path .\Processes.csv
"Name","SI","Handles","VM","WS","PM","NPM","Path","Parent","Company","CPU","FileVersion", ...
"ApplicationFrameHost","4","511","2203597099008","35364864","21979136","30048", ...
O cmdlet Get-Process
obtém Process objetos. Os objetos de processo são enviados pelo pipeline para o cmdlet Export-Csv
.
Export-Csv
converte os objetos de processo em uma série de cadeias de caracteres CSV. O parâmetro Path especifica que o arquivo Processes.csv
é salvo no diretório atual. O parâmetro NoTypeInformation remove o cabeçalho de informações #TYPE da saída CSV e não é necessário no PowerShell 6. O cmdlet Get-Content
usa o parâmetro Path para exibir o arquivo localizado no diretório atual.
Exemplo 3: Exportar processos para um arquivo delimitado por ponto-e-vírgula
Este exemplo obtém Process objetos e exporta os objetos para um arquivo com um delimitador de ponto-e-vírgula.
Get-Process | Export-Csv -Path .\Processes.csv -Delimiter ';' -NoTypeInformation
Get-Content -Path .\Processes.csv
"Name";"SI";"Handles";"VM";"WS";"PM";"NPM";"Path";"Parent";"Company";"CPU";"FileVersion"; ...
"ApplicationFrameHost";"4";"509";"2203595321344";"34807808";"21770240";"29504"; ...
O cmdlet Get-Process
obtém Process objetos. Os objetos de processo são enviados pelo pipeline para o cmdlet Export-Csv
.
Export-Csv
converte os objetos de processo em uma série de cadeias de caracteres CSV. O parâmetro Path especifica que o arquivo Processes.csv
é salvo no diretório atual. O parâmetro Delimiter especifica um ponto-e-vírgula para separar os valores da cadeia de caracteres. O parâmetro NoTypeInformation remove o cabeçalho de informações #TYPE da saída CSV e não é necessário no PowerShell 6. O cmdlet Get-Content
usa o parâmetro Path para exibir o arquivo localizado no diretório atual.
Exemplo 4: Exportar processos usando o separador de lista da cultura atual
Este exemplo obtém Process objetos e exporta os objetos para um arquivo. O delimitador é o separador de lista da cultura atual.
(Get-Culture).TextInfo.ListSeparator
Get-Process | Export-Csv -Path .\Processes.csv -UseCulture -NoTypeInformation
Get-Content -Path .\Processes.csv
"Name","SI","Handles","VM","WS","PM","NPM","Path","Parent","Company","CPU","FileVersion", ...
"ApplicationFrameHost","4","511","2203597099008","35364864","21979136","30048", ...
O cmdlet Get-Culture
usa as propriedades aninhadas TextInfo e ListSeparator e exibe o separador de lista padrão da cultura atual. O cmdlet Get-Process
obtém Process objetos. Os objetos de processo são enviados pelo pipeline para o cmdlet Export-Csv
.
Export-Csv
converte os objetos de processo em uma série de cadeias de caracteres CSV. O parâmetro Path especifica que o arquivo Processes.csv
é salvo no diretório atual. O parâmetro UseCulture usa o separador de lista padrão da cultura atual como delimitador. O parâmetro NoTypeInformation remove o cabeçalho de informações #TYPE da saída CSV e não é necessário no PowerShell 6. O cmdlet Get-Content
usa o parâmetro Path para exibir o arquivo localizado no diretório atual.
Exemplo 5: Exportar processos com informações de tipo
Este exemplo explica como incluir as informações de cabeçalho do #TYPE em um arquivo CSV. O cabeçalho #TYPE é o padrão em versões anteriores ao PowerShell 6.0.
Get-Process | Export-Csv -Path .\Processes.csv
Get-Content -Path .\Processes.csv
#TYPE System.Diagnostics.Process
"Name","SI","Handles","VM","WS","PM","NPM","Path","Company","CPU","FileVersion", ...
"ApplicationFrameHost","4","507","2203595001856","35139584","20934656","29504", ...
O cmdlet Get-Process
obtém Process objetos. Os objetos de processo são enviados pelo pipeline para o cmdlet Export-Csv
.
Export-Csv
converte os objetos de processo em uma série de cadeias de caracteres CSV.
O parâmetro Path especifica que o arquivo Processes.csv
é salvo no diretório atual.
O cmdlet Get-Content
usa o parâmetro Path para exibir o arquivo localizado no diretório atual.
Exemplo 6: Exportar e acrescentar objetos a um arquivo CSV
Este exemplo descreve como exportar objetos para um arquivo CSV e usar o parâmetro Append para adicionar objetos a um arquivo existente.
$AppService = (Get-Service -DisplayName *Application* | Select-Object -Property DisplayName, Status)
$AppService | Export-Csv -Path .\Services.Csv -NoTypeInformation
Get-Content -Path .\Services.Csv
$WinService = (Get-Service -DisplayName *Windows* | Select-Object -Property DisplayName, Status)
$WinService | Export-Csv -Path .\Services.csv -NoTypeInformation -Append
Get-Content -Path .\Services.Csv
"DisplayName","Status"
"Application Layer Gateway Service","Stopped"
"Application Identity","Running"
"Windows Audio Endpoint Builder","Running"
"Windows Audio","Running"
"Windows Event Log","Running"
O cmdlet Get-Service
obtém objetos de serviço. O parâmetro DisplayName retorna serviços que contêm a palavra Application. Os objetos de serviço são enviados pelo pipeline para o cmdlet Select-Object
.
Select-Object
usa o parâmetro Property para especificar o DisplayName e Status propriedades. A variável $AppService
armazena os objetos.
Os objetos $AppService
são enviados pelo pipeline para o cmdlet Export-Csv
.
Export-Csv
converte os objetos de serviço em uma série de cadeias de caracteres CSV. O parâmetro Path especifica que o arquivo Services.csv
é salvo no diretório atual. O parâmetro NoTypeInformation remove o cabeçalho de informações #TYPE da saída CSV e não é necessário no PowerShell 6. O cmdlet Get-Content
usa o parâmetro Path para exibir o arquivo localizado no diretório atual.
Os cmdlets Get-Service
e Select-Object
são repetidos para serviços que contêm a palavra Windows. A variável $WinService
armazena os objetos de serviço. O cmdlet Export-Csv
usa o parâmetro Append para especificar que os objetos $WinService
sejam adicionados ao arquivo Services.csv
existente. O cmdlet Get-Content
é repetido para exibir o arquivo atualizado que inclui os dados anexados.
Exemplo 7: O cmdlet Format dentro de um pipeline cria resultados inesperados
Este exemplo mostra por que é importante não usar um cmdlet format em um pipeline. Quando a saída inesperada for recebida, solucione problemas na sintaxe do pipeline.
Get-Date | Select-Object -Property DateTime, Day, DayOfWeek, DayOfYear |
Export-Csv -Path .\DateTime.csv -NoTypeInformation
Get-Content -Path .\DateTime.csv
"DateTime","Day","DayOfWeek","DayOfYear"
"Wednesday, January 2, 2019 14:59:34","2","Wednesday","2"
Get-Date | Format-Table -Property DateTime, Day, DayOfWeek, DayOfYear |
Export-Csv -Path .\FTDateTime.csv -NoTypeInformation
Get-Content -Path .\FTDateTime.csv
"ClassId2e4f51ef21dd47e99d3c952918aff9cd","pageHeaderEntry","pageFooterEntry","autosizeInfo", ...
"033ecb2bc07a4d43b5ef94ed5a35d280",,,,"Microsoft.PowerShell.Commands.Internal.Format. ...
"9e210fe47d09416682b841769c78b8a3",,,,,
"27c87ef9bbda4f709f6b4002fa4af63c",,,,,
"4ec4f0187cb04f4cb6973460dfe252df",,,,,
"cf522b78d86c486691226b40aa69e95c",,,,,
O cmdlet Get-Date
obtém o objeto DateTime. O objeto é enviado pelo pipeline para o cmdlet Select-Object
.
Select-Object
usa o parâmetro Property para selecionar um subconjunto de propriedades de objeto. O objeto é enviado pelo pipeline para o cmdlet Export-Csv
.
Export-Csv
converte o objeto em um formato CSV. O parâmetro Path especifica que o arquivo DateTime.csv
é salvo no diretório atual. O parâmetro NoTypeInformation remove o cabeçalho de informações #TYPE da saída CSV e não é necessário no PowerShell 6. O cmdlet Get-Content
usa o parâmetro Path para exibir o arquivo CSV localizado no diretório atual.
Quando o cmdlet Format-Table
é usado dentro do pipeline para selecionar propriedades, resultados inesperados são recebidos.
Format-Table
envia objetos de formato de tabela pelo pipeline para o cmdlet Export-Csv
em vez do objeto DateTime.
Export-Csv
converte os objetos de formato de tabela em uma série de cadeias de caracteres CSV. O cmdlet Get-Content
exibe o arquivo CSV que contém os objetos de formato de tabela.
Exemplo 8: Usando o parâmetro Force para substituir arquivos somente leitura
Este exemplo cria um arquivo vazio e somente leitura e usa o parâmetro Force para atualizar o arquivo.
New-Item -Path .\ReadOnly.csv -ItemType File
Set-ItemProperty -Path .\ReadOnly.csv -Name IsReadOnly -Value $true
Get-Process | Export-Csv -Path .\ReadOnly.csv -NoTypeInformation
Export-Csv : Access to the path 'C:\ReadOnly.csv' is denied.
At line:1 char:15
+ Get-Process | Export-Csv -Path .\ReadOnly.csv -NoTypeInformation
+ ~~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo : OpenError: (:) [Export-Csv], UnauthorizedAccessException
+ FullyQualifiedErrorId : FileOpenFailure,Microsoft.PowerShell.Commands.ExportCsvCommand
Get-Process | Export-Csv -Path .\ReadOnly.csv -NoTypeInformation -Force
Get-Content -Path .\ReadOnly.csv
"Name";"SI";"Handles";"VM";"WS";"PM";"NPM";"Path";"Parent";"Company";"CPU";"FileVersion"; ...
"ApplicationFrameHost";"4";"509";"2203595321344";"34807808";"21770240";"29504"; ...
O cmdlet New-Item
usa os parâmetros Path e ItemType para criar o arquivo ReadOnly.csv
no diretório atual. O cmdlet Set-ItemProperty
usa os parâmetros Name e Value para alterar a propriedade IsReadOnly do arquivo para true. O cmdlet Get-Process
obtém Process objetos. Os objetos de processo são enviados pelo pipeline para o cmdlet Export-Csv
.
Export-Csv
converte os objetos de processo em uma série de cadeias de caracteres CSV. O parâmetro Path especifica que o arquivo ReadOnly.csv
é salvo no diretório atual. O parâmetro NoTypeInformation remove o cabeçalho de informações #TYPE da saída CSV e não é necessário no PowerShell 6. A saída mostra que o arquivo não é gravado porque o acesso é negado.
O parâmetro Force é adicionado ao cmdlet Export-Csv
para forçar a exportação a gravar no arquivo. O cmdlet Get-Content
usa o parâmetro Path para exibir o arquivo localizado no diretório atual.
Exemplo 9: Usando o parâmetro Force com Append
Este exemplo mostra como usar os parâmetros Force e Append. Quando esses parâmetros são combinados, propriedades de objeto incompatíveis podem ser gravadas em um arquivo CSV.
$Content = [PSCustomObject]@{Name = 'PowerShell'; Version = '7.0'}
$Content | Export-Csv -Path .\ParmFile.csv -NoTypeInformation
$AdditionalContent = [PSCustomObject]@{Name = 'Windows PowerShell'; Edition = 'Desktop'}
$AdditionalContent | Export-Csv -Path .\ParmFile.csv -NoTypeInformation -Append
Export-Csv : Cannot append CSV content to the following file: ParmFile.csv.
The appended object does not have a property that corresponds to the following column:
Version. To continue with mismatched properties, add the -Force parameter, and then retry
the command.
At line:1 char:22
+ $AdditionalContent | Export-Csv -Path .\ParmFile.csv -NoTypeInformation -Append
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo : InvalidData: (Version:String) [Export-Csv], InvalidOperationException
+ FullyQualifiedErrorId : CannotAppendCsvWithMismatchedPropertyNames,Microsoft.PowerShell. ...
$AdditionalContent | Export-Csv -Path .\ParmFile.csv -NoTypeInformation -Append -Force
Import-Csv -Path .\ParmFile.csv
Name Version
---- -------
PowerShell 7.0
Windows PowerShell
Uma expressão cria o PSCustomObject com Name e Version propriedades. Os valores são armazenados na variável $Content
. A variável $Content
é enviada pelo pipeline para o cmdlet Export-Csv
.
Export-Csv
usa o parâmetro Path e salva o arquivo ParmFile.csv
no diretório atual. O parâmetro NoTypeInformation remove o cabeçalho de informações #TYPE da saída CSV e não é necessário no PowerShell 6.
Outra expressão cria um PSCustomObject com as propriedades Name e Edition. Os valores são armazenados na variável $AdditionalContent
. A variável $AdditionalContent
é enviada pelo pipeline para o cmdlet Export-Csv
. O parâmetro Append é usado para adicionar os dados ao arquivo. O acréscimo falha porque há uma incompatibilidade de nome de propriedade entre Versão e Edition.
O cmdlet Export-Csv
parâmetro Force é usado para forçar a exportação a gravar no arquivo. A propriedade Edition é descartada. O cmdlet Import-Csv
usa o parâmetro Path para exibir o arquivo localizado no diretório atual.
Parâmetros
-Append
Use esse parâmetro para que Export-CSV
adicione a saída CSV ao final do arquivo especificado. Sem esse parâmetro, Export-CSV
substitui o conteúdo do arquivo sem aviso.
Esse parâmetro foi introduzido no Windows PowerShell 3.0.
Tipo: | SwitchParameter |
Position: | Named |
Default value: | False |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-Confirm
Solicita confirmação antes de executar o cmdlet.
Tipo: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-Delimiter
Especifica um delimitador para separar os valores de propriedade. O padrão é uma vírgula (,
). Insira um caractere, como dois pontos (:
). Para especificar um ponto-e-vírgula (;
), coloque-o entre aspas.
Tipo: | Char |
Position: | 1 |
Default value: | comma (,) |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-Encoding
Especifica a codificação para o arquivo CSV exportado. O valor padrão é ASCII
.
Os valores aceitáveis para este parâmetro são os seguintes:
-
ASCII
Usa o conjunto de caracteres ASCII (7 bits). -
BigEndianUnicode
Usa UTF-16 com a ordem de bytes big-endian. -
Default
Usa a codificação que corresponde à página de código ativa do sistema (geralmente ANSI). -
OEM
Usa a codificação que corresponde à página de código OEM atual do sistema. -
Unicode
Usa UTF-16 com a ordem de bytes little-endian. -
UTF7
usa UTF-7. -
UTF8
usa UTF-8. -
UTF32
Usa UTF-32 com a ordem de bytes little-endian.
Tipo: | String |
Valores aceites: | ASCII, BigEndianUnicode, Default, OEM, Unicode, UTF7, UTF8, UTF32 |
Position: | Named |
Default value: | ASCII |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-Force
Esse parâmetro permite que Export-Csv
substitua arquivos com o atributo Somente leitura.
Quando parâmetros Force e Append são combinados, os objetos que contêm propriedades incompatíveis podem ser gravados em um arquivo CSV. Somente as propriedades que correspondem são gravadas no arquivo. As propriedades incompatíveis são descartadas.
Tipo: | SwitchParameter |
Position: | Named |
Default value: | False |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-InputObject
Especifica os objetos a serem exportados como cadeias de caracteres CSV. Insira uma variável que contenha os objetos ou digite um comando ou expressão que obtenha os objetos. Você também pode canalizar objetos para Export-CSV
.
Tipo: | PSObject |
Position: | Named |
Default value: | None |
Necessário: | True |
Aceitar entrada de pipeline: | True |
Aceitar carateres universais: | False |
-LiteralPath
Especifica o caminho para o arquivo de saída CSV. Ao contrário Path, o valor do parâmetro LiteralPath é usado exatamente como é digitado. Nenhum caractere é interpretado como curinga. Se o caminho incluir caracteres de escape, use aspas simples. Aspas simples dizem ao PowerShell para não interpretar nenhum caractere como sequências de escape.
Tipo: | String |
Aliases: | PSPath |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-NoClobber
Use esse parâmetro para que Export-CSV
não substitua um arquivo existente. Por padrão, se o arquivo existir no caminho especificado, Export-CSV
substitui o arquivo sem aviso.
Tipo: | SwitchParameter |
Aliases: | NoOverwrite |
Position: | Named |
Default value: | False |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-NoTypeInformation
Remove o cabeçalho de informações #TYPE
da saída. Esse parâmetro se tornou o padrão no PowerShell 6.0 e está incluído para compatibilidade com versões anteriores.
Tipo: | SwitchParameter |
Aliases: | NTI |
Position: | Named |
Default value: | False |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-Path
Um parâmetro obrigatório que especifica o local para salvar o arquivo de saída CSV.
Tipo: | String |
Position: | 0 |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-UseCulture
Usa o separador de lista para a cultura atual como o delimitador de item. Para localizar o separador de lista para uma cultura, use o seguinte comando: (Get-Culture).TextInfo.ListSeparator
.
Tipo: | SwitchParameter |
Position: | Named |
Default value: | False |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-WhatIf
Impede que o cmdlet seja processado ou faça alterações. A saída mostra o que aconteceria se o cmdlet fosse executado.
Tipo: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
Entradas
Você pode canalizar qualquer objeto com um adaptador ETS (Extended Type System) para este cmdlet.
Saídas
None
Este cmdlet não retorna nenhuma saída.
Notas
O Windows PowerShell inclui os seguintes aliases para Export-Csv
:
epcsv
O cmdlet Export-CSV
converte os objetos enviados em uma série de cadeias de caracteres CSV e as salva no arquivo de texto especificado. Você pode usar Export-CSV
para salvar objetos em um arquivo CSV e, em seguida, usar o cmdlet Import-Csv
para criar objetos a partir do arquivo CSV.
No arquivo CSV, cada objeto é representado por uma lista separada por caracteres dos valores de propriedade do objeto. Os valores de propriedade são convertidos em cadeias de caracteres usando o ToString() método. As cadeias de caracteres são representadas pelo nome do valor da propriedade. 'Export-CSV não exporta os métodos do objeto.
As cadeias de caracteres CSV são saídas da seguinte maneira:
- Por padrão, a primeira cadeia de caracteres contém o cabeçalho de informações #TYPE seguido pelo nome totalmente qualificado do tipo de objeto. Por exemplo, #TYPE System.Diagnostics.Process.
- Se NoTypeInformation for usada, a primeira cadeia de caracteres incluirá os cabeçalhos das colunas. Os cabeçalhos contêm os nomes de propriedade do primeiro objeto como uma lista separada por caracteres.
- As cadeias de caracteres restantes contêm listas separadas por caracteres dos valores de propriedade de cada objeto.
Quando você envia vários objetos para Export-CSV
, o Export-CSV
organiza o arquivo com base nas propriedades do primeiro objeto enviado. Se os objetos restantes não tiverem uma das propriedades especificadas, o valor da propriedade desse objeto será nulo, conforme representado por duas vírgulas consecutivas. Se os objetos restantes tiverem propriedades adicionais, esses valores de propriedade não serão incluídos no arquivo.
Você pode usar o cmdlet Import-Csv
para recriar objetos a partir das cadeias de caracteres CSV nos arquivos. Os objetos resultantes são versões CSV dos objetos originais que consistem em representações de cadeia de caracteres dos valores de propriedade e nenhum método.
Os cmdlets ConvertTo-Csv
e ConvertFrom-Csv
convertem objetos em cadeias de caracteres CSV e em cadeias de caracteres CSV.
Export-CSV
é o mesmo que ConvertTo-CSV
, exceto que ele salva as cadeias de caracteres CSV em um arquivo.