ConvertToSecureStringCommand Class

Definition

Namespace:

Microsoft.PowerShell.Commands

Assembly:

Microsoft.PowerShell.Security.dll

Package:

Microsoft.PowerShell.Security v7.4.0

Defines the implementation of the 'ConvertTo-SecureString' cmdlet. This cmdlet imports a new SecureString from encrypted data -- one that represents text that should be kept confidential. The text is encrypted for privacy when being used, and deleted from computer memory when no longer needed. When no key is specified, the command uses the DPAPI to decrypt the data. When a key is specified, the command uses the AES algorithm to decrypt the data.

public ref class ConvertToSecureStringCommand sealed : Microsoft::PowerShell::Commands::ConvertFromToSecureStringCommandBase

[System.Management.Automation.Cmdlet("ConvertTo", "SecureString", DefaultParameterSetName="Secure", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096916")]
[System.Management.Automation.OutputType(typeof(System.Security.SecureString))]
public sealed class ConvertToSecureStringCommand : Microsoft.PowerShell.Commands.ConvertFromToSecureStringCommandBase

[<System.Management.Automation.Cmdlet("ConvertTo", "SecureString", DefaultParameterSetName="Secure", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096916")>]
[<System.Management.Automation.OutputType(typeof(System.Security.SecureString))>]
type ConvertToSecureStringCommand = class
    inherit ConvertFromToSecureStringCommandBase

Public NotInheritable Class ConvertToSecureStringCommand
Inherits ConvertFromToSecureStringCommandBase

Inheritance

Object

InternalCommand

Cmdlet

PSCmdlet

SecureStringCommandBase

ConvertFromToSecureStringCommandBase

ConvertToSecureStringCommand

Attributes

CmdletAttribute OutputTypeAttribute

Constructors

ConvertToSecureStringCommand()

Initializes a new instance of the ImportSecureStringCommand class.

Properties

AsPlainText	Gets or sets the flag that marks the unsecured string as a plain text string.
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)
Events	Gets the event manager for the current runspace. (Inherited from PSCmdlet)
Force	Gets or sets the flag that will force the import of a plaintext unsecured string.
Host	Gets the host interaction APIs. (Inherited from PSCmdlet)
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)
Key	Gets or sets the byte version of the encryption key used by the SecureString cmdlets. (Inherited from ConvertFromToSecureStringCommandBase)
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)
SecureKey	Gets or sets the SecureString version of the encryption key used by the SecureString cmdlets. (Inherited from ConvertFromToSecureStringCommandBase)
SecureStringData	Gets or sets the secure string to be used by the get- and set- commands. (Inherited from SecureStringCommandBase)
SessionState	Gets the instance of session state for the current runspace. (Inherited from PSCmdlet)
Stopping	Is this command stopping? (Inherited from Cmdlet)
String	Gets or sets the unsecured string to be imported.

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)
EndProcessing()	When overridden in the derived class, performs clean-up after the command execution. Default implementation in the base class just returns. (Inherited from Cmdlet)
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, Object)	(Inherited from PSCmdlet)
GetVariableValue(String)	(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()	When overridden in the derived class, performs execution of the command. (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)
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)