Sdílet prostřednictvím

Publish-Module

  • Reference
Modul:
PowerShellGet

Publikuje zadaný modul z místního počítače do online galerie.

Syntax

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

Description

Rutina Publish-Module publikuje modul do online galerie založené na NuGetu pomocí klíče rozhraní API uloženého jako součást profilu uživatele v galerii. Modul, který se má publikovat, můžete zadat buď podle názvu modulu, nebo cesty ke složce, která modul obsahuje.

Toto je rutina proxy pro rutinu Publish-PSResource v Microsoft.PowerShell.PSResourceGet. Další informace najdete v tématu Publish-PSResource.

Příklady

Příklad 1: Publikování modulu

V tomto příkladu se myDscModule publikuje do online galerie pomocí klíče rozhraní API k označení účtu online galerie vlastníka modulu. Pokud MyDscModule není platný modul manifestu, který určuje název, verzi, popis a autora, dojde k chybě.

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

Příklad 2: Publikování modulu s metadaty galerie

V tomto příkladu se MyDscModule publikuje do online galerie pomocí klíče rozhraní API k označení účtu galerie vlastníka modulu. Další poskytnutá metadata se zobrazí na webové stránce modulu v galerii. Vlastník přidá dvě vyhledávací značky modulu, které ho přidají ke službě Active Directory. Přidá se stručná poznámka k vydání verze. Pokud MyDscModule není platný modul manifestu, který určuje název, verzi, popis a autora, dojde k chybě.

$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

Parametry

-AllowPrerelease

Rutina proxy serveru tento parametr ignoruje, protože ho nepodporuje Publish-PSResource.

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

-Confirm

Před spuštěním nástroje zobrazí výzvu k Publish-Modulepotvrzení.

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

-Credential

Určuje uživatelský účet, který má práva k publikování modulu pro zadaného poskytovatele balíčků nebo zdroj.

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

-Exclude

Rutina proxy serveru tento parametr ignoruje, protože ho nepodporuje Publish-PSResource.

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

-Force

Rutina proxy serveru tento parametr ignoruje, protože ho nepodporuje Publish-PSResource.

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

-FormatVersion

Rutina proxy serveru tento parametr ignoruje, protože ho nepodporuje Publish-PSResource.

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

-IconUri

Rutina proxy serveru tento parametr ignoruje, protože ho nepodporuje Publish-PSResource.

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

-LicenseUri

Rutina proxy serveru tento parametr ignoruje, protože ho nepodporuje Publish-PSResource.

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

-Name

Rutina proxy serveru tento parametr ignoruje, protože ho nepodporuje Publish-PSResource.

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

-NuGetApiKey

Určuje klíč rozhraní API, který chcete použít k publikování modulu do online galerie. Klíč rozhraní API je součástí vašeho profilu v online galerii a najdete ho na stránce uživatelského účtu v galerii. Klíč rozhraní API je funkce specifická pro NuGet.

Rutina proxy serveru mapuje tento parametr na parametr ApiKey pro Publish-PSResource.

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

-Path

Určuje cestu k modulu, který chcete publikovat. Tento parametr přijímá cestu ke složce, která obsahuje modul. Složka musí mít stejný název jako modul.

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

-ProjectUri

Rutina proxy serveru tento parametr ignoruje, protože ho nepodporuje Publish-PSResource.

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

-ReleaseNotes

Rutina proxy serveru tento parametr ignoruje, protože ho nepodporuje Publish-PSResource.

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

-Repository

Určuje popisný název úložiště zaregistrovaného spuštěním příkazu Register-PSRepository. Úložiště musí mít PublishLocation, což je platný identifikátor URI NuGet. Hodnotu PublishLocation můžete nastavit spuštěním příkazu Set-PSRepository.

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

-RequiredVersion

Rutina proxy serveru tento parametr ignoruje, protože ho nepodporuje Publish-PSResource.

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

-SkipAutomaticTags

Rutina proxy serveru tento parametr ignoruje, protože ho nepodporuje Publish-PSResource.

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

-Tags

Rutina proxy serveru tento parametr ignoruje, protože ho nepodporuje Publish-PSResource.

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

-WhatIf

Ukazuje, co by se stalo, když se Publish-Module spustí. Rutina není spuštěna.

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

Vstupy

String

PSCredential

Výstupy

Object

Poznámky

PowerShell obsahuje následující aliasy pro Publish-Module:

  • Všechny platformy:
    • pumo

Publish-Module běží na PowerShellu 3.0 nebo novějších verzích PowerShellu, ve Windows 7 nebo Windows 2008 R2 a novějších verzích Windows.

Galerie prostředí PowerShell už nepodporuje protokol TLS (Transport Layer Security) verze 1.0 a 1.1. Musíte použít protokol TLS 1.2 nebo novější. Pomocí následujícího příkazu se ujistěte, že používáte protokol TLS 1.2:

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

Publikování modulu vyžaduje metadata, která se zobrazí na stránce galerie modulu. Požadovaná metadata zahrnují název modulu, verzi, popis a autora. Metadata musí být definována v manifestu modulu. Další informace najdete v tématu Hodnoty manifestu balíčků, které mají vliv na uživatelské rozhraní Galerie prostředí PowerShell.