次の方法で共有

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) 形式の文字列に変換します。 プロパティはフィールド名に変換され、フィールド値はプロパティ値に変換され、メソッドは削除されます。

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

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

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

{
  "value": "2018-10-12T23:07:18.8450248-05:00",
  "DisplayHint": 2,
  "DateTime": "October 12, 2018 11:07:18 PM"
}
[
  {
    "value": "2018-10-12T23:07:18.8480668-05:00",
    "DisplayHint": 2,
    "DateTime": "October 12, 2018 11:07:18 PM"
  }
]

この例では、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

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

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

-Compress

出力文字列の空白とインデントされた書式を省略します。

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

-Depth

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

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

-EnumsAsStrings

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

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

-EscapeHandling

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

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

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

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

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

-InputObject

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

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

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

入力

Object

任意のオブジェクトをパイプ処理して ConvertTo-Jsonできます。

出力

String

メモ

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