Export-FormatData

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

Salva dados de formatação da sessão atual em um arquivo de formatação.

Sintaxe

Export-FormatData
      -InputObject <ExtendedTypeDefinition[]>
      -Path <String>
      [-Force]
      [-NoClobber]
      [-IncludeScriptBlock]
      [<CommonParameters>]
Export-FormatData
      -InputObject <ExtendedTypeDefinition[]>
      -LiteralPath <String>
      [-Force]
      [-NoClobber]
      [-IncludeScriptBlock]
      [<CommonParameters>]

Description

O Export-FormatData cmdlet cria arquivos de formatação do PowerShell (format.ps1xml) a partir dos objetos de formatação na sessão atual. Ele usa os objetos ExtendedTypeDefinition que Get-FormatData os retorna e os salva em um arquivo no formato XML.

O PowerShell usa os dados em arquivos de formatação (format.ps1xml) para gerar a exibição padrão de objetos do Microsoft .NET Framework na sessão. Você pode exibir e editar os arquivos de formatação e usar o cmdlet Update-FormatData para adicionar os dados de formatação a uma sessão.

Para obter mais informações sobre como formatar arquivos no PowerShell, consulte about_Format.ps1xml.

Exemplos

Exemplo 1: Exportar dados de formato de sessão

Get-FormatData -TypeName "*" | Export-FormatData -Path "allformat.ps1xml" -IncludeScriptBlock

Este comando exporta todos os dados de formato na sessão para o arquivo AllFormat.ps1xml.

O comando usa o Get-FormatData cmdlet para obter os dados de formato na sessão. Um valor de * (all) para o parâmetro TypeName direciona o cmdlet para obter todos os dados na sessão.

O comando usa um operador de pipeline (|) para enviar os dados de formato do comando para o Export-FormatData cmdlet, que exporta os dados de Get-FormatData formato para o arquivo AllFormat.ps1.

O Export-FormatData comando usa o parâmetro IncludeScriptBlock para incluir blocos de script nos dados de formato no arquivo.

Exemplo 2: Exportar dados de formato para um tipo

$F = Get-FormatData -TypeName "helpinfoshort"
Export-FormatData -InputObject $F -Path "c:\test\help.format.ps1xml" -IncludeScriptBlock

Esses comandos exportam os dados de formato do tipo HelpInfoShort para o arquivo Help.format.ps1xml.

O primeiro comando usa o Get-FormatData cmdlet para obter os dados de formato para o tipo HelpInfoShort e os salva na $F variável.

O segundo comando usa o parâmetro InputObject do Export-FormatData cmdlet para inserir os dados de formato salvos na $F variável. Ele também usa o parâmetro IncludeScriptBlock para incluir blocos de script na saída.

Exemplo 3: Exportar dados de formato sem um bloco de script

Get-FormatData -TypeName "System.Diagnostics.Process" | Export-FormatData -Path process.format.ps1xml
Update-FormatData -PrependPath ".\process.format.ps1xml"
Get-Process p*

Handles  NPM(K)  PM(K)  WS(K) VM(M)   CPU(s)    Id ProcessName
-------  ------  -----  ----- -----   ------    -- -----------
323                                       5600 powershell
336                                       3900 powershell_ise
138                                       4076 PresentationFontCache

Este exemplo mostra o efeito de omitir o parâmetro IncludeScriptBlock de um Export-FormatData comando.

O primeiro comando usa o Get-FormatData cmdlet para obter os dados de formato para o objeto System.Diagnostics.Process que o cmdlet Get-Process retorna. O comando usa um operador de pipeline (|) para enviar os dados de formatação para o Export-FormatData cmdlet, que os exporta para o arquivo Process.format.ps1xml no diretório atual.

Nesse caso, o Export-FormatData comando não usa o parâmetro IncludeScriptBlock .

O segundo comando usa o Update-FormatData cmdlet para adicionar o arquivo Process.format.ps1xml à sessão atual. O comando usa o parâmetro PrependPath para garantir que os dados de formatação para objetos de processo no arquivo Process.format.ps1xml sejam encontrados antes dos dados de formatação padrão para objetos de processo.

O terceiro comando mostra os efeitos dessa mudança. O comando usa o Get-Process cmdlet para obter processos com nomes que começam com P. A saída mostra que os valores de propriedade que são calculados usando blocos de script estão faltando na exibição.

Parâmetros

-Force

Força o comando a ser executado sem pedir a confirmação do usuário.

Tipo:SwitchParameter
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-IncludeScriptBlock

Indica se os blocos de script no formato de dados são exportados.

Como os blocos de script contêm código e podem ser usados maliciosamente, eles não são exportados por padrão.

Tipo:SwitchParameter
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-InputObject

Especifica o formato de objetos de dados a serem exportados. Insira uma variável que contenha os objetos ou um comando que obtenha os objetos, como um Get-FormatData comando. Você também pode canalizar os objetos de Get-FormatData para Export-FormatData.

Tipo:ExtendedTypeDefinition[]
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-LiteralPath

Especifica um local para o arquivo de saída. Ao contrário do parâmetro Path , o valor de LiteralPath é usado exatamente como é digitado. Nenhum caractere é interpretado como curinga. Se o caminho incluir caracteres de escape, coloque-o entre aspas simples. Aspas simples dizem ao PowerShell para não interpretar nenhum caractere como sequências de escape.

Tipo:String
Aliases:PSPath, LP
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-NoClobber

Indica que o cmdlet não substitui arquivos existentes. Por padrão, substitui arquivos sem aviso, Export-FormatData a menos que o arquivo tenha o atributo somente leitura.

Para direcionar Export-FormatData para substituir arquivos somente leitura, use o parâmetro Force .

Tipo:SwitchParameter
Aliases:NoOverwrite
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Path

Especifica um local para o arquivo de saída. Insira um caminho (opcional) e um nome de arquivo com uma extensão de nome de arquivo format.ps1xml. Se você omitir o caminho, Export-FormatData criará o arquivo no diretório atual.

Se você usar uma extensão de nome de arquivo diferente de .ps1xml, o Update-FormatData cmdlet não reconhecerá o arquivo.

Se você especificar um arquivo existente, Export-FormatData substituirá o arquivo sem aviso, a menos que o arquivo tenha o atributo somente leitura. Para substituir um arquivo somente leitura, use o parâmetro Force . Para evitar que os arquivos sejam substituídos, use o parâmetro NoClobber .

Tipo:String
Aliases:FilePath
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

Entradas

ExtendedTypeDefinition

Você pode canalizar objetos ExtendedTypeDefinition para Get-FormatData este cmdlet.

Saídas

None

Este cmdlet não retorna nenhuma saída. Ele gera um arquivo e o salva no caminho especificado.

Notas

  • Para usar qualquer arquivo de formatação, incluindo um arquivo de formatação exportado, a política de execução da sessão deve permitir a execução de scripts e arquivos de configuração. Para obter mais informações, consulte about_Execution_Policies.