Dela via


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

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

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

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 -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 namn, version, beskrivning och 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.

Parameteregenskaper

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.

Parameteregenskaper

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.

Parameteregenskaper

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

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

Parameteregenskaper

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

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

Parameteregenskaper

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

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

Parameteregenskaper

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

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

Parameteregenskaper

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

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

Parameteregenskaper

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

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

Parameteregenskaper

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.

Proxy-cmdleten mappar den här parametern till ApiKey-parameternPublish-PSResourceför .

Parameteregenskaper

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.

Parameteregenskaper

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

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

Parameteregenskaper

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

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

Parameteregenskaper

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.

Parameteregenskaper

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

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

Parameteregenskaper

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

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

Parameteregenskaper

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

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

Parameteregenskaper

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.

Parameteregenskaper

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.

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

PowerShell-galleriet stöder inte längre TLS-versionerna (Transport Layer Security) 1.0 och 1.1. Du måste använda TLS 1.2 eller senare. Använd följande kommando för att se till 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 innehåller modulens namn, version, beskrivning och författare. Metadata måste definieras i modulmanifestet. Mer information finns i Paketmanifestvärden som påverkar PowerShell-galleriets användargränssnitt.