Freigeben über

Update-PSModuleManifest

  • Referenz
Modul:
Microsoft.PowerShell.PSResourceGet

Aktualisiert eine Modulmanifestdatei.

Syntax

Update-PSModuleManifest
      [-Path] <String>
      [-NestedModules <Object[]>]
      [-Guid <Guid>]
      [-Author <String>]
      [-CompanyName <String>]
      [-Copyright <String>]
      [-RootModule <String>]
      [-ModuleVersion <Version>]
      [-Description <String>]
      [-ProcessorArchitecture <ProcessorArchitecture>]
      [-CompatiblePSEditions <String[]>]
      [-PowerShellVersion <Version>]
      [-ClrVersion <Version>]
      [-DotNetFrameworkVersion <Version>]
      [-PowerShellHostName <String>]
      [-PowerShellHostVersion <Version>]
      [-RequiredModules <Object[]>]
      [-TypesToProcess <String[]>]
      [-FormatsToProcess <String[]>]
      [-ScriptsToProcess <String[]>]
      [-RequiredAssemblies <String[]>]
      [-FileList <String[]>]
      [-ModuleList <Object[]>]
      [-FunctionsToExport <String[]>]
      [-AliasesToExport <String[]>]
      [-VariablesToExport <String[]>]
      [-CmdletsToExport <String[]>]
      [-DscResourcesToExport <String[]>]
      [-Tags <String[]>]
      [-ProjectUri <Uri>]
      [-LicenseUri <Uri>]
      [-IconUri <Uri>]
      [-ReleaseNotes <String>]
      [-Prerelease <String>]
      [-HelpInfoUri <Uri>]
      [-DefaultCommandPrefix <String>]
      [-ExternalModuleDependencies <String[]>]
      [-RequireLicenseAcceptance]
      [-PrivateData <Hashtable>]
      [<CommonParameters>]

Beschreibung

Dieses Cmdlet aktualisiert die in einer Modulmanifestdatei gespeicherten Daten. Mit den Parametern können Sie angeben, welche Eigenschaften aktualisiert werden. Update-PSModuleManifest überschreibt alle vorhandenen Werte im Modulmanifest.

Das Cmdlet gibt kein Objekt zurück.

Beispiele

Beispiel 1

In diesem Beispiel wird die eigenschaft Author im Modulmanifest in New Authorgeändert.

Update-PSModuleManifest -Path 'C:\MyModules\TestModule' -Author 'New Author'

Beispiel 2

In diesem Beispiel wird die Prerelease-Eigenschaft in beta2geändert.

Update-PSModuleManifest -Path 'C:\MyModules\TestModule' -Prerelease 'beta2'

Beispiel 3

In diesem Beispiel werden mehrere Eigenschaften aktualisiert.

$parameters = @{
    Path = 'C:\MyModules\TestModule'
    Tags = 'Windows', 'Linux'
    Description = 'A module for managing packages.'
}
Update-PSModuleManifest

Parameter

-AliasesToExport

Gibt die Aliase an, die das Modul exportiert. Wildcards sind zulässig.

Typ:String[]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:True

-Author

Gibt den Modulautor an.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ClrVersion

Gibt die Mindestversion der Common Language Runtime (CLR) von Microsoft .NET Framework an, die für das Modul erforderlich ist.

Typ:Version
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-CmdletsToExport

Gibt die Cmdlets an, die das Modul exportiert. Wildcards sind zulässig.

Typ:String[]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:True

-CompanyName

Gibt das Unternehmen oder den Anbieter an, das das Modul erstellt hat.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-CompatiblePSEditions

Gibt die kompatible PSEditions- des Moduls an. Informationen zu PSEditionfinden Sie unter Modules with compatible PowerShell Editions.

Typ:String[]
Zulässige Werte:Desktop, Core
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Copyright

Gibt eine Copyright-Anweisung für das Modul an.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-DefaultCommandPrefix

Gibt das Standardbefehlspräfix an.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Description

Gibt eine Beschreibung des Moduls an.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-DotNetFrameworkVersion

Gibt die Mindestversion von Microsoft .NET Framework an, die vom Modul benötigt wird.

Typ:Version
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-DscResourcesToExport

Gibt die DSC-Ressourcen (Desired State Configuration) an, die vom Modul exportiert werden. Wildcards sind zulässig.

Typ:String[]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:True

-ExternalModuleDependencies

Gibt ein Array externer Modulabhängigkeiten an.

Typ:String[]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-FileList

Gibt alle Elemente an, die im Modul enthalten sind.

Typ:String[]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-FormatsToProcess

Gibt die Formatierungsdateien (.ps1xml) an, die beim Importieren des Moduls verarbeitet werden.

Wenn Sie ein Modul importieren, führt PowerShell das cmdlet Update-FormatData mit den angegebenen Dateien aus. Da Formatierungsdateien nicht auf den Bereich festgelegt sind, wirken sie sich auf alle Sitzungszustände in der Sitzung aus.

Typ:String[]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-FunctionsToExport

Gibt die Funktionen an, die das Modul exportiert. Wildcards sind zulässig.

Typ:String[]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:True

-Guid

Gibt einen eindeutigen Bezeichner für das Modul an. Die GUID- wird verwendet, um zwischen Modulen mit demselben Namen zu unterscheiden.

Typ:Guid
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-HelpInfoUri

Gibt die Internetadresse der XML-Datei des Moduls an. Geben Sie einen URI (Uniform Resource Identifier) ein, der mit http: oder https:beginnt.

Weitere Informationen finden Sie unter Aktualisierbare Hilfe.

Typ:Uri
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-IconUri

Gibt den URI eines Symbols für das Modul an. Das angegebene Symbol wird auf der Katalogwebseite für das Modul angezeigt.

Typ:Uri
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-LicenseUri

Gibt die URL der Lizenzierungsbedingungen für das Modul an.

Typ:Uri
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ModuleList

Gibt ein Array von Modulen an, die im Modul enthalten sind.

Geben Sie jeden Modulnamen als Zeichenfolge oder als Hashtable mit ModuleName- und ModuleVersion--Schlüssel ein. Die Hashtabelle kann auch über einen optionalen GUID--Schlüssel verfügen. Sie können Zeichenfolgen und Hashtables im Parameterwert kombinieren.

Dieser Schlüssel dient als Modulbestand.

Typ:Object[]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ModuleVersion

Gibt die Version des Moduls an.

Typ:Version
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-NestedModules

Gibt Skriptmodule (.psm1) und binäre Module (.dll) an, die in den Sitzungszustand des Moduls importiert werden. Die Dateien in den NestedModules Schlüssel werden in der Reihenfolge ausgeführt, in der sie aufgelistet sind.

Geben Sie jeden Modulnamen als Zeichenfolge oder als Hashtable mit ModuleName- und ModuleVersion--Schlüssel ein. Die Hashtabelle kann auch über einen optionalen GUID--Schlüssel verfügen. Sie können Zeichenfolgen und Hashtables im Parameterwert kombinieren.

Typ:Object[]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Path

Gibt den Pfad und Dateinamen des Modulmanifests an. Geben Sie den Dateinamen mit einer .psd1 Dateierweiterung ein.

Typ:String
Position:0
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-PowerShellHostName

Gibt den Namen des PowerShell-Hostprogramms an, das das Modul benötigt. Geben Sie den Namen des Hostprogramms ein, z. B. PowerShell ISE-Host oder ConsoleHost. Wildcards sind nicht zulässig.

Der Name eines Hostprogramms wird in $Host.Namegespeichert.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-PowerShellHostVersion

Gibt die Mindestversion des PowerShell-Hostprogramms an, das mit dem Modul funktioniert. Geben Sie eine Versionsnummer ein, z. B. 1.1.

Typ:Version
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-PowerShellVersion

Gibt die Mindestversion von PowerShell an, die mit diesem Modul funktioniert. Sie können z. B. Versionen wie 5.1 oder 7.2angeben.

Typ:Version
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Prerelease

Gibt den Vorabversionswert an, der an die Modulversion angefügt wird. Wenn z. B. Prerelease-preview ist und die ModuleVersion-1.0.0ist, wird die Version des Moduls 1.0.0-preview.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-PrivateData

Gibt Daten an, die beim Importieren an das Modul übergeben werden. Dabei kann es sich um beliebige Werte handeln, die in einer Hashtabelle gespeichert sind.

Typ:Hashtable
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ProcessorArchitecture

Gibt die Prozessorarchitektur an, die das Modul benötigt.

Die zulässigen Werte für diesen Parameter sind:

  • Amd64
  • Arm
  • IA64
  • MSIL
  • None (unbekannt oder nicht angegeben)
  • X86
Typ:ProcessorArchitecture
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ProjectUri

Gibt den URI einer Webseite zu diesem Projekt an.

Typ:Uri
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ReleaseNotes

Gibt eine Zeichenfolge an, die Versionshinweise oder Kommentare für das Modul enthält.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-RequiredAssemblies

Gibt die Assemblydateien (.dll) an, die vom Modul benötigt werden. PowerShell lädt die angegebenen Assemblys, bevor Typen oder Formate aktualisiert, geschachtelte Module importiert oder die im RootModule Schlüssel angegebene Moduldatei importiert werden.

Verwenden Sie RequiredAssemblies- für Assemblys, die geladen werden müssen, um formatierungs- oder Typdateien zu aktualisieren, die im FormatsToProcess-- oder TypesToProcess- Schlüssel aufgelistet sind, auch wenn diese Assemblys auch im NestedModules Schlüssel aufgeführt sind.

Typ:String[]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-RequiredModules

Gibt Module an, die sich im globalen Sitzungszustand befinden müssen. Wenn sich die erforderlichen Module nicht im globalen Sitzungszustand befinden, importiert PowerShell sie. Wenn die erforderlichen Module nicht verfügbar sind, schlägt der Befehl Import-Module fehl.

Der Wert kann ein Array sein, das Modulnamen oder Modulspezifikationen enthält. Eine Modulspezifikation ist eine Hashtabelle mit den folgenden Schlüsseln.

  • ModuleName - Erforderlicher Gibt den Modulnamen an.
  • GUID - Optionaler Gibt die GUID des Moduls an.
  • Außerdem Erforderlicher, um mindestens einen der drei folgenden Tasten anzugeben.
    • ModuleVersion – Gibt eine akzeptable Mindestversion 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.
Typ:Object[]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-RequireLicenseAcceptance

Gibt an, dass für das Modul eine Lizenzakzeptanz erforderlich ist.

Typ:SwitchParameter
Position:Named
Standardwert:False
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-RootModule

Gibt die primäre oder Stammdatei des Moduls an. Geben Sie den Dateinamen eines Skripts (.ps1), ein Skriptmodul (.psm1), ein Modulmanifest (.psd1), eine Assembly (.dll) oder eine XML-Cmdlet-Definitionsdatei (.cdxml) ein. Wenn das Modul importiert wird, werden die aus dem Stammmodul exportierten Elemente in den Sitzungszustand des Aufrufers importiert.

Wenn ein Modul über eine Manifestdatei verfügt und keine Datei im RootModule Schlüssel angegeben wird, wird das Manifest zur primären Datei für das Modul. Das Modul wird als Manifestmodul (ModuleType = Manifest) bezeichnet.

Um Member aus .psm1- oder .dll-Dateien zu exportieren, müssen die Namen dieser Dateien in den Werten der RootModule- oder NestedModules Schlüssel im Manifest angegeben werden.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ScriptsToProcess

Gibt Skriptdateien (.ps1) an, die beim Importieren des Moduls im Sitzungszustand des Aufrufers ausgeführt werden. Sie können diese Skripts verwenden, um eine Umgebung vorzubereiten, genauso wie Sie ein Anmeldeskript verwenden können.

Um Skripts anzugeben, die im Sitzungszustand des Moduls ausgeführt werden, verwenden Sie die NestedModules Schlüssel.

Typ:String[]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Tags

Gibt ein Array von Tags an.

Typ:String[]
Aliase:Tag
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-TypesToProcess

Gibt die Typdateien (.ps1xml) an, die beim Importieren des Moduls ausgeführt werden.

Wenn Sie das Modul importieren, führt PowerShell das cmdlet Update-TypeData mit den angegebenen Dateien aus. Da Typdateien nicht auf den Bereich festgelegt sind, wirken sie sich auf alle Sitzungszustände in der Sitzung aus.

Typ:String[]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-VariablesToExport

Gibt die Variablen an, die das Modul exportiert. Wildcards sind zulässig.

Verwenden Sie diesen Parameter, um einzuschränken, welche Variablen vom Modul exportiert werden.

Typ:String[]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:True

Eingaben

None

Ausgaben

Hinweise

Eine vollständige Beschreibung der Modulmanifestdatei finden Sie unter about_Module_Manifests.