Update-ModuleManifest

Updates file manifes modul.

Sintaks

Update-ModuleManifest
      [-Path] <String>
      [-NestedModules <Object[]>]
      [-Guid <Guid>]
      [-Author <String>]
      [-CompanyName <String>]
      [-Copyright <String>]
      [-RootModule <String>]
      [-ModuleVersion <Version>]
      [-Description <String>]
      [-ProcessorArchitecture <ProcessorArchitecture>]
      [-CompatiblePSEditions <String[]>]
      [-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[]>]
      [-PrivateData <Hashtable>]
      [-Tags <String[]>]
      [-ProjectUri <Uri>]
      [-LicenseUri <Uri>]
      [-IconUri <Uri>]
      [-ReleaseNotes <String[]>]
      [-Prerelease <String>]
      [-HelpInfoUri <Uri>]
      [-PassThru]
      [-DefaultCommandPrefix <String>]
      [-ExternalModuleDependencies <String[]>]
      [-PackageManagementProviders <String[]>]
      [-RequireLicenseAcceptance]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Deskripsi

Cmdlet Update-ModuleManifest memperbarui file manifes modul (.psd1).

Contoh

Contoh 1: Memperbarui manifes modul

Contoh ini memperbarui file manifes modul yang ada. Splatting digunakan untuk meneruskan nilai parameter ke Update-ModuleManifest. Untuk informasi selengkapnya, lihat about_Splatting.

$Params = @{
  Path = "C:\Test\TestManifest.psd1"
  Author = "TestUser1"
  CompanyName = "Contoso Corporation"
  Copyright = "(c) 2019 Contoso Corporation. All rights reserved."
}

Update-ModuleManifest @Params

$Params adalah splat yang menyimpan nilai parameter untuk Path, Author, CompanyName, dan Copyright. Update-ModuleManifest mendapatkan nilai parameter dari @Params dan memperbarui manifes modul, TestManifest.psd1.

Parameter

-AliasesToExport

Menentukan alias yang diekspor modul. Kartubebas diizinkan.

Gunakan parameter ini untuk membatasi alias yang diekspor oleh modul. AliasesToExport dapat menghapus alias dari daftar alias yang diekspor, tetapi tidak dapat menambahkan alias ke daftar.

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

-Author

Menentukan penulis modul.

Type:String
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False

-CmdletsToExport

Menentukan cmdlet yang diekspor modul. Kartubebas diizinkan.

Gunakan parameter ini untuk membatasi cmdlet yang diekspor oleh modul. CmdletsToExport dapat menghapus cmdlet dari daftar cmdlet yang diekspor, tetapi tidak dapat menambahkan cmdlet ke daftar.

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

-CompanyName

Menentukan perusahaan atau vendor yang membuat modul.

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

-CompatiblePSEditions

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

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

-Confirm

Meminta konfirmasi sebelum menjalankan Update-ModuleManifest.

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

-Copyright

Menentukan pernyataan hak cipta untuk modul.

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

-DefaultCommandPrefix

Menentukan awalan perintah default.

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

-Description

Menentukan deskripsi modul.

Type:String
Position:Named
Default value:None
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
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
Accept pipeline input:False
Accept wildcard characters:False

-ExternalModuleDependencies

Menentukan array dependensi modul eksternal.

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

-FileList

Menentukan semua item yang disertakan dalam modul.

Type:String[]
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False

-FunctionsToExport

Menentukan fungsi yang diekspor modul. Kartubebas diizinkan.

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

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

-Guid

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

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

-HelpInfoUri

Menentukan alamat internet file XML HelpInfo 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 versi 3.0. Ini berisi informasi tentang lokasi file bantuan modul yang dapat diunduh 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.

Type:Uri
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False

-LicenseUri

Menentukan URL istilah lisensi untuk modul.

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

-ModuleList

Menentukan array modul yang disertakan dalam modul.

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 inventori modul. Modul yang tercantum dalam nilai kunci ini tidak diproses secara otomatis.

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

-ModuleVersion

Menentukan versi modul.

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

-NestedModules

Menentukan modul skrip (.psm1) dan modul biner (.dll) yang diimpor ke 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.

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

-PackageManagementProviders

Menentukan array penyedia manajemen paket.

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

-PassThru

Mengembalikan objek yang mewakili item yang sedang Anda kerjakan. Secara default, Update-ModuleManifest tidak menghasilkan output apa pun.

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

-Path

Menentukan jalur dan nama file manifes modul. Masukkan jalur dan nama file dengan .psd1 ekstensi nama file, seperti $PSHOME\Modules\MyModule\MyModule.psd1.

Jika Anda menentukan jalur ke file yang ada, Update-ModuleManifest mengganti 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.

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

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

-PowerShellHostName

Menentukan nama program host PowerShell yang diperlukan modul. Masukkan nama program host, seperti 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
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
Accept pipeline input:False
Accept wildcard characters:False

-PowerShellVersion

Menentukan versi minimum PowerShell yang akan berfungsi dengan modul ini. Misalnya, Anda dapat menentukan 3.0, 4.0, atau 5.0 sebagai nilai parameter ini.

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

-Prerelease

Menunjukkan modul adalah prarilis.

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

-PrivateData

Menentukan data yang diteruskan ke modul saat diimpor.

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

-ProcessorArchitecture

Menentukan arsitektur prosesor yang diperlukan modul.

Nilai yang dapat diterima untuk parameter ini adalah:

  • Amd64
  • Lengan
  • IA64
  • MSIL
  • Tidak ada (tidak diketahui atau tidak ditentukan)
  • X86
Type:ProcessorArchitecture
Accepted values:None, MSIL, X86, IA64, Amd64, Arm
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-ProjectUri

Menentukan URL halaman web tentang proyek ini.

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

-ReleaseNotes

Menentukan array string yang berisi catatan rilis atau komentar yang Anda inginkan tersedia untuk versi skrip ini.

Type:String[]
Position:Named
Default value:None
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 menentukan 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 dalam kunci NestedModules .

Type:String[]
Position:Named
Default value:None
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.

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

-RequireLicenseAcceptance

Menentukan bahwa penerimaan lisensi diperlukan untuk modul.

Type:SwitchParameter
Position:Named
Default value:None
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 ditentukan 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.

Di PowerShell 2.0, kunci ini disebut ModuleToProcess.

Type:String
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False

-Tags

Menentukan array tag.

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

-TypesToProcess

Menentukan file jenis (.ps1xml) yang berjalan saat 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
Accept pipeline input:False
Accept wildcard characters:False

-VariablesToExport

Menentukan variabel yang diekspor modul. Kartubebas diizinkan.

Gunakan parameter ini untuk membatasi variabel yang diekspor oleh modul. VariablesToExport dapat menghapus variabel dari daftar variabel yang diekspor, tetapi tidak dapat menambahkan variabel ke daftar.

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

-WhatIf

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

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

Input

String

Output

Object

Catatan

Penting

Pada April 2020, PowerShell Gallery tidak lagi mendukung Transport Layer Security (TLS) versi 1.0 dan 1.1. Jika Anda tidak menggunakan TLS 1.2 atau yang lebih tinggi, Anda akan menerima kesalahan saat mencoba mengakses Galeri PowerShell. Gunakan perintah berikut untuk memastikan Anda menggunakan TLS 1.2:

[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12

Untuk informasi selengkapnya, lihat pengumuman di blog PowerShell.