about_Requires
Kurze Beschreibung
Verhindert, dass ein Skript ohne die erforderlichen Elemente ausgeführt wird.
Lange Beschreibung
Die #Requires Anweisung verhindert, dass ein Skript ausgeführt wird, es sei denn, die PowerShell-Version, -Module (und -Version) und die Edition-Voraussetzungen sind erfüllt. Wenn die Voraussetzungen nicht erfüllt sind, führt PowerShell das Skript nicht aus oder stellt andere Laufzeitfeatures bereit, z. B. den Abschluss der Registerkarte.
Syntax
#Requires -Version <N>[.<n>]
#Requires -Modules { <Module-Name> | <Hashtable> }
#Requires -PSEdition <PSEdition-Name>
#Requires -RunAsAdministrator
Weitere Informationen zur Syntax finden Sie unter ScriptRequirements.
Regeln für die Verwendung
Ein Skript kann mehrere #Requires Anweisungen enthalten. Die #Requires Anweisungen können in einer beliebigen Zeile in einem Skript angezeigt werden.
Das Platzieren einer #Requires Anweisung in einer Funktion beschränkt den Umfang nicht. Alle #Requires Anweisungen werden immer global angewendet und müssen erfüllt werden, bevor das Skript ausgeführt werden kann.
Warnung
Obwohl eine #Requires Anweisung in einer zeile in einem Skript angezeigt werden kann, wirkt sich die Position in einem Skript nicht auf die Reihenfolge der Anwendung aus. Der globale Zustand, den die #Requires Anweisung darstellt, muss vor der Skriptausführung erfüllt werden.
Beispiel:
Get-Module AzureRM.Netcore | Remove-Module
#Requires -Modules AzureRM.Netcore
Möglicherweise denken Sie, dass der obige Code nicht ausgeführt werden sollte, da das erforderliche Modul vor der #Requires Anweisung entfernt wurde. Der Zustand musste jedoch erfüllt werden, #Requires bevor das Skript sogar ausgeführt werden konnte. Dann hat die erste Zeile des Skripts den erforderlichen Zustand ungültig.
Parameter
-Assemblyassemblypfad <> | <. NET-Assemblyspezifikation>
Wichtig
Die -Assembly Syntax ist veraltet. Es dient keine Funktion. Die Syntax wurde in PowerShell 5.1 hinzugefügt, der unterstützende Code wurde jedoch nie implementiert. Die Syntax wird weiterhin aus Gründen der Abwärtskompatibilität akzeptiert.
Gibt den Pfad zur Assembly-DLL-Datei oder einen .NET-Assemblynamen an. Der Assembly-Parameter wurde in PowerShell 5.0 eingeführt. Weitere Informationen zu .NET-Assemblys finden Sie unter Assemblynamen.
Zum Beispiel:
#Requires -Assembly path\to\foo.dll
#Requires -Assembly "System.Management.Automation, Version=3.0.0.0,
Culture=neutral, PublicKeyToken=31bf3856ad364e35"
-Version <N>[.<n>]
Gibt die Mindestversion von PowerShell an, die für das Skript erforderlich ist. Geben Sie eine Hauptversionsnummer und optionale Nebenversionsnummer ein.
Zum Beispiel:
#Requires -Version 6.0
-Module-Modulname <> | <Hashtabelle>
Gibt PowerShell-Module an, die für das Skript erforderlich sind. Geben Sie den Modulnamen und eine optionale Versionsnummer ein.
Wenn sich die erforderlichen Module nicht in der aktuellen Sitzung befinden, importiert PowerShell sie. Wenn die Module nicht importiert werden können, löst PowerShell einen Beendigungsfehler aus.
Die #Requires Anweisung lädt keine Klassen- und Enumerationsdefinitionen im Modul. Verwenden Sie die using module Anweisung am Anfang ihres Skripts, um das Modul zu importieren, einschließlich der Klassen- und Enumerationsdefinitionen. Weitere Informationen finden Sie unter about_Using.
Geben Sie für jedes Modul den Modulnamen (<String>) oder eine Hashtabelle ein. Der Wert kann eine Kombination aus Zeichenfolgen und Hashtabellen sein. Die Hashtabelle verfügt über die folgenden Schlüssel.
ModuleName- Erforderlich . Gibt den Modulnamen an.GUID- Optional Gibt die GUID des Moduls an.- Es ist auch erforderlich , mindestens eine der drei folgenden Tasten anzugeben.
ModuleVersion- Gibt eine mindestens akzeptable Version des Moduls an.MaximumVersion- Gibt die maximal zulässige Version des Moduls an.RequiredVersion- Gibt eine genaue, erforderliche Version des Moduls an. Dies kann nicht mit den anderen Versionsschlüsseln verwendet werden.
Hinweis
RequiredVersion wurde in Windows PowerShell 5.0 hinzugefügt.
MaximumVersion wurde in Windows PowerShell 5.1 hinzugefügt.
Zum Beispiel:
Erfordert, dass AzureRM.Netcore (Version 0.12.0 oder höher) installiert ist.
#Requires -Modules @{ ModuleName="AzureRM.Netcore"; ModuleVersion="0.12.0" }
Erfordert, dass AzureRM.Netcore (nur Version 0.12.0) installiert ist.
#Requires -Modules @{ ModuleName="AzureRM.Netcore"; RequiredVersion="0.12.0" }
Erfordert, dass AzureRM.Netcore (Version 0.12.0 oder kleiner) installiert ist.
#Requires -Modules @{ ModuleName="AzureRM.Netcore"; MaximumVersion="0.12.0" }
Fordern Sie an, dass eine beliebige Version von AzureRM.Netcore und PowerShellGet installiert ist.
#Requires -Modules AzureRM.Netcore, PowerShellGet
Stellen Sie bei Verwendung des Schlüssels RequiredVersion sicher, dass die Versionszeichenfolge exakt mit der erforderlichen Versionszeichenfolge übereinstimmt.
Get-Module AzureRM.Netcore -ListAvailable
Directory: /home/azureuser/.local/share/powershell/Modules
ModuleType Version Name PSEdition ExportedCommands
---------- ------- ---- --------- ----------------
Script 0.12.0 AzureRM.Netcore Core
Das folgende Beispiel schlägt fehl, da 0.12 nicht exakt mit 0.12.0 übereinstimmt.
#Requires -Modules @{ ModuleName="AzureRM.Netcore"; RequiredVersion="0.12" }
-PSEdition <PSEdition-Name>
Gibt eine PowerShell-Edition an, die das Skript erfordert. Gültige Werte sind Core für PowerShell und Desktop für Windows PowerShell.
Zum Beispiel:
#Requires -PSEdition Core
-RunAsAdministrator
Wenn dieser Switch-Parameter Zu Ihrer #Requires Anweisung hinzugefügt wird, gibt er an, dass die PowerShell-Sitzung, in der Sie das Skript ausführen, mit erhöhten Benutzerrechten gestartet werden muss. Der RunAsAdministrator-Parameter wird auf einem Nicht-Windows-Betriebssystem ignoriert. Der RunAsAdministrator-Parameter wurde in PowerShell 4.0 eingeführt.
Zum Beispiel:
#Requires -RunAsAdministrator
Beispiele
Das folgende Skript enthält zwei #Requires Anweisungen. Wenn die in beiden Anweisungen angegebenen Anforderungen nicht erfüllt sind, wird das Skript nicht ausgeführt. Jede #Requires Anweisung muss das erste Element in einer Zeile sein:
#Requires -Modules AzureRM.Netcore
#Requires -Version 6.0
Param
(
[parameter(Mandatory=$true)]
[String[]]
$Path
)
...
