Condividi tramite

Dichiarazione dell'attributo parameter

  • Articolo

L'attributo Parameter identifica una proprietà pubblica della classe cmdlet come parametro del cmdlet.

Sintassi

[Parameter()]
[Parameter(Named Parameters...)]

Parametri

Mandatory (System.Boolean) Parametro denominato facoltativo. True indica che il parametro del cmdlet è obbligatorio. Se non viene specificato un parametro obbligatorio quando viene richiamato il cmdlet, Windows PowerShell richiede all'utente un valore di parametro. Il valore predefinito è false.

ParameterSetName (System.String) Parametro denominato facoltativo. Specifica il set di parametri a cui appartiene questo parametro del cmdlet. Se non viene specificato alcun set di parametri, il parametro appartiene a tutti i set di parametri.

Position (System.Int32) Parametro denominato facoltativo. Specifica la posizione del parametro all'interno di un comando di Windows PowerShell.

ValueFromPipeline (System.Boolean) Parametro denominato facoltativo. True indica che il parametro del cmdlet accetta il relativo valore da un oggetto pipeline. Specificare questa parola chiave se il cmdlet accede all'oggetto completo, non solo a una proprietà dell'oggetto . Il valore predefinito è false.

ValueFromPipelineByPropertyName (System.Boolean) Parametro denominato facoltativo. True indica che il parametro del cmdlet accetta il relativo valore da una proprietà di un oggetto pipeline con lo stesso nome o lo stesso alias di questo parametro. Ad esempio, se il cmdlet ha un parametro Name e l'oggetto pipeline ha anche una proprietà Name, il valore della proprietà Name viene assegnato al parametro Name del cmdlet. Il valore predefinito è false.

ValueFromRemainingArguments (System.Boolean) Parametro denominato facoltativo. True indica che il parametro del cmdlet accetta tutti gli argomenti rimanenti passati al cmdlet. Il valore predefinito è false.

HelpMessage (System.String) Parametro denominato facoltativo. Specifica una breve descrizione del parametro. Windows PowerShell visualizza questo messaggio quando viene eseguito un cmdlet e non viene specificato un parametro obbligatorio.

HelpMessageBaseName (System.String) Parametro denominato facoltativo. Specifica il percorso in cui risiedono gli identificatori di risorsa. Ad esempio, questo parametro può specificare un assembly di risorse contenente i messaggi della Guida che si desidera localizzare.

HelpMessageResourceId (System.String) Parametro denominato facoltativo. Specifica l'identificatore della risorsa per un messaggio della Guida.

DontShow (System.Boolean) Parametro denominato facoltativo. True indica che il parametro è nascosto all'utente per l'espansione della scheda e IntelliSense. Il valore predefinito è false.

Osservazioni

  • Per altre informazioni su come dichiarare questo attributo, vedere Come dichiarare i parametri dei cmdlet.

  • Un cmdlet può avere un numero qualsiasi di parametri. Tuttavia, per un'esperienza utente migliore, limitare il numero di parametri.

  • I parametri devono essere dichiarati in campi o proprietà non statici pubblici. I parametri devono essere dichiarati nelle proprietà. La proprietà deve avere una funzione di accesso del set pubblico e, se viene specificata la parola chiave ValueFromPipeline o ValueFromPipelineByPropertyName, la proprietà deve avere una funzione di accesso get pubblica.

  • Quando si specificano parametri posizionali, limitare il numero di parametri posizionali in un parametro impostato su meno di cinque. Inoltre, i parametri posizionali non devono essere contigui. Le posizioni 5, 100 e 250 funzionano come posizioni 0, 1 e 2.

  • Quando la parola chiave Position non viene specificata, è necessario fare riferimento al parametro del cmdlet in base al relativo nome.

  • Quando si usano set di parametri, tenere presente quanto segue:

    • Ogni set di parametri deve avere almeno un parametro univoco. Una buona progettazione dei cmdlet indica che questo parametro univoco deve essere obbligatorio, se possibile. Se il cmdlet è progettato per essere eseguito senza parametri, il parametro univoco non può essere obbligatorio.

    • Nessun set di parametri deve contenere più di un parametro posizionale con la stessa posizione.

    • Un solo parametro in un set di parametri deve dichiarare ValueFromPipeline = true.

    • Più parametri possono definire ValueFromPipelineByPropertyName = true.

  • Per altre informazioni sulle linee guida per i nomi dei parametri, vedere Cmdlet Parameter Names.

  • L'attributo del parametro è definito dalla classe System.Management.Automation.ParameterAttribute.

  • Il parametro DontShow presenta gli effetti collaterali seguenti:

    • Influisce su tutti i set di parametri per il parametro associato, anche se è presente un set di parametri in cui DontShow non è usato.
    • Nasconde i parametri comuni dal completamento delle schede e Da IntelliSense. DontShow non nasconde i parametri comuni facoltativi: WhatIf, Confirmo UseTransaction.

Vedere anche