Поделиться через

ConvertTo-Xml

Модуль:
Microsoft.PowerShell.Utility Module

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

Синтаксис

Default (по умолчанию) 

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
Default value:None
Допустимые значения:Stream, String, Document
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Depth

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

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

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

Свойства параметра

Тип:Int32
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-InputObject

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

Свойства параметра

Тип:PSObject
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:0
Обязательно:True
Значение из конвейера:True
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-NoTypeInformation

Omits атрибут Type из узлов объектов.

Свойства параметра

Тип:SwitchParameter
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

CommonParameters

Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.

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

PSObject

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

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

String

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

XmlDocument

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