ConvertTo-Json

構文

ConvertTo-Json
              [-InputObject] <Object>
              [-Depth <Int32>]
              [-Compress]
              [-EnumsAsStrings]
              [-AsArray]
              [-EscapeHandling <StringEscapeHandling>]
              [<CommonParameters>]

説明

ConvertTo-Json コマンドレットは、.NET オブジェクトを JavaScript Object Notation (JSON) 形式の文字列に変換します。 プロパティはフィールド名に変換され、フィールドの値はプロパティの値に変換されます。メソッドは削除されます。

その後、 ConvertFrom-Json コマンドレットを使用して、JSON 形式の文字列を JSON オブジェクトに変換できます。これは PowerShell で簡単に管理できます。

多くの Web サイトが、サーバーと Web ベースのアプリ間の通信のために、XML ではなく JSON を使用してデータをシリアル化しています。

PowerShell 7.1 の時点で、入力オブジェクトの深さがコマンドに指定された深度を超えた場合、 ConvertTo-Json は警告を出力します。 これにより、オブジェクトを変換するときに不要なデータが失われるのを防ぐことができます。

このコマンドレットは、Windows PowerShell 3.0 で導入されました。

例

例 1

(Get-UICulture).Calendar | ConvertTo-Json

{
  "MinSupportedDateTime": "0001-01-01T00:00:00",
  "MaxSupportedDateTime": "9999-12-31T23:59:59.9999999",
  "AlgorithmType": 1,
  "CalendarType": 1,
  "Eras": [
    1
  ],
  "TwoDigitYearMax": 2029,
  "IsReadOnly": true
}

このコマンドでは、 ConvertTo-Json コマンドレットを使用して、GregorianCalendar オブジェクトを JSON 形式の文字列に変換します。

例 2

Get-Date | ConvertTo-Json; Get-Date | ConvertTo-Json -AsArray

"2021-08-05T16:13:05.6394416-07:00"
[
  "2021-08-05T16:13:05.6421709-07:00"
]

この例では、AsArray switch パラメーターの有無に関係なく、ConvertTo-Json コマンドレットからの出力を示します。 出力の 2 番目の部分が配列角かっこで囲まれていることがわかります。

例 3

@{Account="User01";Domain="Domain01";Admin="True"} | ConvertTo-Json -Compress

{"Domain":"Domain01","Account":"User01","Admin":"True"}

このコマンドは、ConvertTo-Jsonの Compress パラメーターを使用した場合の効果を示します。 圧縮は、文字列の外観に影響を与えますが、有効性には影響を与えません。

例 4

Get-Date | Select-Object -Property * | ConvertTo-Json

{
  "DisplayHint": 2,
  "DateTime": "October 12, 2018 10:55:32 PM",
  "Date": "2018-10-12T00:00:00-05:00",
  "Day": 12,
  "DayOfWeek": 5,
  "DayOfYear": 285,
  "Hour": 22,
  "Kind": 2,
  "Millisecond": 639,
  "Minute": 55,
  "Month": 10,
  "Second": 32,
  "Ticks": 636749817326397744,
  "TimeOfDay": {
    "Ticks": 825326397744,
    "Days": 0,
    "Hours": 22,
    "Milliseconds": 639,
    "Minutes": 55,
    "Seconds": 32,
    "TotalDays": 0.95523888627777775,
    "TotalHours": 22.925733270666665,
    "TotalMilliseconds": 82532639.774400011,
    "TotalMinutes": 1375.54399624,
    "TotalSeconds": 82532.6397744
  },
  "Year": 2018
}

この例では、 ConvertTo-Json コマンドレットを使用して、 System.DateTime オブジェクトを Get-Date コマンドレットから JSON 形式の文字列に変換します。 このコマンドでは、Select-Object コマンドレットを使用して、DateTime オブジェクトのすべてのプロパティ (*) を取得します。 出力には、返された JSON 文字列 ConvertTo-Json 示されます。

例 5

Get-Date | Select-Object -Property * | ConvertTo-Json | ConvertFrom-Json

DisplayHint : 2
DateTime    : October 12, 2018 10:55:52 PM
Date        : 2018-10-12 12:00:00 AM
Day         : 12
DayOfWeek   : 5
DayOfYear   : 285
Hour        : 22
Kind        : 2
Millisecond : 768
Minute      : 55
Month       : 10
Second      : 52
Ticks       : 636749817527683372
TimeOfDay   : @{Ticks=825527683372; Days=0; Hours=22; Milliseconds=768; Minutes=55; Seconds=52;
              TotalDays=0.95547185575463; TotalHours=22.9313245381111; TotalMilliseconds=82552768.3372;
              TotalMinutes=1375.87947228667; TotalSeconds=82552.7683372}
Year        : 2018

この例では、 ConvertTo-Json コマンドレットと ConvertFrom-Json コマンドレットを使用して、オブジェクトを JSON 文字列と JSON オブジェクトに変換する方法を示します。

パラメーター

-AsArray

-Compress

-Depth

-EnumsAsStrings

-EscapeHandling

-InputObject

入力

Object

任意のオブジェクトをこのコマンドレットにパイプできます。

出力

String

このコマンドレットは、JSON 文字列に変換された入力オブジェクトを表す文字列を返します。

メモ

ConvertTo-Json コマンドレットは、Newtonsoft Json.NETを使用して実装されます。

関連リンク

• JavaScript と .NET での JavaScript Object Notation (JSON) の概要
• ConvertFrom-Json
• Get-Content
• Get-UICulture
• Invoke-WebRequest
• Invoke-RestMethod
• NewtonSoft.Json.StringEscapeHandling