Bagikan melalui


Publish-Module

Menerbitkan modul tertentu dari komputer lokal ke galeri online.

Sintaks

ModuleNameParameterSet (Default)

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

ModulePathParameterSet

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

cmdlet Publish-Module 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.

Properti parameter

Jenis:SwitchParameter
Nilai default:False
Mendukung wildcard:False
DontShow:False

Set parameter

ModuleNameParameterSet
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-Confirm

Meminta konfirmasi sebelum menjalankan Publish-Module.

Properti parameter

Jenis:SwitchParameter
Nilai default:False
Mendukung wildcard:False
DontShow:False
Alias:Cf

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-Credential

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

Properti parameter

Jenis:PSCredential
Nilai default:None
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-Exclude

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

Properti parameter

Jenis:

String[]

Nilai default:None
Mendukung wildcard:False
DontShow:False

Set parameter

ModuleNameParameterSet
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-Force

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

Properti parameter

Jenis:SwitchParameter
Nilai default:False
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-FormatVersion

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

Properti parameter

Jenis:Version
Nilai default:None
Nilai yang diterima:2.0
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-IconUri

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

Properti parameter

Jenis:Uri
Nilai default:None
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-LicenseUri

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

Properti parameter

Jenis:Uri
Nilai default:None
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-Name

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

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Set parameter

ModuleNameParameterSet
Position:Named
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa: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.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa: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.

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Set parameter

ModulePathParameterSet
Position:Named
Wajib:True
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:True
Nilai dari argumen yang tersisa:False

-ProjectUri

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

Properti parameter

Jenis:Uri
Nilai default:None
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-ReleaseNotes

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

Properti parameter

Jenis:

String[]

Nilai default:None
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-Repository

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

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-RequiredVersion

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

Properti parameter

Jenis:String
Nilai default:None
Mendukung wildcard:False
DontShow:False

Set parameter

ModuleNameParameterSet
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-SkipAutomaticTags

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

Properti parameter

Jenis:SwitchParameter
Nilai default:False
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-Tags

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

Properti parameter

Jenis:

String[]

Nilai default:None
Mendukung wildcard:False
DontShow:False

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

-WhatIf

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

Properti parameter

Jenis:SwitchParameter
Nilai default:False
Mendukung wildcard:False
DontShow:False
Alias:wi

Set parameter

(All)
Position:Named
Wajib:False
Nilai dari alur:False
Nilai dari alur berdasarkan nama properti:False
Nilai dari argumen yang tersisa:False

CommonParameters

Cmdlet ini mendukung parameter umum: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, dan -WarningVariable. Untuk informasi selengkapnya, lihat about_CommonParameters.

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 nilai manifes Paket yang memengaruhiUI Galeri PowerShell .