Export-CSV
Converte objetos do Microsoft .NET Framework em uma série de cadeias de caracteres CSV de tamanho variável e salva as cadeias de caracteres em um arquivo CSV.
Sintaxe
Export-CSV [[-Delimitador] <char>] [-Path] <string> -InputObject <psobject> [-Encoding <string>] [-Force] [-NoClobber] [-NoTypeInformation] [-Confirm] [-WhatIf] [<CommonParameters>]
Export-CSV [-UseCulture] [-Path] <string> -InputObject <psobject> [-Encoding <string>] [-Force] [-NoClobber] [-NoTypeInformation] [-Confirm] [-WhatIf] [<CommonParameters>]
Descrição
O cmdlet Export-CSV cria um arquivo CSV de tamanho variável que representa os objetos enviados.
Em seguida, é possível 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.
Também é possível usar os cmdlets ConvertTo-CSV e ConvertFrom-CSV para converter objetos do .NET Framework em cadeias de caracteres CSV (e vice-versa). Export-CSV é igual a ConvertTo-CSV, com a exceção de que ele salva as cadeias de caracteres CSV em um arquivo.
É possível usar os parâmetros do cmdlet Export-CSV para especificar um delimitador diferente de uma vírgula ou direcionar o Export-CSV para usar o delimitador padrão da cultura atual.
Quando você envia vários objetos ao Export-CSV, o Export-CSV organiza o arquivo baseado nas propriedades do primeiro objeto enviado. Se os objetos restantes não tiverem uma das propriedades especificadas, o valor da propriedade daquele 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.
Para obter mais informações, consulte Export-CSV e a seção Observações.
Parâmetros
-Delimitador <char>
Especifica um delimitador para separar os valores de propriedade. O padrão é uma vírgula (,). Digite um caractere, como dois pontos (:). Para especificar um ponto-e-vírgula (;), coloque-o entre aspas.
Necessário? |
false |
Posição? |
2 |
Valor padrão |
, (vírgula) |
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-Encoding <string>
Especifica a codificação do arquivo CSV exportado. Os valores válidos são: Unicode, UTF7, UTF8, ASCII, UTF32, BigEndianUnicode, Default e OEM. O padrão é ASCII.
Necessário? |
false |
Posição? |
named |
Valor padrão |
ASCII |
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-Force
Substitui o arquivo especificado no caminho sem solicitar.
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-InputObject <psobject>
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. Também é possível canalizar objetos para Export-CSV.
Necessário? |
true |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
true (ByValue, ByPropertyName) |
Aceitar caracteres curinga? |
false |
-NoClobber
Não substitui (sobrescreve o conteúdo) de um arquivo existente. Por padrão, se existir um arquivo no caminho especificado, Export-CSV substituirá o arquivo sem aviso prévio.
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-NoTypeInformation
Omite as informações sobre tipo do arquivo CSV. Por padrão, a primeira linha do arquivo CSV contém "#TYPE" seguido pelo nome totalmente qualificado do tipo do objeto do .NET Framework.
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-Path <string>
Especifica o caminho para o arquivo CSV de saída. Esse parâmetro é obrigatório.
Necessário? |
true |
Posição? |
1 |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-UseCulture
Use o separador de lista da cultura atual como o delimitador de itens. O padrão é uma vírgula (,).
Esse parâmetro é muito útil em scripts que estão sendo distribuídos mundialmente aos usuários. Para localizar o separador de lista de uma cultura, use o comando a seguir: (Get-Culture).TextInfo.ListSeparator.
Necessário? |
false |
Posição? |
named |
Valor padrão |
Vírgula |
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-Confirm
Solicita confirmação antes da execução do comando.
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
-WhatIf
Descreve o que aconteceria se você executasse o comando, sem executá-lo de fato.
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
false |
Aceitar caracteres curinga? |
false |
<CommonParameters>
Esse cmdlet oferece suporte aos parâmetros comuns: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer e -OutVariable. Para obter mais informações, consulte about_Commonparameters.
Entradas e saídas
O tipo de entrada é o tipo dos objetos que você pode canalizar para o cmdlet. O tipo de retorno é o tipo dos objetos que o cmdlet retorna.
Entradas |
System.Management.Automation.PSObject É possível canalizar qualquer objeto do .NET Framework para Export-CSV. |
Saídas |
System.String A lista CSV será enviada ao arquivo atribuído no parâmetro Path. |
Observações
O cmdlet Export-CSV converte os objetos que você envia em uma série de cadeias de caracteres CSV de tamanho variável e as salva no arquivo de texto especificado. É possível usar o Export-CSV para salvar objetos em um arquivo CSV e, em seguida, usar o cmdlet Import-CSV para criar objetos a partir do texto no arquivo CSV.
No arquivo CSV, cada objeto é representado por uma lista separada por vírgulas dos valores de propriedade do objeto. Os valores de propriedade são convertidos em cadeias de caracteres (usando o método ToString() do objeto), de forma que eles geralmente são representados pelo nome do valor da propriedade. O Export-CSV não exporta os métodos do objeto.
O formato de um arquivo exportado é o seguinte:
--A primeira linha do arquivo CSV contém a cadeia de caracteres '#TYPE' seguida pelo nome totalmente qualificado do tipo do .NET Framework do objeto, como #TYPE System.Diagnostics.Process. Para suprimir essa linha, use o parâmetro NoTypeInformation.
-- A próxima linha do arquivo CSV representa os cabeçalhos de coluna. Ela contém uma lista separada por vírgulas dos nomes de todas as propriedades do primeiro objeto.
-- As linhas adicionais do arquivo consistem em listas separadas por vírgulas dos valores de propriedade de cada objeto.
Exemplo 1
C:\PS>get-process wmiprvse | select-object basePriority,ID,SessionID,WorkingSet | export-csv -path data.csv
Descrição
-----------
Este comando seleciona algumas propriedades do processo wmiprvse e as exporta para um arquivo de formato CSV nomeado data.csv.
Exemplo 2
C:\PS>get-process | export-csv processes.csv
C:\PS> get-process | export-csv processes.csv
# In processes.csv
#TYPE System.Diagnostics.Process
__NounName,Name,Handles,VM,WS,PM,NPM,Path,Company,CPU,FileVersion,...
Process,powershell,626,201666560,76058624,61943808,11960,C:\WINDOWS...
Process,powershell,257,151920640,38322176,37052416,7836,C:\WINDOWS\...
Descrição
-----------
Esse comando exporta objetos que representam os processos do computador para o arquivo Process.csv no diretório atual. Como ele não especifica um delimitador, uma vírgula (,) é usada para separar os campos do arquivo.
Exemplo 3
C:\PS>get-process | export-csv processes.csv -Delimiter ";"
# In processes.csv
#TYPE System.Diagnostics.Process
__NounName;Name;Handles;VM;WS;PM;NPM;Path;Company;CPU;FileVersion;...
Process;powershell;626;201666560;76058624;61943808;11960;C:\WINDOWS...
Process;powershell;257;151920640;38322176;37052416;7836;C:\WINDOWS\...
Descrição
-----------
Esse comando exporta objetos que representam os processos do computador para o arquivo Process.csv no diretório atual. Ele usa o parâmetro Delimiter para especificar o ponto-e-vírgula (;). Como resultado, os campos do arquivo são separados por pontos-e-vírgulas.
Exemplo 4
C:\PS>get-process | export-csv processes.csv -UseCulture
Descrição
-----------
Esse comando exporta objetos que representam os processos do computador para o arquivo Process.csv no diretório atual. Ele usa o parâmetro UseCulture para direcionar o Export-CSV para usar o delimitador especificado pela propriedade ListSeparator da cultura atual.
Exemplo 5
C:\PS>get-process | export-csv processes.csv -NoTypeInformation
C:\PS> get-process | export-csv processes.csv -NoTypeInformation
# In processes.csv
__NounName,Name,Handles,VM,WS,PM,NPM,Path,Company,CPU,FileVersion,...
Process,powershell,626,201666560,76058624,61943808,11960,C:\WINDOWS...
Process,powershell,257,151920640,38322176,37052416,7836,C:\WINDOWS\...
Descrição
-----------
Esse comando exporta objetos que representam os processos do computador para o arquivo Process.csv no diretório atual. Ele usa o parâmetro NoTypeInformation para suprimir as informações sobre tipo no arquivo.