Update-ModuleManifest

Referenz

Modul:: PowerShellGet

Aktualisiert eine Modulmanifestdatei

Syntax

Update-ModuleManifest
      [-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[]>]
      [-PrivateData <Hashtable>]
      [-Tags <String[]>]
      [-ProjectUri <Uri>]
      [-LicenseUri <Uri>]
      [-IconUri <Uri>]
      [-ReleaseNotes <String[]>]
      [-Prerelease <String>]
      [-HelpInfoUri <Uri>]
      [-PassThru]
      [-DefaultCommandPrefix <String>]
      [-ExternalModuleDependencies <String[]>]
      [-PackageManagementProviders <String[]>]
      [-RequireLicenseAcceptance]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Beschreibung

Das Update-ModuleManifest Cmdlet aktualisiert eine Modulmanifestdatei (.psd1).

Beispiele

Beispiel 1: Aktualisieren eines Modulmanifests

In diesem Beispiel wird eine vorhandene Modulmanifestdatei aktualisiert. Das Splatting wird verwendet, um Parameterwerte an zu Update-ModuleManifestübergeben. Weitere Informationen finden Sie unter about_Splatting.

$Params = @{
  Path = "C:\Test\TestManifest.psd1"
  Author = "TestUser1"
  CompanyName = "Contoso Corporation"
  Copyright = "(c) 2019 Contoso Corporation. All rights reserved."
}

Update-ModuleManifest @Params

$Params ist ein Splat, der die Parameterwerte für Path, Author, CompanyName und Copyright speichert. Update-ModuleManifest ruft die Parameterwerte von ab @Params und aktualisiert das Modulmanifest TestManifest.psd1.

Parameter

-AliasesToExport

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

Verwenden Sie diesen Parameter, um die Aliase einzuschränken, die vom Modul exportiert werden. AliasesToExport kann Aliase aus der Liste der exportierten Aliase entfernen, aber der Liste keine Aliase hinzufügen.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-Author

Gibt den Autor des Moduls an.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ClrVersion

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

Hinweis

Diese Einstellung gilt nur für die PowerShell Desktop-Edition, z. B. Windows PowerShell 5.1, und gilt nur für .NET Framework Versionen niedriger als 4.5. Diese Anforderung hat keine Auswirkungen auf neuere Versionen von PowerShell oder die .NET Framework.

Type:	Version
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CmdletsToExport

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

Verwenden Sie diesen Parameter, um die Cmdlets einzuschränken, die vom Modul exportiert werden. CmdletsToExport kann Cmdlets aus der Liste der exportierten Cmdlets entfernen, kann der Liste jedoch keine Cmdlets hinzufügen.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-CompanyName

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CompatiblePSEditions

Gibt die kompatiblen PSEditionen des Moduls an. Informationen zu PSEdition finden Sie unter Module mit kompatiblen PowerShell-Editionen.

Type:	String[]
Accepted values:	Desktop, Core
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Fordert Sie zur Bestätigung auf, bevor Sie ausführen Update-ModuleManifest.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Copyright

Gibt eine Urheberrechtserklärung für das Modul an.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultCommandPrefix

Gibt das Standardbefehlspräfix an.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Description

Gibt eine Beschreibung des Moduls an.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DotNetFrameworkVersion

Gibt die für das Modul erforderliche Mindestversion des Microsoft .NET Framework an.

Hinweis

Type:	Version
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DscResourcesToExport

Gibt die Desired State Configuration (DSC)-Ressourcen an, die das Modul exportiert. Platzhalter sind zulässig.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ExternalModuleDependencies

Gibt ein Array externer Modulabhängigkeiten an.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FileList

Gibt alle Elemente an, die im Modul enthalten sind.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FormatsToProcess

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

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

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FunctionsToExport

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

Verwenden Sie diesen Parameter, um die Funktionen einzuschränken, die vom Modul exportiert werden. FunctionsToExport kann Funktionen aus der Liste der exportierten Aliase entfernen, der Liste jedoch keine Funktionen hinzufügen.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-Guid

Gibt einen eindeutigen Bezeichner für das Modul an. Die GUID kann verwendet werden, um Module mit dem gleichen Namen zu unterscheiden.

Type:	Guid
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-HelpInfoUri

Gibt die Internetadresse der Xml-Datei HelpInfo des Moduls an. Geben Sie einen URI (Uniform Resource Identifier) ein, der mit HTTP oder HTTPS beginnt.

Die XML-Datei HelpInfo unterstützt das aktualisierbare Hilfefeature, das in PowerShell Version 3.0 eingeführt wurde. Sie enthält Informationen zum Speicherort der herunterladbaren Hilfedateien des Moduls und die Versionsnummern der neuesten Hilfedateien für jedes unterstützte Gebietsschema.

Informationen zur aktualisierbaren Hilfe finden Sie unter about_Updatable_Help. Informationen zur XML-Datei HelpInfo finden Sie unter Unterstützung der aktualisierbaren Hilfe.

Type:	Uri
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-IconUri

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

Type:	Uri
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LicenseUri

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

Type:	Uri
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ModuleList

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

Geben Sie jeden Modulnamen als Zeichenfolge oder Hashtabelle mit den Schlüsseln ModuleName und ModuleVersion ein. Die Hashtabelle kann auch einen optionalen GUID-Schlüssel haben. Sie können Zeichenfolgen und Hashtabellen im Parameterwert kombinieren.

Dieser Schlüssel ist als Modulinventar konzipiert. Die Module, die im Wert dieses Schlüssels aufgeführt sind, werden nicht automatisch verarbeitet.

Type:	Object[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ModuleVersion

Gibt die Version des Moduls an.

Type:	Version
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-NestedModules

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

Type:	Object[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PackageManagementProviders

Gibt ein Array von Paketverwaltungsanbietern an.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PassThru

Gibt ein Objekt zurück, das das Element darstellt, mit dem Sie arbeiten. Standardmäßig Update-ModuleManifest generiert keine Ausgabe.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Path

Gibt den Pfad und dateinamen des Modulmanifests an. Geben Sie einen Pfad und einen Dateinamen mit einer .psd1 Dateinamenerweiterung ein, z $PSHOME\Modules\MyModule\MyModule.psd1. B. .

Wenn Sie den Pfad zu einer vorhandenen Datei angeben, ersetzt die Datei ohne Warnung, es sei denn, Update-ModuleManifest die Datei verfügt über das schreibgeschützte Attribut.

Das Manifest sollte sich im Verzeichnis des Moduls befinden, und der Name der Manifestdatei sollte mit dem Namen des Modulverzeichnisses übereinstimmen, jedoch mit einer .psd1 Erweiterung.

Sie können keine Variablen wie $PSHOME oder $HOMEals Reaktion auf eine Aufforderung zur Eingabe eines Path-Parameterwerts verwenden. Um eine Variable zu verwenden, schließen Sie den Path-Parameter in den Befehl ein.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-PowerShellHostName

Gibt den Namen des PowerShell-Hostprogramms an, das für das Modul erforderlich ist. Geben Sie den Namen des Hostprogramms ein, z. B. PowerShell ISE Host oder ConsoleHost. Wildcards sind nicht zulässig.

Um den Namen eines Hostprogramms zu ermitteln, geben Sie im Programm ein $Host.Name.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PowerShellHostVersion

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

Type:	Version
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PowerShellVersion

Gibt die Mindestversion von PowerShell an, die mit diesem Modul funktioniert. Sie können beispielsweise 3.0, 4.0 oder 5.0 als Wert dieses Parameters angeben.

Type:	Version
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Prerelease

Gibt an, dass es sich um eine Vorabversion des Moduls handelt.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PrivateData

Gibt Daten an, die beim Importieren an das Modul übergeben werden.

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ProcessorArchitecture

Gibt die Prozessorarchitektur an, die das Modul erfordert.

Zulässige Werte für diesen Parameter:

Amd64
Arm
IA64
MSIL
Keine (unbekannt oder nicht angegeben)
X86

Type:	ProcessorArchitecture
Accepted values:	None, MSIL, X86, IA64, Amd64, Arm
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ProjectUri

Gibt die URL einer Webseite zu diesem Projekt an.

Type:	Uri
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ReleaseNotes

Gibt ein Zeichenfolgenarray an, das Versionshinweise oder Kommentare enthält, die für diese Version des Skripts verfügbar sein sollen.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RequiredAssemblies

Gibt die Assemblydateien (.dll) an, die für das Modul erforderlich sind. Geben Sie die Namen der Assemblydateien ein. PowerShell lädt die angegebenen Assemblys, bevor Typen oder Formate aktualisiert, geschachtelte Module importiert oder die Moduldatei importiert wird, die im Wert des RootModule-Schlüssels angegeben ist.

Verwenden Sie diesen Parameter, um alle Assemblys anzugeben, die das Modul benötigt, einschließlich Assemblys, die geladen werden müssen, um alle Formatierungs- oder Typdateien zu aktualisieren, die in den Schlüsseln FormatsToProcess oder TypesToProcess aufgeführt sind, auch wenn diese Assemblys auch als binäre Module im Schlüssel NestedModules aufgeführt sind.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RequiredModules

Gibt die Module an, die im globalen Sitzungsstatus enthalten sein 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 Import-Module Befehl fehl.

Type:	Object[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RequireLicenseAcceptance

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RootModule

Gibt die primäre oder Stammdatei des Moduls an. Geben Sie den Dateinamen eines Skripts (.ps1), eines Skriptmoduls (.psm1), eines Modulmanifests (.psd1), einer Assembly (.dll), einer Cmdletdefinitions-XML-Datei (.cdxml) oder eines Workflows (.xaml) ein. Wenn das Modul importiert wird, werden die aus der Stammmodul-Datei exportierten Member in den Sitzungsstatus des Aufrufers importiert.

Wenn ein Modul über eine Manifestdatei verfügt und keine Stammdatei im RootModule-Schlüssel angegeben wurde, wird das Manifest zur primären Datei für das Modul. Und das Modul wird zu einem Manifestmodul (ModuleType = Manifest).

Zum Exportieren von Membern aus .psm1 oder .dll Dateien in einem Modul, das über ein Manifest verfügt, müssen die Namen dieser Dateien in den Werten der Schlüssel RootModule oder NestedModules im Manifest angegeben werden. Andernfalls werden ihre Member nicht exportiert.

In PowerShell 2.0 wurde dieser Schlüssel als ModuleToProcess bezeichnet.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ScriptsToProcess

Gibt Skriptdateien (.ps1) an, die im Sitzungszustand des Aufrufers ausgeführt werden, wenn das Modul importiert wird. Sie können diese Skripte zur Vorbereitung einer Umgebung verwenden, wie Sie ein Anmeldeskript verwenden würden.

Um Skripte anzugeben, die im Sitzungsstatus des Moduls ausgeführt werden, verwenden Sie den NestedModules-Schlüssel.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Tags

Gibt ein Array von Tags an.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TypesToProcess

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

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

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-VariablesToExport

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

Verwenden Sie diesen Parameter, um die Variablen einzuschränken, die vom Modul exportiert werden. VariablesToExport kann Variablen aus der Liste der exportierten Variablen entfernen, aber der Liste keine Variablen hinzufügen.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-WhatIf

Zeigt, was bei Ausführungen passieren Update-ModuleManifest würde. Das Cmdlet wird nicht ausgeführt.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Eingaben

String

Ausgaben

Object

Hinweise

Wichtig

Ab April 2020 unterstützt der PowerShell-Katalog die TLS-Versionen (Transport Layer Security) 1.0 und 1.1 nicht mehr. Wenn Sie nicht TLS 1.2 oder höher verwenden, erhalten Sie beim Versuch des Zugriffs auf den PowerShell-Katalog eine Fehlermeldung. Mit dem folgenden Befehl können Sie sicherstellen, dass Sie TLS 1.2 verwenden:

[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12

Weitere Informationen finden Sie im PowerShell-Blog in der Ankündigung.