Export-FormatData
Salva dados de formatação da sessão atual em um arquivo de formatação.
Sintaxe
ByPath (Padrão)
Export-FormatData
-InputObject <ExtendedTypeDefinition[]>
-Path <String>
[-Force]
[-NoClobber]
[-IncludeScriptBlock]
[<CommonParameters>]
ByLiteralPath
Export-FormatData
-InputObject <ExtendedTypeDefinition[]>
-LiteralPath <String>
[-Force]
[-NoClobber]
[-IncludeScriptBlock]
[<CommonParameters>]
Description
O cmdlet Export-FormatData cria arquivos de formatação do PowerShell (format.ps1xml) dos objetos de formatação na sessão atual. Ele usa os objetos ExtendedTypeDefinition que Get-FormatData 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
Esse comando exporta todos os dados de formato na sessão para o arquivo AllFormat.ps1xml.
O comando usa o cmdlet Get-FormatData para obter os dados de formato na sessão. Um valor de * (todos) 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 Get-FormatData para o cmdlet Export-FormatData, que exporta os dados de formato para o arquivo AllFormat.ps1xml.
O comando Export-FormatData 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 para o tipo de helpInfoShort para o arquivo Help.format.ps1xml.
O primeiro comando usa o cmdlet Get-FormatData para obter os dados de formato do tipo de helpInfoShort e os salva na variável $F.
O segundo comando usa o parâmetro InputObject do cmdlet Export-FormatData para inserir os dados de formato salvos na variável $F. 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 comando Export-FormatData.
O primeiro comando usa o cmdlet Get-FormatData para obter os dados de formato do 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 cmdlet Export-FormatData, que os exporta para o arquivo Process.format.ps1xml no diretório atual.
Nesse caso, o comando Export-FormatData não usa o parâmetro IncludeScriptBlock.
O segundo comando usa o cmdlet Update-FormatData 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 alteração. O comando usa o cmdlet Get-Process para obter processos que têm nomes que começam com P. A saída mostra que os valores de propriedade calculados usando blocos de script estão ausentes da exibição.
Parâmetros
-Force
Força o comando a ser executado sem solicitar a confirmação do usuário.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-IncludeScriptBlock
Indica se os blocos de script nos dados de formato são exportados.
Como os blocos de script contêm código e podem ser usados mal-intencionados, eles não são exportados por padrão.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-InputObject
Especifica os objetos de dados de formato a serem exportados. Insira uma variável que contenha os objetos ou um comando que obtém os objetos, como um comando Get-FormatData. Você também pode canalizar os objetos de Get-FormatData para Export-FormatData.
Propriedades do parâmetro
| Tipo: | |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | 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 caractere curinga. Se o caminho incluir caracteres de escape, coloque-o entre aspas simples. Aspas simples indicam ao PowerShell que não deve interpretar nenhum caractere como uma sequência de escape.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | PSPath, LP |
Conjuntos de parâmetros
ByLiteralPath
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-NoClobber
Indica que o cmdlet não substitui arquivos existentes. Por padrão, Export-FormatData substitui arquivos sem aviso, a menos que o arquivo tenha o atributo somente leitura.
Para direcionar Export-FormatData para substituir arquivos somente leitura, use o parâmetro Force.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | NoOverwrite |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | 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 cmdlet Update-FormatData 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 impedir que os arquivos sejam substituídos, use o parâmetro
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | FilePath |
Conjuntos de parâmetros
ByPath
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.
Entradas
ExtendedTypeDefinition
Você pode redirecionar objetos ExtendedTypeDefinition de Get-FormatData para este cmdlet.
Saídas
None
Esse cmdlet não retorna nenhuma saída. Ele gera um arquivo e o salva no caminho especificado.
Observações
- 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 que scripts e arquivos de configuração sejam executados. Para obter mais informações, consulte o item sobre Políticas de Execução.
