Publish-Module

  • Referens
Modul:
PowerShellGet

Publicerar en angiven modul från den lokala datorn till ett onlinegalleri.

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

Cmdleten Publish-Module publicerar en modul till ett NuGet-baserat onlinegalleri med hjälp av en API-nyckel som lagras som en del av en användares profil i galleriet. Du kan ange vilken modul som ska publiceras antingen efter modulens namn eller av sökvägen till mappen som innehåller modulen.

Det här är en proxy-cmdlet för Publish-PSResource cmdleten i Microsoft.PowerShell.PSResourceGet. Mer information finns i Publicera PSResource.

Exempel

Exempel 1: Publicera en modul

I det här exemplet publiceras MyDscModule till onlinegalleriet med hjälp av API-nyckeln för att ange modulägarens onlinegallerikonto. Om MyDscModule inte är en giltig manifestmodul som anger ett namn, en version, en beskrivning och en författare uppstår ett fel.

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

Exempel 2: Publicera en modul med gallerimetadata

I det här exemplet publiceras MyDscModule i onlinegalleriet med hjälp av API-nyckeln för att ange modulägarens gallerikonto. De ytterligare metadata som tillhandahålls visas på webbsidan för modulen i galleriet. Ägaren lägger till två söktaggar för modulen som relaterar den till Active Directory. en kort versionsanteckning läggs till. Om MyDscModule inte är en giltig manifestmodul som anger ett namn, en version, en beskrivning och en författare uppstår ett fel.

$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

Parametrar

-AllowPrerelease

Proxy-cmdleten ignorerar den här parametern eftersom den inte stöds av Publish-PSResource.

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

-Confirm

Uppmanar dig att bekräfta innan du Publish-Modulekör .

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

-Credential

Anger ett användarkonto som har behörighet att publicera en modul för en angiven paketprovider eller källa.

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

-Exclude

Proxy-cmdleten ignorerar den här parametern eftersom den inte stöds av Publish-PSResource.

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

-Force

Proxy-cmdleten ignorerar den här parametern eftersom den inte stöds av Publish-PSResource.

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

-FormatVersion

Proxy-cmdleten ignorerar den här parametern eftersom den inte stöds av Publish-PSResource.

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

-IconUri

Proxy-cmdleten ignorerar den här parametern eftersom den inte stöds av Publish-PSResource.

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

-LicenseUri

Proxy-cmdleten ignorerar den här parametern eftersom den inte stöds av Publish-PSResource.

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

-Name

Proxy-cmdleten ignorerar den här parametern eftersom den inte stöds av Publish-PSResource.

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

-NuGetApiKey

Anger den API-nyckel som du vill använda för att publicera en modul i onlinegalleriet. API-nyckeln är en del av din profil i onlinegalleriet och finns på användarkontosidan i galleriet. API-nyckeln är NuGet-specifika funktioner.

Proxy-cmdleten mappar den här parametern till ApiKey-parametern för Publish-PSResource.

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

-Path

Anger sökvägen till modulen som du vill publicera. Den här parametern accepterar sökvägen till mappen som innehåller modulen. Mappen måste ha samma namn som modulen.

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

-ProjectUri

Proxy-cmdleten ignorerar den här parametern eftersom den inte stöds av Publish-PSResource.

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

-ReleaseNotes

Proxy-cmdleten ignorerar den här parametern eftersom den inte stöds av Publish-PSResource.

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

-Repository

Anger det egna namnet på en lagringsplats som har registrerats genom att köra Register-PSRepository. Lagringsplatsen måste ha en PublishLocation, som är en giltig NuGet-URI. PublishLocation kan anges genom att köra Set-PSRepository.

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

-RequiredVersion

Proxy-cmdleten ignorerar den här parametern eftersom den inte stöds av Publish-PSResource.

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

-SkipAutomaticTags

Proxy-cmdleten ignorerar den här parametern eftersom den inte stöds av Publish-PSResource.

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

-Tags

Proxy-cmdleten ignorerar den här parametern eftersom den inte stöds av Publish-PSResource.

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

-WhatIf

Visar vad som skulle hända om körningarna Publish-Module . Cmdleten körs inte.

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

Indata

String

PSCredential

Utdata

Object

Kommentarer

PowerShell innehåller följande alias för Publish-Module:

  • Alla plattformar:
    • pumo

Publish-Module körs på PowerShell 3.0 eller senare versioner av PowerShell, i Windows 7 eller Windows 2008 R2 och senare versioner av Windows.

PowerShell-galleriet har inte längre stöd för TLS-versionerna 1.0 och 1.1. Du måste använda TLS 1.2 eller senare. Använd följande kommando för att kontrollera att du använder TLS 1.2:

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

För att publicera en modul krävs metadata som visas på gallerisidan för modulen. Nödvändiga metadata inkluderar modulnamn, version, beskrivning och författare. Metadata måste definieras i modulmanifestet. Mer information finns i Paketmanifestvärden som påverkar PowerShell-galleriet användargränssnitt.