ConvertTo-Xml

  • Référence
Module:
Microsoft.PowerShell.Utility

Crée une représentation XML d'un objet.

Syntax

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

Description

L’applet ConvertTo-Xml de commande crée une représentation XML d’un ou plusieurs objets .NET. Pour utiliser cette applet de commande, dirigez un ou plusieurs objets vers l’applet de commande ou utilisez le paramètre InputObject pour spécifier l’objet.

Lorsque vous dirigez plusieurs objets vers ConvertTo-Xml ou utilisez le paramètre InputObject pour envoyer plusieurs objets, ConvertTo-Xml retourne un document XML unique en mémoire qui inclut des représentations de tous les objets.

Cette applet de commande est similaire à Export-Clixml , sauf qu’elle Export-Clixml stocke le code XML résultant dans un fichier CLI (Common Language Infrastructure) qui peut être réimporté en tant qu’objets avec Import-Clixml. ConvertTo-Xml retourne une représentation en mémoire d’un document XML. Vous pouvez donc continuer à le traiter dans PowerShell. ConvertTo-Xml n’a pas la possibilité de convertir des objets en XML CLI.

Exemples

Exemple 1 : Convertir une date en XML

Get-Date | ConvertTo-Xml

Cette commande convertit la date actuelle (objet DateTime ) en XML.

Exemple 2 : Convertir des processus en XML

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

Cette commande convertit les objets de processus qui représentent tous les processus sur l’ordinateur en document XML. Les objets sont étendus à une profondeur de trois niveaux.

Paramètres

-As

Détermine le format de sortie. Les valeurs valides pour ce paramètre sont :

  • String - Retourne une seule chaîne.
  • Stream - Retourne un tableau de chaînes.
  • Document - Renvoie un objet XmlDocument .

La valeur par défaut est Document.

Type:String
Accepted values:Stream, String, Document
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Depth

Spécifie le nombre de niveaux d'objets contenus inclus dans la représentation XML. La valeur par défaut est 1.

Par exemple, si les propriétés de l'objet contiennent également des objets, pour enregistrer une représentation XML des propriétés des objets contenus, vous devez spécifier une profondeur de 2.

La valeur par défaut peut être remplacée par le type d'objet des fichiers Types.ps1xml. Pour plus d’informations, consultez about_Types.ps1xml.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Spécifie l'objet à convertir. Entrez une variable contenant les objets, ou tapez une commande ou une expression qui obtient ces objets. Vous pouvez également diriger des objets vers ConvertTo-XML.

Type:PSObject
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-NoTypeInformation

Omet l'attribut Type des nœuds d'objet.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entrées

PSObject

Vous pouvez diriger n’importe quel objet vers cette applet de commande

Sorties

String

Lorsque vous utilisez le paramètre As et définissez la valeur stringsur , cette applet de commande retourne le code XML sous forme de chaîne. Lorsque la valeur est stream, cette applet de commande retourne un tableau de chaînes.

XmlDocument

Par défaut, cette applet de commande retourne un document XML.