Condividi tramite

Dichiarazione dell'attributo Cmdlet

  • Articolo

L'attributo Cmdlet identifica una classe Microsoft .NET Framework come cmdlet e specifica il verbo e il sostantivo usati per richiamare il cmdlet.

Sintassi

[Cmdlet("verbName", "nounName")]
[Cmdlet("verbName", "nounName", Named Parameters...)]

Parametri

VerbName (System.String) obbligatorio. Specifica il verbo del cmdlet. Questo verbo specifica l'azione eseguita dal cmdlet . Per altre informazioni sui verbi dei cmdlet approvati, vedere Cmdlet Verb Names e Required Development Guidelines.

NounName (System.String) obbligatorio. Specifica il sostantivo del cmdlet. Questo sostantivo specifica la risorsa su cui agisce il cmdlet. Per altre informazioni sui sostantivi dei cmdlet, vedere Cmdlet Declaration e fortemente consigliato per le linee guida per lo sviluppo.

SupportsShouldProcess (System.Boolean) Parametro denominato facoltativo. True indica che il cmdlet supporta le chiamate al metodo System.Management.Automation.Cmdlet.ShouldProcess, che fornisce al cmdlet un modo per richiedere all'utente un'azione che modifica il sistema. False, il valore predefinito indica che il cmdlet non supporta le chiamate al metodo System.Management.Automation.Cmdlet.ShouldProcess. Per altre informazioni sulle richieste di conferma, vedere Richiesta di conferma.

ConfirmImpact (System.Management.Automation.ConfirmImpact) Parametro denominato facoltativo. Specifica quando l'azione del cmdlet deve essere confermata da una chiamata al metodo System.Management.Automation.Cmdlet.ShouldProcess. System.Management.Automation.Cmdlet.ShouldProcess verrà chiamato solo quando il valore ConfirmImpact del cmdlet (per impostazione predefinita, Medium) è uguale o maggiore del valore della variabile $ConfirmPreference. Questo parametro deve essere specificato solo quando viene specificato il parametro SupportsShouldProcess.

DefaultParameterSetName (System.String) Parametro denominato facoltativo. Specifica il set di parametri predefinito che il runtime di Windows PowerShell tenta di usare quando non è in grado di determinare quale parametro impostato da usare. Si noti che questa situazione può essere eliminata rendendo il parametro univoco di ogni parametro impostato un parametro obbligatorio.

C'è un caso in cui Windows PowerShell non può usare il set di parametri predefinito anche se è specificato un nome del set di parametri predefinito. Il runtime di Windows PowerShell non può distinguere tra set di parametri basati esclusivamente sul tipo di oggetto. Ad esempio, se si dispone di un set di parametri che accetta una stringa come percorso del file e un altro set che accetta direttamente un oggetto fileInfo , Windows PowerShell non può determinare quale parametro impostato da usare in base ai valori passati al cmdlet, né usa il set di parametri predefinito. In questo caso, anche se si specifica un nome di set di parametri predefinito, Windows PowerShell genera un messaggio di errore ambiguo del set di parametri.

SupportsTransactions (System.Boolean) Parametro denominato facoltativo. True indica che il cmdlet può essere usato all'interno di una transazione. Quando si specifica True, il runtime di Windows PowerShell aggiunge il parametro UseTransaction all'elenco di parametri del cmdlet. False, il valore predefinito indica che il cmdlet non può essere usato all'interno di una transazione.

Osservazioni:

  • Insieme, il verbo e il sostantivo vengono usati per identificare il cmdlet registrato e per richiamare il cmdlet all'interno di uno script.

  • Quando il cmdlet viene richiamato dalla console di Windows PowerShell, il comando è simile al comando seguente:

VerbName-NounName

I parametri del cmdlet Confirm e WhatIf sono disponibili solo per i cmdlet che supportano chiamate System.Management.Automation.Cmdlet.ShouldProcess.

Esempio

La definizione di classe seguente usa l'attributo Cmdlet per identificare la classe .NET Framework per un cmdlet Get-Proc che recupera informazioni sui processi in esecuzione nel computer locale.

[Cmdlet(VerbsCommon.Get, "Proc")]
public class GetProcCommand : Cmdlet

Per altre informazioni sul cmdlet Get-Proc, vedere GetProc Tutorial.

Vedere anche

scrittura di un cmdlet di Windows PowerShell