Dichiarazione dell'attributo ParameterParameter Attribute Declaration

  • 2 minuti per la lettura

L'attributo Parameter identifica una proprietà pubblica della classe cmdlet come parametro del cmdlet.The Parameter attribute identifies a public property of the cmdlet class as a cmdlet parameter.

SintassiSyntax

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

ParametriParameters

Mandatory (System. Boolean) parametro denominato facoltativo.Mandatory (System.Boolean) Optional named parameter. True indica che il parametro del cmdlet è obbligatorio.True indicates the cmdlet parameter is required. Se non viene fornito un parametro obbligatorio quando viene richiamato il cmdlet, Windows PowerShell richiede all'utente un valore di parametro.If a required parameter is not provided when the cmdlet is invoked, Windows PowerShell prompts the user for a parameter value. Il valore predefinito è false.The default is false.

ParameterSetName (System. String) parametro denominato facoltativo.ParameterSetName (System.String) Optional named parameter. Specifica il set di parametri a cui appartiene il parametro del cmdlet.Specifies the parameter set that this cmdlet parameter belongs to. Se non viene specificato alcun set di parametri, il parametro appartiene a tutti i set di parametri.If no parameter set is specified, the parameter belongs to all parameter sets.

Position (System. Int32) parametro denominato facoltativo.Position (System.Int32) Optional named parameter. Specifica la posizione del parametro all'interno di un comando di Windows PowerShell.Specifies the position of the parameter within a Windows PowerShell command.

ValueFromPipeline (System. Boolean) parametro denominato facoltativo.ValueFromPipeline (System.Boolean) Optional named parameter. True indica che il parametro del cmdlet prende il valore da un oggetto pipeline.True indicates that the cmdlet parameter takes its value from a pipeline object. Specificare questa parola chiave se il cmdlet accede all'oggetto completo, non solo a una proprietà dell'oggetto.Specify this keyword if the cmdlet accesses the complete object, not just a property of the object. Il valore predefinito è false.The default is false.

ValueFromPipelineByPropertyName (System. Boolean) parametro denominato facoltativo.ValueFromPipelineByPropertyName (System.Boolean) Optional named parameter. True indica che il parametro del cmdlet prende il valore da una proprietà di un oggetto pipeline con lo stesso nome o lo stesso alias del parametro.True indicates that the cmdlet parameter takes its value from a property of a pipeline object that has either the same name or the same alias as this parameter. Se, ad esempio, il cmdlet dispone di un Name parametro e l'oggetto pipeline dispone anche di una Name proprietà, il valore della Name proprietà viene assegnato al Name parametro del cmdlet.For example, if the cmdlet has a Name parameter and the pipeline object also has a Name property, the value of the Name property is assigned to the Name parameter of the cmdlet. Il valore predefinito è false.The default is false.

ValueFromRemainingArguments (System. Boolean) parametro denominato facoltativo.ValueFromRemainingArguments (System.Boolean) Optional named parameter. True indica che il parametro del cmdlet accetta tutti gli argomenti rimanenti passati al cmdlet.True indicates that the cmdlet parameter accepts all remaining arguments that are passed to the cmdlet. Il valore predefinito è false.The default is false.

HelpMessage Parametro denominato facoltativo.HelpMessage Optional named parameter. Specifica una breve descrizione del parametro.Specifies a short description of the parameter. Windows PowerShell Visualizza questo messaggio quando viene eseguito un cmdlet e non viene specificato un parametro obbligatorio.Windows PowerShell displays this message when a cmdlet is run and a mandatory parameter is not specified.

HelpMessageBaseName Parametro denominato facoltativo. Specifica la posizione in cui risiedono gli identificatori di risorsa.HelpMessageBaseName Optional named parameter.Specifies the location where resource identifiers reside. Questo parametro, ad esempio, può specificare un assembly di risorse che contiene i messaggi della guida che si desidera localizzare.For example, this parameter could specify a resource assembly that contains Help messages that you want to localize.

HelpMessageResourceId Parametro denominato facoltativo. Specifica l'identificatore di risorsa per un messaggio della guida.HelpMessageResourceId Optional named parameter.Specifies the resource identifier for a Help message.

CommentiRemarks

  • Per ulteriori informazioni su come dichiarare questo attributo, vedere come dichiarare i parametri dei cmdlet.For more information about how to declare this attribute, see How to Declare Cmdlet Parameters.

  • Un cmdlet può avere un numero qualsiasi di parametri.A cmdlet can have any number of parameters. Tuttavia, per un'esperienza utente migliore, limitare il numero di parametri.However, for a better user experience, limit the number of parameters.

  • I parametri devono essere dichiarati in proprietà o campi non statici pubblici.Parameters must be declared on public non-static fields or properties. I parametri devono essere dichiarati in proprietà.Parameters should be declared on properties. La proprietà deve disporre di una funzione di accesso set pubblica ValueFromPipeline . Se ValueFromPipelineByPropertyName si specifica la parola chiave o, la proprietà deve disporre di una funzione di accesso get pubblica.The property must have a public set accessor, and if the ValueFromPipeline or ValueFromPipelineByPropertyName keyword is specified, the property must have a public get accessor.

  • Quando si specificano parametri posizionali, limitare il numero di parametri posizionali in un parametro impostato su un valore minore di 5.When you specify positional parameters, limit the number of positional parameters in a parameter set to less than five. E, i parametri posizionali non devono essere contigui.And, positional parameters do not have to be contiguous. Le posizioni 5, 100 e 250 funzionano allo stesso modo delle posizioni 0, 1 e 2.Positions 5, 100, and 250 work the same as positions 0, 1, and 2.

  • Quando la Position parola chiave non è specificata, il relativo nome deve essere usato come riferimento al parametro del cmdlet.When the Position keyword is not specified, the cmdlet parameter must be referenced by its name.

  • Quando si usano i set di parametri, tenere presente quanto segue:When you use parameter sets, note the following:

    • Ogni set di parametri deve avere almeno un parametro univoco.Each parameter set must have at least one unique parameter. Una progettazione di cmdlet efficace indica che questo parametro univoco deve essere obbligatorio, se possibile.Good cmdlet design indicates this unique parameter should also be mandatory if possible. Se il cmdlet è progettato per l'esecuzione senza parametri, il parametro Unique non può essere obbligatorio.If your cmdlet is designed to be run without parameters, the unique parameter cannot be mandatory.

    • Nessun set di parametri deve contenere più di un parametro posizionale con la stessa posizione.No parameter set should contain more than one positional parameter with the same position.

    • È necessario dichiarare un solo parametro in un set di parametri ValueFromPipeline = true .Only one parameter in a parameter set should declare ValueFromPipeline = true. È possibile definire più parametri ValueFromPipelineByPropertyName = true .Multiple parameters can define ValueFromPipelineByPropertyName = true.

    • È possibile definire più parametri ValueFromPipelineByPropertyName = true .Multiple parameters can define ValueFromPipelineByPropertyName = true.

  • Per ulteriori informazioni sulle linee guida per i nomi dei parametri, vedere cmdlet parameter names.For more information about the guidelines for parameter names, see Cmdlet Parameter Names.

  • L'attributo Parameter è definito dalla classe System. Management. Automation. ParameterAttribute .The parameter attribute is defined by the System.Management.Automation.Parameterattribute class.

Vedere ancheSee Also

System. Management. Automation. ParameterAttributeSystem.Management.Automation.Parameterattribute

Nomi dei parametri del cmdletCmdlet Parameter Names

Scrittura di un cmdlet di Windows PowerShellWriting a Windows PowerShell Cmdlet