ConvertTo-Xml
Создает 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-файл в XML-файле CLI , который можно повторно импортировать как объекты с помощью Import-Clixml. ConvertTo-Xml
возвращает представление XML-документа в памяти, чтобы продолжить его обработку в PowerShell. ConvertTo-Xml
не имеет возможности преобразования объектов в XML-интерфейс командной строки.
Примеры
Пример 1. Преобразование даты в XML
PS C:\> Get-Date | ConvertTo-Xml
Эта команда преобразует текущую дату (объект DateTime ) в XML.
Пример 2. Преобразование процессов в XML
PS C:\> ConvertTo-Xml -As "Document" -InputObject (Get-Process) -Depth 3
Эта команда преобразует объекты процессов, представляющие все процессы на компьютере, в XML-документ. Объекты расширяются до трех уровней.
Параметры
-As
Определяет формат вывода. Допустимые значения для этого параметра:
- Строка. возвращает отдельную строку;
- Поток. возвращает массив строк;
- Документ. Возвращает объект XmlDocument .
Значение по умолчанию — Document.
Type: | String |
Accepted values: | Stream, String, Document |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Depth
Указывает, сколько уровней вложенных объектов включается в XML-представление. Значение по умолчанию — 1.
Например, если свойства объекта также содержат объекты, то для сохранения XML-представления свойств этих вложенных объектов необходимо указать глубину, равную 2.
Значение по умолчанию можно переопределить для типа объекта в файлах Types.ps1xml. Дополнительные сведения см. в разделе about_Types.ps1xml.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Задает объект для преобразования. Введите переменную, которая содержит объекты, или команду или выражение, которое возвращает объекты. Объекты также можно передать в ConvertTo-XML.
Type: | PSObject |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-NoTypeInformation
Исключает атрибут Type из узлов объектов.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Входные данные
Вы можете передать любой объект в ConvertTo-XML.
Выходные данные
System.String or System.Xml.XmlDocument
Значение параметра As определяет тип объекта, возвращаемого ConvertTo-XML .