Example usage of ConvertTo-Json.
Get-Process | Select-Object -First 3 Name, Id | ConvertTo-Json -Depth 3ConvertTo-Json cmdlet
Converts an object to a JSON-formatted string.
Syntax
ConvertTo-Json [-InputObject] <object> [-Depth <int>]This is a practical syntax summary, not every parameter set. Run Get-Command ConvertTo-Json -Syntax and Get-Help ConvertTo-Json -Full in the installed version for its complete syntax and parameter metadata. Common parameters and -WhatIf/-Confirm support depend on the command and PowerShell version.
Examples
Read all available parameter sets and help for the installed module.
Get-Help ConvertTo-Json -FullParameters, options and clauses
| Option / clause | Description |
|---|---|
-InputObject <object> | Specify the object to serialize. |
-Depth <n> | Set maximum nesting depth. |
-Compress | Remove formatting whitespace. |
-EnumsAsStrings | Serialize enum values as strings where supported. |
-Verbose | Write additional diagnostic detail to the verbose stream. |
-Debug | Write debugging messages to the debug stream. |
-ErrorAction <action> | Control how a non-terminating error is handled. |
-ErrorVariable <name> | Store error records in a variable. |
-WarningAction <action> | Control how warnings are handled. |
-WarningVariable <name> | Store warning messages in a variable. |
-InformationAction <action> | Control how information messages are handled. |
-InformationVariable <name> | Store information messages in a variable. |
-OutVariable <name> | Store output in a variable as well as sending it onward. |
-OutBuffer <count> | Set the number of objects to collect before the next command runs. |
-PipelineVariable <name> | Store the current pipeline object in a variable during processing. |
-ProgressAction <action> | Control progress reporting in versions that support this parameter. |
-WhatIf / -Confirm | Risk-control parameters available only on commands that support ShouldProcess. |
Related PowerShell references
Review a command and its target before running it. Commands that alter files, services, accounts, disks, permissions or databases may be difficult to reverse. Test in a safe environment and keep backups.