ConvertFrom-Json
Konvertiert eine JSON-formatierte Zeichenfolge in ein benutzerdefiniertes Objekt oder eine Hashtabelle.
Syntax
ConvertFrom-Json
[-InputObject] <String>
[-AsHashtable]
[-Depth <Int32>]
[-NoEnumerate]
[<CommonParameters>]
Beschreibung
Das ConvertFrom-Json
Cmdlet konvertiert eine json-formatierte Zeichenfolge (JavaScript Object Notation) in ein benutzerdefiniertes PSObject - oder Hashtable-Objekt , das über eine Eigenschaft für jedes Feld in der JSON-Zeichenfolge verfügt.
JSON wird häufig von Websites verwendet, um eine Textdarstellung der Objekte bereitzustellen. Das Cmdlet fügt dem neuen Objekt die Eigenschaften hinzu, während jede Zeile der JSON-Zeichenfolge verarbeitet wird.
Der JSON-Standard ermöglicht doppelte Schlüsselnamen, die in PSObject - und Hashtable-Typen verboten sind. Wenn beispielsweise die JSON-Zeichenfolge doppelte Schlüssel enthält, wird nur der letzte Schlüssel von diesem Cmdlet verwendet. Weitere Beispiele finden Sie unten.
Verwenden Sie das ConvertTo-Json
Cmdlet, um eine JSON-Zeichenfolge aus einem beliebigen Objekt zu generieren.
Dieses Cmdlet wurde in PowerShell 3.0 eingeführt.
Hinweis
Ab PowerShell 6 unterstützt das Cmdlet JSON mit Kommentaren. JSON-Kommentare beginnen mit zwei Schrägstrichen (//
) Zeichen. JSON-Kommentare werden nicht in der Vom Cmdlet ausgegebenen Objekte erfasst. Vor PowerShell 6 würde ein Fehler zurückgegeben, ConvertFrom-Json
wenn ein JSON-Kommentar aufgetreten ist.
Beispiele
Beispiel 1: Konvertieren eines DateTime-Objekts in ein JSON-Objekt
Dieser Befehl verwendet und ConvertTo-Json
ConvertFrom-Json
cmdlets, um ein DateTime-Objekt aus dem Get-Date
Cmdlet in ein JSON-Objekt zu konvertieren und dann in ein PSCustomObject.
Get-Date | Select-Object -Property * | ConvertTo-Json | ConvertFrom-Json
DisplayHint : 2
DateTime : Friday, January 13, 2012 8:06:31 PM
Date : 1/13/2012 8:00:00 AM
Day : 13
DayOfWeek : 5
DayOfYear : 13
Hour : 20
Kind : 2
Millisecond : 400
Minute : 6
Month : 1
Second : 31
Ticks : 634620819914009002
TimeOfDay : @{Ticks=723914009002; Days=0; Hours=20; Milliseconds=400; Minutes=6; Seconds=31; TotalDays=0.83786343634490734; TotalHours=20.108722472277776; TotalMilliseconds=72391400.900200009; TotalMinutes=1206.5233483366667;TotalSeconds=72391.4009002}
Year : 2012
Im Beispiel wird das Select-Object
Cmdlet verwendet, um alle Eigenschaften des DateTime-Objekts abzurufen. Es verwendet das ConvertTo-Json
Cmdlet, um das DateTime-Objekt in eine Zeichenfolge zu konvertieren, die als JSON-Objekt formatiert ist, und das ConvertFrom-Json
Cmdlet, um die JSON-formatierte Zeichenfolge in ein PSCustomObject-Objekt zu konvertieren.
Beispiel 2: Abrufen von JSON-Zeichenfolgen aus einem Webdienst und Konvertieren in PowerShell-Objekte
Dieser Befehl verwendet das Invoke-WebRequest
Cmdlet, um JSON-Zeichenfolgen aus einem Webdienst abzurufen, und anschließend wird das ConvertFrom-Json
Cmdlet zum Konvertieren von JSON-Inhalten in Objekte verwendet, die in PowerShell verwaltet werden können.
# Ensures that Invoke-WebRequest uses TLS 1.2
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
$j = Invoke-WebRequest 'https://api.github.com/repos/PowerShell/PowerShell/issues' | ConvertFrom-Json
Sie können auch das Invoke-RestMethod
Cmdlet verwenden, das JSON-Inhalte automatisch in Objekte konvertiert.
Beispiel 3: Konvertieren einer JSON-Zeichenfolge in ein benutzerdefiniertes Objekt
In diesem Beispiel wird gezeigt, wie Sie mithilfe des ConvertFrom-Json
Cmdlets eine JSON-Datei in ein benutzerdefiniertes PowerShell-Objekt konvertieren.
Get-Content -Raw JsonFile.JSON | ConvertFrom-Json
Der Befehl verwendet das Cmdlet "Get-Content", um die Zeichenfolgen in einer JSON-Datei abzurufen. Der Raw-Parameter gibt die gesamte Datei als einzelnes JSON-Objekt zurück. Anschließend wird der Pipelineoperator verwendet, um die durch Trennzeichen getrennte Zeichenfolge an das ConvertFrom-Json
Cmdlet zu senden, wodurch sie in ein benutzerdefiniertes Objekt konvertiert wird.
Beispiel 4: Konvertieren einer JSON-Zeichenfolge in eine Hashtabelle
Dieser Befehl zeigt ein Beispiel, in dem der -AsHashtable
Schalter Einschränkungen des Befehls überwinden kann.
'{ "key":"value1", "Key":"value2" }' | ConvertFrom-Json -AsHashtable
Die JSON-Zeichenfolge enthält zwei Schlüsselwertpaare mit Schlüsseln, die sich nur bei der Groß-/Kleinschreibung unterscheiden. Ohne den Schalter hätte der Befehl einen Fehler ausgelöst.
Beispiel 5: Roundtrip für ein einzelnes Elementarray
Dieser Befehl zeigt ein Beispiel, in dem der -NoEnumerate
Switch verwendet wird, um ein einzelnes ELEMENT-JSON-Array zu roundtripen.
Write-Output "With -NoEnumerate: $('[1]' | ConvertFrom-Json -NoEnumerate | ConvertTo-Json -Compress)"
Write-Output "Without -NoEnumerate: $('[1]' | ConvertFrom-Json | ConvertTo-Json -Compress)"
With -NoEnumerate: [1]
Without -NoEnumerate: 1
Die JSON-Zeichenfolge enthält ein Array mit einem einzelnen Element. Ohne den Schalter wird der JSON-Code in ein PSObject konvertiert und dann mit dem ConvertTo-Json
Befehl wieder in eine einzelne ganze Zahl konvertiert.
Parameter
-AsHashtable
Konvertiert den JSON-Code in ein Hashtabellenobjekt. Dieser Switch wurde in PowerShell 6.0 eingeführt. Ab PowerShell 7.3 ist das Objekt eine OrderedHashtable und behält die Reihenfolge der Schlüssel aus dem JSON-Code bei. In früheren Versionen ist das Objekt eine Hashtable.
Es gibt mehrere Szenarien, in denen sie einige Einschränkungen des ConvertFrom-Json
Cmdlets überwinden kann.
- Ohne diesen Schalter werden zwei oder mehr Schlüssel in einem JSON-Objekt ohne Berücksichtigung der Groß-/Kleinschreibung identisch behandelt, sie werden als identische Schlüssel behandelt. In diesem Fall ist nur der letzte dieser Nicht-Groß-/Kleinschreibung identische Schlüssel im konvertierten Objekt enthalten.
- Ohne diesen Schalter löst das Cmdlet einen Fehler aus, wenn der JSON-Code einen Schlüssel enthält, der eine leere Zeichenfolge ist. PSCustomObject kann keine Eigenschaftsnamen haben, die leere Zeichenfolgen sind. Dies kann z. B. in
project.lock.json
Dateien auftreten. - Hashtabellen können für bestimmte Datenstrukturen schneller verarbeitet werden.
Typ: | SwitchParameter |
Position: | Named |
Standardwert: | False |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | False |
Platzhalterzeichen akzeptieren: | False |
-Depth
Ruft die maximale Tiefe ab, über die die JSON-Eingabe verfügen darf, oder legt sie fest. Der Standardwert ist 1024.
Dieser Parameter wurde in PowerShell 6.2 eingeführt.
Typ: | Int32 |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | False |
Platzhalterzeichen akzeptieren: | False |
-InputObject
Gibt die JSON-Zeichenfolgen an, die in JSON-Objekte konvertiert werden sollen. Geben Sie eine Variable ein, die die Zeichenfolge enthält, oder geben Sie einen Befehl oder Ausdruck ein, der die Zeichenfolge abruft. Sie können auch eine Zeichenfolge an ConvertFrom-Json
.
Der InputObject-Parameter ist erforderlich, der Wert kann jedoch eine leere Zeichenfolge sein. Wenn das Eingabeobjekt eine leere Zeichenfolge ist, ConvertFrom-Json
wird keine Ausgabe generiert. Der InputObject-Wert kann nicht sein $null
.
Typ: | String |
Position: | 0 |
Standardwert: | None |
Erforderlich: | True |
Pipelineeingabe akzeptieren: | True |
Platzhalterzeichen akzeptieren: | False |
-NoEnumerate
Gibt an, dass die Ausgabe nicht aufgezählt wird.
Wenn Sie diesen Parameter festlegen, werden Arrays als einzelnes Objekt gesendet, anstatt jedes Element separat zu senden. Dadurch wird sichergestellt, dass JSON per ConvertTo-Json
Roundtripped erfolgen kann.
Typ: | SwitchParameter |
Position: | Named |
Standardwert: | False |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | False |
Platzhalterzeichen akzeptieren: | False |
Eingaben
Sie können eine JSON-Zeichenfolge an ConvertFrom-Json
.
Ausgaben
PSCustomObject
Hinweise
Dieses Cmdlet wird mithilfe von Newtonsoft Json.NET implementiert.
Ab PowerShell 6 versucht, Zeichenfolgen, die als Zeitstempel formatiert sind, ConvertTo-Json
in DateTime-Werte zu konvertieren. Der konvertierte Wert ist eine [datetime]
Instanz mit einem Kind
Eigenschaftensatz wie folgt:
Unspecified
, wenn in der Eingabezeichenfolge keine Zeitzoneninformationen vorhanden sind.Utc
, wenn es sich bei den ZeitzoneninformationenZ
um eine nachfolgende Zeitzone handelt.Local
, wenn die Zeitzoneninformationen als nachgestellter UTC-Offset angegeben werden, z+02:00
. B. . Der Offset wird ordnungsgemäß in die konfigurierte Zeitzone des Anrufers konvertiert. Die Standardmäßige Ausgabeformatierung gibt nicht den ursprünglichen Zeitzonenoffset an.
Der PSObject-Typ behält die Reihenfolge der Eigenschaften bei, wie in der JSON-Zeichenfolge dargestellt. Ab PowerShell 7.3 erstellt der AsHashtable-Parameter eine OrderedHashtable. Die Schlüssel-Wert-Paare werden in der Reihenfolge hinzugefügt, die in der JSON-Zeichenfolge dargestellt wird. Die OrderedHashtable behält diese Reihenfolge bei.