ConvertTo-Xml

  • Ссылка
Модуль:
Microsoft.PowerShell.Utility

Создает XML-представление объекта.

Синтаксис

ConvertTo-Xml
              [-Depth <Int32>]
              [-InputObject] <PSObject>
              [-NoTypeInformation]
              [-As <String>]
              [<CommonParameters>]

Описание

Командлет ConvertTo-Xml создает xml-представление одного или нескольких объектов .NET. Чтобы использовать этот командлет, передайте один или несколько объектов в командлет или используйте параметр InputObject для указания объекта.

При отправке нескольких объектов ConvertTo-Xml или использовании параметра InputObject для отправки нескольких объектов ConvertTo-Xml возвращается один XML-документ в памяти, включающий представления всех объектов.

Этот командлет похож на Export-Clixml , за исключением того, что Export-Clixml сохраняет полученный XML-файл в файле командной строки (CLI), который можно импортировать в виде объектов с помощью Import-Clixml. ConvertTo-Xml возвращает в памяти представление XML-документа, поэтому его можно продолжать обрабатывать в PowerShell. ConvertTo-Xml Не имеет возможности преобразовать объекты в XML-файл CLI.

Примеры

Пример 1. Преобразование даты в XML

Get-Date | ConvertTo-Xml

Эта команда преобразует текущую дату (объект DateTime ) в XML.

Пример 2. Преобразование процессов в XML

ConvertTo-Xml -As "Document" -InputObject (Get-Process) -Depth 3

Эта команда преобразует объекты процесса, представляющие все процессы на компьютере в XML-документ. Объекты расширяются до трех уровней.

Параметры

-As

Определяет формат вывода. Допустимые значения для этого параметра:

  • String — возвращает одну строку.
  • Stream — возвращает массив строк.
  • Document — возвращает объект XmlDocument .

Значение по умолчанию — Document.

Тип:String
Допустимые значения:Stream, String, Document
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Depth

Указывает, сколько уровней вложенных объектов включается в XML-представление. Значение по умолчанию равно 1.

Например, если свойства объекта также содержат объекты, то для сохранения XML-представления свойств этих вложенных объектов необходимо указать глубину, равную 2.

Значение по умолчанию можно переопределить для типа объекта в файлах Types.ps1xml. Дополнительные сведения см. в разделе about_Types.ps1xml.

Тип:Int32
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-InputObject

Задает объект для преобразования. Введите переменную, которая содержит объекты, или команду или выражение, которое возвращает объекты. Можно также передать объекты ConvertTo-XMLв .

Тип:PSObject
Position:0
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-NoTypeInformation

Исключает атрибут Type из узлов объектов.

Тип:SwitchParameter
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

Входные данные

PSObject

Вы можете передать любой объект в этот командлет.

Выходные данные

String

При использовании параметра As и присвоении значения stringэтому командлету возвращается XML в виде строки. Если значение равно stream, этот командлет возвращает массив строк.

XmlDocument

По умолчанию этот командлет возвращает XML-документ.