New-ModuleManifest

Sözdizimi

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

New-ModuleManifest Cmdlet yeni bir modül bildirimi (.psd1) dosyası oluşturur, değerlerini doldurur ve bildirim dosyasını belirtilen yola kaydeder.

Modül yazarları bu cmdlet'i kullanarak modülleri için bir bildirim oluşturabilir. Modül bildirimi, karma tablo içeren bir dosyadır .psd1 . Karma tablodaki anahtarlar ve değerler modülün içeriğini ve özniteliklerini açıklar, önkoşulları tanımlar ve bileşenlerin nasıl işlendiğini belirler. Bir modül için bildirimler gerekli değildir.

New-ModuleManifest , varsayılan çıkışı bildirim şablonu olarak kullanabilmeniz için yaygın olarak kullanılan tüm bildirim anahtarlarını içeren bir bildirim oluşturur. Değerleri eklemek veya değiştirmek ya da bu cmdlet'in eklemediği modül anahtarlarını eklemek için, sonuçta elde edilen dosyayı bir metin düzenleyicisinde açın.

Path ve PassThru dışında her parametre bir modül bildirim anahtarı ve değeri oluşturur. Modül bildiriminde yalnızca ModuleVersion anahtarı gereklidir. Parametre açıklamasında belirtilmediği sürece, komutundan bir parametreyi atlarsanız, New-ModuleManifest ilişkili değer için hiçbir etkisi olmayan bir açıklama dizesi oluşturur.

PowerShell 2.0'da, New-ModuleManifest gerekli parametre değerlerine ek olarak komutta belirtilmeyen yaygın olarak kullanılan parametrelerin değerlerini ister. PowerShell 3.0'da başlayarak, New-ModuleManifest yalnızca gerekli parametre değerleri belirtilmediğinde istemler oluşturur.

Modülünüzü PowerShell Galerisi yayımlamayı planlıyorsanız bildirim belirli özellikler için değerler içermelidir. Daha fazla bilgi için Galeri belgelerindeki PowerShell Galerisi yayımlanan öğeler için gerekli meta veriler bölümüne bakın.

Örnekler

Örnek 1 - Yeni modül bildirimi oluşturma

Bu örnek, dosyada Path parametresi tarafından belirtilen yeni bir modül bildirimi oluşturur. PassThru parametresi çıkışı işlem hattına ve dosyasına gönderir.

Çıkış, bildirimdeki tüm anahtarların varsayılan değerlerini gösterir.

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

}

Örnek 2 - Önceden doldurulmuş bazı ayarlarla yeni bir bildirim oluşturma

Bu örnek yeni bir modül bildirimi oluşturur. İlgili bildirim anahtarlarına değer eklemek için PowerShellVersion ve AliasesToExport parametrelerini kullanır.

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

Örnek 3 - Diğer modülleri gerektiren bir bildirim oluşturma

Bu örnekte, BitsTransfer modülünün adını belirtmek için bir dize biçimi ve PSScheduledJob modülünün adını, GUID'sini ve sürümünü belirtmek için karma tablo biçimi kullanılır.

$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

Bu örnekte ModuleList, RequiredModules ve NestedModules parametresinin dize ve karma tablo biçimlerinin nasıl kullanılacağı gösterilmektedir. Dizeleri ve karma tabloları aynı parametre değerinde birleştirebilirsiniz.

Örnek 4 - Güncelleştirilebilir yardımı destekleyen bir bildirim oluşturma

Bu örnek, modül bildiriminde bir HelpInfoUri anahtarı oluşturmak için HelpInfoUri parametresini kullanır. parametresinin ve anahtarın değeri http veya https ile başlamalıdır. Bu değer, Güncelleştirilebilir Yardım sistemine modülün HelpInfo XML güncelleştirilebilir yardım bilgileri dosyasını nerede bulacağını bildirir.

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

Güncelleştirilebilir Yardım hakkında bilgi için bkz . about_Updatable_Help. HelpInfo XML dosyası hakkında bilgi için bkz . Güncelleştirilebilir Yardımı Destekleme.

Örnek 5 - Modül bilgilerini alma

Bu örnekte bir modülün yapılandırma değerlerinin nasıl alınıyor olduğu gösterilmektedir. Modül bildirimindeki değerler, modül nesnesinin özelliklerinin değerlerine yansıtılır.

Get-Module Cmdlet, List parametresi kullanılarak Microsoft.PowerShell.Diagnostics modülünü almak için kullanılır. komutu, modül nesnesinin Format-List tüm özelliklerini ve değerlerini görüntülemek için modülü cmdlet'ine gönderir.

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}

Parametreler

-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

Girişler

None

Nesneleri bu cmdlet'e yöneltemezsiniz.

Çıkışlar

None

Varsayılan olarak, bu cmdlet çıkış döndürmez.

String

PassThru parametresini kullandığınızda, bu cmdlet modül bildirimini temsil eden bir dize döndürür.

Notlar

New-ModuleManifestWindows ve Windows dışı platformlarda çalıştırıldığında UTF8NoBOM olarak kodlanmış modül bildirimi (.psd1) dosyaları oluşturulur.

Modül bildirimleri genellikle isteğe bağlıdır. Ancak, genel derleme önbelleğine yüklenen bir derlemeyi dışarı aktarmak için modül bildirimi gerekir.

Dizine dosya eklemek veya değiştirmek için PowerShell'i $pshome\Modules Yönetici olarak çalıştır seçeneğiyle başlatın.

PowerShell 2.0'da, birçok parametresi New-ModuleManifest bir modül bildiriminde gerekli olmasa bile zorunludu. PowerShell 3.0'dan başlayarak, yalnızca Path parametresi zorunludur.

Oturum, PowerShell yürütme ortamının bir örneğidir. Bir oturumda bir veya daha fazla oturum durumu olabilir. Varsayılan olarak, bir oturumun yalnızca genel oturum durumu vardır, ancak içeri aktarılan her modülün kendi oturum durumu vardır. Oturum durumları, bir modüldeki komutların genel oturum durumunu etkilemeden çalışmasına izin verir.

Çağıranın oturum durumu, modülün içeri aktarıldığı oturum durumudur. Genellikle genel oturum durumuna başvurur, ancak modül iç içe modülleri içeri aktardığında çağıran modüldür ve çağıranın oturum durumu modülün oturum durumudur.

İlişkili Bağlantılar

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