about_Requires

  • Artigo

Aplica-se a: Windows PowerShell 2.0, Windows PowerShell 3.0

TÓPICO

about_Requires

DESCRIÇÃO BREVE

Impede que um script seja executado sem os elementos necessários.

DESCRIÇÃO LONGA

A instrução #Requires impede a execução de um script a menos que os pré-requisitos de snap-ins, módulos e versão do Windows PowerShell® e de versão do módulo e do snap-in sejam atendidos. Se os pré-requisitos não forem atendidos, o Windows PowerShell não executa o script.

Você pode usar instruções #Requires em qualquer script. Você não pode usá-las em funções, cmdlets ou snap-ins.

SINTAXE

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

REGRAS PARA USO

  • - A instrução #Requires deve ser o primeiro item em uma linha em um script.

  • - Um script pode incluir mais de uma instrução #Requires.

  • - As instruções #Requires podem aparecer em qualquer linha em um script.

PARÂMETROS

  -Version <N>[.<n>]

Especifica a versão mínima do Windows PowerShell que o script exige. Insira um número de versão principal e o número da versão secundária opcional.

Por exemplo:

        #Requires -Version 3.0

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

Especifica um snap-in do Windows PowerShell que o script exige. Insira o nome do snap-in e um número de versão opcional.

Por exemplo:

        #Requires –PSSnapin DiskSnapin -Version 1.2

  -Modules <Module-Name> | <Hashtable>

Especifica módulos do Windows PowerShell que o script exige. Insira o nome do módulo e um número de versão opcional. O parâmetro Modules é introduzido no Windows PowerShell 3.0.

Se os módulos necessários não estiverem na sessão atual, o Windows PowerShell os importa. Se não for possível importar os módulos, o Windows PowerShell gera um erro de encerramento.

Para cada módulo, digite o nome do módulo (<Cadeia de caracteres>) ou uma tabela de hash com as chaves a seguir. O valor pode ser uma combinação de cadeias de caracteres e tabelas de hash.

  • -- ModuleName. Essa chave é necessária.

  • -- ModuleVersion. Essa chave é necessária.

  • -- GUID. Essa chave é opcional.

Por exemplo,

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

  -ShellId

Especifica o shell que o script exige. Insira a ID do shell.

Por exemplo,

        #Requires –ShellId MyLocalShell

  -RunAsAdministrator

Quando esse parâmetro de opção é adicionado à sua instrução Requires, ele especifica que a sessão do Windows PowerShell na qual você está executando o script deve ser iniciada com direitos de usuário elevados (Executar como Administrador).

Por exemplo,

        #Requires -RunAsAdministrator

EXEMPLOS

O script a seguir tem duas instruções #Requires. Se os requisitos especificados em ambas as instruções não forem atendidos, o script não é executado. Cada instrução #Requires deve ser o primeiro item em uma linha:

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

OBSERVAÇÕES

No Windows PowerShell 3.0, os pacotes do Windows PowerShell Core aparecem como módulos em sessões iniciadas usando o método InitialSessionState.CreateDefault2, como as sessões iniciadas no console Windows PowerShell. Caso contrário, eles aparecerem como snap-ins. A exceção é Microsoft.PowerShell.Core, que é sempre um snap-in.

CONSULTE TAMBÉM

about_Automatic_Variables

about_Language_Keyword

about_PSSnapins

get-PSSnapin