Crée une représentation XML d'un objet.
Syntaxe
ConvertTo-XML [-InputObject] <psobject> [-As <string>] [-Depth <int>] [-NoTypeInformation] [<CommonParameters>]
Description
L'applet de commande ConvertTo-Xml crée une représentation XML d'un ou plusieurs objets Microsoft .NET Framework. 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 que vous utilisez le paramètre InputObject pour envoyer plusieurs objets, ConvertTo-XML retourne un document XML unique qui inclut des représentations de tous les objets.
Cette applet de commande est semblable à l'applet de commande Export-Clixml, à ceci près que Export-Clixml stocke le contenu XML obtenu dans un fichier. ConvertTo-XML retourne le contenu XML, que vous pouvez donc continuer à traiter dans Windows PowerShell.
Paramètres
-As <string>
Détermine le format de sortie. Les valeurs valides sont :
-- String : retourne une chaîne unique.
-- Stream : retourne un tableau de chaînes.
-- Document : retourne un objet XmlDocument.
La valeur par défaut est Stream.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
Stream |
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-Depth <int>
Spécifie combien de niveaux d'objets contenus sont inclus dans la représentation XML. La valeur par défaut est 1.
Par exemple, si les propriétés d'objet contiennent également des objets, vous devez spécifier le niveau d'imbrication 2 pour enregistrer une représentation XML des propriétés des objets contenus.
La valeur par défaut peut être remplacée pour le type d'objet dans les fichiers Types.ps1xml. Pour plus d'informations, consultez about_Types.ps1xml.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
1 |
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-InputObject <psobject>
Spécifie l'objet à convertir. Entrez une variable contenant les objets ou tapez une commande ou une expression permettant d'obtenir ces objets. Vous pouvez également diriger les objets vers ConvertTo-XML.
|
Obligatoire ? |
true |
|
Position ? |
1 |
|
Valeur par défaut |
aucun |
|
Accepter l'entrée de pipeline ? |
true (ByValue) |
|
Accepter les caractères génériques ? |
true |
-NoTypeInformation
Omet l'attribut Type des nœuds d'objet.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
False |
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
<CommonParameters>
Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer et -OutVariable. Pour plus d'informations, consultez about_Commonparameters.
Entrées et sorties
Le type d'entrée est le type des objets que vous pouvez diriger vers l'applet de commande. Le type de retour est le type des objets que l'applet de commande retourne.
|
Entrées |
System.Management.Automation.PSObject Vous pouvez diriger n'importe quel objet vers ConvertTo-XML. |
|
Sorties |
System.String ou System.Xml.XmlDocument La valeur du paramètre As détermine le type d'objet retourné par ConvertTo-XML. |
Exemple 1
C:\PS>get-date | convertto-xml Description ----------- Cette commande convertit la date actuelle (objet DateTime) au format XML.
Exemple 2
C:\PS>convertto-xml -as Document -inputObject (get-process) -depth 3 Description ----------- Cette commande convertit les objets processus représentant tous les processus de l'ordinateur en un document XML. Les objets sont développés sur une profondeur de 3 niveaux.
Voir aussi