New-ModuleManifest

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>]
   [-Prerelease <String>]
   [-RequireLicenseAcceptance]
   [-ExternalModuleDependencies <String[]>]
   [-HelpInfoUri <String>]
   [-PassThru]
   [-DefaultCommandPrefix <String>]
   [-WhatIf]
   [-Confirm] 
   [<CommonParameters>]

Description

Cmdleten New-ModuleManifest skapar en ny modulmanifestfil (.psd1) som fyller i dess värden och sparar manifestfilen i den angivna sökvägen.

Modulförfattare kan använda den här cmdleten för att skapa ett manifest för sin modul. Ett modulmanifest är en .psd1 fil som innehåller en hash-tabell. Nycklarna och värdena i hash-tabellen beskriver innehållet och attributen i modulen, definierar förutsättningarna och avgör hur komponenterna bearbetas. Manifest krävs inte för en modul.

New-ModuleManifest skapar ett manifest som innehåller alla vanliga manifestnycklar, så att du kan använda standardutdata som en manifestmall. Om du vill lägga till eller ändra värden eller lägga till modulnycklar som den här cmdleten inte lägger till öppnar du den resulterande filen i en textredigerare.

Varje parameter, förutom Path och PassThru, skapar en modulmanifestnyckel och dess värde. I ett modulmanifest krävs endast ModuleVersion-nyckeln . Om du inte anger någon parameter i parameterbeskrivningen skapar du en kommentarssträng för det associerade värdet som inte har någon effekt om du utelämnar en parameter från kommandot New-ModuleManifest .

I PowerShell 2.0 New-ModuleManifest uppmanas du att ange värden för vanliga parametrar som inte anges i kommandot, förutom obligatoriska parametervärden. Från och med PowerShell 3.0 New-ModuleManifest uppmanas endast när obligatoriska parametervärden inte har angetts.

Om du planerar att publicera modulen i PowerShell-galleriet måste manifestet innehålla värden för vissa egenskaper. Mer information finns i Nödvändiga metadata för objekt som publicerats till PowerShell-galleriet i galleridokumentationen.

Exempel

Exempel 1 – Skapa ett nytt modulmanifest

I det här exemplet skapas ett nytt modulmanifest i filen som anges av parametern Sökväg . Parametern PassThru skickar utdata till pipelinen och till filen.

Utdata visar standardvärdena för alla nycklar i manifestet.

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

#
# Module manifest for module 'Test-Module'
#
# Generated by: ContosoAdmin
#
# Generated on: 7/12/2019
#

@{

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

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

# Supported PSEditions
# CompatiblePSEditions = @()

# ID used to uniquely identify this module
GUID = 'e1826c6e-c420-4eef-9ac8-185e3669ca6a'

# Author of this module
Author = 'ContosoAdmin'

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

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

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

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

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

# Minimum version of the 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 = ''

        # Prerelease string of this module
        # Prerelease = ''

        # Flag to indicate whether the module requires explicit user acceptance for install/update/save
        # RequireLicenseAcceptance = $false

        # External dependent modules of this module
        # ExternalModuleDependencies = @()

    } # 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 = ''

}

Exempel 2 – Skapa ett nytt manifest med några förifyllda inställningar

I det här exemplet skapas ett nytt modulmanifest. Den använder parametrarna PowerShellVersion och AliasesToExport för att lägga till värden i motsvarande manifestnycklar.

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

Exempel 3 – Skapa ett manifest som kräver andra moduler

I det här exemplet används ett strängformat för att ange namnet på BitsTransfer-modulen och hashtabellformatet för att ange namnet, ett GUID och en version av modulen PSScheduledJob .

$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

Det här exemplet visar hur du använder sträng- och hashtabellformaten för parametern ModuleList, RequiredModules och NestedModules. Du kan kombinera strängar och hash-tabeller i samma parametervärde.

Exempel 4 – Skapa ett manifest som stöder uppdateringsbar hjälp

I det här exemplet används parametern HelpInfoUri för att skapa en HelpInfoUri-nyckel i modulmanifestet. Värdet för parametern och nyckeln måste börja med http eller https. Det här värdet talar om för updatable Help-systemet var du hittar hjälpinformationsfilen helpinfo XML updatable för modulen.

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

Information om uppdateringsbar hjälp finns i about_Updatable_Help. Information om XML-filen HelpInfo finns i Support Updatable Help (Stöd för uppdateringsbar hjälp).

Exempel 5 – Hämta modulinformation

Det här exemplet visar hur du hämtar konfigurationsvärdena för en modul. Värdena i modulmanifestet återspeglas i värdena för egenskaperna för modulobjektet.

Cmdleten Get-Module används för att hämta modulen Microsoft.PowerShell.Diagnostics med hjälp av parametern List . Kommandot skickar modulen till cmdleten Format-List för att visa alla egenskaper och värden för modulobjektet.

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}

Parametrar

-AliasesToExport

-Author

-ClrVersion

-CmdletsToExport

-CompanyName

-CompatiblePSEditions

-Confirm

-Copyright

-DefaultCommandPrefix

-Description

-DotNetFrameworkVersion

-DscResourcesToExport

-ExternalModuleDependencies

-FileList

-FormatsToProcess

-FunctionsToExport

-Guid

-HelpInfoUri

-IconUri

-LicenseUri

-ModuleList

-ModuleVersion

-NestedModules

-PassThru

-Path

-PowerShellHostName

-PowerShellHostVersion

-PowerShellVersion

-Prerelease

-PrivateData

-ProcessorArchitecture

-ProjectUri

-ReleaseNotes

-RequiredAssemblies

-RequiredModules

-RequireLicenseAcceptance

-RootModule

-ScriptsToProcess

-Tags

-TypesToProcess

-VariablesToExport

-WhatIf

Indata

None

Du kan inte skicka objekt till den här cmdleten.

Utdata

None

Som standard returnerar den här cmdleten inga utdata.

String

När du använder parametern PassThru returnerar den här cmdleten en sträng som representerar modulmanifestet.

Kommentarer

New-ModuleManifest körs på Windows- och icke-Windows-plattformar skapar modulmanifestfiler (.psd1) kodade som UTF8NoBOM.

Modulmanifest är vanligtvis valfria. Ett modulmanifest krävs dock för att exportera en sammansättning som är installerad i den globala sammansättningscacheminnet.

Om du vill lägga till eller ändra filer i $pshome\Modules katalogen startar du PowerShell med alternativet Kör som administratör .

I PowerShell 2.0 var många parametrar New-ModuleManifest för obligatoriska, även om de inte behövdes i ett modulmanifest. Från och med PowerShell 3.0 är endast parametern Path obligatorisk.

En session är en instans av PowerShell-körningsmiljön. En session kan ha ett eller flera sessionstillstånd. Som standard har en session endast ett globalt sessionstillstånd, men varje importerad modul har sitt eget sessionstillstånd. Sessionstillstånd tillåter att kommandona i en modul körs utan att det globala sessionstillståndet påverkas.

Anroparens sessionstillstånd är sessionstillståndet som en modul importeras till. Vanligtvis refererar den till det globala sessionstillståndet, men när en modul importerar kapslade moduler är anroparen modulen och anroparens sessionstillstånd är modulens sessionstillstånd.

Relaterade länkar

• Export-ModuleMember
• Get-Module
• Import-Module
• New-Module
• Remove-Module
• Test-ModuleManifest
• about_Modules