ConvertTo-Json

ConvertTo-Json
    [-InputObject] <Object>
    [-Depth <Int32>]
    [-Compress]
    [<CommonParameters>]

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

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

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

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

(Get-UICulture).Calendar | ConvertTo-Json

{
    "MinSupportedDateTime":  "\/Date(-62135596800000)\/",
    "MaxSupportedDateTime":  "\/Date(253402300799999)\/",
    "AlgorithmType":  1,
    "CalendarType":  1,
    "Eras":  [
                 1
             ],
    "TwoDigitYearMax":  2029,
    "IsReadOnly":  false
}

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

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

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

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

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

{
    "DisplayHint":  2,
    "DateTime":  "Friday, January 13, 2012 8:06:16 PM",
    "Date":  "\/Date(1326441600000)\/",
    "Day":  13,
    "DayOfWeek":  5,
    "DayOfYear":  13,
    "Hour":  20,
    "Kind":  2,
    "Millisecond":  221,
    "Minute":  6,
    "Month":  1,
    "Second":  16,
    "Ticks":  634620819762218083,
    "TimeOfDay":  {
                      "Ticks":  723762218083,
                      "Days":  0,
                      "Hours":  20,
                      "Milliseconds":  221,
                      "Minutes":  6,
                      "Seconds":  16,
                      "TotalDays":  0.83768775241087956,
                      "TotalHours":  20.104506057861109,
                      "TotalMilliseconds":  72376221.8083,
                      "TotalMinutes":  1206.2703634716668,
                      "TotalSeconds":  72376.22180829999
                  },
    "Year":  2012
}

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

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 オブジェクトに変換する方法を示します。

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。

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

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

ConvertTo-Json コマンドレットは、JavaScriptSerializer クラスを使用して実装されます。