Dichiarazione dell'attributo Cmdlet

Articolo
09/27/2021

L'attributo Cmdlet identifica una classe .NET Framework Microsoft 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 (Nomi dei verbi cmdlet) e Required Development Guidelines (Linee guida per lo sviluppo obbligatorie).

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 Dichiarazione di cmdlet e Linee guida per lo sviluppo fortemente consigliate.

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 prima che venga eseguita 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 $ConfirmPreference variabile. Questo parametro deve essere specificato solo quando SupportsShouldProcess viene specificato il parametro .

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

Esiste un caso in cui Windows PowerShell possibile usare il set di parametri predefinito anche se viene specificato un nome di set di parametri predefinito. Il Windows PowerShell runtime non è in grado di 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 di un altro set che accetta direttamente un oggetto FileInfo, Windows PowerShell non è in grado di determinare quale set di parametri usare in base ai valori passati al cmdlet e non usa il set di parametri predefinito. In questo caso, anche se si specifica un nome di set di parametri predefinito, Windows PowerShell viene generato un messaggio di errore di set di parametri ambiguo.

SupportsTransactions (System.Boolean) Parametro denominato facoltativo. True indica che il cmdlet può essere usato all'interno di una transazione. Quando True viene specificato , il runtime 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.

Commenti

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 Windows PowerShell, il comando è simile al comando seguente:

VerbName-NounName

Tutti i cmdlet che modificano le risorse all'esterno di Windows PowerShell devono includere la parola chiave quando viene dichiarato l'attributo Cmdlet, che consente al cmdlet di chiamare il metodo SupportsShouldProcess System.Management.Automation.Cmdlet.ShouldProcess prima che il cmdlet esegua l'azione. Se la chiamata System.Management.Automation.Cmdlet.ShouldProcess restituisce false , l'azione non deve essere eseguita. Per altre informazioni sulle richieste di conferma generate dalla chiamata System.Management.Automation.Cmdlet.ShouldProcess, vedere Richiesta di conferma.

I Confirm parametri dei cmdlet e sono disponibili solo per i cmdlet che WhatIf supportano le 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 Esercitazione su GetProc.

Vedere anche

Scrittura di un cmdlet di Windows PowerShell