Parámetros

Parámetros

Los trabajos admiten la generación automática de formularios con parámetros basados en el bloque param de su script. El tipo de control cambiará según el tipo que defina en el bloque. Los parámetros obligatorios también serán requeridos por la interfaz de usuario.

Parámetros básicos

Los parámetros se pueden definir simplemente sin ningún tipo de atributo de parámetro y aparecerán como cuadros de texto en la interfaz de usuario.

param($Test)

$Test

Tipos de parámetros

Universal admite varios tipos de parámetros. Puede usar los tipos String, String[], Int, DateTime, Boolean, Switch y Enum.

String

Puede definir parámetros de tipo cadena especificando el tipo [String] o no especificando ningún tipo. Las cadenas generarán un cuadro de texto.

param(
    [String]$Textbox,
    $Textbox2
)

Matrices de cadenas

Puede especificar matrices de cadenas usando el especificador de tipo [String[]]. Las matrices de cadenas generarán un cuadro de selección de múltiples etiquetas.

param([String[]]$Array)

Fecha y hora

Puede usar el especificador de tipo [DateTime] para crear un selector de fecha y hora.

param([DateTime]$DateTime)

Boolean

Puede usar un selector de tipo [Bool] para crear un conmutador.

param([Bool]$Switch)

Integer

Puede definir un selector de números usando el especificador de tipo [Int].

param([Int]$Number)

Parámetro Switch

Puede definir un parámetro de tipo switch usando el especificador de tipo [Switch] para crear un conmutador.

param([Switch]$Switch)

Enumeraciones

Puede usar valores System.Enum para crear cuadros de selección. Por ejemplo, podría usar System.DayOrWeek para crear un cuadro de selección del día de la semana.

param([System.DayOfWeek]$DayOfWeek)

PSCredential

Cuando especifica un PSCredential, se presentará al usuario un menú desplegable con las credenciales disponibles como variables.

param(
    [PSCredential]$Credential
)

File

Puede permitir que los usuarios suban ficheros usando el tipo [File].

param(
    [File]$File
)

Los ficheros estarán disponibles como un objeto PSUFile en sus scripts. Este objeto tiene una matriz byte[] que puede usar para procesar el fichero.

Por ejemplo, puede obtener el contenido de cadena del fichero convirtiéndolo mediante las clases Encoding.

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

Nombre para mostrar

Puede usar el DisplayNameAtrribute para establecer un nombre para mostrar para el parámetro del script.

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

Mensajes de ayuda

Puede definir mensajes de ayuda para sus parámetros usando la propiedad HelpMessage del atributo Parameter.

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

Parámetros obligatorios

Puede usar el atributo Parameter para definir parámetros obligatorios.

param(
    [Parameter(Mandatory)]
    $RequiredParameter
)

$RequiredParameter

Valor predeterminado

Puede usar valores estáticos y predeterminados para los parámetros. El valor predeterminado se calcula cuando el trabajo está a punto de ejecutarse.

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

$Parameter
$ExecutionTime

ValidateSet

El atributo ValidateSet se utiliza para imponer qué valores se pueden pasar a un parámetro. Obtenga información sobre ValidateSet aquí. PowerShell Universal creará automáticamente un menú desplegable con los valores proporcionados al atributo ValidateSet para los parámetros.

Por ejemplo, un script podría definir un bloque param de la siguiente manera.

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

El resultado se muestra a continuación.

Atributo ValidateSet

Pasar parámetros desde PowerShell

Puede pasar parámetros desde PowerShell usando el cmdlet Invoke-PSUScript. Este cmdlet admite parámetros dinámicos. Si tiene un bloque param en su script, estos parámetros se añadirán automáticamente a Invoke-PSUScript.

Por ejemplo, tenía un script llamado Script1.ps1 y su contenido era el siguiente.

param($MyParameter)

$MyParameter

Después podría invocar ese script usando esta sintaxis.

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

El resultado sería que Hello se muestra en el registro del trabajo y en la canalización.

Conjuntos de parámetros

PowerShell Universal admite conjuntos de parámetros. Cuando se define un conjunto de parámetros, se proporciona un menú desplegable que permite cambiar entre los conjuntos.

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

Conjuntos de parámetros