Paramètres

Paramètres

Les tâches prennent en charge la génération automatique de formulaires avec des paramètres basés sur le bloc param de votre script. Le type de contrôle change selon le type que vous définissez dans le bloc. Les paramètres obligatoires seront également requis par l'interface utilisateur.

Paramètres de base

Les paramètres peuvent être simplement définis sans aucun type d'attribut de paramètre et ils apparaîtront sous forme de zones de texte dans l'interface utilisateur.

param($Test)

$Test

Types de paramètres

Universal prend en charge divers types de paramètres. Vous pouvez utiliser les types String, String[], Int, DateTime, Boolean, Switch et Enum.

String

Vous pouvez définir des paramètres de type chaîne en spécifiant le type [String] ou en ne spécifiant aucun type du tout. Les chaînes génèrent une zone de texte.

param(
    [String]$Textbox,
    $Textbox2
)

Tableaux de chaînes

Vous pouvez spécifier des tableaux de chaînes en utilisant le spécificateur de type [String[]]. Les tableaux de chaînes génèrent une zone de sélection à plusieurs étiquettes.

param([String[]]$Array)

Date et heure

Vous pouvez utiliser le spécificateur de type [DateTime] pour créer un sélecteur de date et d'heure.

param([DateTime]$DateTime)

Boolean

Vous pouvez utiliser un sélecteur de type [Bool] pour créer un interrupteur.

param([Bool]$Switch)

Integer

Vous pouvez définir un sélecteur de nombre en utilisant le spécificateur de type [Int].

param([Int]$Number)

Paramètre Switch

Vous pouvez définir un paramètre switch en utilisant le spécificateur de type [Switch] pour créer un interrupteur.

param([Switch]$Switch)

Énumérations

Vous pouvez utiliser des valeurs System.Enum pour créer des zones de sélection. Par exemple, vous pourriez utiliser System.DayOrWeek pour créer une zone de sélection du jour de la semaine.

param([System.DayOfWeek]$DayOfWeek)

PSCredential

Lorsque vous spécifiez un PSCredential, l'utilisateur se voit présenter une liste déroulante des identifiants disponibles en tant que variables.

param(
    [PSCredential]$Credential
)

File

Vous pouvez permettre aux utilisateurs de téléverser des fichiers en utilisant le type [File].

param(
    [File]$File
)

Les fichiers seront disponibles en tant qu'objet PSUFile dans vos scripts. Cet objet possède un tableau byte[] que vous pouvez utiliser pour traiter le fichier.

Par exemple, vous pouvez obtenir le contenu du fichier sous forme de chaîne en le convertissant à l'aide des classes Encoding.

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

Nom d'affichage

Vous pouvez utiliser le DisplayNameAtrribute pour définir un nom d'affichage pour le paramètre de script.

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

Messages d'aide

Vous pouvez définir des messages d'aide pour vos paramètres en utilisant la propriété HelpMessage de l'attribut Parameter.

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

Paramètres requis

Vous pouvez utiliser l'attribut Parameter pour définir les paramètres requis.

param(
    [Parameter(Mandatory)]
    $RequiredParameter
)

$RequiredParameter

Valeur par défaut

Vous pouvez utiliser à la fois des valeurs statiques et des valeurs par défaut pour les paramètres. La valeur par défaut est calculée lorsque la tâche est sur le point d'être exécutée.

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

$Parameter
$ExecutionTime

ValidateSet

L'attribut ValidateSet est utilisé pour imposer les valeurs qui peuvent être passées à un paramètre. Apprenez-en plus sur ValidateSet ici. PowerShell Universal crée automatiquement un menu déroulant avec les valeurs fournies à l'attribut ValidateSet pour les paramètres.

Par exemple, un script pourrait définir un bloc param comme suit.

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

Le résultat est illustré ci-dessous.

Attribut ValidateSet

Passer des paramètres depuis PowerShell

Vous pouvez passer des paramètres depuis PowerShell en utilisant l'applet de commande Invoke-PSUScript. Cette applet de commande prend en charge les paramètres dynamiques. Si votre script comporte un bloc param, ces paramètres seront automatiquement ajoutés à Invoke-PSUScript.

Par exemple, j'avais un script nommé Script1.ps1 et son contenu était le suivant.

param($MyParameter)

$MyParameter

Je pourrais ensuite invoquer ce script en utilisant cette syntaxe.

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

Le résultat serait que Hello soit affiché dans le journal de la tâche et dans le pipeline.

Ensembles de paramètres

PowerShell Universal prend en charge les ensembles de paramètres. Lorsqu'un ensemble de paramètres est défini, une liste déroulante est fournie pour permettre de basculer entre les ensembles.

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

Ensembles de paramètres