Yeni Modül Manifest'i (Microsoft.PowerShell.Core)


New-ModuleManifest

Modül:
Microsoft.PowerShell.Core

Yeni bir modül bildirimi oluşturur.

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>]

Tanım

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

Modül yazarları bu cmdlet'i kendi modülleri için bir bildirim oluşturmak amacıyla kullanabilirler. Modül bildirimi, karma tablosu içeren bir .psd1 dosyasıdır. Karma tablosundaki anahtarlar ve değerler modülün içeriğini ve niteliklerini tanımlar, önkoşulları tanımlar ve bileşenlerin nasıl işleneceğini belirler. Bir modül için bildirimler gerekli değildir.

New-ModuleManifest, yaygın olarak kullanılan tüm bildirim anahtarlarını içeren bir bildirim oluşturur; böylece varsayılan çıktıyı bildirim şablonu olarak kullanabilirsiniz. Değerleri eklemek veya değiştirmek ya da bu cmdlet'in eklemediği modül anahtarlarını eklemek için sonuç dosyasını bir metin düzenleyicide açın.

Path ve PassThru dışındaki her parametre, bir modül bildirim anahtarı ve onun değerini oluşturur. Bir modül bildiriminde yalnızca ModuleVersion anahtarı gereklidir. Parametre açıklamasında belirtilmediği sürece, komuttan bir parametreyi çıkarırsanız New-ModuleManifest, ilişkili değer için hiçbir etkisi olmayan bir yorum 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 de ister. PowerShell 3,0'dan itibaren New-ModuleManifest yalnızca gerekli parametre değerleri belirtilmediğinde istemde bulunur.

Modülünüzü PowerShell Galerisi'nde yayınlamayı planlıyorsanız bildirimin belirli özelliklere ilişkin değerleri içermesi gerekir. Daha fazla bilgi için Galeri belgelerindeki PowerShell Galerisinde yayınlanan öğeler için gerekli meta verilere bakın.

Örnekler

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

Bu örnek, dosyada Path parametresi tarafından belirtilen yeni bir modül bildirimi oluşturur. PassThru parametresi çıktıyı ardışık düzene ve dosyaya gönderir.

Çıktı, 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'un adını, GUID'sini ve sürümünü belirtmek için karma tablo biçimi kullanılır. modülü.

$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 örnek, ModuleList, RequiredModules ve NestedModules parametrelerinin dize ve karma tablo biçimlerinin nasıl kullanılacağını gösterir. Dizeleri ve karma tabloları aynı parametre değerinde birleştirebilirsiniz.

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

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

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

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

Örnek 5 - Modül bilgilerinin alınması

Bu örnek, bir modülün konfigürasyon değerlerinin nasıl alınacağını gösterir. Modül bildirimindeki değerler, modül nesnesinin özelliklerinin değerlerine yansıtılır.

Get-Module cmdlet'i, List parametresini kullanarak Microsoft.PowerShell.Diagnostics modülünü almak için kullanılır. Komut, modül nesnesinin tüm özelliklerini ve değerlerini görüntülemek için modülü Format-List 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

Modülün dışa aktardığı takma adları belirtir. Joker karakterlere izin verilir.

Modül tarafından dışa aktarılan takma adları kısıtlamak için bu parametreyi kullanabilirsiniz. Dışa aktarılan takma adlar listesinden takma adları kaldırabilir ancak listeye takma ad ekleyemez.

Bu parametreyi atlarsanız, New-ModuleManifest, * (tümü) değerine sahip bir AliasesToExport anahtarı oluşturur; bu, modül manifest tarafından dışa aktarılır.

Tip :

String[]

Konum:

Adlandırılmış

Varsayılan değer:

* (Tümü)

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

True

-Author

Modül yazarını belirtir.

Bu parametreyi atlarsanız New-ModuleManifest, geçerli kullanıcının adını içeren bir Yazar anahtarı oluşturur.

Tip :

String

Konum:

Adlandırılmış

Varsayılan değer:

Geçerli kullanıcının adı

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-ClrVersion

Modülün gerektirdiği Microsoft .NET Framework Ortak Dil Çalışma Zamanı'nın (CLR) minimum sürümünü belirtir.

Not

Bu ayar yalnızca Windows PowerShell 5,1 gibi PowerShell Desktop sürümü için geçerlidir ve yalnızca 4,5'ten düşük .NET Framework sürümleri için geçerlidir. Bu gereksinimin PowerShell veya .NET Framework'ün daha yeni sürümleri için hiçbir etkisi yoktur.

Tip :

Sürüm

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-CmdletsToExport

Modülün dışa aktardığı cmdlet'leri belirtir. Joker karakterlere izin verilir.

Modül tarafından dışa aktarılan cmdlet'leri kısıtlamak için bu parametreyi kullanabilirsiniz. Dışa aktarılan cmdlet'ler listesinden cmdlet'leri kaldırabilir ancak listeye cmdlet'ler ekleyemez.

Bu parametreyi atlarsanız, New-ModuleManifest, * (tümü) değerine sahip bir CmdletsToExport anahtarı oluşturur; bu, modül manifest tarafından dışa aktarılır.

Tip :

String[]

Konum:

Adlandırılmış

Varsayılan değer:

* (Tümü)

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

True

-CompanyName

Modülü oluşturan şirketi veya satıcıyı tanımlar.

Bu parametreyi atlarsanız New-ModuleManifest, "Bilinmeyen" değerine sahip bir CompanyName anahtarı oluşturur.

Tip :

String

Konum:

Adlandırılmış

Varsayılan değer:

"Bilinmiyor"

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-CompatiblePSEditions

Modülün uyumlu PSEdition'larını belirtir. PSEdition hakkında bilgi için bkz. Uyumlu PowerShell Sürümlerine sahip Modüller.

Tip :

String[]

Kabul edilen değerler:

Masaüstü, Çekirdek

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-Confirm

Cmdlet'i çalıştırmadan önce sizden onay ister.

Tip :

SwitchParameter

Takma adlar:

cf

Konum:

Adlandırılmış

Varsayılan değer:

False

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-Copyright

Modül için bir telif hakkı beyanını belirtir.

Bu parametreyi atlarsanız, New-ModuleManifest, (c) değerine sahip bir Telif Hakkı anahtarı oluşturur. Tüm hakları saklıdır. burada <yıl> geçerli yılı ve <kullanıcı adı> Yazar anahtarının değeridir.

Tip :

String

Konum:

Adlandırılmış

Varsayılan değer:

(c) . Her hakkı saklıdır.

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-DefaultCommandPrefix

Bir oturuma aktarıldıklarında modüldeki tüm komutların adlarının başına eklenen bir öneki belirtir. Bir önek dizesi girin. Ön ekler, kullanıcının oturumunda komut adı çakışmalarını önler.

Modül kullanıcıları, Import-Module cmdlet'inin Prefix parametresini belirterek bu öneki geçersiz kılabilir.

Bu parametre PowerShell 3,0'da tanıtıldı.

Tip :

String

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-Description

Modülün içeriğini açıklar.

Tip :

String

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-DotNetFrameworkVersion

Modülün gerektirdiği minimum Microsoft .NET Framework sürümünü belirtir.

Not

Bu ayar yalnızca Windows PowerShell 5,1 gibi PowerShell Desktop sürümü için geçerlidir ve yalnızca 4,5'ten düşük .NET Framework sürümleri için geçerlidir. Bu gereksinimin PowerShell veya .NET Framework'ün daha yeni sürümleri için hiçbir etkisi yoktur.

Tip :

Sürüm

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-DscResourcesToExport

Modülün dışa aktardığı İstenen Durum Yapılandırması (DSC) kaynaklarını belirtir. Joker karakterlere izin verilir.

Tip :

String[]

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

True

-ExternalModuleDependencies

Bu modülün bağlı olduğu harici modüllerin listesi.

Tip :

String[]

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-FileList

Modüle dahil olan tüm öğeleri belirtir.

Bu anahtar bir modül envanteri görevi görecek şekilde tasarlanmıştır. Anahtarda listelenen dosyalar, modül yayınlandığında dahil edilir ancak hiçbir işlev otomatik olarak dışa aktarılmaz.

Tip :

String[]

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-FormatsToProcess

Modül içe aktarıldığında çalıştırılan biçimlendirme dosyalarını (.ps1xml) belirtir.

Bir modülü içe aktardığınızda PowerShell, belirtilen dosyalarla Update-FormatData cmdlet'ini çalıştırır. Biçimlendirme dosyalarının kapsamı belirlenmediğinden oturumdaki tüm oturum durumlarını etkiler.

Tip :

String[]

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-FunctionsToExport

Modülün dışa aktardığı işlevleri belirtir. Joker karakterlere izin verilir.

Modül tarafından dışa aktarılan işlevleri kısıtlamak için bu parametreyi kullanabilirsiniz. Dışa aktarılan takma adlar listesinden işlevleri kaldırabilir ancak listeye işlevler ekleyemez.

Bu parametreyi atlarsanız, New-ModuleManifest, * (tümü) değerine sahip bir FunctionsToExport anahtarı oluşturur; bu, modül manifest tarafından dışa aktarılır.

Tip :

String[]

Konum:

Adlandırılmış

Varsayılan değer:

* (Tümü)

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

True

-Guid

Modül için benzersiz bir tanımlayıcı belirtir. GUID aynı ada sahip modüller arasında ayrım yapmak için kullanılabilir.

Bu parametreyi atlarsanız, New-ModuleManifest manifestte bir GUID anahtarı oluşturur ve değer için bir GUID oluşturur.

PowerShell'de yeni bir GUID oluşturmak için [guid]::NewGuid() yazın.

Tip :

Rehber

Konum:

Adlandırılmış

Varsayılan değer:

Modül için oluşturulan bir GUID

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-HelpInfoUri

Modül için HelpInfo XML dosyasının internet adresini belirtir. http veya https ile başlayan bir Tekdüzen Kaynak Tanımlayıcısı (URI) girin.

HelpInfo XML dosyası, PowerShell 3,0'da sunulan Güncelleştirilebilir Yardım özelliğini destekler. Modül için indirilebilir yardım dosyalarının konumu ve desteklenen her yerel ayar için en yeni yardım dosyalarının sürüm numaraları hakkında bilgi içerir.

Güncellenebilir 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ın Desteklenmesi.

Bu parametre PowerShell 3,0'da tanıtıldı.

Tip :

String

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-IconUri

Modül için bir simgenin URL'sini belirtir. Belirtilen simge modülün galeri web sayfasında görüntülenir.

Tip :

Uri

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-LicenseUri

Modüle ilişkin lisans koşullarının URL'sini belirtir.

Tip :

Uri

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-ModuleList

Bu modüle dahil olan tüm modülleri listeler.

Her modül adını ModuleName ve ModuleVersion tuşlarıyla bir dize veya karma tablo olarak girin. Karma tablosunda isteğe bağlı bir GUID anahtarı da bulunabilir. Dizeleri ve karma tabloları parametre değerinde birleştirebilirsiniz.

Bu anahtar bir modül envanteri görevi görecek şekilde tasarlanmıştır. Bu anahtarın değerinde listelenen modüller otomatik olarak işlenmez.

Tip :

Object[]

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-ModuleVersion

Modülün sürümünü belirtir.

Bu parametre gerekli değildir ancak manifestte bir ModuleVersion anahtarı gereklidir. Bu parametreyi atlarsanız New-ModuleManifest, 1,0 değerine sahip bir ModuleVersion anahtarı oluşturur.

Tip :

Sürüm

Konum:

Adlandırılmış

Varsayılan değer:

1.0

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-NestedModules

Modülün oturum durumuna içe aktarılan komut dosyası modüllerini (.psm1) ve ikili modülleri (.dll) belirtir. NestedModules anahtarındaki dosyalar, değerde listelendikleri sırayla çalışır.

Her modül adını ModuleName ve ModuleVersion tuşlarıyla bir dize veya karma tablo olarak girin. Karma tablosunda isteğe bağlı bir GUID anahtarı da bulunabilir. Dizeleri ve karma tabloları parametre değerinde birleştirebilirsiniz.

Genellikle iç içe geçmiş modüller, kök modülün dahili işlemleri için ihtiyaç duyduğu komutları içerir. Varsayılan olarak, iç içe geçmiş modüllerdeki komutlar, modülün oturum durumundan arayanın oturum durumuna aktarılır, ancak kök modül, verdiği komutları kısıtlayabilir. Örneğin, bir Export-ModuleMember komutunu kullanarak.

Modül oturum durumundaki iç içe geçmiş modüller kök modül tarafından kullanılabilir, ancak arayanın oturum durumunda Get-Module komutu tarafından döndürülmezler.

NestedModules anahtarında listelenen komut dosyaları (.ps1), arayanın oturum durumunda değil, modülün oturum durumunda çalıştırılır. Arayanın oturum durumunda bir komut dosyasını çalıştırmak için, bildirim dosyasındaki ScriptsToProcess anahtarının değerinde komut dosyası adını listeleyin.

Tip :

Object[]

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-PassThru

Ortaya çıkan modül bildirimini konsola yazar ve bir .psd1 dosyası oluşturur. Varsayılan olarak bu cmdlet herhangi bir çıktı oluşturmaz.

Tip :

SwitchParameter

Konum:

Adlandırılmış

Varsayılan değer:

False

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-Path

Yeni modül bildiriminin yolunu ve dosya adını belirtir. $pshome\Modules\MyModule\MyModule.psd1 gibi .psd1 dosya adı uzantısına sahip bir yol ve dosya adı girin. Yol parametresi gereklidir.

Mevcut bir dosyanın yolunu belirtirseniz, dosya salt okunur özniteliğe sahip olmadığı sürece New-ModuleManifest, uyarı vermeden dosyayı değiştirir.

Bildirim, modülün dizininde yer almalı ve bildirim dosyasının adı, modül dizini adıyla aynı olmalı, ancak .psd1 dosya adı uzantısına sahip olmalıdır.

Not

Path parametre değeri istemine yanıt olarak $PSHOME veya $HOME gibi değişkenleri kullanamazsınız. Bir değişken kullanmak için komuta Yol parametresini ekleyin.

Tip :

String

Konum:

1

Varsayılan değer:

None

Gerekli:

True

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-PowerShellHostName

Modülün gerektirdiği PowerShell ana bilgisayar programının adını belirtir. Ana bilgisayar programının adını girin (örneğin, Windows PowerShell ISE Ana Bilgisayarı veya ConsoleHost). Joker karakterlere izin verilmez.

Bir ana bilgisayar programının adını bulmak için programa $Host.Name yazın.

Tip :

String

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-PowerShellHostVersion

Modülle çalışan PowerShell ana bilgisayar programının minimum sürümünü belirtir. 1.1 gibi bir sürüm numarası girin.

Tip :

Sürüm

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-PowerShellVersion

Bu modülle çalışan minimum PowerShell sürümünü belirtir. Örneğin parametre değeri olarak 1,0, 2,0 veya 3,0 girebilirsiniz. X.X formatında olmalıdır. Örneğin 5 gönderirseniz PowerShell bir hata verecektir.

Tip :

Sürüm

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-Prerelease

Bu modülün yayın öncesi dizisi. Bir Ön Sürüm dizesinin eklenmesi, modülün bir ön sürüm sürümü olduğunu tanımlar. Modül PowerShell Galerisi'nde yayınlandığında bu veriler ön sürüm paketlerini tanımlamak için kullanılır. Galeri'den ön sürüm paketleri almak için AllowPrerelease parametresini PowerShellGet komutları Find-Module, Install-Module, ile birlikte kullanmanız gerekir. Güncelleme Modülü ve Modül Kaydetme.

Tip :

String

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-PrivateData

İçe aktarıldığında modüle aktarılan verileri belirtir.

Tip :

Nesne

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-ProcessorArchitecture

Modülün gerektirdiği işlemci mimarisini belirtir. Geçerli değerler x86, AMD64, IA64, MSIL ve Hiçbiri'dir (bilinmiyor veya belirtilmemiş).

Tip :

ProcessorArchitecture

Kabul edilen değerler:

Yok, MSIL, X86, IA64, Amd64, Arm

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-ProjectUri

Bu projeyle ilgili bir web sayfasının URL'sini belirtir.

Tip :

Uri

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-ReleaseNotes

Sürüm notlarını belirtir.

Tip :

String

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-RequiredAssemblies

Modülün gerektirdiği derleme (.dll) dosyalarını belirtir. Derleme dosya adlarını girin. PowerShell, türleri veya biçimleri güncellemeden, iç içe geçmiş modülleri içe aktarmadan veya RootModule anahtarının değerinde belirtilen modül dosyasını içe aktarmadan önce belirtilen derlemeleri yükler.

FormatsToProcess veya TypesToProcess anahtarlarında listelenen biçimlendirme veya tür dosyalarını güncellemek için yüklenmesi gereken derlemeler de dahil olmak üzere, modülün gerektirdiği tüm derlemeleri listelemek için bu parametreyi kullanın. bu derlemeler NestedModules anahtarında ikili modüller olarak listelenmiş olsa bile.

Tip :

String[]

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-RequiredModules

Genel oturum durumunda olması gereken modülleri belirtir. Gerekli modüller genel oturum durumunda değilse PowerShell bunları içe aktarır. Gerekli modüller mevcut değilse Import-Module komutu başarısız olur.

Her modül adını ModuleName ve ModuleVersion tuşlarıyla bir dize veya karma tablo olarak girin. Karma tablosunda isteğe bağlı bir GUID anahtarı da bulunabilir. Dizeleri ve karma tabloları parametre değerinde birleştirebilirsiniz.

PowerShell 2,0'da Import-Module gerekli modülleri otomatik olarak içe aktarmaz. Yalnızca gerekli modüllerin genel oturum durumunda olduğunu doğrular.

Tip :

Object[]

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-RequireLicenseAcceptance

Modülün yükleme, güncelleme veya kaydetme için açık kullanıcı kabulü gerektirip gerektirmediğini belirten işaret.

Tip :

SwitchParameter

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-RootModule

Modülün birincil veya kök dosyasını belirtir. Bir komut dosyasının dosya adını (.ps1), bir komut dosyasının modülünü (.psm1), bir modül bildirimini (.psd1), ve bir komut dosyasını girin derleme (.dll), bir cmdlet tanımı XML dosyası (.cdxml) veya bir iş akışı (.xaml). Modül içe aktarıldığında, kök modül dosyasından dışa aktarılan üyeler arayanın oturum durumuna aktarılır.

Bir modülün bir bildirim dosyası varsa ve RootModule anahtarında herhangi bir kök dosya atanmamışsa, bildirim, modülün birincil dosyası haline gelir ve modül, bir bildirim modülü haline gelir (ModuleType=Manifest).

Bildirimi olan bir modüldeki .psm1 veya .dll dosyalarından üyeleri dışa aktarmak için bu dosyaların adları RootModule< değerlerinde belirtilmelidir. Manifest'te veya NestedModules anahtarlarını kullanın. Aksi takdirde üyeleri dışa aktarılmaz.

Not

PowerShell 2.0'da bu anahtara ModuleToProcess adı verildi. RootModule parametre adını veya ModuleToProcess takma adını kullanabilirsiniz.

Tip :

String

Takma adlar:

ModuleToProcess

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-ScriptsToProcess

Modül içe aktarıldığında arayanın oturum durumunda çalışacak komut dosyası (.ps1) dosyalarını belirtir. Bu komut dosyalarını, tıpkı bir oturum açma komut dosyası kullandığınız gibi, bir ortam hazırlamak için kullanabilirsiniz.

Modülün oturum durumunda çalışan komut dosyalarını belirtmek için NestedModules anahtarını kullanın.

Tip :

String[]

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-Tags

Bir etiket dizisini belirtir.

Tip :

String[]

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-TypesToProcess

Modül içe aktarıldığında çalıştırılan tür dosyalarını (.ps1xml) belirtir.

Modülü içe aktardığınızda PowerShell, belirtilen dosyalarla Update-TypeData cmdlet'ini çalıştırır. Tür dosyalarının kapsamı belirlenmediğinden oturumdaki tüm oturum durumlarını etkiler.

Tip :

String[]

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-VariablesToExport

Modülün dışa aktardığı değişkenleri belirtir. Joker karakterlere izin verilir.

Modül tarafından dışa aktarılan değişkenleri kısıtlamak için bu parametreyi kullanabilirsiniz. Dışa aktarılan değişkenler listesinden değişkenleri kaldırabilir ancak listeye değişken ekleyemez.

Bu parametreyi atlarsanız, New-ModuleManifest, * (tümü) değerine sahip bir VariablesToExport anahtarı oluşturur; bu, modül manifest tarafından dışa aktarılır.

Tip :

String[]

Konum:

Adlandırılmış

Varsayılan değer:

* (Tümü)

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

True

-WhatIf

New-ModuleManifest çalıştırılırsa ne olacağını gösterir. Cmdlet çalıştırılmıyor.

Tip :

SwitchParameter

Takma adlar:

wi

Konum:

Adlandırılmış

Varsayılan değer:

False

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

Girişler

Yok

Nesneleri bu cmdlet'e aktaramazsınız.

Çıkışlar

Yok

Varsayılan olarak bu cmdlet hiçbir çıktı döndürmez.

Dize

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

Notlar

Windows ve Windows dışı platformlarda çalışan New-ModuleManifest, UTF8NoBOM olarak kodlanmış modül bildirimi (.psd1) dosyaları oluşturur.

Modül bildirimleri genellikle isteğe bağlıdır. Ancak genel derleme önbelleğinde yüklü olan bir derlemeyi dışarı aktarmak için bir modül bildirimi gereklidir.

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

Not

PowerShell 6,2'den itibaren PowerShell, modül bildiriminin FileList özelliğinde listelenen tüm DLL dosyalarını yüklemeye çalışır. FileList'te bulunan yerel DLL'ler işlem sırasında yüklenemiyor ve hata göz ardı ediliyor. Yönetilen tüm DLL'ler süreçte yüklenir. Bu davranış PowerShell 7.1'de kaldırılmıştır.

PowerShell 2.0'da, New-ModuleManifest'in birçok parametresi, bir modül bildiriminde zorunlu olmasa da zorunluydu. PowerShell 3.0'dan itibaren yalnızca Yol parametresi zorunludur.

Oturum, PowerShell yürütme ortamının bir örneğidir. Bir oturumun bir veya daha fazla oturum durumu olabilir. Varsayılan olarak bir oturumun yalnızca genel bir oturum durumu vardır ancak içe 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.

Arayanın oturum durumu, bir modülün içe aktarıldığı oturum durumudur. Genellikle genel oturum durumuna atıfta bulunur, ancak bir modül iç içe geçmiş modülleri içe aktardığında, arayan modüldür ve arayanın oturum durumu da modülün oturum durumudur.

İlgili makaleler