次の方法で共有

ConvertTo-Json

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

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

構文

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

説明

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

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

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

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

例

例 1

(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 形式の文字列に変換します。

例 2

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

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

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

例 3

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 コマンドレットを使用して、DateTime オブジェクトのすべてのプロパティ (*) を取得します。 出力には、返された JSON 文字列 ConvertTo-Json 示されます。

例 4

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

パラメーター

-Compress

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

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Depth

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

型:Int32
配置:Named
規定値:2
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-InputObject

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

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

型:Object
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

入力

Object

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

出力

String

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

メモ

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