System.Management.Automation Namespace
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.
Classes
ActionPreferenceStopException |
ActionPreferenceStopException indicates that the command stopped due to the ActionPreference.Stop or Inquire policy. |
AliasAttribute |
Declares an alternative name for a parameter, cmdlet, or function. |
AliasInfo |
Provides information about a mapping between a command name and a real command. |
AllowEmptyCollectionAttribute |
Allows an empty collection as the argument to a mandatory collection parameter. |
AllowEmptyStringAttribute |
Allows an empty string as the argument to a mandatory string parameter. |
AllowNullAttribute |
Allows a NULL as the argument to a mandatory parameter. |
ApplicationFailedException |
Defines the exception that is thrown if a native command fails. |
ApplicationInfo |
Provides information for applications that are not directly executable by PowerShell. |
ArgumentCompleterAttribute |
This attribute is used to specify an argument completer for a parameter to a cmdlet or function.
|
ArgumentCompleterFactoryAttribute |
Base class for parameterized argument completer attributes. |
ArgumentCompletionsAttribute |
This attribute is used to specify an argument completions for a parameter of a cmdlet or function based on string array. [Parameter()] [ArgumentCompletions("Option1","Option2","Option3")] public string Noun { get; set; } |
ArgumentTransformationAttribute |
Serves as the base class for attributes that perform argument transformation. |
ArgumentTransformationMetadataException |
Defines the exception thrown for all ArgumentTransformation attributes. |
AuthorizationManager |
Defines the base class for an authorization manager of a Runspace. An authorization manager helps a host control and restrict the execution of commands. For each of the command types listed in the CommandTypes enumeration, the engine requests permission from the AuthorizationManager to run the command. Extending this class requires that you override the ShouldRun method with the logic specific to your needs. The base class gives permission to run every command. The default Microsoft.PowerShell.PSAuthorizationManager provides a customized and much more complete authorization policy. |
BackgroundDispatcher |
A simple implementation of IBackgroundDispatcher. |
BreakException |
Flow control BreakException. |
Breakpoint |
Holds the information for a given breakpoint. |
BreakpointUpdatedEventArgs |
Arguments for the BreakpointUpdated event. |
CachedValidValuesGeneratorBase |
Optional base class for IValidateSetValuesGenerator implementations that want a default implementation to cache valid values. |
CallStackFrame |
A call stack item returned by the Get-PSCallStack cmdlet. |
CatalogInformation |
Object returned by Catalog Cmdlets |
ChildItemCmdletProviderIntrinsics |
Exposes the Children noun of the Cmdlet Providers to the Cmdlet base class. The methods of this class use the providers to perform operations. |
Cmdlet |
Defines members and overrides used by Cmdlets. All Cmdlets must derive from Cmdlet. |
CmdletAttribute |
Identifies a class as a cmdlet and specifies the verb and noun identifying this cmdlet. |
CmdletBindingAttribute |
Identifies PowerShell script code as behaving like a cmdlet and hence uses cmdlet parameter binding instead of script parameter binding. |
CmdletCommonMetadataAttribute |
Contains information about a cmdlet's metadata. |
CmdletInfo |
The command information for cmdlets that are directly executable by PowerShell. |
CmdletInvocationException |
Indicates that a cmdlet hit a terminating error. |
CmdletProviderInvocationException |
Indicates that a cmdlet hit a terminating error of type ProviderInvocationException. This is generally reported from the standard provider navigation cmdlets such as get-childitem. |
CmdletProviderManagementIntrinsics |
Exposes the APIs to manage the Cmdlet Providers the Cmdlet base class. The methods of this class get and set provider data in session state. |
CmsMessageRecipient |
Represents a message recipient for the Cms cmdlets. |
CommandBreakpoint |
A breakpoint on a command. |
CommandCompletion |
Provides a set of possible completions for given input. |
CommandInfo |
The base class for the information about commands. Contains the basic information about the command, like name and type. |
CommandInvocationIntrinsics |
Interfaces that cmdlets can use to build script blocks and execute scripts. |
CommandLookupEventArgs |
EventArgs for the ScriptCmdletVariableUpdate event. |
CommandMetadata |
This class represents the compiled metadata for a command type. |
CommandNotFoundException |
This exception is thrown when a command cannot be found. |
CommandParameterInfo |
Provides information about a cmdlet parameter for a particular parameter set. |
CommandParameterSetInfo |
The information about a parameter set and its parameters for a cmdlet. |
CompletionCompleters | |
CompletionResult |
Class used to store a tab completion or Intellisense result. |
ConfigurationInfo |
Provides information about a configuration that is stored in session state. |
ContainerParentJob |
Top level container job. |
ContentCmdletProviderIntrinsics |
Exposes the Content nouns to the Cmdlet Providers to the Cmdlet base class. The methods of this class use the providers to perform operations. |
ContinueException |
Flow control ContinueException. |
ConvertThroughString |
Enables a type that only has conversion from string to be converted from all other types through string. |
CredentialAttribute |
Defines the attribute used to designate a cmdlet parameter as one that should accept credentials. |
CustomControl | |
CustomControlBuilder | |
CustomControlEntry | |
CustomEntryBuilder | |
CustomItemBase | |
CustomItemExpression | |
CustomItemFrame | |
CustomItemNewline | |
CustomItemText | |
CustomPSSnapIn |
Raw mshsnapin is a class for allowing mshsnapin developers to directly specify the set of cmdlets, providers, types, formats, assemblies available in the mshsnapin. To use this class, mshsnapin developers will drive from it and fill in details about cmdlet, provider, type, format, assemblies. This class will also facilitate the registration of the mshsnapin through installutil.exe. This class will be built with monad core engine dll. |
DataAddedEventArgs |
Event arguments passed to PSDataCollection DataAdded handlers. |
DataAddingEventArgs |
Event arguments passed to PSDataCollection DataAdding handlers. |
Debugger |
Base class for all PowerShell debuggers. |
DebuggerCommandResults |
Command results returned from Debugger.ProcessCommand. |
DebuggerStopEventArgs |
Arguments for the DebuggerStop event. |
DebugRecord |
A debug record in the PSInformationalBuffers. |
DebugSource |
Contains debugger script and script file information. |
DefaultParameterDictionary |
A versionable hashtable, so the caching of UserInput -> ParameterBindingResult will work. |
DisplayEntry |
One entry in a format display unit, script block or property name. |
DriveManagementIntrinsics |
Exposes the Cmdlet Family Provider's drives to the Cmdlet base class. The methods of this class get and set provider data in session state. |
DriveNotFoundException |
DriveNotFoundException occurs when no drive can be found with the specified name. |
DscLocalConfigurationManagerAttribute |
Indication the configuration is for local configuration manager, also known as meta configuration. |
DscPropertyAttribute |
When specified on a property or field of a DSC Resource, the property can or must be specified in a configuration, unless it is marked NotConfigurable, in which case it is returned by the Get() method of the resource. |
DscResourceAttribute |
Indicates the class defines a DSC resource. |
DscResourceInfo |
Contains a DSC resource information. |
DscResourcePropertyInfo |
Contains a DSC resource property information. |
DynamicClassImplementationAssemblyAttribute |
This attribute is used on a dynamic assembly to mark it as one that is used to implement a set of classes defined in a PowerShell script. |
EngineIntrinsics |
Exposes the Engine APIs for a particular instance of the engine. |
EntrySelectedBy |
Each control (table, list, wide, or custom) may have multiple entries. If there are multiple entries, there must be a default entry with no condition, all other entries must have EntrySelectedBy specified. This is useful when you need a single view for grouping or otherwise just selecting the shape of formatting, but need distinct formatting rules for each instance. For example, when listing files, you may want to group based on the parent path, but select different entries depending on if the item is a file or directory. |
ErrorCategoryInfo |
Contains auxiliary information about an ErrorRecord |
ErrorDetails |
Additional details about an ErrorRecord |
ErrorRecord |
Represents an error. |
ExitException |
Implements the exit keyword. |
ExperimentalAttribute |
The attribute that applies to cmdlet/function/parameter to define what the engine should do with it. |
ExperimentalFeature |
Support experimental features in PowerShell. |
ExtendedTypeDefinition |
Specifies additional type definitions for an object. |
ExtendedTypeSystemException |
Defines the exception thrown for all Extended type system related errors. |
ExternalScriptInfo |
Provides information for scripts that are directly executable by PowerShell but are not built into the runspace configuration. |
FilterInfo |
Provides information about a filter that is stored in session state. |
FlagsExpression<T> |
Takes as input a collection of strings and builds an expression tree from the input. At the evaluation stage, it walks down the tree and evaluates the result. |
FlowControlException |
FlowControlException, base class for flow control exceptions. |
FormatViewDefinition |
Defines a formatting view for a particular type. |
ForwardedEventArgs |
Event argument associated with the event fired in a remote runspace and forwarded to the current runspace. |
FunctionInfo |
Provides information about a function that is stored in session state. |
GettingValueExceptionEventArgs |
Serves as the arguments for events triggered by exceptions in the GetValue method of PSObjectPropertyDescriptor |
GetValueException |
Defines the exception thrown for errors getting the value of properties. |
GetValueInvocationException |
Defines the exception thrown for exceptions thrown by property getters. |
HaltCommandException |
A cmdlet/provider should throw HaltCommandException when it wants to terminate the running command without this being considered an error. |
HiddenAttribute |
Specify that the member is hidden for the purposes of cmdlets like Get-Member and that the member is not displayed by default by Format-* cmdlets. |
HostInformationMessage |
Class that holds informational messages to represent output created by the Write-Host cmdlet. |
HostUtilities |
Implements utility methods that might be used by Hosts. |
IncompleteParseException |
Defines the exception thrown when a incomplete parse error occurs while parsing PowerShell script text. |
InformationalRecord |
Base class for items in the PSInformationalBuffers. A PSInformationalRecord consists of a string Message and the InvocationInfo and pipeline state corresponding to the command that created the record. |
InformationRecord |
Defines a data structure used to represent informational context destined for the host or user. |
InvalidJobStateException |
Defines exception which is thrown when state of the PSJob is different from the expected state. |
InvalidPowerShellStateException |
Defines exception which is thrown when state of the PowerShell is different from the expected state. |
InvocationInfo |
Describes how and where this command was invoked. |
ItemCmdletProviderIntrinsics |
Exposes the Item noun of the Cmdlet Providers to the Cmdlet base class. The methods of this class use the providers to perform operations. |
ItemNotFoundException |
ItemNotFoundException occurs when the path contained no wildcard characters and an item at that path could not be found. |
Job |
Represents a command running in background. A job object can internally contain many child job objects. |
Job2 |
New base class for a job that provides extended state management functionality on the job. Since the existing Job class is an abstract class and there are existing implementations of the same, it is required to have a new class that will have the extended functionality. This is to ensure that backwards compatibility is maintained However, this class will derive from the existing Job class. The option of deprecating the existing class was considered as well. In order to maintain backwards compatibility of PowerShell job cmdlets they will have to work with the old interface and hence deprecating the Job class did not add any benefit rather than deriving from the same. |
JobDataAddedEventArgs |
Event arguments that indicate data has been added to a child job. |
JobDefinition |
Contains the definition of a job which is defined in a job store. |
JobFailedException |
Container exception for jobs that can map errors and exceptions to specific lines in their input. |
JobIdentifier |
Object that must be created by PowerShell to allow reuse of an ID for a job. Also allows setting of the Instance Id so that jobs may be recreated. |
JobInvocationInfo |
Class that helps define the parameters to be passed to a job so that the job can be instantiated without having to specify the parameters explicitly. Helps in passing job parameters to disk. |
JobManager |
Manager for JobSourceAdapters for invocation and management of specific Job types. |
JobRepository |
Class which has list of job objects currently active in the system. |
JobSourceAdapter |
Abstract class for a job store which will contain the jobs of a specific type. |
JobStateEventArgs |
Event arguments passed to JobStateEvent handlers StateChanged event. |
JobStateInfo |
Type which has information about JobState and Exception ,if any, associated with JobState. |
LanguagePrimitives |
Defines language support methods. |
LineBreakpoint |
A breakpoint on a line or statement. |
ListControl |
Defines a list control. |
ListControlBuilder | |
ListControlEntry |
Defines one entry in a list control. |
ListControlEntryItem |
Defines one row in a list control entry. |
ListEntryBuilder | |
LocationChangedEventArgs |
Event argument for the LocationChangedAction containing information about the old location we were in and the new location we changed to. |
LoopFlowException |
LoopFlowException, base class for loop control exceptions. |
MetadataException |
Defines the exception thrown for all Metadata errors. |
MethodException |
Defines the exception thrown for Method related errors. |
MethodInvocationException |
Defines the exception thrown for Method invocation exceptions. |
ModuleIntrinsics |
Encapsulates the basic module operations for a PowerShell engine instance... |
NativeCommandExitException |
This exception is used by the NativeCommandProcessor to indicate an error when a native command returns a non-zero exit code. |
NullValidationAttributeBase |
Base type of Null Validation attributes. |
OrderedHashtable |
OrderedHashtable is a hashtable that preserves the order of the keys. |
OutputTypeAttribute |
OutputTypeAttribute is used to specify the type of objects output by a cmdlet or script. |
PagingParameters |
The parameters for the paging support enabled by SupportsPaging. Includes: -IncludeTotalCount, -Skip [int], -First [int] |
ParameterAttribute |
Identifies parameters to Cmdlets. |
ParameterBindingException |
The exception thrown if the specified value can not be bound parameter of a command. |
ParameterMetadata |
This class represents the compiled metadata for a parameter. |
ParameterSetMetadata |
This class represents the compiled metadata for a parameter set. |
ParentContainsErrorRecordException |
ParentContainsErrorRecordException is the exception contained by the ErrorRecord which is associated with a PowerShell engine custom exception through the IContainsErrorRecord interface. |
ParseException |
Defines the exception thrown when a syntax error occurs while parsing PowerShell script text. |
ParsingMetadataException |
Defines the exception thrown for all parameter binding exceptions related to metadata attributes. |
PathInfo |
An object that represents a path. |
PathInfoStack |
An object that represents a stack of paths. |
PathIntrinsics |
Exposes the path manipulation and location APIs to the Cmdlet base class. |
PipelineClosedException |
PipelineClosedException occurs when someone tries to write to an asynchronous pipeline source and the pipeline has already been stopped. |
PipelineDepthException |
PipelineDepthException occurs when the number of commands participating in a pipeline (object streaming) exceeds the configured maximum. |
PipelineStoppedException |
Indicates that the pipeline has already been stopped. |
Platform |
These are platform abstractions and platform specific implementations. |
PowerShell |
Represents a PowerShell command or script to execute against a Runspace(Pool) if provided, otherwise execute using a default Runspace. Provides access to different result buffers like output, error, debug, verbose, progress, warning, and information. Provides a simple interface to execute a powershell command:
The above statement creates a local runspace using default configuration, executes the command and then closes the runspace. Using RunspacePool property, the caller can provide the runspace where the command / script is executed. |
PowerShellAssemblyLoadContextInitializer |
This is the managed entry point for Microsoft.PowerShell.CoreCLR.AssemblyLoadContext.dll. |
PowerShellStreams<TInput,TOutput> |
Define all the output streams and one input stream for a workflow. |
PowerShellUnsafeAssemblyLoad |
Provides helper functions to facilitate calling managed code from a native PowerShell host. |
ProcessRunspaceDebugEndEventArgs |
ProcessRunspaceDebugEnd event arguments. |
ProgressRecord |
Defines a data structure used to represent the status of an ongoing operation at a point in time. |
PropertyCmdletProviderIntrinsics |
Exposes the Property noun of the Cmdlet Providers to the Cmdlet base class. The methods of this class use the providers to perform operations. |
PropertyNotFoundException |
Defines the exception thrown for errors getting the value of properties. |
ProviderCmdlet |
Providers that want to specify OutputType can use these strings for the ProviderCmdlet parameter. |
ProviderInfo |
Information about a loaded Cmdlet Provider. |
ProviderIntrinsics |
Exposes the Cmdlet Family Providers to the Cmdlet base class. The methods of this class use the providers to perform operations. |
ProviderInvocationException |
An exception that wraps all exceptions that are thrown by providers. This allows callers of the provider APIs to be able to catch a single exception no matter what any of the various providers may have thrown. |
ProviderNameAmbiguousException |
ProviderNameAmbiguousException occurs when more than one provider exists for a given name and the request did not contain the PSSnapin name qualifier. |
ProviderNotFoundException |
ProviderNotFoundException occurs when no provider can be found with the specified name. |
ProxyCommand |
A ProxyCommand class used to represent a Command constructed Dynamically. |
PSAdaptedProperty |
A property created by a user-defined PSPropertyAdapter. |
PSAliasProperty |
Serves as an alias to another member. |
PSArgumentException |
This is a wrapper for exception class ArgumentException which provides additional information via IContainsErrorRecord. |
PSArgumentNullException |
This is a wrapper for exception class ArgumentNullException which provides additional information via IContainsErrorRecord. |
PSArgumentOutOfRangeException |
This is a wrapper for exception class ArgumentOutOfRangeException which provides additional information via IContainsErrorRecord. |
PSChildJobProxy |
Job class used for children of PSJobProxy jobs. |
PSClassInfo |
Contains a PS Class information. |
PSClassMemberInfo |
Contains a class field information. |
PSCmdlet |
Defines members and overrides used by Cmdlets. All Cmdlets must derive from Cmdlet. |
PSCodeMethod |
Serves as a method implemented with a reference to another method. |
PSCodeProperty |
Serves as a property implemented with references to methods for getter and setter. |
PSCommand |
Defines a PowerShell command / script object which can be used with PowerShell object. |
PSControl |
Defines a control for the formatting types defined by PowerShell. |
PSControlGroupBy |
Allows specifying a header for groups of related objects being formatted, can be specified on any type of PSControl. |
PSCredential |
Offers a centralized way to manage usernames, passwords, and credentials. |
PSCustomObject |
Serves as a placeholder BaseObject when PSObject's constructor with no parameters is used. |
PSDataCollection<T> |
build Thread Safe buffer used with PowerShell Hosting interfaces. |
PSDataStreams |
Streams generated by PowerShell invocations. |
PSDebugContext |
This class exposes the information about the debugger that is available via $PSDebugContext. |
PSDefaultValueAttribute |
Specify a default value and/or help comment for a command parameter. This attribute does not have any semantic meaning, it is simply an aid to tools to make it simpler to know the true default value of a command parameter (which may or may not have any correlation with, e.g., the backing store of the Parameter's property or field. |
PSDriveInfo |
Defines a drive that exposes a provider path to the user. |
PSDynamicMember |
A dynamic member. |
PSEngineEvent |
Constants that represent PowerShell engine events. |
PSEvent |
Used to access the adapted or base events from the BaseObject. |
PSEventArgs |
The event arguments associated with an event. |
PSEventArgsCollection |
This class contains the collection of events received by the execution context. |
PSEventHandler |
The generic event handler from which specific event handlers extend. When possible, add functionality to this class instead of the IL generated by the GenerateEventHandler() method. |
PSEventJob |
A class to give a job-like interface to event actions. |
PSEventManager |
Represents the interface to the PowerShell eventing functionality. This class allows you to subscribe to, and receive events. |
PSEventSubscriber |
Represents a subscriber to an event. |
PSEventUnsubscribedEventArgs |
The event arguments associated with unsubscribing from an event. |
PSInstaller |
PSInstaller is a class for facilitating installation of monad engine and monad PSSnapin's. This class implements installer api from CLR. At install time, installation utilities (like InstallUtil.exe) will call api implementation functions in this class automatically. This includes functions like Install, Uninstall, Rollback and Commit. This class is an abstract class for handling installation needs that are common for all monad components, which include,
Different monad component will derive from this class. Two common components that need install include,
|
PSInvalidCastException |
Defines the exception thrown for type conversion errors. |
PSInvalidOperationException |
This is a wrapper for exception class InvalidOperationException which provides additional information via IContainsErrorRecord. |
PSInvocationSettings |
Settings to control command invocation. |
PSInvocationStateChangedEventArgs |
Event arguments passed to PowerShell state change handlers InvocationStateChanged event. |
PSInvocationStateInfo |
Type which has information about InvocationState and Exception associated with InvocationState. |
PSJobProxy |
Class that will serve as the API for hosting and executing workflows in PowerShell. This class will have a behavior similar to how the Runspace and PowerShell APIs behave in the remoting scenario. The objects on the client side act as proxies to the real objects on the server |
PSJobStartEventArgs |
Arguments for the script job start callback event. |
PSListModifier |
PSListModifier is a simple helper class created by the update-list cmdlet. The update-list cmdlet will either return an instance of this class, or it will internally use an instance of this class to implement the updates. Cmdlets can also take a PSListModifier as a parameter. Usage might look like:
Alias would take a PSListModifier and the Cmdlet code would be responsible for apply updates (possibly using PSListModifier.ApplyTo or else using custom logic). |
PSListModifier<T> |
A generic version of PSListModifier that exists for the sole purpose of making cmdlets that accept a PSListModifier more usable. Users that look at the syntax of the command will see something like PSListModifier[Mailbox] and know they need to pass in Mailboxes. |
PSMemberInfo |
Serves as the base class for all members of an PSObject. |
PSMemberInfoCollection<T> |
Serves as the collection of members in an PSObject or MemberSet. |
PSMemberSet |
Serves as a set of members. |
PSMethod |
Used to access the adapted or base methods from the BaseObject. |
PSMethodInfo |
Serves as a base class for all members that behave like methods. |
PSModuleInfo |
Class describing a PowerShell module... |
PSNoteProperty |
Serves as a property that is a simple name-value pair. |
PSNotImplementedException |
This is a wrapper for exception class NotImplementedException which provides additional information via IContainsErrorRecord. |
PSNotSupportedException |
This is a wrapper for exception class NotSupportedException which provides additional information via IContainsErrorRecord. |
PSObject |
Wraps an object providing alternate views of the available members and ways to extend them. Members can be methods, properties, parameterized properties, etc. |
PSObjectDisposedException |
This is a wrapper for exception class ObjectDisposedException which provides additional information via IContainsErrorRecord. |
PSObjectPropertyDescriptor |
Serves as the property information generated by the GetProperties method of PSObjectTypeDescriptor. |
PSObjectTypeDescriptionProvider |
Retrieves a PSObjectTypeDescriptor to provides information about the properties for an object of the type PSObject. |
PSObjectTypeDescriptor |
Provides information about the properties for an object of the type PSObject. |
PSParameterizedProperty |
Used to access parameterized properties from the BaseObject. |
PSParseError |
This is a class that represents a syntax error from parsing. |
PSParser |
PSParser class. |
PSPrimitiveDictionary |
PSPrimitiveDictionary is a Hashtable that is limited to 1) case-insensitive strings as keys and 2) values that can be serialized and deserialized during PowerShell remoting handshake (in major-version compatible versions of PowerShell remoting) |
PSProperty |
Used to access the adapted or base properties from the BaseObject. |
PSPropertyAdapter |
User-defined property adapter. |
PSPropertyInfo |
Serves as a base class for all members that behave like properties. |
PSPropertySet |
Serves as a list of property names. |
PSReference |
Define type for a reference object in PowerShell scripting language. |
PSScriptMethod |
Serves as a method implemented with a script. |
PSScriptProperty |
Serves as a property implemented with getter and setter scripts. |
PSSecurityException |
This is a wrapper for exception class SecurityException. |
PSSerializer |
This class provides public functionality for serializing a PSObject. |
PSSessionTypeOption |
This is the base class from which other classes should derive. This class defines the options for the specified configuration type. |
PSSnapIn |
MshSnapin is a class for regular mshsnapin's which is constructed based on mshsnapin assembly. This class derives from PSSnapInInstaller and will be used as the base for all regular mshsnapins. |
PSSnapInInfo |
Contains information about a PSSnapin. |
PSSnapInInstaller |
MshSnapinBase (or MshSnapinInstaller) is a class for facilitating registry of necessary information for monad mshsnapin's. This class will be built with monad core engine dll (System.Management.Automation.dll). This is the base class for two kinds of mshsnapins: MshSnapin and CustomMshSnapin. Each mshsnapin assembly should derive from this class (indirectly) and fill in information about mshsnapin name, vendor, and version. At install time, installation utilities (like InstallUtil.exe) will call install this engine assembly based on the implementation in this class. This class derives from base class PSInstaller. PSInstaller will handle the details about how information got written into registry. Here, the information about registry content is provided. The reason of not calling this class MshSnapinInstaller is to "hide" the details that MshSnapin class is actually doing installion. It is also more intuitive since people deriving from this class will think there are really implementing a class for mshsnapin. |
PSSnapInSpecification |
Defines the name and version tuple of a PSSnapin. |
PSStyle |
Contains configuration for how PowerShell renders text. |
PSStyle.BackgroundColor |
Contains background colors. |
PSStyle.FileInfoFormatting |
Contains formatting styles for FileInfo objects. |
PSStyle.FileInfoFormatting.FileExtensionDictionary |
Custom dictionary handling validation of extension and content. |
PSStyle.ForegroundColor |
Contains foreground colors. |
PSStyle.FormattingData |
Contains formatting styles for steams and objects. |
PSStyle.ProgressConfiguration |
Contains configuration for the progress bar visualization. |
PSToken |
This is public class for representing a powershell token. |
PSTraceSource |
An PSTraceSource is a representation of a System.Diagnostics.TraceSource instance that is used in the PowerShell components to produce trace output. |
PSTransaction |
Represents an active transaction |
PSTransactionContext |
We don't need PSTransaction related types on CSS because System.Transactions namespace is not available in CoreCLR. |
PSTransportOption |
This the abstract class that defines the options for underlying transport layer. |
PSTypeConverter |
Defines a base class implemented when you need to customize the type conversion for a target class. |
PSTypeName |
Represents Type, but can be used where a real type might not be available, in which case the name of the type can be used. |
PSTypeNameAttribute |
Specifies PSTypeName of a cmdlet or function parameter. |
PSVariable |
Represents a variable in the PowerShell language. |
PSVariableIntrinsics |
Exposes the APIs to manipulate variables in the Runspace. |
PSVariableProperty |
Serves as a property that is a simple name-value pair. |
PSVersionHashTable |
Represents an implementation of '$PSVersionTable' variable. The implementation contains ordered 'Keys' and 'GetEnumerator' to get user-friendly output. |
PSVersionInfo |
Encapsulates $PSVersionTable. Provides a simple interface to retrieve details from the PowerShell version table:
|
ReadOnlyPSMemberInfoCollection<T> |
Serves as a read only collection of members. |
RedirectedException |
Indicates that a success object was written and success-to-error ("1>&2") has been specified. |
RegisterArgumentCompleterCommand | |
RemoteCommandInfo |
A CommandInfo that has been serialized/deserialized as part of an InvocationInfo during a remote invocation. |
RemoteException |
Exception used to wrap the error coming from remote instance of PowerShell. |
Repository<T> |
Class which has list of job objects currently active in the system. |
RunspaceInvoke |
Defines a class which allows simple execution of commands from CLR languages |
RunspacePoolStateInfo |
Defines type which has information about RunspacePoolState and exception associated with that state. |
RunspaceRepository |
Repository of remote runspaces available in a local runspace. |
RuntimeDefinedParameter |
Represents a parameter declaration that can be constructed at runtime. |
RuntimeDefinedParameterDictionary |
Represents a collection of runtime-defined parameters that are keyed based on the name of the parameter. |
RuntimeException |
RuntimeException is the base class for exceptions likely to occur while a PowerShell command is running. |
ScriptBlock |
An object representing a pre-compiled block of powershell script. |
ScriptBlockToPowerShellNotSupportedException |
Defines the exception thrown when conversion from ScriptBlock to PowerShell is forbidden (i.e. when the script block has undeclared variables or more than one statement) |
ScriptCallDepthException |
ScriptCallDepthException occurs when the number of session state objects of this type in this scope exceeds the configured maximum. |
ScriptInfo |
The command information for scripts that are directly executable by PowerShell. |
ScriptRequiresException |
Defines the exception thrown when a script's requirements to run specified by the #requires statements are not met. |
SecurityDescriptorCmdletProviderIntrinsics |
Provides the *-SecurityDescriptor noun for the cmdlet providers. |
SemanticVersion |
An implementation of semantic versioning (https://semver.org) that can be converted to/from Version. When converting to Version, a PSNoteProperty is added to the instance to store the semantic version label so that it can be recovered when creating a new SemanticVersion. |
SessionState |
Exposes the APIs to manipulate the providers, Runspace data, and location to the Cmdlet base class. |
SessionStateException |
SessionStateException represents an error working with session state objects: variables, aliases, functions, filters, drives, or providers. |
SessionStateOverflowException |
SessionStateOverflowException occurs when the number of session state objects of this type in this scope exceeds the configured maximum. |
SessionStateUnauthorizedAccessException |
SessionStateUnauthorizedAccessException occurs when a change to a session state object cannot be completed because the object is read-only or constant, or because an object which is declared constant cannot be removed or made non-constant. |
SettingValueExceptionEventArgs |
Serves as the arguments for events triggered by exceptions in the SetValue method of PSObjectPropertyDescriptor |
SetValueException |
Defines the exception thrown for errors setting the value of properties. |
SetValueInvocationException |
Defines the exception thrown for exceptions thrown by property setters. |
Signature |
Represents a digital signature on a signed file. |
StartRunspaceDebugProcessingEventArgs |
StartRunspaceDebugProcessing event arguments. |
SteppablePipeline |
A steppable pipeline wrapper object... |
SupportsWildcardsAttribute |
Specifies that a parameter supports wildcards. |
TableControl |
Defines a table control. |
TableControlBuilder |
A helper class for defining table controls |
TableControlColumn |
Defines a particular column within a row in a table control. |
TableControlColumnHeader |
Defines the header for a particular column in a table control. |
TableControlRow |
Defines a single row in a table control. |
TableRowDefinitionBuilder |
A helper class for defining table controls |
TerminateException |
Used by the debugger to terminate the execution of the current command. |
ValidateArgumentsAttribute |
Serves as the base class for Validate attributes that validate parameter arguments. |
ValidateCountAttribute |
Validates that the parameter argument count is in the specified range. |
ValidateDriveAttribute |
Validates that the path has an approved root drive. |
ValidateEnumeratedArgumentsAttribute |
A variant of ValidateArgumentsAttribute which unrolls enumeration values and validates each element individually. |
ValidateLengthAttribute |
Validates that the length of each parameter argument's Length falls in the range specified by MinLength and MaxLength. |
ValidateNotNullAttribute |
Validates that the parameters's argument is not null. |
ValidateNotNullOrAttributeBase |
Validates that the parameters's argument is not null, is not an empty string or a string with white-space characters only, and is not an empty collection. |
ValidateNotNullOrEmptyAttribute |
Validates that the parameters's argument is not null, is not an empty string, and is not an empty collection. If argument is a collection, each argument is verified. |
ValidateNotNullOrWhiteSpaceAttribute |
Validates that the parameters's argument is not null, is not an empty string, is not a string that consists only of white-space characters, and is not an empty collection. If argument is a collection, each argument is verified. |
ValidatePatternAttribute |
Validates that each parameter argument matches the RegexPattern. |
ValidateRangeAttribute |
Validates that each parameter argument falls in the range specified by MinRange and MaxRange. |
ValidateScriptAttribute |
Class for validating against a script block. |
ValidateSetAttribute |
Validates that each parameter argument is present in a specified set. |
ValidateTrustedDataAttribute |
Validates that each parameter argument is Trusted data. |
ValidateUserDriveAttribute |
Validates that the path parameter is a User drive. |
ValidationMetadataException |
Defines the exception thrown for all Validate attributes. |
VariableBreakpoint |
A breakpoint on a variable. |
VariablePath |
A variable path that you can query the scope and drive of the variable reference. |
VerbInfo |
Provides information about a verb used to name commands defined in PowerShell. |
VerboseRecord |
A verbose record in the PSInformationalBuffers. |
VerbsCommon |
Verbs that are commonly used in cmdlet names. |
VerbsCommunications |
Verbs that are commonly used in cmdlet names when the cmdlet is used to communicate with something. |
VerbsData |
Verbs that are commonly used in cmdlet names when the cmdlet manipulates data. |
VerbsDiagnostic |
Verbs that are commonly used in cmdlet names when the cmdlet is used to diagnose the health of something. |
VerbsLifecycle |
Verbs that are commonly used in cmdlet names when the cmdlet manipulates the lifecycle of something. |
VerbsOther |
Canonical verbs that don't fit into any of the other categories. |
VerbsSecurity |
Verbs that are commonly used in cmdlet names when the cmdlet is used to secure a resource. |
VTUtility |
Class to help with VT escape sequences. |
WarningRecord |
A warning record in the PSInformationalBuffers. |
WideControl |
Defines a list control. |
WideControlBuilder | |
WideControlEntryItem |
Defines one item in a wide control entry. |
WildcardPattern |
Represents a wildcard pattern. |
WildcardPatternException |
Thrown when a wildcard pattern is invalid. |
WorkflowInfo |
Provides information about a workflow that is stored in session state. |
Structs
SwitchParameter |
Type used to define a parameter on a cmdlet script of function that can only be used as a switch. |
Interfaces
IArgumentCompleter |
A type specified by the ArgumentCompleterAttribute must implement this interface. |
IArgumentCompleterFactory |
Creates a new argument completer. |
IBackgroundDispatcher |
An object that can be used to execute a method on a threadpool thread while correctly managing system state, such as flowing ETW activities from the current thread to the threadpool thread. |
ICommandRuntime |
This interface defines the set of functionality that must be implemented to directly execute an instance of a Cmdlet. |
ICommandRuntime2 |
This interface defines the set of functionality that must be implemented to directly execute an instance of a Cmdlet. ICommandRuntime2 extends the ICommandRuntime interface by adding support for the informational data stream. |
IContainsErrorRecord |
Implemented by exception classes which contain additional ErrorRecord information. |
IDynamicParameters |
An interface that a Cmdlet or CmdletProvider must implement to indicate that it has dynamic parameters. |
IJobDebugger |
Interface to expose a job debugger. |
IModuleAssemblyCleanup |
Used by modules to provide a hook to the engine for cleanup on removal w.r.t. compiled assembly being removed. |
IModuleAssemblyInitializer |
Used by Modules/Snapins to provide a hook to the engine for startup initialization w.r.t compiled assembly loading. |
IResourceSupplier |
Objects implementing this interface can be used by ErrorDetails(IResourceSupplier, String, String, Object[]) |
IValidateSetValuesGenerator |
Allows dynamically generate set of values for ValidateSetAttribute |
Enums
ActionPreference |
Defines the Action Preference options. These options determine what will happen when a particular type of event occurs. For example, setting shell variable ErrorActionPreference to "Stop" will cause the command to stop when an otherwise non-terminating error occurs. |
Alignment |
Specifies possible alignment enumerations for display cells. |
BreakpointUpdateType |
Kinds of breakpoint updates. |
CatalogValidationStatus |
Defines the possible status when validating integrity of catalog |
CommandOrigin |
This enum defines the dispatch origin of a command. |
CommandTypes |
Defines the types of commands that PowerShell can execute. |
CompletionResultType |
Possible types of CompletionResults. |
ConfirmImpact |
Defines the ConfirmImpact levels. These levels describe the "destructiveness" of an action, and thus the degree of important that the user confirm the action. For example, setting the read-only flag on a file might be Low, and reformatting a disk might be High. These levels are also used in $ConfirmPreference to describe which operations should be confirmed. Operations with ConfirmImpact equal to or greater than $ConfirmPreference are confirmed. Operations with ConfirmImpact.None are never confirmed, and no operations are confirmed when $ConfirmPreference is ConfirmImpact.None (except when explicitly requested with -Confirm). |
CopyContainers |
Determines how the source container of a copy operation will be used. |
DebuggerResumeAction |
Possible actions for the debugger after hitting a breakpoint/step. |
DebugModes |
Defines debugging mode. |
DisplayEntryValueType |
Specifies the type of entry value. |
DSCResourceRunAsCredential |
To specify RunAs behavior for the class /// |
ErrorCategory |
Errors reported by PowerShell will be in one of these categories. |
ErrorView |
Defines the potential ErrorView options. |
ExperimentAction |
Indicates the action to take on the cmdlet/parameter that has the attribute declared. |
ImplementedAsType |
Enumerated values for DSC resource implementation type. |
JobState |
Enumeration for job status values. Indicates the status of the result object. |
JobThreadOptions |
Specifies the various thread options that can be used for the ThreadBasedJob. |
ModuleAccessMode |
Defines the possible access modes for a module... |
ModuleIntrinsics.PSModulePathScope |
The available module path scopes. |
ModuleType |
Indicates the type of a module. |
NativeArgumentPassingStyle |
Defines the different native command argument parsing options. |
OutputRendering |
Defines the options for output rendering. |
Platform.XDG_Type |
X Desktop Group configuration type enum. |
PowerShellStreamType |
Enumeration of the possible PowerShell stream types. This enumeration is obsolete. |
ProgressRecordType |
Defines two types of progress record that refer to the beginning (or middle) and end of an operation. |
ProgressView |
Defines the options for views of progress rendering. |
PSCredentialTypes |
Defines the valid types of PSCredentials. Used by PromptForCredential calls. |
PSCredentialUIOptions |
Defines the options available when prompting for credentials. Used by PromptForCredential calls. |
PSInvocationState |
Enumerated type defining the state of the PowerShell. |
PSLanguageMode |
This enum defines what subset of the PowerShell language is permitted when calling into this execution environment. |
PSMemberTypes |
Enumerates all possible types of members. |
PSMemberViewTypes |
Enumerator for all possible views available on a PSObject. |
PSModuleAutoLoadingPreference |
Defines the preference options for the Module Auto-loading feature. |
PSTokenType |
PowerShell token types. |
PSTraceSourceOptions |
These flags enable tracing based on the types of a tracing supplied. Each type of tracing will allow for one or more methods in the StructuredTraceSource class to become "enabled". |
PSTransactionStatus |
The status of a PowerShell transaction. |
RemoteStreamOptions |
These flags control whether InvocationInfo is added to items in the Error, Warning, Verbose and Debug streams during remote calls. |
RemotingBehavior |
Controls or overrides the remoting behavior, during invocation, of a command that supports ambient remoting. |
RemotingCapability |
Defines the various types of remoting behaviour that a cmdlet may desire when used in a context that supports ambient / automatic remoting. |
ResolutionPurpose |
Defines the purpose for resolution of a CmsMessageRecipient. |
ReturnContainers |
This enum determines which types of containers are returned from some of the provider methods. |
RollbackSeverity |
The severity of error that causes PowerShell to automatically rollback the transaction. |
RunspaceMode |
Enumerated type defining runspace modes for nested pipeline. |
ScopedItemOptions |
The options that define some of the constraints for session state items like variables, aliases, and functions. |
SessionCapabilities |
Defines session capabilities provided by a PowerShell session. |
SessionStateCategory |
Categories of session state objects, used by SessionStateException. |
SessionStateEntryVisibility |
This enum defines the visibility of execution environment elements... |
ShouldProcessReason |
This describes the reason why ShouldProcess returned what it returned. Not all possible reasons are covered. |
SignatureStatus |
Defines the valid status flags that a signature on a file may have. |
SignatureType |
Defines the valid types of signatures. |
SigningOption |
Defines the options that control what data is embedded in the signature blob. |
SplitOptions |
A enum corresponding to the options on the -split operator. |
TypeInferenceRuntimePermissions |
Enum describing permissions to use runtime evaluation during type inference. |
ValidateRangeKind |
Predefined range kind to use with ValidateRangeAttribute. |
VariableAccessMode |
The access type for variable breakpoints to break on. |
VTUtility.VT |
Available VT escape codes other than colors. |
WhereOperatorSelectionMode |
Controls the matching behaviour of the Where() operator. |
WildcardOptions |
Provides enumerated values to use to set wildcard pattern matching options. |
Delegates
GetSymmetricEncryptionKey |
Declare a delegate which returns the encryption key and initialization vector for symmetric encryption algorithm. |
MemberNamePredicate |
A Predicate that determine if a member name matches a criterion. |
PSEventReceivedEventHandler |
The delegate that handles notifications of new events added to the collection. |
PSEventUnsubscribedEventHandler |
The delegate that handles notifications of the event being unsubscribed. |