about_Requires

  • Artículo

Se aplica a: Windows PowerShell 4.0, Windows PowerShell 5.0

TEMA

about_Requires

DESCRIPCIÓN BREVE

Impide que un script se ejecute sin los elementos necesarios.

DESCRIPCIÓN LARGA

La instrucción #Requires impide que un script se ejecute a menos que se cumplan los requisitos previos de la versión, los módulos, los complementos y la versión de módulo y complemento de Windows PowerShell®. Si no se cumplen los requisitos previos, Windows PowerShell no ejecuta el script.

Puede usar instrucciones #Requires en cualquier script. No puede usarlas en funciones, cmdlets o complementos.

SINTAXIS

          #Requires -Version <N>[.<n>] 
          #Requires –PSSnapin <PSSnapin-Name> [-Version <N>[.<n>]]
          #Requires -Modules { <Module-Name> | <Hashtable> } 
          #Requires –ShellId <ShellId>
          #Requires -RunAsAdministrator

REGLAS DE USO

  • - La instrucción #Requires debe ser el primer elemento de una línea de script.

  • - Un script puede incluir más de una instrucción #Requires.

  • - Las instrucciones #Requires pueden aparecer en cualquier línea de un script.

PARÁMETROS

  -Version <N>[.<n>]

Especifica la versión mínima de Windows PowerShell que el script requiere. Escriba un número de versión principal y el número de versión secundaria opcional.

Por ejemplo:

        #Requires -Version 3.0

  -PSSnapin <PSSnapin-Name> [-Version <N>[.<n>]]

Especifica un complemento de Windows PowerShell que el script requiere. Escriba el nombre del complemento y un número de versión opcional.

Por ejemplo:

        #Requires –PSSnapin DiskSnapin -Version 1.2

  -Modules <Module-Name> | <Hashtable>

Especifica los módulos de Windows PowerShell que el script requiere. Escriba el nombre del módulo y un número de versión opcional. El parámetro Modules se introdujo en Windows PowerShell 3.0.

Si los módulos necesarios no están en la sesión actual, Windows PowerShell los importa. Si no es posible importar los módulos, Windows PowerShell genera un error de terminación.

Para cada módulo, escriba el nombre del módulo (<String>) o una tabla hash con las claves siguientes. El valor puede ser una combinación de cadenas y tablas hash.

  • -- ModuleName. Esta clave es obligatoria.

  • -- ModuleVersion. Esta clave es obligatoria.

  • -- GUID. Esta clave es opcional.

Por ejemplo,

        #Requires -Modules PSWorkflow, @{ModuleName="PSScheduledJob";ModuleVersion=1.0.0.0}

  -ShellId

Especifica el shell que el script requiere. Escriba el identificador de shell.

Por ejemplo,

        #Requires –ShellId MyLocalShell

  -RunAsAdministrator

Cuando este parámetro de modificador se agrega a la instrucción Requires, especifica que la sesión de Windows PowerShell en la que se está ejecutando el script debe iniciarse con derechos de usuario elevados (Ejecutar como administrador).

Por ejemplo,

        #Requires -RunAsAdministrator

EJEMPLOS

El script siguiente tiene dos instrucciones #Requires. Si no se cumplen los requisitos especificados en ambas instrucciones, el script no se ejecuta. Cada instrucción #Requires debe ser el primer elemento de una línea:

          #Requires –Modules PSWorkflow
          #Requires –Version 3
          Param
         (
             [parameter(Mandatory=$true)]
             [String[]]
             $Path
         )
         ...

NOTAS

En Windows PowerShell 3.0, los paquetes principales de Windows PowerShell aparecen como módulos en las sesiones que se inician con el método InitialSessionState.CreateDefault2, como las sesiones iniciadas en la consola de Windows PowerShell. En caso contrario, aparecen como complementos. La excepción es Microsoft.PowerShell.Core, que siempre es un complemento.

VEA TAMBIÉN

about_Automatic_Variables

about_Language_Keyword

about_PSSnapins

get-PSSnapin