HOME > Json系コマンドレット > ConvertTo-Json
ConvertTo-Json
ConvertTo-Jsonは、Json形式にフォーマットするコマンドです。
エイリアスなし
解説
PowerShellオブジェクトをJSON形式の文字列に変換します。
構文
- (構文)
- ConvertTo-Json [-InputObject] <Object> [<CommonParameters>]
パラメータ | 説明 |
---|---|
-InputObject オブジェクト | JSON形式に変換するオブジェクトを指定する |
-Depth 数 | JSON表現に含める子オブジェクトのレベルを指定する (デフォルト値は2) |
-Compress | 出力文字列内の空白文字とインデントを省略する |
共通的なパラメータは「共通パラメータ」をご覧ください。
サンプル
オブジェクトをJSON文字列に変換する(-InputObject版)
PS C:\>$item = @{
Name = "みかん"
Price = 50
Note = "愛媛産"
}
PS C:\>$json = $json = ConvertTo-Json -InputObject $item
PS C:\>$json
(結果)
{
"Price": 50,
"Name": "みかん",
"Note": "愛媛産"
}
オブジェクトをJSON文字列に変換する(パイプ版)
PS C:\>$item = @{
Name = "みかん"
Price = 50
Note = "愛媛産"
}
PS C:\>$json = $item | ConvertTo-Json
PS C:\>$json
(結果)
{
"Price": 50,
"Name": "みかん",
"Note": "愛媛産"
}
オブジェクトをJSON文字列に変換する(空白とインデントを省略)
PS C:\>$item = @{
Name = "みかん"
Price = 50
Note = "愛媛産"
}
PS C:\>$json = $json = ConvertTo-Json -InputObject $item -Compress
PS C:\>$json
(結果)
{"Price":50,"Name":"みかん","Note":"愛媛産"}
Get-Processコマンドレットの出力結果からJSON形式に変換する
Get-Process | Select-Object -First 3 -Property Name, CPU, WorkingSet | ConvertTo-Json
コマンドのヘルプを表示する
Get-Help ConvertTo-Json
備考
- デフォルトのネストレベルは2です。
これを超える場合は-Depthパラメータで指定してください。 - Powershellのすべてのオブジェクトに対応しているわけではありません。
関連項目
- Json系コマンドレット
- ConvertTo-Json:Json形式にフォーマットする
- ConvertFrom-Json:Json形式からコンバートする