Publish-Module

Modul:

PowerShellGet Module

Egy megadott modult tesz közzé a helyi számítógépről egy online katalógusba.

Syntax

ModuleNameParameterSet (Alapértelmezett)

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

Description

A Publish-Module parancsmag egy modult tesz közzé egy online NuGet-alapú katalógusban egy API-kulccsal, amelyet egy felhasználó profiljának részeként tárol a katalógusban. Megadhatja a közzéteendő modult a modul neve vagy a modult tartalmazó mappa elérési útja alapján.

Ha név alapján ad meg egy modult, Publish-Module közzéteszi az első modult, amely a Get-Module -ListAvailable <Name>futtatásával található. Ha egy közzéteendő modul minimális verzióját adja meg, Publish-Module az első modult olyan verzióval teszi közzé, amely nagyobb vagy egyenlő a megadott minimális verziónál.

A modul közzétételéhez metaadatokra van szükség, amelyek a modul katalógusoldalán jelennek meg. A szükséges metaadatok tartalmazzák a modul nevét, verzióját, leírását és szerzőét. Bár a legtöbb metaadat a moduljegyzékből származik, bizonyos metaadatokat meg kell adni paraméterekben Publish-Module , például a Címke, a ReleaseNote, az IconUri, a ProjectUri és a LicenseUri paraméterekben, mivel ezek a paraméterek megfelelnek a NuGet-alapú katalógus mezőinek.

A modul verziószámait tartalmazó paraméterek verziószámként formázott sztringeket várnak.

• A standard verziószámok formátuma x.y.z az x, y és z számokat jelöli
• Az előzetes verziók formátuma x.y.z-<prerelease_label><prerelease_label> az adott kiadáshoz rendelt tetszőleges sztring.

Példák

1. példa: Modul közzététele

Ebben a példában a MyDscModule az API-kulccsal jelenik meg az online katalógusban a modul tulajdonosának online katalógusfiókjának jelzésére. Ha a MyDscModule nem érvényes jegyzékmodul, amely egy nevet, verziót, leírást és szerzőt határoz meg, hiba történik.

Publish-Module -Name "MyDscModule" -NuGetApiKey "11e4b435-6cb4-4bf7-8611-5162ed75eb73"

2. példa: Modul közzététele a katalógus metaadataival

Ebben a példában a MyDscModule az API-kulccsal jelenik meg az online katalógusban a modul tulajdonosának katalógusfiókjának jelzésére. A megadott további metaadatok megjelennek a modul weblapján a katalógusban. A tulajdonos két keresési címkét ad hozzá a modulhoz, amelyek az Active Directoryhoz kapcsolódnak; a rendszer hozzáad egy rövid kibocsátási megjegyzést. Ha a MyDscModule nem érvényes jegyzékmodul, amely egy nevet, verziót, leírást és szerzőt határoz meg, hiba történik.

$parameters = @{
    Name        = "MyDscModule"
    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

Paraméterek

-AllowPrerelease

Lehetővé teszi az előzetesként megjelölt modulok közzétételét.

Paramétertulajdonságok

Típus:	SwitchParameter
Alapértelmezett érték:	False
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

ModuleNameParameterSet

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-Confirm

Megerősítést kér a Publish-Modulefuttatása előtt.

Paramétertulajdonságok

Típus:	SwitchParameter
Alapértelmezett érték:	False
Támogatja a helyettesítő karaktereket:	False
DontShow:	False
Aliasok:	Cf

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-Credential

Olyan felhasználói fiókot ad meg, amely jogosult egy adott csomagszolgáltató vagy -forrás moduljának közzétételére.

Paramétertulajdonságok

Típus:	PSCredential
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	True
Fennmaradó argumentumokból származó érték:	False

-Exclude

Meghatározza a közzétett modulból kizárandó fájlokat.

Paramétertulajdonságok

Típus:	String[]
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

ModuleNameParameterSet

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-Force

Kényszeríti a parancs futtatását anélkül, hogy felhasználói megerősítést kérne.

Paramétertulajdonságok

Típus:	SwitchParameter
Alapértelmezett érték:	False
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-FormatVersion

Csak a ValidateSet attribútum által megadott érvényes értékeket fogadja el.

További információ: ValidateSet Attribútumdeklaráció és ValidateSetAttribute.

Paramétertulajdonságok

Típus:	Version
Alapértelmezett érték:	None
Elfogadott értékek:	2.0
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-IconUri

Megadja a modul ikonjának URL-címét. A megadott ikon megjelenik a modul katalógusának weblapján.

Paramétertulajdonságok

Típus:	Uri
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-LicenseUri

Megadja a közzétenni kívánt modul licencfeltételeinek URL-címét.

Paramétertulajdonságok

Típus:	Uri
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-Name

Megadja a közzétenni kívánt modul nevét. Publish-Module a megadott modulnevet keresi a $Env:PSModulePath.

Paramétertulajdonságok

Típus:	String
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

ModuleNameParameterSet

Position:	Named
Kötelező:	True
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	True
Fennmaradó argumentumokból származó érték:	False

-NuGetApiKey

Megadja azt az API-kulcsot, amellyel modult szeretne közzétenni az online katalógusban. Az API-kulcs a profil része az online katalógusban, és megtalálható a felhasználói fiók oldalán a katalógusban. Az API-kulcs NuGet-specifikus funkció.

Paramétertulajdonságok

Típus:	String
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-Path

Megadja a közzétenni kívánt modul elérési útját. Ez a paraméter elfogadja a modult tartalmazó mappa elérési útját. A mappának ugyanazzal a névvel kell rendelkeznie, mint a modulnak.

Paramétertulajdonságok

Típus:	String
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

ModulePathParameterSet

Position:	Named
Kötelező:	True
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	True
Fennmaradó argumentumokból származó érték:	False

-ProjectUri

Megadja a projekthez tartozó weblap URL-címét.

Paramétertulajdonságok

Típus:	Uri
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-ReleaseNotes

A modul ezen verziójának felhasználói számára elérhetővé tenni kívánt kibocsátási megjegyzéseket vagy megjegyzéseket tartalmazó sztringet határoz meg.

Paramétertulajdonságok

Típus:	String[]
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-Repository

A futtatással Register-PSRepositoryregisztrált adattár rövid nevét adja meg. Az adattárnak rendelkeznie kell egy PublishLocation, amely érvényes NuGet URI. A PublishLocation a Set-PSRepositoryfuttatásával állítható be.

Paramétertulajdonságok

Típus:	String
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-RequiredVersion

Egy közzéteendő modul pontos verzióját adja meg.

Paramétertulajdonságok

Típus:	String
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

ModuleNameParameterSet

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-SkipAutomaticTags

Eltávolítja a parancsokat és erőforrásokat a címkék közé való belefoglalásból. Kihagyja a címkék modulhoz való automatikus hozzáadását.

Paramétertulajdonságok

Típus:	SwitchParameter
Alapértelmezett érték:	False
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-Tags

Egy vagy több címkét ad hozzá a közzétett modulhoz. Ilyen címkék például a DesiredStateConfiguration, a DSC, a DSCResourceKit vagy a PSModule. Több címke elkülönítése vesszővel.

Paramétertulajdonságok

Típus:	String[]
Alapértelmezett érték:	None
Támogatja a helyettesítő karaktereket:	False
DontShow:	False

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

-WhatIf

Megjeleníti, mi történne, ha a Publish-Module futna. A parancsmag nem fut.

Paramétertulajdonságok

Típus:	SwitchParameter
Alapértelmezett érték:	False
Támogatja a helyettesítő karaktereket:	False
DontShow:	False
Aliasok:	Wi

Paraméterkészletek

(All)

Position:	Named
Kötelező:	False
Folyamatból származó érték:	False
Folyamatból származó érték tulajdonságnév alapján:	False
Fennmaradó argumentumokból származó érték:	False

CommonParameters

Ez a parancsmag a következő gyakori paramétereket támogatja: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction és -WarningVariable. További információért lásd about_CommonParameters.

Bevitelek

String

PSCredential

Kimenetek

Object

Jegyzetek

A PowerShell a következő aliasokat tartalmazza Publish-Module:

• Minden platform:
  • pumo

Publish-Module a PowerShell PowerShell 3.0-s vagy újabb kiadásain fut, Windows 7 vagy Windows 2008 R2 rendszeren, valamint a Windows újabb kiadásain.

Fontos

2020 áprilisától a PowerShell-katalógus már nem támogatja a Transport Layer Security (TLS) 1.0-s és 1.1-es verzióját. Ha nem TLS 1.2 vagy újabb verziót használ, hibaüzenet jelenik meg a PowerShell-gyűjtemény elérésekor. A következő paranccsal győződjön meg arról, hogy a TLS 1.2-t használja:

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

További információ: közlemény a PowerShell blogjában.

A modul közzétételéhez metaadatokra van szükség, amelyek a modul katalógusoldalán jelennek meg. A szükséges metaadatok tartalmazzák a modul nevét, verzióját, leírását és szerzőét. A legtöbb metaadat a moduljegyzékből származik, de néhány metaadat megadható Publish-Module paraméterekben, például Címke, ReleaseNote, IconUri, ProjectUriés LicenseUri. További információ: Csomagjegyzék-értékek, amelyek hatással vannak a PowerShell-katalógus felhasználói felületére.

Kapcsolódó hivatkozások

• Find-Module
• Install-Module
• Register-PSRepository
• Set-PSRepository
• Uninstall-Module
• Update-Module