ConvertFromJsonCommand Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The ConvertFrom-Json command. This command converts a Json string representation to a JsonObject.
public ref class ConvertFromJsonCommand : System::Management::Automation::Cmdletpublic class ConvertFromJsonCommand : System.Management.Automation.Cmdlet[System.Management.Automation.Cmdlet("ConvertFrom", "Json", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096606", RemotingCapability=System.Management.Automation.RemotingCapability.None)]
public class ConvertFromJsonCommand : System.Management.Automation.Cmdlet[System.Management.Automation.Cmdlet("ConvertFrom", "Json", HelpUri="https://go.microsoft.com/fwlink/?LinkID=217031", RemotingCapability=System.Management.Automation.RemotingCapability.None)]
public class ConvertFromJsonCommand : System.Management.Automation.Cmdlettype ConvertFromJsonCommand = class
inherit Cmdlet[<System.Management.Automation.Cmdlet("ConvertFrom", "Json", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096606", RemotingCapability=System.Management.Automation.RemotingCapability.None)>]
type ConvertFromJsonCommand = class
inherit Cmdlet[<System.Management.Automation.Cmdlet("ConvertFrom", "Json", HelpUri="https://go.microsoft.com/fwlink/?LinkID=217031", RemotingCapability=System.Management.Automation.RemotingCapability.None)>]
type ConvertFromJsonCommand = class
inherit CmdletPublic Class ConvertFromJsonCommand
Inherits Cmdlet- Inheritance
- Attributes
Constructors
| ConvertFromJsonCommand() |
Properties
| AsHashtable |
Returned data structure is a Hashtable instead a CustomPSObject. |
| CommandOrigin |
This property tells you if you were being invoked inside the runspace or if it was an external request. (Inherited from InternalCommand) |
| CommandRuntime |
Holds the command runtime object for this command. This object controls what actually happens when a write is called. (Inherited from Cmdlet) |
| CurrentPSTransaction |
Gets an object that surfaces the current PowerShell transaction. When this object is disposed, PowerShell resets the active transaction. (Inherited from Cmdlet) |
| Depth |
Gets or sets the maximum depth the JSON input is allowed to have. By default, it is 1024. |
| InputObject |
Gets or sets the InputString property. |
| NoEnumerate |
Gets or sets the switch to prevent ConvertFrom-Json from unravelling collections during deserialization, instead passing them as a single object through the pipeline. |
| Stopping |
Is this command stopping? (Inherited from Cmdlet) |
Methods
| BeginProcessing() |
Prerequisite checks |
| BeginProcessing() |
When overridden in the derived class, performs initialization of command execution. Default implementation in the base class just returns. (Inherited from Cmdlet) |
| EndProcessing() |
The main execution method for the ConvertFrom-Json command. |
| GetResourceString(String, String) |
Gets the resource string corresponding to baseName and resourceId from the current assembly. You should override this if you require a different behavior. (Inherited from Cmdlet) |
| Invoke() |
Invoke this cmdlet object returning a collection of results. (Inherited from Cmdlet) |
| Invoke<T>() |
Returns a strongly-typed enumerator for the results of this cmdlet. (Inherited from Cmdlet) |
| ProcessRecord() |
Buffers InputObjet contents available in the pipeline. |
| ShouldContinue(String, String, Boolean, Boolean, Boolean) |
Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll. (Inherited from Cmdlet) |
| ShouldContinue(String, String, Boolean, Boolean) |
Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll. (Inherited from Cmdlet) |
| ShouldContinue(String, String) |
Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant only offers Yes/No, not YesToAll/NoToAll. (Inherited from Cmdlet) |
| ShouldProcess(String, String, String, ShouldProcessReason) |
Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify the complete text describing the operation, rather than just the name and action. (Inherited from Cmdlet) |
| ShouldProcess(String, String, String) |
Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify the complete text describing the operation, rather than just the name and action. (Inherited from Cmdlet) |
| ShouldProcess(String, String) |
Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. This variant allows the caller to specify text for both the target resource and the action. (Inherited from Cmdlet) |
| ShouldProcess(String) |
Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed. (Inherited from Cmdlet) |
| StopProcessing() |
When overridden in the derived class, interrupts currently running code within the command. It should interrupt BeginProcessing, ProcessRecord, and EndProcessing. Default implementation in the base class just returns. (Inherited from Cmdlet) |
| ThrowTerminatingError(ErrorRecord) |
Terminate the command and report an error. (Inherited from Cmdlet) |
| TransactionAvailable() |
Returns true if a transaction is available and active. (Inherited from Cmdlet) |
| WriteCommandDetail(String) |
Write text into pipeline execution log. (Inherited from Cmdlet) |
| WriteDebug(String) |
Display debug information. (Inherited from Cmdlet) |
| WriteError(ErrorRecord) |
Internal variant: Writes the specified error to the error pipe. (Inherited from Cmdlet) |
| WriteInformation(InformationRecord) |
Route information to the user or host. (Inherited from Cmdlet) |
| WriteInformation(Object, String[]) |
Route information to the user or host. (Inherited from Cmdlet) |
| WriteObject(Object, Boolean) |
Writes one or more objects to the output pipe. If the object is a collection and the enumerateCollection flag is true, the objects in the collection will be written individually. (Inherited from Cmdlet) |
| WriteObject(Object) |
Writes the object to the output pipe. (Inherited from Cmdlet) |
| WriteProgress(ProgressRecord) |
Display progress information. (Inherited from Cmdlet) |
| WriteVerbose(String) |
Display verbose information. (Inherited from Cmdlet) |
| WriteWarning(String) |
Display warning information. (Inherited from Cmdlet) |