New-ModuleManifest

Membuat manifes modul baru.

Sintaks

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

Deskripsi

New-ModuleManifest Cmdlet membuat file manifes modul baru (.psd1), mengisi nilainya, dan menyimpan file manifes di jalur yang ditentukan.

Penulis modul dapat menggunakan cmdlet ini untuk membuat manifes untuk modul mereka. Manifes modul adalah .psd1 file yang berisi tabel hash. Kunci dan nilai dalam tabel hash menjelaskan konten dan atribut modul, menentukan prasyarat, dan menentukan bagaimana komponen diproses. Manifes tidak diperlukan untuk modul.

New-ModuleManifest membuat manifes yang menyertakan semua kunci manifes yang umum digunakan, sehingga Anda dapat menggunakan output default sebagai templat manifes. Untuk menambahkan atau mengubah nilai, atau untuk menambahkan kunci modul yang tidak ditambahkan cmdlet ini, buka file yang dihasilkan di editor teks.

Setiap parameter, kecuali Untuk Path dan PassThru, membuat kunci manifes modul dan nilainya. Dalam manifes modul, hanya kunci ModuleVersion yang diperlukan. Kecuali ditentukan dalam deskripsi parameter, jika Anda menghilangkan parameter dari perintah, New-ModuleManifest membuat string komentar untuk nilai terkait yang tidak berpengaruh.

Di PowerShell 2.0, New-ModuleManifest meminta nilai parameter yang umum digunakan yang tidak ditentukan dalam perintah, selain nilai parameter yang diperlukan. Dimulai di PowerShell 3.0, New-ModuleManifest hanya meminta saat nilai parameter yang diperlukan tidak ditentukan.

Jika Anda berencana menerbitkan modul di Galeri PowerShell, manifes harus berisi nilai untuk properti tertentu. Untuk informasi selengkapnya, lihat Metadata yang diperlukan untuk item yang diterbitkan ke Galeri PowerShell dalam dokumentasi Galeri.

Contoh

Contoh 1 - Membuat manifes modul baru

Contoh ini membuat manifes modul baru dalam file yang ditentukan oleh parameter Jalur . Parameter PassThru mengirimkan output ke alur dan ke file.

Output menunjukkan nilai default semua kunci dalam manifes.

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

}

Contoh 2 - Buat manifes baru dengan beberapa pengaturan yang telah diisi sebelumnya

Contoh ini membuat manifes modul baru. Ini menggunakan parameter PowerShellVersion dan AliasesToExport untuk menambahkan nilai ke kunci manifes yang sesuai.

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

Contoh 3 - Membuat manifes yang memerlukan modul lain

Contoh ini menggunakan format string untuk menentukan nama modul BitsTransfer dan format tabel hash untuk menentukan nama, GUID, dan versi modul 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

Contoh ini menunjukkan cara menggunakan format tabel string dan hash parameter ModuleList, RequiredModules, dan NestedModules. Anda dapat menggabungkan string dan tabel hash dalam nilai parameter yang sama.

Contoh 4 - Buat manifes yang mendukung bantuan yang dapat diperbarui

Contoh ini menggunakan parameter HelpInfoUri untuk membuat kunci HelpInfoUri dalam manifes modul. Nilai parameter dan kunci harus dimulai dengan http atau https. Nilai ini memberi tahu sistem Bantuan yang Dapat Diperbarui tempat menemukan file informasi bantuan yang dapat diperbarui XML HelpInfo untuk modul.

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

Untuk informasi tentang Bantuan yang Dapat Diperbarui, lihat about_Updatable_Help. Untuk informasi tentang file XML HelpInfo, lihat Mendukung Bantuan yang Dapat Diperbarui.

Contoh 5 - Mendapatkan informasi modul

Contoh ini menunjukkan cara mendapatkan nilai konfigurasi modul. Nilai dalam manifes modul tercermin dalam nilai properti objek modul.

Get-Module Cmdlet digunakan untuk mendapatkan modul Microsoft.PowerShell.Diagnostics menggunakan parameter Daftar. Perintah mengirimkan modul ke Format-List cmdlet untuk menampilkan semua properti dan nilai objek modul.

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

Menentukan alias yang diekspor modul. Kartubebas diizinkan.

Anda dapat menggunakan parameter ini untuk membatasi alias yang diekspor oleh modul. Ini dapat menghapus alias dari daftar alias yang diekspor, tetapi tidak dapat menambahkan alias ke daftar.

Jika Anda menghilangkan parameter ini, New-ModuleManifest buat kunci AliasesToExport dengan nilai * (semua), yang berarti bahwa semua alias yang ditentukan dalam modul diekspor oleh manifes.

Type:String[]
Position:Named
Default value:* (all)
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-Author

Menentukan penulis modul.

Jika Anda menghilangkan parameter ini, New-ModuleManifest buat kunci Penulis dengan nama pengguna saat ini.

Type:String
Position:Named
Default value:Name of the current user
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ClrVersion

Menentukan versi minimum Common Language Runtime (CLR) dari Microsoft .NET Framework yang diperlukan modul.

Catatan

Pengaturan ini hanya berlaku untuk edisi PowerShell Desktop, seperti Windows PowerShell 5.1, dan hanya berlaku untuk versi .NET Framework yang lebih rendah dari 4.5. Persyaratan ini tidak berpengaruh untuk versi PowerShell atau .NET Framework yang lebih baru.

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

-CmdletsToExport

Menentukan cmdlet yang diekspor modul. Kartubebas diizinkan.

Anda dapat menggunakan parameter ini untuk membatasi cmdlet yang diekspor oleh modul. Ini dapat menghapus cmdlet dari daftar cmdlet yang diekspor, tetapi tidak dapat menambahkan cmdlet ke daftar.

Jika Anda menghilangkan parameter ini, New-ModuleManifest membuat kunci CmdletsToExport dengan nilai * (semua), yang berarti bahwa semua cmdlet yang ditentukan dalam modul diekspor oleh manifes.

Type:String[]
Position:Named
Default value:* (all)
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-CompanyName

Mengidentifikasi perusahaan atau vendor yang membuat modul.

Jika Anda menghilangkan parameter ini, New-ModuleManifest buat kunci CompanyName dengan nilai "Tidak Diketahui".

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

-CompatiblePSEditions

Menentukan PSEdisi yang kompatibel dengan modul. Untuk informasi tentang PSEdition, lihat Modul dengan Edisi PowerShell yang kompatibel.

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

-Confirm

Meminta Anda mengonfirmasi sebelum menjalankan cmdlet.

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

Menentukan pernyataan hak cipta untuk modul.

Jika Anda menghilangkan parameter ini, New-ModuleManifest membuat kunci Hak Cipta dengan nilai (c) <year> <username>. All rights reserved. di mana <year> adalah tahun saat ini dan <username> merupakan nilai kunci Penulis .

Type:String
Position:Named
Default value:(c) <year> <username>. All rights reserved.
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultCommandPrefix

Menentukan awalan yang diawali ke kata benda semua perintah dalam modul saat diimpor ke dalam sesi. Masukkan string awalan. Awalan mencegah konflik nama perintah dalam sesi pengguna.

Pengguna modul dapat mengambil alih awalan ini dengan menentukan parameter AwalanImport-Module cmdlet.

Parameter ini diperkenalkan di PowerShell 3.0.

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

-Description

Menjelaskan konten modul.

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

-DotNetFrameworkVersion

Menentukan versi minimum Microsoft .NET Framework yang diperlukan modul.

Catatan

Pengaturan ini hanya berlaku untuk edisi PowerShell Desktop, seperti Windows PowerShell 5.1, dan hanya berlaku untuk versi .NET Framework yang lebih rendah dari 4.5. Persyaratan ini tidak berpengaruh untuk versi PowerShell atau .NET Framework yang lebih baru.

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

-DscResourcesToExport

Menentukan sumber daya Desired State Configuration (DSC) yang diekspor modul. Kartubebas diizinkan.

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

-ExternalModuleDependencies

Daftar modul eksternal yang bergantung pada modul ini.

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

-FileList

Menentukan semua item yang disertakan dalam modul.

Kunci ini dirancang untuk bertindak sebagai inventaris modul. File yang tercantum dalam kunci disertakan saat modul diterbitkan, tetapi fungsi apa pun tidak diekspor secara otomatis.

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

-FormatsToProcess

Menentukan file pemformatan (.ps1xml) yang berjalan saat modul diimpor.

Saat Anda mengimpor modul, PowerShell menjalankan Update-FormatData cmdlet dengan file yang ditentukan. Karena file pemformatan tidak terlingkup, file tersebut memengaruhi semua status sesi dalam sesi.

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

-FunctionsToExport

Menentukan fungsi yang diekspor modul. Kartubebas diizinkan.

Anda dapat menggunakan parameter ini untuk membatasi fungsi yang diekspor oleh modul. Ini dapat menghapus fungsi dari daftar alias yang diekspor, tetapi tidak dapat menambahkan fungsi ke daftar.

Jika Anda menghilangkan parameter ini, New-ModuleManifest membuat kunci FunctionsToExport dengan nilai * (semua), yang berarti bahwa semua fungsi yang ditentukan dalam modul diekspor oleh manifes.

Type:String[]
Position:Named
Default value:* (all)
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-Guid

Menentukan pengidentifikasi unik untuk modul. GUID dapat digunakan untuk membedakan antara modul dengan nama yang sama.

Jika Anda menghilangkan parameter ini, New-ModuleManifest buat kunci GUID dalam manifes dan menghasilkan GUID untuk nilai tersebut.

Untuk membuat GUID baru di PowerShell, ketik [guid]::NewGuid().

Type:Guid
Position:Named
Default value:A GUID generated for the module
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HelpInfoUri

Menentukan alamat internet file XML HelpInfo untuk modul. Masukkan Pengidentifikasi Sumber Daya Seragam (URI) yang dimulai dengan http atau https.

File XML HelpInfo mendukung fitur Bantuan yang Dapat Diperbarui yang diperkenalkan di PowerShell 3.0. Ini berisi informasi tentang lokasi file bantuan yang dapat diunduh untuk modul dan nomor versi file bantuan terbaru untuk setiap lokal yang didukung.

Untuk informasi tentang Bantuan yang Dapat Diperbarui, lihat about_Updatable_Help. Untuk informasi tentang file XML HelpInfo, lihat Mendukung Bantuan yang Dapat Diperbarui.

Parameter ini diperkenalkan di PowerShell 3.0.

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

-IconUri

Menentukan URL ikon untuk modul. Ikon yang ditentukan ditampilkan di halaman web galeri untuk modul.

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

-LicenseUri

Menentukan URL istilah lisensi untuk modul.

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

-ModuleList

Mencantumkan semua modul yang disertakan dalam modul ini.

Masukkan setiap nama modul sebagai string atau sebagai tabel hash dengan kunci ModuleName dan ModuleVersion . Tabel hash juga dapat memiliki kunci GUID opsional. Anda dapat menggabungkan string dan tabel hash dalam nilai parameter.

Kunci ini dirancang untuk bertindak sebagai inventaris modul. Modul yang tercantum dalam nilai kunci ini tidak diproses secara otomatis.

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

-ModuleVersion

Menentukan versi modul.

Parameter ini tidak diperlukan, tetapi kunci ModuleVersion diperlukan dalam manifes. Jika Anda menghilangkan parameter ini, New-ModuleManifest buat kunci ModuleVersion dengan nilai 1.0.

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

-NestedModules

Menentukan modul skrip (.psm1) dan modul biner (.dll) yang diimpor ke dalam status sesi modul. File dalam kunci NestedModules berjalan dalam urutan di mana file tersebut tercantum dalam nilai .

Masukkan setiap nama modul sebagai string atau sebagai tabel hash dengan kunci ModuleName dan ModuleVersion . Tabel hash juga dapat memiliki kunci GUID opsional. Anda dapat menggabungkan string dan tabel hash dalam nilai parameter.

Biasanya, modul berlapis berisi perintah yang dibutuhkan modul akar untuk pemrosesan internalnya. Secara default, perintah dalam modul berlapis diekspor dari status sesi modul ke status sesi pemanggil, tetapi modul akar dapat membatasi perintah yang diekspornya. Misalnya, dengan menggunakan Export-ModuleMember perintah.

Modul berlapis dalam status sesi modul tersedia untuk modul akar, tetapi tidak dikembalikan oleh Get-Module perintah dalam status sesi pemanggil.

Skrip (.ps1) yang tercantum dalam kunci NestedModules dijalankan dalam status sesi modul, bukan dalam status sesi pemanggil. Untuk menjalankan skrip dalam status sesi pemanggil, cantumkan nama file skrip dalam nilai kunci ScriptsToProcess dalam manifes.

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

-PassThru

Menulis manifes modul yang dihasilkan ke konsol dan membuat .psd1 file. Secara default, cmdlet ini tidak menghasilkan output apa pun.

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

-Path

Menentukan jalur dan nama file manifes modul baru. Masukkan jalur dan nama file dengan .psd1 ekstensi nama file, seperti $pshome\Modules\MyModule\MyModule.psd1. Parameter Jalur diperlukan.

Jika Anda menentukan jalur ke file yang ada, New-ModuleManifest ganti file tanpa peringatan kecuali file memiliki atribut baca-saja.

Manifes harus terletak di direktori modul, dan nama file manifes harus sama dengan nama direktori modul, tetapi dengan .psd1 ekstensi nama file.

Catatan

Anda tidak dapat menggunakan variabel, seperti $PSHOME atau $HOME, sebagai respons terhadap permintaan untuk nilai parameter Jalur . Untuk menggunakan variabel, sertakan parameter Jalur dalam perintah .

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

-PowerShellHostName

Menentukan nama program host PowerShell yang diperlukan modul. Masukkan nama program host, seperti Windows PowerShell ISE Host atau ConsoleHost. Kartubebas tidak diizinkan.

Untuk menemukan nama program host, dalam program, ketik $Host.Name.

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

-PowerShellHostVersion

Menentukan versi minimum program host PowerShell yang berfungsi dengan modul. Masukkan nomor versi, seperti 1.1.

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

-PowerShellVersion

Menentukan versi minimum PowerShell yang berfungsi dengan modul ini. Misalnya, Anda dapat memasukkan 1.0, 2.0, atau 3.0 sebagai nilai parameter. Ini harus dalam format X.X. Misalnya, jika Anda mengirimkan 5, PowerShell akan melemparkan kesalahan.

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

-Prerelease

String prarilis modul ini. Menambahkan string Prarilis mengidentifikasi modul sebagai versi prarilis. Saat modul diterbitkan ke Galeri PowerShell, data ini digunakan untuk mengidentifikasi paket prarilis. Untuk memperoleh paket prarilis dari Galeri, Anda harus menggunakan parameter AllowPrerelease dengan perintah Find-ModulePowerShellGet , , Install-ModuleUpdate-Module, dan Save-Module.

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

-PrivateData

Menentukan data yang diteruskan ke modul saat diimpor.

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

-ProcessorArchitecture

Menentukan arsitektur prosesor yang diperlukan modul. Nilai yang valid adalah x86, AMD64, IA64, MSIL, dan None (tidak diketahui atau tidak ditentukan).

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

-ProjectUri

Menentukan URL halaman web tentang proyek ini.

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

-ReleaseNotes

Menentukan catatan rilis.

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

-RequiredAssemblies

Menentukan file assembly (.dll) yang diperlukan modul. Masukkan nama file rakitan. PowerShell memuat rakitan yang ditentukan sebelum memperbarui jenis atau format, mengimpor modul berlapis, atau mengimpor file modul yang ditentukan dalam nilai kunci RootModule .

Gunakan parameter ini untuk mencantumkan semua rakitan yang diperlukan modul, termasuk rakitan yang harus dimuat untuk memperbarui pemformatan atau mengetik file yang tercantum dalam kunci FormatsToProcess atau TypeToProcess , bahkan jika rakitan tersebut juga terdaftar sebagai modul biner di kunci NestedModules .

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

-RequiredModules

Menentukan modul yang harus dalam status sesi global. Jika modul yang diperlukan tidak dalam status sesi global, PowerShell mengimpornya. Jika modul yang diperlukan tidak tersedia, Import-Module perintah gagal.

Masukkan setiap nama modul sebagai string atau sebagai tabel hash dengan kunci ModuleName dan ModuleVersion . Tabel hash juga dapat memiliki kunci GUID opsional. Anda dapat menggabungkan string dan tabel hash dalam nilai parameter.

Di PowerShell 2.0, Import-Module tidak mengimpor modul yang diperlukan secara otomatis. Ini hanya memverifikasi bahwa modul yang diperlukan berada dalam status sesi global.

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

-RequireLicenseAcceptance

Bendera untuk menunjukkan apakah modul memerlukan penerimaan pengguna eksplisit untuk menginstal, memperbarui, atau menyimpan.

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

-RootModule

Menentukan file utama atau akar modul. Masukkan nama file skrip (.ps1), modul skrip (.psm1), manifes modul(.psd1), rakitan (.dll), file XML definisi cmdlet (.cdxml), atau alur kerja (.xaml). Saat modul diimpor, anggota yang diekspor dari file modul akar diimpor ke status sesi pemanggil.

Jika modul memiliki file manifes dan tidak ada file akar yang ditunjuk dalam kunci RootModule , manifes menjadi file utama untuk modul, dan modul menjadi modul manifes (ModuleType = Manifest).

Untuk mengekspor anggota dari .psm1 atau .dll file dalam modul yang memiliki manifes, nama file tersebut harus ditentukan dalam nilai kunci RootModule atau NestedModules dalam manifes. Jika tidak, anggota mereka tidak diekspor.

Catatan

Di PowerShell 2.0, kunci ini disebut ModuleToProcess. Anda dapat menggunakan nama parameter RootModule atau alias ModuleToProcess-nya .

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

-ScriptsToProcess

Menentukan file skrip (.ps1) yang berjalan dalam status sesi pemanggil saat modul diimpor. Anda dapat menggunakan skrip ini untuk menyiapkan lingkungan, sama seperti Anda dapat menggunakan skrip login.

Untuk menentukan skrip yang berjalan dalam status sesi modul, gunakan kunci NestedModules .

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

-Tags

Menentukan array tag.

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

-TypesToProcess

Menentukan jenis file (.ps1xml) yang berjalan ketika modul diimpor.

Saat Anda mengimpor modul, PowerShell menjalankan Update-TypeData cmdlet dengan file yang ditentukan. Karena file jenis tidak terlingkup, file tersebut memengaruhi semua status sesi dalam sesi.

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

-VariablesToExport

Menentukan variabel yang diekspor modul. Kartubebas diizinkan.

Anda dapat menggunakan parameter ini untuk membatasi variabel yang diekspor oleh modul. Ini dapat menghapus variabel dari daftar variabel yang diekspor, tetapi tidak dapat menambahkan variabel ke daftar.

Jika Anda menghilangkan parameter ini, New-ModuleManifest membuat kunci VariablesToExport dengan nilai * (semua), yang berarti bahwa semua variabel yang ditentukan dalam modul diekspor oleh manifes.

Type:String[]
Position:Named
Default value:* (all)
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-WhatIf

Menunjukkan apa yang akan terjadi jika New-ModuleManifest berjalan. Cmdlet tidak dijalankan.

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

Input

None

Anda tidak dapat menyalurkan objek ke cmdlet ini.

Output

None

Secara default, cmdlet ini tidak mengembalikan output.

String

Saat Anda menggunakan parameter PassThru , cmdlet ini mengembalikan string yang mewakili manifes modul.

Catatan

New-ModuleManifest berjalan pada platform Windows dan non-Windows membuat file manifes modul (.psd1) yang dikodekan sebagai UTF8NoBOM.

Manifes modul biasanya opsional. Namun, manifes modul diperlukan untuk mengekspor rakitan yang diinstal di cache perakitan global.

Untuk menambahkan atau mengubah file di $pshome\Modules direktori, mulai PowerShell dengan opsi Jalankan sebagai administrator .

Catatan

Dimulai di PowerShell 6.2, PowerShell mencoba memuat semua file DLL yang tercantum dalam properti FileList dari manifes modul. DLL asli ada di FileList yang gagal dimuat dalam proses dan kesalahan diabaikan. Semua DLL terkelola dimuat dalam proses. Perilaku ini dihapus di PowerShell 7.1.

Di PowerShell 2.0, banyak parameter New-ModuleManifest wajib, meskipun tidak diperlukan dalam manifes modul. Dimulai di PowerShell 3.0, hanya parameter Jalur yang wajib.

Sesi adalah instans lingkungan eksekusi PowerShell. Sesi dapat memiliki satu atau beberapa status sesi. Secara default, sesi hanya memiliki status sesi global, tetapi setiap modul yang diimpor memiliki status sesinya sendiri. Status sesi memungkinkan perintah dalam modul berjalan tanpa memengaruhi status sesi global.

Status sesi pemanggil adalah status sesi tempat modul diimpor. Biasanya, ini mengacu pada status sesi global, tetapi ketika modul mengimpor modul berlapis, pemanggil adalah modul dan status sesi pemanggil adalah status sesi modul.