ConvertToJsonCommand Class

Definition

Namespace:

Microsoft.PowerShell.Commands

Assembly:

Microsoft.PowerShell.Commands.Utility.dll

Package:

Microsoft.PowerShell.Commands.Utility v7.4.0

The ConvertTo-Json command. This command converts an object to a Json string representation.

public ref class ConvertToJsonCommand : System::Management::Automation::PSCmdlet

[System.Management.Automation.Cmdlet("ConvertTo", "Json", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096925", RemotingCapability=System.Management.Automation.RemotingCapability.None)]
[System.Management.Automation.OutputType(typeof(System.String))]
public class ConvertToJsonCommand : System.Management.Automation.PSCmdlet, IDisposable

[<System.Management.Automation.Cmdlet("ConvertTo", "Json", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096925", RemotingCapability=System.Management.Automation.RemotingCapability.None)>]
[<System.Management.Automation.OutputType(typeof(System.String))>]
type ConvertToJsonCommand = class
    inherit PSCmdlet
    interface IDisposable

Public Class ConvertToJsonCommand
Inherits PSCmdlet
Implements IDisposable

Inheritance

Object

InternalCommand

Cmdlet

PSCmdlet

ConvertToJsonCommand

Attributes

CmdletAttribute OutputTypeAttribute

Implements

IDisposable

Constructors

ConvertToJsonCommand()

Properties

AsArray	Gets or sets the AsArray property. If the AsArray property is set to be true, the result JSON string will be returned with surrounding '[', ']' chars. Otherwise, the array symbols will occur only if there is more than one input object.
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)
Compress	Gets or sets the Compress property. If the Compress property is set to be true, the Json string will be output in the compressed way. Otherwise, the Json string will be output with indentations.
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 Depth property.
EnumsAsStrings	Gets or sets the EnumsAsStrings property. If the EnumsAsStrings property is set to true, enum values will be converted to their string equivalent. Otherwise, enum values will be converted to their numeric equivalent.
EscapeHandling	Specifies how strings are escaped when writing JSON text. If the EscapeHandling property is set to EscapeHtml, the result JSON string will be returned with HTML (<, >, &, ', ") and control characters (e.g. newline) are escaped.
Events	Gets the event manager for the current runspace. (Inherited from PSCmdlet)
Host	Gets the host interaction APIs. (Inherited from PSCmdlet)
InputObject	Gets or sets the InputObject property.
InvokeCommand	Provides access to utility routines for executing scripts and creating script blocks. (Inherited from PSCmdlet)
InvokeProvider	Gets the instance of the provider interface APIs for the current runspace. (Inherited from PSCmdlet)
JobManager	Manager for JobSourceAdapters registered. (Inherited from PSCmdlet)
JobRepository	Repository for jobs. (Inherited from PSCmdlet)
MyInvocation	Contains information about the identity of this cmdlet and how it was invoked. (Inherited from PSCmdlet)
PagingParameters	If the cmdlet declares paging support (via SupportsPaging), then PagingParameters property contains arguments of the paging parameters. Otherwise PagingParameters property is null. (Inherited from PSCmdlet)
ParameterSetName	The name of the parameter set in effect. (Inherited from PSCmdlet)
SessionState	Gets the instance of session state for the current runspace. (Inherited from PSCmdlet)
Stopping	Is this command stopping? (Inherited from Cmdlet)

Methods

BeginProcessing()	When overridden in the derived class, performs initialization of command execution. Default implementation in the base class just returns. (Inherited from Cmdlet)
CurrentProviderLocation(String)	(Inherited from PSCmdlet)
Dispose()	IDisposable implementation, dispose of any disposable resources created by the cmdlet.
Dispose(Boolean)	Implementation of IDisposable for both manual Dispose() and finalizer-called disposal of resources.
EndProcessing()	Do the conversion to json and write output.
GetResolvedProviderPathFromPSPath(String, ProviderInfo)	(Inherited from PSCmdlet)
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)
GetUnresolvedProviderPathFromPSPath(String)	(Inherited from PSCmdlet)
GetVariableValue(String)	(Inherited from PSCmdlet)
GetVariableValue(String, Object)	(Inherited from PSCmdlet)
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()	Caching the input objects for the command.
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)
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, 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)
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)
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, 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, 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)
StopProcessing()	Process the Ctrl+C signal.
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)	Writes the object to the output pipe. (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)
WriteProgress(ProgressRecord)	Display progress information. (Inherited from Cmdlet)
WriteVerbose(String)	Display verbose information. (Inherited from Cmdlet)
WriteWarning(String)	Display warning information. (Inherited from Cmdlet)