Dichiarazione dell'attributo Parameter

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 cmdlet è obbligatorio. Se non viene fornito un parametro obbligatorio quando viene richiamato il cmdlet, Windows PowerShell 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 Windows PowerShell comando.

ValueFromPipeline (System.Boolean) Parametro denominato facoltativo. True indica che il parametro del cmdlet accetta il 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 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 e anche l'oggetto pipeline ha una proprietà , il valore della proprietà viene assegnato al Name Name parametro del Name Name 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 Parametro denominato facoltativo. Specifica una breve descrizione del parametro. Windows PowerShell questo messaggio viene visualizzato quando viene eseguito un cmdlet e non viene specificato un parametro obbligatorio.

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

HelpMessageResourceId Parametro denominato facoltativo. Specifica l'identificatore di risorsa per un messaggio della Guida.

Commenti

• 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 una migliore esperienza utente, limitare il numero di parametri.

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

• Quando si specificano parametri posizionali, limitare il numero di parametri posizionali in un set di parametri a meno di cinque. E non è necessario che i parametri posizionali siano contigui. Le posizioni 5, 100 e 250 funzionano come le posizioni 0, 1 e 2.

• Quando la parola chiave non viene specificata, è necessario fare riferimento Position al parametro del cmdlet in base al 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 anche 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 Nomi dei parametri dei cmdlet.

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

Vedere anche

System.Management.Automation.Parameterattribute

Nomi dei parametri dei cmdlet

Scrittura di un cmdlet di Windows PowerShell