CmdletAttribute Class
Updated: April 27, 2016
Applies To: Windows PowerShell
Identifies a .NET Framework class as a cmdlet, and defines the verb and noun name pair used to invoke the cmdlet.
Assembly: System.Management.Automation (in System.Management.Automation.dll)
System.Attribute
System.Management.Automation.Internal.CmdletMetadataAttribute
System.Management.Automation.CmdletCommonMetadataAttribute
System.Management.Automation.CmdletAttribute
| Name | Description | |
|---|---|---|
![]() | CmdletAttribute(String, String) | Creates a new CmdletAttribute object that contains the verb and noun name pair used to invoke the cmdlet. |
| Name | Description | |
|---|---|---|
![]() | ConfirmImpact | Gets or sets the impact level, which is used when the user requests confirmation using the $ConfirmPreference shell variable. This property is introduced in Windows PowerShell 2.0.(Inherited from CmdletCommonMetadataAttribute.) |
![]() | DefaultParameterSetName | Gets or sets the parameter set that is used when Windows PowerShell cannot determine the parameter set to use based on the specified parameters. This property is introduced in Windows PowerShell 2.0.(Inherited from CmdletCommonMetadataAttribute.) |
![]() | HelpUri | Gets or sets a HelpUri value that indicates the location of online help. This is used by Get-Help to retrieve help content when -Online is specified. Introduced in Windows PowerShell 3.0.(Inherited from CmdletCommonMetadataAttribute.) |
![]() | NounName | Gets the noun name that describes the resource on which the cmdlet performs its action. |
![]() | RemotingCapability | Gets or sets the RemotingBehavior value that declares how this cmdlet should interact with ambient remoting. Introduced in Windows PowerShell 3.0.(Inherited from CmdletCommonMetadataAttribute.) |
![]() | SupportsPaging | Gets or sets a value that indicates whether the cmdlet supports paging. Introduced in Windows PowerShell 3.0.(Inherited from CmdletCommonMetadataAttribute.) |
![]() | SupportsShouldProcess | Gets or sets a value that indicates whether calls to the ShouldProcess method are supported. This call is used to request confirmation from the user before the operation is performed. This property is introduced in Windows PowerShell 2.0.(Inherited from CmdletCommonMetadataAttribute.) |
![]() | SupportsTransactions | Gets or sets a value that indicates whether the action of the command can be accepted or rolled back within a Windows PowerShell transaction. This property is introduced in Windows PowerShell 2.0.(Inherited from CmdletCommonMetadataAttribute.) |
![]() | TypeId | (Inherited from Attribute.) |
![]() | VerbName | Gets the verb name that describes the action performed by the cmdlet. |
| Name | Description | |
|---|---|---|
![]() | Equals(Object) | (Inherited from Attribute.) |
![]() | GetHashCode() | (Inherited from Attribute.) |
![]() | GetType() | (Inherited from Object.) |
![]() | IsDefaultAttribute() | (Inherited from Attribute.) |
![]() | Match(Object) | (Inherited from Attribute.) |
![]() | ToString() | (Inherited from Object.) |
| Name | Description | |
|---|---|---|
![]() ![]() | _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) | (Inherited from Attribute.) |
![]() ![]() | _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) | (Inherited from Attribute.) |
![]() ![]() | _Attribute.GetTypeInfoCount(UInt32) | (Inherited from Attribute.) |
![]() ![]() | _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) | (Inherited from Attribute.) |
This attribute is used for .NET Framework classes that derive from the Cmdlet and PSCmdlet classes.
For more information about the declaration syntax used to specify the Cmdlet attribute, see Cmdlet Attribute Declaration.
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.



