New-ModuleManifest

Referenz

Modul:: Microsoft.PowerShell.Core

Erstellt ein neues Modulmanifest.

Syntax

New-ModuleManifest
   [-Path] <string>
   [-NestedModules <Object[]>]
   [-Guid <guid>]
   [-Author <string>]
   [-CompanyName <string>]
   [-Copyright <string>]
   [-RootModule <string>]
   [-ModuleVersion <version>]
   [-Description <string>]
   [-ProcessorArchitecture <ProcessorArchitecture>]
   [-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[]>]
   [-CompatiblePSEditions <string[]>]
   [-PrivateData <Object>]
   [-Tags <string[]>]
   [-ProjectUri <uri>]
   [-LicenseUri <uri>]
   [-IconUri <uri>]
   [-ReleaseNotes <string>]
   [-HelpInfoUri <string>]
   [-PassThru]
   [-DefaultCommandPrefix <string>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Beschreibung

Das New-ModuleManifest Cmdlet erstellt eine neue Modulmanifestdatei (.psd1), füllt ihre Werte auf und speichert die Manifestdatei im angegebenen Pfad.

Modulautoren können dieses Cmdlet verwenden, um ein Manifest für ihr Modul zu erstellen. Ein Modulmanifest ist eine .psd1 Datei, die eine Hashtabelle enthält. Die Schlüssel und Werte in der Hashtabelle beschreiben den Inhalt und die Attribute des Moduls, definieren die erforderlichen Komponenten und bestimmen, wie die Komponenten verarbeitet werden. Manifeste sind für ein Modul nicht erforderlich.

New-ModuleManifest erstellt ein Manifest, das alle häufig verwendeten Manifestschlüssel enthält, sodass Sie die Standardausgabe als Manifestvorlage verwenden können. Um Werte hinzuzufügen oder zu ändern oder Modulschlüssel hinzuzufügen, die von diesem Cmdlet nicht hinzugefügt werden, öffnen Sie die resultierende Datei in einem Text-Editor.

Jeder Parameter mit Ausnahme von Path und PassThru erstellt einen Modulmanifestschlüssel und seinen Wert. In einem Modulmanifest ist nur der ModuleVersion-Schlüssel erforderlich. Sofern sie nicht in der Parameterbeschreibung angegeben ist, wird, wenn Sie einen Parameter aus dem Befehl weglassen, New-ModuleManifest eine Kommentarzeichenfolge für den zugeordneten Wert erstellt, der keine Auswirkung hat.

In PowerShell 2.0 werden Sie aufgefordert, New-ModuleManifest die Werte häufig verwendeter Parameter anzugeben, die nicht im Befehl angegeben sind, zusätzlich zu den erforderlichen Parameterwerten. Ab PowerShell 3.0 werden Aufforderungen nur angezeigt, New-ModuleManifest wenn erforderliche Parameterwerte nicht angegeben werden.

Wenn Sie planen, Ihr Modul im PowerShell-Katalog zu veröffentlichen, muss das Manifest Werte für bestimmte Eigenschaften enthalten. Weitere Informationen finden Sie unter Erforderliche Metadaten für Elemente, die im PowerShell-Katalog in der Katalogdokumentation veröffentlicht wurden.

Beispiele

Beispiel 1 : Erstellen eines neuen Modulmanifests

In diesem Beispiel wird ein neues Modulmanifest in der Datei erstellt, die durch den Path-Parameter angegeben wird. Der PassThru-Parameter sendet die Ausgabe an die Pipeline und an die Datei.

Die Ausgabe zeigt die Standardwerte aller Schlüssel im Manifest.

New-ModuleManifest -Path C:\ps-test\Test-Module\Test-Module.psd1 -PassThru

#
# Module manifest for module 'Test-Module'
#
# Generated by: ContosoAdmin
#
# Generated on: 1/22/2019
#

@{

# Script module or binary module file associated with this manifest.
# RootModule = ''

# Version number of this module.
ModuleVersion = '1.0'

# Supported PSEditions
# CompatiblePSEditions = @()

# ID used to uniquely identify this module
GUID = '47179120-0bcb-4f14-8d80-f4560107f85c'

# Author of this module
Author = 'ContosoAdmin'

# Company or vendor of this module
CompanyName = 'Unknown'

# Copyright statement for this module
Copyright = '(c) 2019 ContosoAdmin. All rights reserved.'

# Description of the functionality provided by this module
# Description = ''

# Minimum version of the Windows PowerShell engine required by this module
# PowerShellVersion = ''

# Name of the Windows PowerShell host required by this module
# PowerShellHostName = ''

# Minimum version of the Windows PowerShell host required by this module
# PowerShellHostVersion = ''

# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
# DotNetFrameworkVersion = ''

# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
# CLRVersion = ''

# Processor architecture (None, X86, Amd64) required by this module
# ProcessorArchitecture = ''

# Modules that must be imported into the global environment prior to importing this module
# RequiredModules = @()

# Assemblies that must be loaded prior to importing this module
# RequiredAssemblies = @()

# Script files (.ps1) that are run in the caller's environment prior to importing this module.
# ScriptsToProcess = @()

# Type files (.ps1xml) to be loaded when importing this module
# TypesToProcess = @()

# Format files (.ps1xml) to be loaded when importing this module
# FormatsToProcess = @()

# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
# NestedModules = @()

# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
FunctionsToExport = @()

# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
CmdletsToExport = @()

# Variables to export from this module
VariablesToExport = '*'

# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
AliasesToExport = @()

# DSC resources to export from this module
# DscResourcesToExport = @()

# List of all modules packaged with this module
# ModuleList = @()

# List of all files packaged with this module
# FileList = @()

# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
PrivateData = @{

    PSData = @{

        # Tags applied to this module. These help with module discovery in online galleries.
        # Tags = @()

        # A URL to the license for this module.
        # LicenseUri = ''

        # A URL to the main website for this project.
        # ProjectUri = ''

        # A URL to an icon representing this module.
        # IconUri = ''

        # ReleaseNotes of this module
        # ReleaseNotes = ''

    } # End of PSData hashtable

} # End of PrivateData hashtable

# HelpInfo URI of this module
# HelpInfoURI = ''

# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
# DefaultCommandPrefix = ''

}

Beispiel 2 : Erstellen eines neuen Manifests mit einigen vorab aufgefüllten Einstellungen

In diesem Beispiel wird ein neues Modulmanifest erstellt. Es verwendet die Parameter PowerShellVersion und AliasesToExport , um den entsprechenden Manifestschlüsseln Werte hinzuzufügen.

$moduleSettings = @{
    PowerShellVersion = 1.0
    Path   = 'C:\ps-test\ManifestTest.psd1'
    AliasesToExport   = @(
      'JKBC'
      'DRC'
      'TAC'
    )
}
New-ModuleManifest @moduleSettings

Beispiel 3 : Erstellen eines Manifests, das andere Module erfordert

In diesem Beispiel wird ein Zeichenfolgenformat verwendet, um den Namen des BitsTransfer-Moduls und das Hashtabellenformat anzugeben, um den Namen, eine GUID und eine Version des PSScheduledJob-Moduls anzugeben.

$moduleSettings = @{
  RequiredModules = ("BitsTransfer", @{
    ModuleName="PSScheduledJob"
    ModuleVersion="1.0.0.0";
    GUID="50cdb55f-5ab7-489f-9e94-4ec21ff51e59"
  })
  Path = 'C:\ps-test\ManifestTest.psd1'
}
New-ModuleManifest @moduleSettings

In diesem Beispiel wird gezeigt, wie Sie die Zeichenfolgen- und Hashtabellenformate des Parameters ModuleList, RequiredModules und NestedModules verwenden. Sie können Zeichenfolgen und Hashtabellen in demselben Parameterwert kombinieren.

Beispiel 4 – Erstellen eines Manifests, das aktualisierbare Hilfe unterstützt

In diesem Beispiel wird der HelpInfoUri-Parameter verwendet, um einen HelpInfoUri-Schlüssel im Modulmanifest zu erstellen. Der Wert des Parameters und des Schlüssels muss mit http oder https beginnen. Dieser Wert zeigt dem „Aktualisierbare Hilfe“-System, wo die HelpInfo-XML-Informationsdatei für das Modul zu finden ist.

$moduleSettings = @{
  HelpInfoUri = 'http://https://go.microsoft.com/fwlink/?LinkID=603'
  Path = 'C:\ps-test\ManifestTest.psd1'
}
New-ModuleManifest @moduleSettings

Informationen zur aktualisierbaren Hilfe finden Sie unter about_Updatable_Help. Informationen zur XML-Datei "HelpInfo" finden Sie unter "Unterstützende aktualisierbare Hilfe".

Beispiel 5 – Abrufen von Modulinformationen

In diesem Beispiel wird gezeigt, wie Die Konfigurationswerte eines Moduls abgerufen werden. Die Werte im Modulmanifest werden in den Werten der Eigenschaften des Modulobjekts wiedergegeben.

Das Get-Module Cmdlet wird verwendet, um das Modul "Microsoft.PowerShell.Diagnostics " mithilfe des List-Parameters abzurufen. Der Befehl sendet das Modul an das Format-List Cmdlet, um alle Eigenschaften und Werte des Modulobjekts anzuzeigen.

Get-Module Microsoft.PowerShell.Diagnostics -List | Format-List -Property *

LogPipelineExecutionDetails : False
Name                        : Microsoft.PowerShell.Diagnostics
Path                        : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\Microsoft.PowerShell.Diagnostics\Micro
                              soft.PowerShell.Diagnostics.psd1
Definition                  :
Description                 :
Guid                        : ca046f10-ca64-4740-8ff9-2565dba61a4f
HelpInfoUri                 : https://go.microsoft.com/fwlink/?LinkID=210596
ModuleBase                  : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\Microsoft.PowerShell.Diagnostics
PrivateData                 :
Version                     : 3.0.0.0
ModuleType                  : Manifest
Author                      : Microsoft Corporation
AccessMode                  : ReadWrite
ClrVersion                  : 4.0
CompanyName                 : Microsoft Corporation
Copyright                   : Microsoft Corporation. All rights reserved.
DotNetFrameworkVersion      :
ExportedFunctions           : {}
ExportedCmdlets             : {[Get-WinEvent, Get-WinEvent], [Get-Counter, Get-Counter], [Import-Counter,
                              Import-Counter], [Export-Counter, Export-Counter]...}
ExportedCommands            : {[Get-WinEvent, Get-WinEvent], [Get-Counter, Get-Counter], [Import-Counter,
                              Import-Counter], [Export-Counter, Export-Counter]...}
FileList                    : {}
ModuleList                  : {}
NestedModules               : {}
PowerShellHostName          :
PowerShellHostVersion       :
PowerShellVersion           : 3.0
ProcessorArchitecture       : None
Scripts                     : {}
RequiredAssemblies          : {}
RequiredModules             : {}
RootModule                  :
ExportedVariables           : {}
ExportedAliases             : {}
ExportedWorkflows           : {}
SessionState                :
OnRemove                    :
ExportedFormatFiles         : {C:\Windows\system32\WindowsPowerShell\v1.0\Event.format.ps1xml,
                              C:\Windows\system32\WindowsPowerShell\v1.0\Diagnostics.format.ps1xml}
ExportedTypeFiles           : {C:\Windows\system32\WindowsPowerShell\v1.0\GetEvent.types.ps1xml}

Parameter

-AliasesToExport

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

Sie können diesen Parameter verwenden, um die Aliase einzuschränken, die vom Modul exportiert werden. Sie kann Aliase aus der Liste der exportierten Aliase entfernen, der Liste jedoch keine Aliase hinzufügen.

Wenn Sie diesen Parameter weglassen, New-ModuleManifest wird ein AliasesToExport-Schlüssel mit dem Wert * (alle) erstellt, was bedeutet, dass alle im Modul definierten Aliase vom Manifest exportiert werden.

Typ:	String[]
Position:	Named
Standardwert:	* (all)
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	True

-Author

Gibt den Autor des Moduls an.

Wenn Sie diesen Parameter weglassen, New-ModuleManifest wird ein Author-Schlüssel mit dem Namen des aktuellen Benutzers erstellt.

Typ:	String
Position:	Named
Standardwert:	Name of the current user
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-ClrVersion

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

Hinweis

Diese Einstellung ist nur für die PowerShell Desktop Edition gültig, z. B. Windows PowerShell 5.1, und gilt nur für .NET Framework-Versionen unter 4.5. Diese Anforderung hat keine Auswirkung auf neuere Versionen von PowerShell oder .NET Framework.

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

-CmdletsToExport

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

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

Wenn Sie diesen Parameter weglassen, New-ModuleManifest wird ein CmdletsToExport-Schlüssel mit dem Wert * (alle) erstellt, was bedeutet, dass alle im Modul definierten Cmdlets vom Manifest exportiert werden.

Typ:	String[]
Position:	Named
Standardwert:	* (all)
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	True

-CompanyName

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

Wenn Sie diesen Parameter weglassen, New-ModuleManifest wird ein CompanyName-Schlüssel mit dem Wert "Unknown" erstellt.

Typ:	String
Position:	Named
Standardwert:	"Unknown"
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-CompatiblePSEditions

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

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

-Confirm

Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.

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

-Copyright

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

Wenn Sie diesen Parameter weglassen, New-ModuleManifest wird ein Copyright-Schlüssel mit dem Wert " (c) <year> <username>. All rights reserved. Wo <year> ist das aktuelle Jahr" erstellt und <username> der Wert des Author-Schlüssels .

Typ:	String
Position:	Named
Standardwert:	(c) <year> <username>. All rights reserved.
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-DefaultCommandPrefix

Gibt ein Präfix an, das den Substantiven aller Befehle im Modul vorangestellt wird, wenn sie in eine Sitzung importiert werden. Geben Sie eine Präfixzeichenfolge ein. Präfixe verhindern Konflikte bei Befehlsnamen in der Sitzung eines Benutzers.

Modulbenutzer können dieses Präfix überschreiben, indem Sie den Präfixparameter des Import-Module Cmdlets angeben.

Dieser Parameter wurde in PowerShell 3.0 eingeführt.

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

-Description

Beschreibt den Inhalt des Moduls.

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

-DotNetFrameworkVersion

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

Hinweis

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. Platzhalter sind zulässig.

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

-FileList

Gibt alle Elemente an, die im Modul enthalten sind.

Dieser Schlüssel ist als Modulinventar konzipiert. Die im Schlüssel aufgeführten Dateien werden beim Veröffentlichen des Moduls eingeschlossen, aber alle Funktionen werden nicht automatisch exportiert.

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 ausgeführt werden.

Wenn Sie ein Modul importieren, führt PowerShell das Update-FormatData Cmdlet 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. Platzhalter sind zulässig.

Sie können diesen Parameter verwenden, um die Funktionen einzuschränken, die vom Modul exportiert werden. Sie kann Funktionen aus der Liste der exportierten Aliase entfernen, aber sie kann der Liste keine Funktionen hinzufügen.

Wenn Sie diesen Parameter weglassen, New-ModuleManifest wird ein FunctionsToExport-Schlüssel mit dem Wert * (alle) erstellt, was bedeutet, dass alle im Modul definierten Funktionen vom Manifest exportiert werden.

Typ:	String[]
Position:	Named
Standardwert:	* (all)
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	True

-Guid

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

Wenn Sie diesen Parameter weglassen, New-ModuleManifest wird im Manifest ein GUID-Schlüssel erstellt und eine GUID für den Wert generiert.

Geben Sie [guid]::NewGuid()zum Erstellen einer neuen GUID in PowerShell ein.

Typ:	Guid
Position:	Named
Standardwert:	A GUID generated for the module
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-HelpInfoUri

Gibt die Internetadresse der HelpInfo-XML-Datei für das Modul an. Geben Sie einen URI (Uniform Resource Identifier) ein, der mit http oder https beginnt.

Die HelpInfo-XML-Datei unterstützt das feature "Aktualisierbare Hilfe", das in PowerShell 3.0 eingeführt wurde. Es enthält Informationen über den Speicherort der herunterladbaren Hilfedateien für das Modul 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ützende aktualisierbare Hilfe".

Dieser Parameter wurde in PowerShell 3.0 eingeführt.

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

-IconUri

Gibt die URL 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

Listet alle Module auf, die in diesem Modul enthalten sind.

Geben Sie jeden Modulnamen als Zeichenfolge oder als Hashtabelle mit ModuleName - und ModuleVersion-Schlüsseln ein. Die Hashtabelle kann auch über einen optionalen GUID-Schlüssel verfügen. 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.

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

-ModuleVersion

Gibt die Version des Moduls an.

Dieser Parameter ist nicht erforderlich, aber im Manifest ist ein ModuleVersion-Schlüssel erforderlich. Wenn Sie diesen Parameter weglassen, New-ModuleManifest wird ein ModuleVersion-Schlüssel mit dem Wert 1,0 erstellt.

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

-NestedModules

Gibt Skriptmodule () und binäre Module (.psm1.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.

Geschachtelte Module enthalten i. d. R. Befehle, die das Stammmodul für die interne Verarbeitung benötigt. Standardmäßig werden die Befehle in geschachtelten Modulen aus dem Sitzungszustand des Moduls in den Sitzungszustand des Aufrufers exportiert, das Stammmodul kann jedoch die exportierten Befehle einschränken. Beispielsweise mithilfe eines Export-ModuleMember Befehls.

Geschachtelte Module im Modulsitzungsstatus sind für das Stammmodul verfügbar, werden jedoch nicht von einem Get-Module Befehl im Sitzungszustand des Aufrufers zurückgegeben.

Skripts (.ps1) die im Schlüssel "NestedModules " aufgeführt sind, werden im Sitzungszustand des Moduls ausgeführt, nicht im Sitzungszustand des Aufrufers. Um ein Skript im Sitzungszustand des Aufrufers auszuführen, listen Sie den Namen der Skriptdatei im Wert des ScriptsToProcess-Schlüssels im Manifest auf.

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

-PassThru

Schreibt das resultierende Modulmanifest in die Konsole und erstellt eine .psd1 Datei. Standardmäßig generiert dieses Cmdlet keine Ausgabe.

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

-Path

Gibt den Pfad und Dateinamen des neuen Modulmanifests an. Geben Sie einen Pfad und Dateinamen mit einer .psd1 Dateinamenerweiterung ein, z $pshome\Modules\MyModule\MyModule.psd1. B. . Der Path-Parameter ist erforderlich.

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

Das Manifest sollte sich im Verzeichnis des Moduls befinden, und der Manifestdateiname sollte mit dem Modulverzeichnisnamen identisch sein, jedoch mit einer .psd1 Dateinamenerweiterung.

Hinweis

Variablen, z $PSHOME . B. oder $HOME, können nicht als Reaktion auf eine Eingabeaufforderung für einen Path-Parameterwert verwendet werden. Um eine Variable zu verwenden, schließen Sie den Path-Parameter in den Befehl ein.

Typ:	String
Position:	1
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. Windows PowerShell ISE-Host oder ConsoleHost. Wildcards sind nicht zulässig.

Geben Sie im Programm $Host.Nameden Namen eines Hostprogramms ein.

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 an, 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. "1.0", "2.0" oder "3.0" als Wert des Parameters eingeben. Er muss im X.X-Format vorliegen. Wenn Sie beispielsweise übermitteln 5, löst PowerShell einen Fehler aus.

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

-PrivateData

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

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

-ProcessorArchitecture

Gibt die Prozessorarchitektur an, die das Modul erfordert. Gültige Werte sind x86, AMD64, IA64, MSIL und None (unbekannt oder nicht angegeben).

Typ:	ProcessorArchitecture
Zulässige Werte:	None, MSIL, X86, IA64, Amd64, Arm
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-ProjectUri

Gibt die URL einer Webseite zu diesem Projekt an.

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

-ReleaseNotes

Gibt Versionshinweise an.

Typ:	String
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	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 auflisten, 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 ebenfalls als Binärmodule im Schlüssel "NestedModules " aufgeführt sind.

Typ:	String[]
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	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.

In PowerShell 2.0 Import-Module werden die erforderlichen Module nicht automatisch importiert. Es überprüft nur, ob sich die erforderlichen Module im globalen Sitzungsstatus befinden.

Typ:	Object[]
Position:	Named
Standardwert:	None
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), eines Skriptmoduls (.psm1), eines Modulmanifests(.psd1), einer Assembly (.dll), einer XML-Datei der Cmdlet-Definition () oder eines Workflows (.cdxml.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 festgelegt wurde, wird das Manifest zur primären Datei für das Modul, und das Modul wird zu einem Manifestmodul (ModuleType = Manifest).

Um Member aus .psm1 oder .dll Dateien in einem Modul mit einem Manifest zu exportieren, müssen die Namen dieser Dateien in den Werten der RootModule - oder NestedModules-Schlüssel im Manifest angegeben werden. Andernfalls werden ihre Mitglieder nicht exportiert.

Hinweis

In PowerShell 2.0 wurde dieser Schlüssel als ModuleToProcess bezeichnet. Sie können den Namen des RootModule-Parameters oder den zugehörigen ModuleToProcess-Alias verwenden.

Typ:	String
Aliase:	ModuleToProcess
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 Skripte zur Vorbereitung einer Umgebung verwenden, wie Sie ein Anmeldeskript verwenden würden.

Verwenden Sie zum Angeben von Skripts, die im Sitzungszustand des Moduls ausgeführt werden, den Schlüssel "NestedModules ".

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

-Tags

Gibt ein Array von Tags an.

Typ:	String[]
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 Update-TypeData Cmdlet 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. Platzhalter sind zulässig.

Sie können diesen Parameter verwenden, um die Variablen einzuschränken, die vom Modul exportiert werden. Sie kann Variablen aus der Liste der exportierten Variablen entfernen, aber sie kann der Liste keine Variablen hinzufügen.

Wenn Sie diesen Parameter weglassen, New-ModuleManifest wird ein VariablesToExport-Schlüssel mit dem Wert * (alle) erstellt, was bedeutet, dass alle im Modul definierten Variablen vom Manifest exportiert werden.

Typ:	String[]
Position:	Named
Standardwert:	* (all)
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	True

-WhatIf

Zeigt, was passiert, wenn New-ModuleManifest ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

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

Eingaben

None

Sie können keine Objekte an dieses Cmdlet weiterleiten.

Ausgaben

None

Standardmäßig gibt dieses Cmdlet keine Ausgabe zurück.

String

Wenn Sie den PassThru-Parameter verwenden, gibt dieses Cmdlet eine Zeichenfolge zurück, die das Modulmanifest darstellt.

Hinweise

New-ModuleManifest erstellt Modulmanifestdateien (.psd1) codiert als UTF16.

Modulmanifeste sind normalerweise optional. Ein Modulmanifest ist jedoch erforderlich, wenn Sie eine Assembly exportieren möchten, die im globalen Assemblycache installiert ist.

Um Dateien im $pshome\Modules Verzeichnis hinzuzufügen oder zu ändern, starten Sie PowerShell mit der Option "Als Administrator ausführen".

In PowerShell 2.0 waren viele Parameter New-ModuleManifest obligatorisch, obwohl sie in einem Modulmanifest nicht erforderlich waren. Ab PowerShell 3.0 ist nur der Path-Parameter obligatorisch.

Eine Sitzung ist eine Instanz der PowerShell-Ausführungsumgebung. Eine Sitzung kann mindestens einen Sitzungsstatus haben. Standardmäßig weist eine Sitzung nur einen globalen Sitzungsstatus auf, jedes importierte Modul verfügt jedoch über einen eigenen Sitzungsstatus. Sitzungsstatus erlauben das Ausführen der Befehle in einem Modul, ohne den globalen Sitzungsstatus zu beeinflussen.

Der Sitzungsstatus des Aufrufers ist der Sitzungszustand, in den ein Modul importiert wird. In der Regel bezieht es sich auf den globalen Sitzungszustand, aber wenn ein Modul geschachtelte Module importiert, ist der Aufrufer das Modul, und der Sitzungszustand des Aufrufers ist der Sitzungszustand des Moduls.

Freigeben über

New-ModuleManifest

Syntax

Beschreibung

Beispiele

Beispiel 1 : Erstellen eines neuen Modulmanifests

Beispiel 2 : Erstellen eines neuen Manifests mit einigen vorab aufgefüllten Einstellungen

Beispiel 3 : Erstellen eines Manifests, das andere Module erfordert

Beispiel 4 – Erstellen eines Manifests, das aktualisierbare Hilfe unterstützt

Beispiel 5 – Abrufen von Modulinformationen

Parameter

-AliasesToExport

-Author

-ClrVersion

-CmdletsToExport

-CompanyName

-CompatiblePSEditions

-Confirm

-Copyright

-DefaultCommandPrefix

-Description

-DotNetFrameworkVersion

-DscResourcesToExport

-FileList

-FormatsToProcess

-FunctionsToExport

-Guid

-HelpInfoUri

-IconUri

-LicenseUri

-ModuleList

-ModuleVersion

-NestedModules

-PassThru

-Path

-PowerShellHostName

-PowerShellHostVersion

-PowerShellVersion

-PrivateData

-ProcessorArchitecture

-ProjectUri

-ReleaseNotes

-RequiredAssemblies

-RequiredModules

-RootModule

-ScriptsToProcess

-Tags

-TypesToProcess

-VariablesToExport

-WhatIf

Eingaben

Ausgaben

Hinweise

Ähnliche Themen

Zusätzliche Ressourcen