Exportar-FormatData (Microsoft.PowerShell.Utility)
Export-FormatData
- Módulo:
- Microsoft.PowerShell.Utility
Guarda los datos de formato de la sesión actual en un archivo de formato.
Sintaxis
Export-FormatData
-InputObject <ExtendedTypeDefinition[]>
-Path <String>
[-Force]
[-NoClobber]
[-IncludeScriptBlock]
[<CommonParameters>]Export-FormatData
-InputObject <ExtendedTypeDefinition[]>
-LiteralPath <String>
[-Force]
[-NoClobber]
[-IncludeScriptBlock]
[<CommonParameters>]Descripción
El cmdlet Export-FormatData crea archivos de formato de PowerShell (format.ps1xml) a partir de los objetos de formato en la sesión actual. Toma los objetos ExtendedTypeDefinition que Get-FormatData devuelve y los guarda en un archivo en formato XML.
PowerShell utiliza los datos de los archivos de formato (format.ps1xml) para generar la visualizació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 cómo formatear 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" -IncludeScriptBlockEste comando exporta todos los datos de formato de la sesión al archivo AllFormat.ps1xml.
El comando utiliza el cmdlet Get-FormatData para obtener los datos de formato en la sesión. Un valor de * (todos) para el parámetro TypeName indica al cmdlet que obtenga todos los datos de la sesión.
El comando utiliza un operador de canalización (|) para enviar los datos de formato del comando Get-FormatData al cmdlet Export-FormatData, que exporta los datos de formato al archivo AllFormat.ps1.
El comando Export-FormatData utiliza el parámetro IncludeScriptBlock para incluir bloques de script en los datos de formato del archivo.
Ejemplo 2: exportar datos de formato para un tipo
$F = Get-FormatData -TypeName "helpinfoshort"
Export-FormatData -InputObject $F -Path "c:\test\help.format.ps1xml" -IncludeScriptBlockEstos comandos exportan los datos de formato para el tipo HelpInfoShort al archivo Help.format.ps1xml.
El primer comando utiliza el cmdlet Get-FormatData para obtener los datos de formato para el tipo HelpInfoShort y los guarda en la variable $F.
El segundo comando utiliza el parámetro InputObject del cmdlet Export-FormatData para ingresar los datos de formato guardados en la variable $F. También utiliza el parámetro IncludeScriptBlock para incluir bloques de script en la salida.
Ejemplo 3: exportar datos de formato sin un bloque de secuencia de comandos
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 PresentationFontCacheEste ejemplo muestra el efecto de omitir el parámetro IncludeScriptBlock de un comando Export-FormatData.
El primer comando utiliza el cmdlet Get-FormatData para obtener los datos de formato para el objeto System.Diagnostics.Process que devuelve el cmdlet Get-Process. El comando utiliza un operador de canalización (|) para enviar los datos de formato al cmdlet Export-FormatData, que los exporta al archivo Process.format.ps1xml en el directorio actual. .
En este caso, el comando Export-FormatData no utiliza el parámetro IncludeScriptBlock.
El segundo comando utiliza el cmdlet Update-FormatData para agregar el archivo Process.format.ps1xml a la sesión actual. El comando utiliza el parámetro PrependPath para garantizar que los datos de formato para los objetos de proceso en el archivo Process.format.ps1xml se encuentren antes que los datos de formato estándar para los objetos de proceso.
El tercer comando muestra los efectos de este cambio. El comando utiliza el cmdlet Get-Process para obtener procesos que tienen nombres que comienzan con P. El resultado muestra que faltan en la pantalla los valores de propiedad calculados mediante bloques de script.
Parámetros
-Force
Fuerza la ejecución del comando sin pedir confirmación al usuario.
- Tipo :
SwitchParameter
- Posición:
Nombrado
- Valor predeterminado:
None
- Requerido:
False
- Aceptar entrada de canalización:
False
- Aceptar caracteres comodín:
False
-IncludeScriptBlock
Indica si se exportan bloques de script en los datos de formato.
Debido a que los bloques de secuencias de comandos contienen código y pueden usarse de manera maliciosa, no se exportan de forma predeterminada.
- Tipo :
-
SwitchParameter
- Posición:
Nombrado
- Valor predeterminado:
None
- Requerido:
False
- Aceptar entrada de canalización:
False
- Aceptar caracteres comodín:
False
-InputObject
Especifica el formato de los objetos de datos que se exportarán. Introduzca una variable que contenga los objetos o un comando que obtenga los objetos, como un comando Get-FormatData. También puede canalizar los objetos desde Get-FormatData a Export-FormatData.
- Tipo :
Definición de tipo extendido[]
- Posición:
Nombrado
- Valor predeterminado:
None
- Requerido:
True
- Aceptar entrada de canalización:
True
- Aceptar caracteres comodín:
False
-LiteralPath
Especifica una ubicación para el archivo de salida. A diferencia del parámetro Path, el valor de LiteralPath se utiliza exactamente tal como se escribe. Ningún carácter se interpreta como comodín. Si la ruta incluye caracteres de escape, escríbala entre comillas simples. Las comillas simples le indican a PowerShell que no interprete ningún carácter como secuencia de escape.
- Tipo :
String
- Alias:
PSPath, LP
- Posición:
Nombrado
- Valor predeterminado:
None
- Requerido:
True
- Aceptar entrada de canalización:
False
- Aceptar caracteres comodín:
False
-NoClobber
Indica que el cmdlet no sobrescribe los archivos existentes. De forma predeterminada, Export-FormatData sobrescribe archivos sin previo aviso a menos que el archivo tenga el atributo de solo lectura.
Para indicar a Export-FormatData que sobrescriba archivos de solo lectura, utilice el parámetro Force.
- Tipo :
SwitchParameter
- Alias:
NoOverwrite
- Posición:
Nombrado
- Valor predeterminado:
None
- Requerido:
False
- Aceptar entrada de canalización:
False
- Aceptar caracteres comodín:
False
-Path
Especifica una ubicación para el archivo de salida. Ingrese una ruta (opcional) y un nombre de archivo con una extensión de nombre de archivo format.ps1xml. Si omite la ruta, Export-FormatData crea el archivo en el directorio actual.
Si utiliza una extensión de nombre de archivo distinta de .ps1xml, el cmdlet Update-FormatData no reconocerá el archivo.
Si especifica un archivo existente, Export-FormatData sobrescribe el archivo sin previo aviso, a menos que el archivo tenga el atributo de solo lectura. Para sobrescribir un archivo de solo lectura, utilice el parámetro Force. Para evitar que los archivos se sobrescriban, utilice el parámetro NoClobber.
- Tipo :
String
- Alias:
FilePath
- Posición:
Nombrado
- Valor predeterminado:
None
- Requerido:
True
- Aceptar entrada de canalización:
False
- Aceptar caracteres comodín:
False
Entradas
Definición de tipo extendido
Puede canalizar objetos ExtendedTypeDefinition desde Get-FormatData a este cmdlet.
Salidas
Ninguno
Este cmdlet no devuelve ningún resultado. Genera un archivo y lo guarda en la ruta especificada.
Notas
- Para utilizar cualquier archivo de formato, incluido un archivo de formato exportado, la política de ejecución de la sesión debe permitir la ejecución de scripts y archivos de configuración. Para obtener más información, consulte about_Execution_Policies.