ConvertTo-Xml

Module:
Microsoft.PowerShell.Utility Module

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

Syntaxe

Default (Par défaut) 

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

Description

L’applet de commande ConvertTo-Xml crée une représentation basée sur 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 le paramètre InputObject ou que vous l’utilisez pour soumettre plusieurs objets, ConvertTo-Xml renvoie un seul document XML 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 XML 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 ne dispose pas d’une option permettant de convertir des objets en CLI XML.

Exemples

Exemple 1 : Convertir une date en XML

Get-Date | ConvertTo-Xml

Cette commande convertit la date actuelle (un 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 acceptables pour ce paramètre sont les suivantes :

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

La valeur par défaut est Document.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Valeurs acceptées:Stream, String, Document
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants: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 substituée pour le type d’objet dans les fichiers Types.ps1xml. Pour plus d’informations, consultez about_Types.ps1xml.

Propriétés du paramètre

Type:Int32
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-InputObject

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

Propriétés du paramètre

Type:PSObject
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:0
Obligatoire:True
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-NoTypeInformation

Omettez l’attribut Type des nœuds d’objet.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

CommonParameters

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

Entrées

PSObject

Vous pouvez diriger n’importe quel objet vers ConvertTo-XML.

Sorties

System.String or System.Xml.XmlDocument

La valeur du paramètre As détermine le type d’objet renvoyé ConvertTo-XML .