Parametri

Parametri

I job supportano la generazione automatica di moduli con parametri basati sul blocco param dello script. Il tipo di controllo cambia in base al tipo definito nel blocco. Anche i parametri obbligatori saranno richiesti dall'interfaccia utente.

Parametri di base

I parametri possono essere definiti semplicemente senza alcun attributo di parametro e verranno visualizzati come caselle di testo nell'interfaccia utente.

param($Test)

$Test

Tipi di parametri

Universal supporta vari tipi di parametri. È possibile utilizzare i tipi String, String[], Int, DateTime, Boolean, Switch ed Enum.

String

È possibile definire i parametri stringa specificando il tipo [String] oppure non specificando alcun tipo. Le stringhe generano una casella di testo.

param(
    [String]$Textbox,
    $Textbox2
)

Array di stringhe

È possibile specificare array di stringhe utilizzando lo specificatore di tipo [String[]]. Gli array di stringhe generano una casella di selezione multi-tag.

param([String[]]$Array)

Data e ora

È possibile utilizzare lo specificatore di tipo [DateTime] per creare un selettore di data e ora.

param([DateTime]$DateTime)

Boolean

È possibile utilizzare un selettore di tipo [Bool] per creare uno switch.

param([Bool]$Switch)

Integer

È possibile definire un selettore numerico utilizzando lo specificatore di tipo [Int].

param([Int]$Number)

Parametro switch

È possibile definire un parametro switch utilizzando lo specificatore di tipo [Switch] per creare uno switch.

param([Switch]$Switch)

Enumerazioni

È possibile utilizzare i valori System.Enum per creare caselle di selezione. Ad esempio, si potrebbe utilizzare System.DayOrWeek per creare una casella di selezione del giorno della settimana.

param([System.DayOfWeek]$DayOfWeek)

PSCredential

Quando si specifica un PSCredential, all'utente verrà presentato un menu a discesa con le credenziali disponibili come variabili.

param(
    [PSCredential]$Credential
)

File

È possibile consentire agli utenti di caricare file utilizzando il tipo [File].

param(
    [File]$File
)

I file saranno disponibili come oggetto PSUFile negli script. Questo oggetto dispone di un array byte[] che è possibile utilizzare per elaborare il file.

Ad esempio, è possibile ottenere il contenuto stringa del file convertendolo tramite le classi Encoding.

[Text.Encoding]::UTF8.GetString($File.Content)

Nome visualizzato

È possibile utilizzare DisplayNameAtrribute per impostare un nome visualizzato per il parametro dello script.

param(
    [ComponentModel.DisplayName("My Script")]
    $MyScript
)

Messaggi di aiuto

È possibile definire messaggi di aiuto per i parametri utilizzando la proprietà HelpMessage dell'attributo Parameter.

param(
    [Parameter(HelpMessage = "Class you want to enroll in")]
    [string]$Class
)

Parametri obbligatori

È possibile utilizzare l'attributo Parameter per definire i parametri obbligatori.

param(
    [Parameter(Mandatory)]
    $RequiredParameter
)

$RequiredParameter

Valore predefinito

È possibile utilizzare sia valori statici sia valori predefiniti per i parametri. Il valore predefinito viene calcolato quando il job sta per essere eseguito.

param(
    $Parameter = "Hello, World",
    [DateTime]$ExecutionTime = Get-Date
)

$Parameter
$ExecutionTime

ValidateSet

L'attributo ValidateSet viene utilizzato per imporre quali valori possono essere passati a un parametro. Scopra di più su ValidateSet qui. PowerShell Universal creerà automaticamente un menu a discesa con i valori forniti all'attributo ValidateSet per i parametri.

Ad esempio, uno script potrebbe definire un blocco param come segue.

param(
    [ValidateSet("Steve", "Mary")]
    [string]$Name
)

Il risultato è mostrato di seguito.

Attributo ValidateSet

Passaggio dei parametri da PowerShell

È possibile passare i parametri da PowerShell utilizzando il cmdlet Invoke-PSUScript. Questo cmdlet supporta i parametri dinamici. Se lo script contiene un blocco param, questi parametri verranno aggiunti automaticamente a Invoke-PSUScript.

Ad esempio, avevo uno script denominato Script1.ps1 e il contenuto era il seguente.

param($MyParameter)

$MyParameter

Potrei quindi invocare quello script utilizzando questa sintassi.

Invoke-PSUScript -Name 'Script.ps1' -MyParameter "Hello"

Il risultato sarebbe che Hello viene restituito nel log del job e nella pipeline.

Set di parametri

PowerShell Universal supporta i set di parametri. Quando viene definito un set di parametri, viene fornito un menu a discesa che consente di passare da un set all'altro.

param(
    [Parameter(ParameterSetName = 'Set1')]
    $Parameter1,
    [Parameter(ParameterSetName = 'Set2')]
    $Parameter2
)

Set di parametri