Bagikan melalui

Publish-Module

  • Referensi
Modul:
PowerShellGet

Menerbitkan modul tertentu dari komputer lokal ke galeri online.

Sintaks

Publish-Module
       -Name <String>
       [-RequiredVersion <String>]
       [-NuGetApiKey <String>]
       [-Repository <String>]
       [-Credential <PSCredential>]
       [-FormatVersion <Version>]
       [-ReleaseNotes <String[]>]
       [-Tags <String[]>]
       [-LicenseUri <Uri>]
       [-IconUri <Uri>]
       [-ProjectUri <Uri>]
       [-Exclude <String[]>]
       [-Force]
       [-AllowPrerelease]
       [-SkipAutomaticTags]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Publish-Module
       -Path <String>
       [-NuGetApiKey <String>]
       [-Repository <String>]
       [-Credential <PSCredential>]
       [-FormatVersion <Version>]
       [-ReleaseNotes <String[]>]
       [-Tags <String[]>]
       [-LicenseUri <Uri>]
       [-IconUri <Uri>]
       [-ProjectUri <Uri>]
       [-Force]
       [-SkipAutomaticTags]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Deskripsi

Publish-Module Cmdlet menerbitkan modul ke galeri berbasis NuGet online dengan menggunakan kunci API, disimpan sebagai bagian dari profil pengguna di galeri. Anda dapat menentukan modul untuk diterbitkan baik dengan nama modul, atau dengan jalur ke folder yang berisi modul.

Ini adalah cmdlet proksi untuk Publish-PSResource cmdlet di Microsoft.PowerShell.PSResourceGet. Untuk informasi selengkapnya, lihat Publish-PSResource.

Contoh

Contoh 1: Menerbitkan modul

Dalam contoh ini, MyDscModule diterbitkan ke galeri online dengan menggunakan kunci API untuk menunjukkan akun galeri online pemilik modul. Jika MyDscModule bukan modul manifes yang valid yang menentukan nama, versi, deskripsi, dan penulis, kesalahan terjadi.

Publish-Module -Path c:\projects\MyDscModule\1.0.0 -NuGetApiKey "11e4b435-6cb4-4bf7-8611-5162ed75eb73"

Contoh 2: Menerbitkan modul dengan metadata galeri

Dalam contoh ini, MyDscModule diterbitkan ke galeri online dengan menggunakan kunci API untuk menunjukkan akun galeri pemilik modul. Metadata tambahan yang disediakan ditampilkan di halaman web untuk modul di galeri. Pemilik menambahkan dua tag pencarian untuk modul, yang berkaitan dengan Direktori Aktif; catatan rilis singkat ditambahkan. Jika MyDscModule bukan modul manifes yang valid yang menentukan nama, versi, deskripsi, dan penulis, kesalahan terjadi.

$parameters = @{
    Path        = 'c:\projects\MyDscModule\1.0.0'
    NuGetApiKey = '11e4b435-6cb4-4bf7-8611-5162ed75eb73'
    LicenseUri  = 'http://contoso.com/license'
    Tag         = 'Active Directory','DSC'
    ReleaseNote = 'Updated the ActiveDirectory DSC Resources to support adding users.'
}
Publish-Module @parameters

Parameter

-AllowPrerelease

Cmdlet proksi mengabaikan parameter ini karena tidak didukung oleh Publish-PSResource.

Jenis:SwitchParameter
Position:Named
Nilai default:False
Diperlukan:False
Terima input alur:False
Terima karakter wildcard:False

-Confirm

Meminta konfirmasi sebelum menjalankan Publish-Module.

Jenis:SwitchParameter
Alias:cf
Position:Named
Nilai default:False
Diperlukan:False
Terima input alur:False
Terima karakter wildcard:False

-Credential

Menentukan akun pengguna yang memiliki hak untuk menerbitkan modul untuk penyedia paket atau sumber tertentu.

Jenis:PSCredential
Position:Named
Nilai default:None
Diperlukan:False
Terima input alur:True
Terima karakter wildcard:False

-Exclude

Cmdlet proksi mengabaikan parameter ini karena tidak didukung oleh Publish-PSResource.

Jenis:String[]
Position:Named
Nilai default:None
Diperlukan:False
Terima input alur:False
Terima karakter wildcard:False

-Force

Cmdlet proksi mengabaikan parameter ini karena tidak didukung oleh Publish-PSResource.

Jenis:SwitchParameter
Position:Named
Nilai default:False
Diperlukan:False
Terima input alur:False
Terima karakter wildcard:False

-FormatVersion

Cmdlet proksi mengabaikan parameter ini karena tidak didukung oleh Publish-PSResource.

Jenis:Version
Nilai yang diterima:2.0
Position:Named
Nilai default:None
Diperlukan:False
Terima input alur:False
Terima karakter wildcard:False

-IconUri

Cmdlet proksi mengabaikan parameter ini karena tidak didukung oleh Publish-PSResource.

Jenis:Uri
Position:Named
Nilai default:None
Diperlukan:False
Terima input alur:False
Terima karakter wildcard:False

-LicenseUri

Cmdlet proksi mengabaikan parameter ini karena tidak didukung oleh Publish-PSResource.

Jenis:Uri
Position:Named
Nilai default:None
Diperlukan:False
Terima input alur:False
Terima karakter wildcard:False

-Name

Cmdlet proksi mengabaikan parameter ini karena tidak didukung oleh Publish-PSResource.

Jenis:String
Position:Named
Nilai default:None
Diperlukan:True
Terima input alur:True
Terima karakter wildcard:False

-NuGetApiKey

Menentukan kunci API yang ingin Anda gunakan untuk menerbitkan modul ke galeri online. Kunci API adalah bagian dari profil Anda di galeri online, dan dapat ditemukan di halaman akun pengguna Anda di galeri. Kunci API adalah fungsionalitas khusus NuGet.

Cmdlet proksi memetakan parameter ini ke parameter ApiKey dari Publish-PSResource.

Jenis:String
Position:Named
Nilai default:None
Diperlukan:False
Terima input alur:False
Terima karakter wildcard:False

-Path

Menentukan jalur ke modul yang ingin Anda terbitkan. Parameter ini menerima jalur ke folder yang berisi modul. Folder harus memiliki nama yang sama dengan modul.

Jenis:String
Position:Named
Nilai default:None
Diperlukan:True
Terima input alur:True
Terima karakter wildcard:False

-ProjectUri

Cmdlet proksi mengabaikan parameter ini karena tidak didukung oleh Publish-PSResource.

Jenis:Uri
Position:Named
Nilai default:None
Diperlukan:False
Terima input alur:False
Terima karakter wildcard:False

-ReleaseNotes

Cmdlet proksi mengabaikan parameter ini karena tidak didukung oleh Publish-PSResource.

Jenis:String[]
Position:Named
Nilai default:None
Diperlukan:False
Terima input alur:False
Terima karakter wildcard:False

-Repository

Menentukan nama yang mudah diingat dari repositori yang telah didaftarkan dengan menjalankan Register-PSRepository. Repositori harus memiliki PublishLocation, yang merupakan URI NuGet yang valid. PublishLocation dapat diatur dengan menjalankan Set-PSRepository.

Jenis:String
Position:Named
Nilai default:None
Diperlukan:False
Terima input alur:False
Terima karakter wildcard:False

-RequiredVersion

Cmdlet proksi mengabaikan parameter ini karena tidak didukung oleh Publish-PSResource.

Jenis:String
Position:Named
Nilai default:None
Diperlukan:False
Terima input alur:False
Terima karakter wildcard:False

-SkipAutomaticTags

Cmdlet proksi mengabaikan parameter ini karena tidak didukung oleh Publish-PSResource.

Jenis:SwitchParameter
Position:Named
Nilai default:False
Diperlukan:False
Terima input alur:False
Terima karakter wildcard:False

-Tags

Cmdlet proksi mengabaikan parameter ini karena tidak didukung oleh Publish-PSResource.

Jenis:String[]
Position:Named
Nilai default:None
Diperlukan:False
Terima input alur:False
Terima karakter wildcard:False

-WhatIf

Menunjukkan apa yang akan terjadi jika Publish-Module dijalankan. Cmdlet tidak dijalankan.

Jenis:SwitchParameter
Alias:wi
Position:Named
Nilai default:False
Diperlukan:False
Terima input alur:False
Terima karakter wildcard:False

Input

String

PSCredential

Output

Object

Catatan

PowerShell menyertakan alias berikut untuk Publish-Module:

  • Semua platform:
    • pumo

Publish-Module berjalan pada PowerShell 3.0 atau yang lebih baru rilis PowerShell, pada Windows 7 atau Windows 2008 R2 dan rilis Windows yang lebih baru.

Galeri PowerShell tidak lagi mendukung Transport Layer Security (TLS) versi 1.0 dan 1.1. Anda harus menggunakan TLS 1.2 atau yang lebih tinggi. Gunakan perintah berikut untuk memastikan Anda menggunakan TLS 1.2:

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

Menerbitkan modul memerlukan metadata yang ditampilkan di halaman galeri untuk modul. Metadata yang diperlukan mencakup nama modul, versi, deskripsi, dan penulis. Metadata harus ditentukan dalam manifes modul. Untuk informasi selengkapnya, lihat Mengemas nilai manifes yang memengaruhi UI Galeri PowerShell.