Publish-Module

Modul:

PowerShellGet Module

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

Syntax

ModuleNameParameterSet (Standard)

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

Beskrivning

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 med modulens namn eller av sökvägen till mappen som innehåller modulen.

När du anger en modul efter namn publicerar Publish-Module den första modulen som skulle hittas genom att köra Get-Module -ListAvailable <Name>. Om du anger en lägsta version av en modul som ska publiceras publicerar Publish-Module den första modulen med en version som är större än eller lika med den lägsta version som du har angett.

För att publicera en modul krävs metadata som visas på gallerisidan för modulen. Nödvändiga metadata innehåller modulens namn, version, beskrivning och författare. Även om de flesta metadata hämtas från modulmanifestet måste vissa metadata anges i Publish-Module parametrar, till exempel Tag, ReleaseNote, IconUri, ProjectUri och LicenseUri, eftersom dessa parametrar matchar fälten i ett NuGet-baserat galleri.

Parametrarna som tar modulversionsnummer förväntar sig strängar som formateras som versionsnummer.

• Standardversionsnummer x.y.z har ett format där x, y och z är tal
• Förhandsversioner har ett format x.y.z-<prerelease_label> där <prerelease_label> är godtycklig sträng tilldelad till den versionen.

Exempel

Exempel 1: Publicera en modul

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

Publish-Module -Name "MyDscModule" -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 namn, version, beskrivning och författare uppstår ett fel.

$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

Parametrar

-AllowPrerelease

Tillåter att moduler som markerats som förhandsversion publiceras.

Egenskaper för parameter

Typ:	SwitchParameter
Standardvärde:	False
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

ModuleNameParameterSet

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

-Confirm

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

Egenskaper för parameter

Typ:	SwitchParameter
Standardvärde:	False
Stöder jokertecken:	False
DontShow:	False
Alias:	jfr

Parameteruppsättningar

(All)

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

-Credential

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

Egenskaper för parameter

Typ:	PSCredential
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

(All)

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	True
Värde från återstående argument:	False

-Exclude

Definierar filer som ska undantas från den publicerade modulen.

Egenskaper för parameter

Typ:	String[]
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

ModuleNameParameterSet

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

-Force

Tvingar kommandot att köras utan att be om användarbekräftelse.

Egenskaper för parameter

Typ:	SwitchParameter
Standardvärde:	False
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

(All)

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

-FormatVersion

Accepterar endast giltiga värden som anges av attributet ValidateSet.

Mer information finns i ValidateSet Attribute Declaration and ValidateSetAttribute.

Egenskaper för parameter

Typ:	Version
Standardvärde:	None
Godkända värden:	2.0
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

(All)

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

-IconUri

Anger URL:en för en ikon för modulen. Den angivna ikonen visas på galleriets webbsida för modulen.

Egenskaper för parameter

Typ:	Uri
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

(All)

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

-LicenseUri

Anger URL:en för licensvillkoren för den modul som du vill publicera.

Egenskaper för parameter

Typ:	Uri
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

(All)

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

-Name

Anger namnet på den modul som du vill publicera. Publish-Module söker efter det angivna modulnamnet i $Env:PSModulePath.

Egenskaper för parameter

Typ:	String
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

ModuleNameParameterSet

Position:	Named
Obligatorisk:	True
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	True
Värde från återstående argument:	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.

Egenskaper för parameter

Typ:	String
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

(All)

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

-Path

Anger sökvägen till den modul 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.

Egenskaper för parameter

Typ:	String
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

ModulePathParameterSet

Position:	Named
Obligatorisk:	True
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	True
Värde från återstående argument:	False

-ProjectUri

Anger URL:en för en webbsida om det här projektet.

Egenskaper för parameter

Typ:	Uri
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

(All)

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

-ReleaseNotes

Anger en sträng som innehåller viktig information eller kommentarer som du vill ska vara tillgänglig för användare av den här versionen av modulen.

Egenskaper för parameter

Typ:	String[]
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

(All)

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

-Repository

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

Egenskaper för parameter

Typ:	String
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

(All)

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

-RequiredVersion

Anger den exakta versionen av en enskild modul som ska publiceras.

Egenskaper för parameter

Typ:	String
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

ModuleNameParameterSet

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

-SkipAutomaticTags

Tar bort kommandon och resurser från att inkluderas som taggar. Hoppar över att automatiskt lägga till taggar i en modul.

Egenskaper för parameter

Typ:	SwitchParameter
Standardvärde:	False
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

(All)

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

-Tags

Lägger till en eller flera taggar i modulen som du publicerar. Exempeltaggar är DesiredStateConfiguration, DSC, DSCResourceKit eller PSModule. Avgränsa flera taggar med kommatecken.

Egenskaper för parameter

Typ:	String[]
Standardvärde:	None
Stöder jokertecken:	False
DontShow:	False

Parameteruppsättningar

(All)

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

-WhatIf

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

Egenskaper för parameter

Typ:	SwitchParameter
Standardvärde:	False
Stöder jokertecken:	False
DontShow:	False
Alias:	Wi

Parameteruppsättningar

(All)

Position:	Named
Obligatorisk:	False
Värde från pipeline:	False
Värde från pipeline efter egenskapsnamn:	False
Värde från återstående argument:	False

CommonParameters

Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.

Ingångar

String

PSCredential

Utgångar

Object

Anteckningar

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, på Windows 7 eller Windows 2008 R2 och senare versioner av Windows.

Viktigt!

Från och med april 2020 stöder PowerShell-galleriet inte längre TLS-versionerna (Transport Layer Security) 1.0 och 1.1. Om du inte använder TLS 1.2 eller senare får du ett felmeddelande när du försöker komma åt PowerShell-galleriet. Använd följande kommando för att se till att du använder TLS 1.2:

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

Mer information finns i meddelande i PowerShell-bloggen.

För att publicera en modul krävs metadata som visas på gallerisidan för modulen. Nödvändiga metadata innehåller modulens namn, version, beskrivning och författare. De flesta metadata hämtas från modulmanifestet, men vissa metadata kan anges i Publish-Module parametrar, till exempel Tag, ReleaseNote, IconUri, ProjectUrioch LicenseUri. Mer information finns i Paketmanifestvärden som påverkar PowerShell-galleriets användargränssnitt.

Relaterade länkar

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