Windows desktop applications
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

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.

Namespace:   System.Management.Automation
Assembly:  System.Management.Automation (in System.Management.Automation.dll)


[AttributeUsageAttribute(AttributeTargets.Class)]
public sealed class CmdletAttribute : CmdletCommonMetadataAttribute

NameDescription
System_CAPS_pubmethodCmdletAttribute(String, String)

Creates a new CmdletAttribute object that contains the verb and noun name pair used to invoke the cmdlet.

NameDescription
System_CAPS_pubpropertyConfirmImpact

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.)

System_CAPS_pubpropertyDefaultParameterSetName

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.)

System_CAPS_pubpropertyHelpUri

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.)

System_CAPS_pubpropertyNounName

Gets the noun name that describes the resource on which the cmdlet performs its action.

System_CAPS_pubpropertyRemotingCapability

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.)

System_CAPS_pubpropertySupportsPaging

Gets or sets a value that indicates whether the cmdlet supports paging. Introduced in Windows PowerShell 3.0.(Inherited from CmdletCommonMetadataAttribute.)

System_CAPS_pubpropertySupportsShouldProcess

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.)

System_CAPS_pubpropertySupportsTransactions

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.)

System_CAPS_pubpropertyTypeId

(Inherited from Attribute.)

System_CAPS_pubpropertyVerbName

Gets the verb name that describes the action performed by the cmdlet.

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Attribute.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Attribute.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodIsDefaultAttribute()

(Inherited from Attribute.)

System_CAPS_pubmethodMatch(Object)

(Inherited from Attribute.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

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.

Return to top
Show:
© 2016 Microsoft