Paramètres

Paramètres pour les tâches PowerShell Universal.

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 varie selon le type défini dans le bloc. Les paramètres obligatoires seront également requis par l'interface utilisateur.

Paramètres de base

Les paramètres peuvent être définis simplement, sans aucun 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 différents 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. 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)

Booléen

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

param([Bool]$Switch)

Entier

Vous pouvez définir un sélecteur numérique 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 commutateur.

param([Switch]$Switch)

Énumérations

Vous pouvez utiliser des valeurs System.Enum pour créer des listes déroulantes. Par exemple, vous pouvez utiliser System.DayOrWeek pour créer une liste 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 informations d'identification disponibles en tant que variables.

param(
    [PSCredential]$Credential
)

Fichier

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 textuel du fichier en le convertissant à l'aide des classes d'encodage.

[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 obligatoires

Vous pouvez utiliser l'attribut Parameter pour définir des paramètres obligatoires.

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 au moment où 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 pouvant être transmises à un paramètre. En savoir 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 transmettre des paramètres depuis PowerShell en utilisant la cmdlet Invoke-PSUScript. Cette cmdlet prend en charge les paramètres dynamiques. Si votre script possède un bloc param, ces paramètres seront automatiquement ajoutés à Invoke-PSUScript.

Par exemple, si vous disposez d'un script nommé Script1.ps1 dont le contenu est le suivant.

param($MyParameter)

$MyParameter

Vous pourriez alors appeler ce script avec la syntaxe suivante.

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

Le résultat serait que Hello s'afficherait 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