Поделиться через

about_Requires

Назначение: Windows PowerShell 2.0, Windows PowerShell 3.0

РАЗДЕЛ

about_Requires

КРАТКОЕ ОПИСАНИЕ

Запрещает запуск сценария без необходимых элементов.

ПОДРОБНОЕ ОПИСАНИЕ

Оператор #Requires запрещает запуск сценария, если не выполняются требования к версии, модулям, оснасткам и версиям оснасток Windows PowerShell®. Если необходимые условия не выполнены, Windows PowerShell не выполняет сценарий.

Операторы #Requires можно использовать в любом сценарии. Их нельзя использовать в функциях, командлетах или оснастках.

СИНТАКСИС

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

ПРАВИЛА ИСПОЛЬЗОВАНИЯ

  • – Оператор #Requires должен быть первым элементом в строке сценария.

  • – Сценарий может содержать несколько операторов #Requires.

  • – Операторы #Requires могут использоваться в любой строке сценария.

ПАРАМЕТРЫ

  -Version <N>[.<n>]

Указывает минимальную версию Windows PowerShell, необходимую сценарию. Введите основной номер версии и при необходимости дополнительный номер версии.

Например:

        #Requires -Version 3.0

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

Указывает оснастку Windows PowerShell, необходимую сценарию. Введите имя оснастки и при необходимости номер версии.

Например:

        #Requires –PSSnapin DiskSnapin -Version 1.2

  -Modules <Module-Name> | <Hashtable>

Указывает модули Windows PowerShell, необходимые сценарию. Введите имя модуля и при необходимости номер версии. Параметр Modules появился в Windows PowerShell 3.0.

Если необходимые модули отсутствуют в текущем сеансе, Windows PowerShell импортирует их. Если импортировать модули не удается, Windows PowerShell выдает неустранимую ошибку.

Для каждого модуля введите его имя (<Строка>) или хэш-таблицу с указанными ниже ключами. Значение может быть сочетанием строк и хэш-таблиц.

  • -- ModuleName. Этот ключ обязателен.

  • -- ModuleVersion. Этот ключ обязателен.

  • -- GUID. Этот ключ необязателен.

Например,

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

  -ShellId

Указывает оболочку, необходимую сценарию. Введите идентификатор оболочки.

Например,

        #Requires –ShellId MyLocalShell

  -RunAsAdministrator

При добавлении этого параметра в оператор requires он указывает на то, что сеанс Windows PowerShell, в котором выполняется сценарий, должен быть запущен с повышенными правами пользователя («Запуск от имени администратора»).

Например,

        #Requires -RunAsAdministrator

ПРИМЕРЫ

Приведенный ниже сценарий содержит два оператора #Requires. Если требования, указанные в обоих операторах, не выполняются, сценарий не запускается. Каждый оператор #Requires должен быть первым элементом в строке:

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

ПРИМЕЧАНИЯ

В Windows PowerShell 3.0 основные пакеты Windows PowerShell представлены в виде модулей в рамках сеансов, запущенных с помощью метода InitialSessionState.CreateDefault2, например сеансов, запущенных в консоли Windows PowerShell. В противном случае они представлены как оснастки. Исключение составляет модуль Microsoft.PowerShell.Core, который всегда является оснасткой.

СМ. ТАКЖЕ

about_Automatic_Variables

about_Language_Keyword

about_PSSnapins

get-PSSnapin