about_Requires
簡単な説明
スクリプトが必要な要素なしで実行されないようにします。
詳細な説明
#Requires ステートメントを使用すると、PowerShell のバージョン、モジュール (およびバージョン)、エディションの前提条件が満たされていない限り、スクリプトが実行されなくなります。 前提条件が満たされていない場合、PowerShell ではスクリプトが実行されず、タブ補完などの他のランタイム機能も提供されません。
構文
#Requires -Version <N>[.<n>]
#Requires -Modules { <Module-Name> | <Hashtable> }
#Requires -PSEdition <PSEdition-Name>
#Requires -RunAsAdministrator
構文の詳細については、「 ScriptRequirementsを参照してください。
使用する規則
スクリプトには、複数の #Requires ステートメントを含めることができます。 #Requiresステートメントは、スクリプト内の任意の行に表示できます。
関数内に #Requires ステートメントを配置しても、そのスコープは制限されません。 すべての #Requires ステートメントは常にグローバルに適用され、スクリプトを実行する前に満たす必要があります。
警告
#Requiresステートメントはスクリプト内の任意の行に表示できますが、スクリプト内での位置はアプリケーションのシーケンスに影響しません。 #Requires ステートメントが提示するグローバル状態は、スクリプトの実行前に満たす必要があります。
例:
Get-Module AzureRM.Netcore | Remove-Module
#Requires -Modules AzureRM.Netcore
必要なモジュールが #Requires ステートメントの前に削除されたため、上記のコードを実行すべきではない可能性があります。 ただし、スクリプトを実行する前に、 #Requires 状態を満たす必要がありました。 その後、スクリプトの最初の行で必要な状態が無効になりました。
パラメーター
-Assembly <Assembly パス> | <。NET アセンブリの仕様>
重要
-Assembly構文は非推奨です。 これは関数を提供しません。 構文は PowerShell 5.1 で追加されましたが、サポート コードは実装されませんでした。 構文は下位互換性のために引き続き受け入れられます。
アセンブリ DLL ファイルまたは .NET アセンブリ名へのパスを指定します。 Assembly パラメーターは、PowerShell 5.0 で導入されました。 .NET アセンブリの詳細については、「 Assembly の名前を参照してください。
次に例を示します。
#Requires -Assembly path\to\foo.dll
#Requires -Assembly "System.Management.Automation, Version=3.0.0.0,
Culture=neutral, PublicKeyToken=31bf3856ad364e35"
-Version <N>[.<n>]
スクリプトに必要な PowerShell の最小バージョンを指定します。 メジャー バージョン番号とオプションのマイナー バージョン番号を入力します。
次に例を示します。
#Requires -Version 6.0
-Modules <Module-Name> | <Hashtable>
スクリプトに必要な PowerShell モジュールを指定します。 モジュール名とオプションのバージョン番号を入力します。
必要なモジュールが現在のセッションにない場合は、PowerShell によってインポートされます。 モジュールをインポートできない場合、PowerShell は終了エラーをスローします。
#Requires ステートメントでは、モジュール内のクラス定義と列挙定義は読み込まれません。 スクリプトの先頭にある using module ステートメントを使用して、クラス定義や列挙定義を含むモジュールをインポートします。 詳細については、「 about_Using」を参照してください。
モジュールごとに、モジュール名 (<String>) またはハッシュテーブルを入力します。 値には、文字列とハッシュテーブルの組み合わせを指定できます。 ハッシュテーブルには次のキーがあります。
ModuleName- 必須 モジュール名を指定します。GUID- 省略可能 モジュールの GUID を指定します。- また、以下の 3 つのキーのうち少なくとも 1 つを指定Required です。
ModuleVersion- モジュールの最小許容バージョンを指定します。MaximumVersion- モジュールの許容される最大バージョンを指定します。RequiredVersion- モジュールの正確で必要なバージョンを指定します。 これは、他のバージョン キーでは使用できません。
Note
RequiredVersion は Windows PowerShell 5.0 で追加されました。
MaximumVersion は Windows PowerShell 5.1 で追加されました。
次に例を示します。
AzureRM.Netcore (バージョン 0.12.0 以上) をインストールする必要があります。
#Requires -Modules @{ ModuleName="AzureRM.Netcore"; ModuleVersion="0.12.0" }
AzureRM.Netcore (only バージョン 0.12.0) がインストールされている必要があります。
#Requires -Modules @{ ModuleName="AzureRM.Netcore"; RequiredVersion="0.12.0" }
AzureRM.Netcore (バージョン 0.12.0 以下) がインストールされている必要があります。
#Requires -Modules @{ ModuleName="AzureRM.Netcore"; MaximumVersion="0.12.0" }
任意のバージョンの AzureRM.Netcore と PowerShellGet をインストールする必要があります。
#Requires -Modules AzureRM.Netcore, PowerShellGet
RequiredVersion キーを使用する場合は、バージョン文字列が必要なバージョン文字列と正確に一致していることを確認します。
Get-Module AzureRM.Netcore -ListAvailable
Directory: /home/azureuser/.local/share/powershell/Modules
ModuleType Version Name PSEdition ExportedCommands
---------- ------- ---- --------- ----------------
Script 0.12.0 AzureRM.Netcore Core
次の例は、 0.12 が 0.12.0 と正確に一致しないために失敗します。
#Requires -Modules @{ ModuleName="AzureRM.Netcore"; RequiredVersion="0.12" }
-PSEdition <PSEdition-Name>
スクリプトに必要な PowerShell エディションを指定します。 有効な値は、PowerShell の場合は Core 、Windows PowerShell の場合は Desktop です。
次に例を示します。
#Requires -PSEdition Core
-RunAsAdministrator
この switch パラメーターを #Requires ステートメントに追加すると、スクリプトを実行している PowerShell セッションを管理者特権で開始する必要があることを指定します。 Windows 以外のオペレーティング システムでは、 RunAsAdministrator パラメーターは無視されます。 RunAsAdministrator パラメーターは、PowerShell 4.0 で導入されました。
次に例を示します。
#Requires -RunAsAdministrator
例
次のスクリプトには、2 つの #Requires ステートメントがあります。 両方のステートメントで指定された要件が満たされていない場合、スクリプトは実行されません。 各 #Requires ステートメントは、行の最初の項目である必要があります。
#Requires -Modules AzureRM.Netcore
#Requires -Version 6.0
Param
(
[parameter(Mandatory=$true)]
[String[]]
$Path
)
...
関連項目
PowerShell