ConvertTo-Xml (Microsoft.PowerShell.Utility)

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 в файле Common Language Infrastructure (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
Принятые значения:: Поток, Строка, Документ
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-Depth

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

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

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

Тип :: Int32
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-InputObject

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

Тип :: PSОбъект
Позиция:: 0
Значение по умолчанию:: None
Необходимый:: True
Примите ввод конвейера:: True
Принимайте подстановочные знаки:: False

-NoTypeInformation

Опускает атрибут Type из узлов объекта.

Тип :: SwitchParameter
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

Входы

PSObject

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

Выходы

Строка

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

XmlDocument

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