CmdletAttribute Class

Definition

Identifies a class as a cmdlet and specifies the verb and noun identifying this cmdlet.

public ref class CmdletAttribute sealed : System::Management::Automation::CmdletCommonMetadataAttribute
[System.AttributeUsage(System.AttributeTargets.Class)]
public sealed class CmdletAttribute : System.Management.Automation.CmdletCommonMetadataAttribute
type CmdletAttribute = class
    inherit CmdletCommonMetadataAttribute
Public NotInheritable Class CmdletAttribute
Inherits CmdletCommonMetadataAttribute
Inheritance
Attributes

Constructors

CmdletAttribute(String, String)

Initializes a new instance of the CmdletAttribute class

Properties

ConfirmImpact

Gets and sets a ConfirmImpact value that indicates the "destructiveness" of the operation and when it should be confirmed. This should only be used when SupportsShouldProcess is specified.

(Inherited from CmdletCommonMetadataAttribute)
DefaultParameterSetName

Gets and sets the cmdlet default parameter set

(Inherited from CmdletCommonMetadataAttribute)
HelpUri

Gets and 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.

(Inherited from CmdletCommonMetadataAttribute)
NounName

Gets the cmdlet noun

RemotingCapability

Gets and sets the RemotingBehavior value that declares how this cmdlet should interact with ambient remoting.

(Inherited from CmdletCommonMetadataAttribute)
SupportsPaging

Gets and sets a Boolean value that indicates the Cmdlet supports Paging. By default the value is false, meaning the cmdlet doesn't support Paging.

(Inherited from CmdletCommonMetadataAttribute)
SupportsShouldProcess

Gets and sets a Boolean value that indicates the Cmdlet supports ShouldProcess. By default the value is false, meaning the cmdlet doesn't support ShouldProcess.

(Inherited from CmdletCommonMetadataAttribute)
SupportsTransactions

Gets and sets a Boolean value that indicates the Cmdlet supports Transactions. By default the value is false, meaning the cmdlet doesn't support Transactions.

(Inherited from CmdletCommonMetadataAttribute)
VerbName

Gets the cmdlet verb

Applies to