ConvertTo-Json

  • リファレンス
モジュール:
Microsoft.PowerShell.Utility

オブジェクトを JSON 形式の文字列に変換します。

構文

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

説明

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

Note

PowerShell 7.2 以降、DateTime オブジェクトと String オブジェクトの拡張型システム プロパティはシリアル化されなくなり、単純なオブジェクトのみが 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 スイッチ パラメーターの有無に関係なく、コマンドレットからのConvertTo-Json出力を示します。 出力の 2 番目の部分が配列角かっこで囲まれていることがわかります。

例 3

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

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

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

例 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

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

パラメーター

-AsArray

入力が 1 つのオブジェクトであっても、オブジェクトを配列角かっこで囲んで出力します。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Compress

出力文字列内の空白文字とインデントが設定された書式設定は省略されます。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Depth

JSON 表現に含める子オブジェクトのレベルを指定します。 値には、次の値を0100指定できます。 既定値は 2 です。 ConvertTo-Json は、入力オブジェクト内のレベルの数がこの数を超えた場合に警告を出力します。

Type:Int32
Position:Named
Default value:2
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EnumsAsStrings

すべての列挙体を文字列形式に変換する代替シリアル化オプションを提供します。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EscapeHandling

結果の JSON 出力で特定の文字をエスケープする方法を制御します。 既定では、制御文字 (改行など) のみがエスケープされます。

使用可能な値は次のとおりです。

  • 既定値 - 制御文字のみがエスケープされます。
  • EscapeNonAscii - ASCII 以外のすべての文字と制御文字がエスケープされます。
  • EscapeHtml - HTML (<, , >, &, "') および制御文字はエスケープされます。

このパラメーターは、PowerShell 6.2 で導入されました。

Type:Newtonsoft.Json.StringEscapeHandling
Position:Named
Default value:Default
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

JSON 形式に変換するオブジェクトを指定します。 オブジェクトが格納されている変数を入力するか、オブジェクトを取得するコマンドまたは式を入力します。 オブジェクト ConvertTo-Jsonをパイプでパイプすることもできます。

InputObject パラメーターは必須ですが、その値は null ($null) または空の文字列にすることができます。 入力オブジェクトが次ConvertTo-Jsonの場合、$null.の JSON 表現nullが返されます。 入力オブジェクトが空の文字列の場合は、 ConvertTo-Json 空の文字列の JSON 表現を返します。

Type:Object
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

入力

Object

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

出力

String

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

メモ

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