Export-FormatData

  • Referencia
Módulo:
Microsoft.PowerShell.Utility

Guarda los datos de formato de la sesión actual en un archivo de formato.

Syntax

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

Description

El Export-FormatData cmdlet crea archivos de formato de PowerShell (format.ps1xml) a partir de los objetos de formato de la sesión actual. Toma los objetos ExtendedTypeDefinition que Get-FormatData devuelve y los guarda en un archivo en formato XML.

PowerShell usa los datos de los archivos de formato (format.ps1xml) para generar la presentación predeterminada de los objetos de Microsoft .NET Framework en la sesión. Puede ver y editar los archivos de formato y usar el cmdlet Update-FormatData para agregar los datos de formato a una sesión.

Para obtener más información sobre el formato de archivos en PowerShell, consulte about_Format.ps1xml.

Ejemplos

Ejemplo 1: Exportar datos de formato de sesión

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

Este comando exporta todos los datos de formato de la sesión al archivo AllFormat.ps1xml.

El comando usa el Get-FormatData cmdlet para obtener los datos de formato en la sesión. Un valor de * (todos) para el parámetro TypeName dirige el cmdlet para obtener todos los datos de la sesión.

El comando usa un operador de canalización (|) para enviar los datos de formato del Get-FormatData comando al Export-FormatData cmdlet , que exporta los datos de formato al archivo AllFormat.ps1.

El Export-FormatData comando usa el parámetro IncludeScriptBlock para incluir bloques de script en los datos de formato del archivo.

Ejemplo 2: Exportación de datos de formato para un tipo

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

Estos comandos exportan los datos de formato del tipo HelpInfoShort al archivo Help.format.ps1xml.

El primer comando usa el Get-FormatData cmdlet para obtener los datos de formato del tipo HelpInfoShort y lo guarda en la $F variable .

El segundo comando usa el parámetro InputObject del Export-FormatData cmdlet para escribir los datos de formato guardados en la $F variable. También usa el parámetro IncludeScriptBlock para incluir bloques de script en la salida.

Ejemplo 3: Exportación de datos de formato sin un bloque 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

En este ejemplo se muestra el efecto de omitir el parámetro IncludeScriptBlock de un Export-FormatData comando.

El primer comando usa el Get-FormatData cmdlet para obtener los datos de formato del objeto System.Diagnostics.Process que devuelve el cmdlet Get-Process. El comando usa un operador de canalización (|) para enviar los datos de formato al Export-FormatData cmdlet , que lo exporta al archivo Process.format.ps1xml en el directorio actual.

En este caso, el Export-FormatData comando no usa el parámetro IncludeScriptBlock .

El segundo comando usa el Update-FormatData cmdlet para agregar el archivo Process.format.ps1xml a la sesión actual. El comando usa el parámetro PrependPath para asegurarse de que los datos de formato de los objetos de proceso en el archivo Process.format.ps1xml se encuentran antes de que se encuentren los datos de formato estándar para los objetos de proceso.

El tercer comando muestra los efectos de este cambio. El comando usa el Get-Process cmdlet para obtener procesos que tienen nombres que comienzan por P. La salida muestra que faltan los valores de propiedad calculados mediante bloques de script de la pantalla.

Parámetros

-Force

Obliga al comando a ejecutarse sin solicitar la confirmación del usuario.

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

-IncludeScriptBlock

Indica si se exportan bloques de script en los datos de formato.

Los bloques de script no se exportan de forma predeterminada, ya que contienen código y pueden usarse de manera malintencionada.

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

-InputObject

Especifica los objetos de datos de formato que se exportarán. Escriba una variable que contenga los objetos o un comando que obtiene los objetos, como un Get-FormatData comando. También puede canalizar los objetos de Get-FormatData a Export-FormatData.

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

-LiteralPath

Especifica una ubicación para el archivo de resultados. A diferencia del parámetro Path , el valor de LiteralPath se usa exactamente como se escribe. Ninguno de los caracteres se interpreta como caracteres comodín. Si la ruta de acceso contiene caracteres de escape, escríbalos entre comillas simples. Las comillas simples indican a PowerShell que no interprete ningún carácter como secuencias de escape.

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

-NoClobber

Indica que el cmdlet no sobrescribe los archivos existentes. De forma predeterminada, Export-FormatData sobrescribe los archivos sin advertencia a menos que el archivo tenga el atributo de solo lectura.

Para dirigir Export-FormatData a sobrescribir archivos de solo lectura, use el parámetro Force .

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

-Path

Especifica una ubicación para el archivo de resultados. Escriba una ruta de acceso (opcional) y un nombre de archivo con una extensión de nombre de archivo format.ps1xml. Si omite la ruta de acceso, Export-FormatData crea el archivo en el directorio actual.

Si usa una extensión de nombre de archivo distinta de .ps1xml, el Update-FormatData cmdlet no reconocerá el archivo.

Si especifica un archivo existente, Export-FormatData sobrescribe el archivo sin advertencia, a menos que el archivo tenga el atributo de solo lectura. Para sobrescribir un archivo de solo lectura, use el parámetro Force . Para evitar que los archivos se sobrescriban, use el parámetro NoClobber .

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

Entradas

ExtendedTypeDefinition

Puede canalizar objetos ExtendedTypeDefinition de Get-FormatData a este cmdlet.

Salidas

None

Este cmdlet no devuelve ningún resultado. Genera un archivo y lo guarda en la ruta especificada.

Notas

  • Para usar cualquier archivo de formato, incluido un archivo de formato exportado, la directiva de ejecución de la sesión debe permitir que se ejecuten scripts y archivos de configuración. Para obtener más información, vea about_Execution_Policies.