| Server IP : 134.29.175.74 / Your IP : 216.73.216.160 Web Server : nginx/1.10.2 System : Windows NT CST-WEBSERVER 10.0 build 19045 (Windows 10) i586 User : Administrator ( 0) PHP Version : 7.1.0 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : OFF | Perl : OFF | Python : OFF | Sudo : OFF | Pkexec : OFF Directory : /Windows/System32/WindowsPowerShell/v1.0/en-US/ |
Upload File : |
ABOUT REQUIRES
Short description
Prevents a script from running without the required elements.
Long description
The #Requires statement prevents a script from running unless the
PowerShell version, modules (and version), or snap-ins (and version), and
edition prerequisites are met. If the prerequisites aren't met, PowerShell
doesn't run the script.
Syntax
#Requires -Assembly { <Path to .dll> | <.NET assembly specification> }
#Requires -Version <N>[.<n>]
#Requires -PSSnapin <PSSnapin-Name> [-Version <N>[.<n>]]
#Requires -Modules { <Module-Name> | <Hashtable> }
#Requires -PSEdition <PSEdition-Name>
#Requires -ShellId <ShellId> -PSSnapin <PSSnapin-Name> [-Version <N>[.<n>]]
#Requires -RunAsAdministrator
For more information about the syntax, see ScriptRequirements.
Rules for use
A script can include more than one #Requires statement. The #Requires
statements can appear on any line in a script.
Placing a #Requires statement inside a function does NOT limit its scope.
All #Requires statements are always applied globally, and must be met,
before the script can execute.
[!WARNING] Even though a #Requires statement can appear on any line in a
script, its position in a script does not affect the sequence of its
application. The global state the #Requires statement presents must be
met before script execution.
Example:
Get-Module AzureRM.Netcore | Remove-Module
#Requires -Modules AzureRM.Netcore
You might think that the above code shouldn't run because the required
module was removed before the #Requires statement. However, the #Requires
state had to be met before the script could even execute. Then the first
line of the script invalidated the required state.
Parameters
-Assembly <Assembly path> | <.NET assembly specification>
Specifies the path to the assembly DLL file or a .NET assembly name. The
ASSEMBLY parameter was introduced in PowerShell 5.0. For more information
about .NET assemblies, see Assembly names.
For example:
#Requires -Assembly path\to\foo.dll
#Requires -Assembly "System.Management.Automation, Version=3.0.0.0,
Culture=neutral, PublicKeyToken=31bf3856ad364e35"
-Version <N>[.<n>]
Specifies the minimum version of PowerShell that the script requires. Enter
a major version number and optional minor version number.
For example:
#Requires -Version 5.1
-PSSnapin <PSSnapin-Name> [-Version <N>[.<n>]]
Specifies a PowerShell snap-in that the script requires. Enter the snap-in
name and an optional version number.
For example:
#Requires -PSSnapin DiskSnapin -Version 1.2
-Modules <Module-Name> | <Hashtable>
Specifies PowerShell modules that the script requires. Enter the module
name and an optional version number.
If the required modules aren't in the current session, PowerShell imports
them. If the modules can't be imported, PowerShell throws a terminating
error.
For each module, type the module name (<String>) or a hash table. The value
can be a combination of strings and hash tables. The hash table has the
following keys.
- ModuleName - REQUIRED Specifies the module name.
- GUID - OPTIONAL Specifies the GUID of the module.
- It's also REQUIRED to specify one of the three below keys. These keys
can't be used together.
- ModuleVersion - Specifies a minimum acceptable version of the
module.
- RequiredVersion - Specifies an exact, required version of the
module.
- MaximumVersion - Specifies the maximum acceptable version of the
module.
[!NOTE] RequiredVersion was added in Windows PowerShell 5.0.
MaximumVersion was added in Windows PowerShell 5.1.
For example:
Require that Hyper-V (version 1.1 or greater) is installed.
#Requires -Modules @{ ModuleName="Hyper-V"; ModuleVersion="1.1" }
Requires that Hyper-V (ONLY version 1.1) is installed.
#Requires -Modules @{ ModuleName="Hyper-V"; RequiredVersion="1.1" }
Requires that Hyper-V (version 1.1 or lesser) is installed.
#Requires -Modules @{ ModuleName="Hyper-V"; MaximumVersion="1.1" }
Requires that any version of PSScheduledJob and PSWorkflow, is installed.
#Requires -Modules PSWorkflow, PSScheduledJob
When using the RequiredVersion key, ensure your version string exactly
matches the version string you wish to require.
Get-Module Hyper-V
ModuleType Version Name ExportedCommands
---------- ------- ---- ------------------
Binary 2.0.0.0 hyper-v {Add-VMAssignableDevice, ...}
The following example fails because 2.0.0 doesn't exactly match 2.0.0.0.
#Requires -Modules @{ ModuleName="Hyper-V"; RequiredVersion="2.0.0" }
-PSEdition <PSEdition-Name>
Specifies a PowerShell edition that the script requires. Valid values are
CORE for PowerShell Core and DESKTOP for Windows PowerShell.
For example:
#Requires -PSEdition Core
-ShellId
Specifies the shell that the script requires. Enter the shell ID. If you
use the SHELLID parameter, you must also include the PSSNAPIN parameter.
You can find the current SHELLID by querying the $ShellId automatic
variable.
For example:
#Requires -ShellId MyLocalShell -PSSnapin Microsoft.PowerShell.Core
[!NOTE] This parameter is intended for use in mini-shells, which have
been deprecated.
-RunAsAdministrator
When this switch parameter is added to your #Requires statement, it
specifies that the PowerShell session in which you're running the script
must be started with elevated user rights. The RUNASADMINISTRATOR parameter
is ignored on a non-Windows operating system. The RUNASADMINISTRATOR
parameter was introduced in PowerShell 4.0.
For example:
#Requires -RunAsAdministrator
Examples
The following script has two #Requires statements. If the requirements
specified in both statements aren't met, the script doesn't run. Each
#Requires statement must be the first item on a line:
#Requires -Modules PSWorkflow
#Requires -Version 3
Param
(
[parameter(Mandatory=$true)]
[String[]]
$Path
)
...
See also
about_Automatic_Variables
about_Language_Keywords
about_PSSnapins
Get-PSSnapin