Dela via


Update-PSModuleManifest

Uppdateringar en modulmanifestfil.

Syntax

Update-PSModuleManifest
      [-Path] <String>
      [-NestedModules <Object[]>]
      [-Guid <Guid>]
      [-Author <String>]
      [-CompanyName <String>]
      [-Copyright <String>]
      [-RootModule <String>]
      [-ModuleVersion <Version>]
      [-Description <String>]
      [-ProcessorArchitecture <ProcessorArchitecture>]
      [-CompatiblePSEditions <String[]>]
      [-PowerShellVersion <Version>]
      [-ClrVersion <Version>]
      [-DotNetFrameworkVersion <Version>]
      [-PowerShellHostName <String>]
      [-PowerShellHostVersion <Version>]
      [-RequiredModules <Object[]>]
      [-TypesToProcess <String[]>]
      [-FormatsToProcess <String[]>]
      [-ScriptsToProcess <String[]>]
      [-RequiredAssemblies <String[]>]
      [-FileList <String[]>]
      [-ModuleList <Object[]>]
      [-FunctionsToExport <String[]>]
      [-AliasesToExport <String[]>]
      [-VariablesToExport <String[]>]
      [-CmdletsToExport <String[]>]
      [-DscResourcesToExport <String[]>]
      [-Tags <String[]>]
      [-ProjectUri <Uri>]
      [-LicenseUri <Uri>]
      [-IconUri <Uri>]
      [-ReleaseNotes <String>]
      [-Prerelease <String>]
      [-HelpInfoUri <Uri>]
      [-DefaultCommandPrefix <String>]
      [-ExternalModuleDependencies <String[]>]
      [-RequireLicenseAcceptance]
      [-PrivateData <Hashtable>]
      [<CommonParameters>]

Description

Den här cmdleten uppdaterar data som lagras i en modulmanifestfil. Med parametrarna kan du ange vilka egenskaper som ska uppdateras. Update-PSModuleManifest skriver över befintliga värden i modulmanifestet.

Cmdleten returnerar inte ett objekt.

Exempel

Exempel 1

I det här exemplet ändras egenskapen Författare i modulmanifestet till New Author.

Update-PSModuleManifest -Path 'C:\MyModules\TestModule' -Author 'New Author'

Exempel 2

I det här exemplet ändras prerelease-egenskapen till beta2.

Update-PSModuleManifest -Path 'C:\MyModules\TestModule' -Prerelease 'beta2'

Exempel 3

Det här exemplet uppdaterar flera egenskaper.

$parameters = @{
    Path = 'C:\MyModules\TestModule'
    Tags = 'Windows', 'Linux'
    Description = 'A module for managing packages.'
}
Update-PSModuleManifest

Parametrar

-AliasesToExport

Anger de alias som modulen exporterar. Jokertecken tillåts.

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

-Author

Anger modulförfattaren.

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

-ClrVersion

Anger den lägsta versionen av Common Language Runtime (CLR) för Microsoft .NET Framework som krävs av modulen.

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

-CmdletsToExport

Anger de cmdletar som modulen exporterar. Jokertecken tillåts.

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

-CompanyName

Anger företaget eller leverantören som skapade modulen.

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

-CompatiblePSEditions

Anger de kompatibla PSEditions för modulen. Information om PSEdition finns i Moduler med kompatibla PowerShell-utgåvor.

Type:String[]
Accepted values:Desktop, Core
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Anger en copyright-instruktion för modulen.

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

-DefaultCommandPrefix

Anger standardkommandoprefixet.

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

-Description

Anger en beskrivning av modulen.

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

-DotNetFrameworkVersion

Anger den lägsta versionen av Microsoft-.NET Framework som krävs av modulen.

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

-DscResourcesToExport

Anger de Desired State Configuration (DSC)-resurser som modulen exporterar. Jokertecken tillåts.

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

-ExternalModuleDependencies

Anger en matris med externa modulberoenden.

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

-FileList

Anger alla objekt som ingår i modulen.

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

-FormatsToProcess

Anger formateringsfilerna (.ps1xml) som bearbetas när modulen importeras.

När du importerar en modul kör PowerShell cmdleten Update-FormatData med de angivna filerna. Eftersom formatering av filer inte är begränsade påverkar de alla sessionstillstånd i sessionen.

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

-FunctionsToExport

Anger de funktioner som modulen exporterar. Jokertecken tillåts.

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

-Guid

Anger en unik identifierare för modulen. GUID används för att skilja mellan moduler med samma namn.

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

-HelpInfoUri

Anger internetadressen för modulens HelpInfo XML-fil. Ange en URI (Uniform Resource Identifier) som börjar med http: eller https:.

Mer information finns i Updatable Help (Uppdateringsbar hjälp).

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

-IconUri

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

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

-LicenseUri

Anger URL:en för licensvillkoren för modulen.

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

-ModuleList

Anger en matris med moduler som ingår i modulen.

Ange varje modulnamn som en sträng eller som en hashtable med ModuleName - och ModuleVersion-nycklar . Hashtabellen kan också ha en valfri GUID-nyckel . Du kan kombinera strängar och hashtables i parametervärdet.

Den här nyckeln är utformad för att fungera som en modulinventering.

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

-ModuleVersion

Anger versionen av modulen.

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

-NestedModules

Anger skriptmoduler (.psm1) och binära moduler (.dll) som importeras till modulens sessionstillstånd. Filerna i nestedModules-nyckeln körs i den ordning som de visas.

Ange varje modulnamn som en sträng eller som en hashtable med ModuleName - och ModuleVersion-nycklar . Hashtabellen kan också ha en valfri GUID-nyckel . Du kan kombinera strängar och hashtables i parametervärdet.

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

-Path

Anger sökvägen och filnamnet för modulmanifestet. Ange filnamn med ett .psd1 filnamnstillägg.

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

-PowerShellHostName

Anger namnet på det PowerShell-värdprogram som modulen kräver. Ange namnet på värdprogrammet, till exempel PowerShell ISE-värd eller ConsoleHost. Jokertecken tillåts inte.

Namnet på ett värdprogram lagras i $Host.Name.

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

-PowerShellHostVersion

Anger den lägsta versionen av PowerShell-värdprogrammet som fungerar med modulen. Ange ett versionsnummer, till exempel 1.1.

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

-PowerShellVersion

Anger den lägsta versionen av PowerShell som fungerar med den här modulen. Du kan till exempel ange versioner som 5.1 eller 7.2.

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

-Prerelease

Anger det förhandsversionsvärde som läggs till i modulversionen. Om Prerelease till exempel är preview och ModuleVersion är 1.0.0är 1.0.0-previewversionen av modulen .

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

-PrivateData

Anger data som skickas till modulen när den importeras. Detta kan vara godtyckliga värden som lagras i en hashtable.

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

-ProcessorArchitecture

Anger den processorarkitektur som modulen kräver.

De acceptabla värdena för den här parametern är:

  • Amd64
  • Arm
  • IA64
  • MSIL
  • None (okänd eller ospecificerad)
  • X86
Type:ProcessorArchitecture
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ProjectUri

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

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

-ReleaseNotes

Anger en sträng som innehåller viktig information eller kommentarer för modulen.

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

-RequiredAssemblies

Anger de sammansättningsfiler (.dll) som krävs av modulen. PowerShell läser in de angivna sammansättningarna innan du uppdaterar typer eller format, importerar kapslade moduler eller importerar modulfilen som anges i RootModule-nyckeln .

Använd RequiredAssemblies för sammansättningar som måste läsas in för att uppdatera formaterings- eller typfiler som anges i nycklarna FormatsToProcess eller TypesToProcess , även om dessa sammansättningar också visas i nestedModules-nyckeln .

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

-RequiredModules

Anger moduler som måste vara i det globala sessionstillståndet. Om de moduler som krävs inte är i det globala sessionstillståndet importerar PowerShell dem. Om de moduler som krävs inte är tillgängliga Import-Module misslyckas kommandot.

Värdet kan vara en matris som innehåller modulnamn eller modulspecifikationer. En modulspecifikation är en hashtable som har följande nycklar.

  • ModuleName - Krävs Anger modulnamnet.
  • GUID - Valfri Anger GUID för modulen.
  • Det är också Obligatoriskt att ange minst en av de tre nycklarna nedan.
    • ModuleVersion – Anger en lägsta godtagbar version av modulen.
    • MaximumVersion – Anger den högsta godkända versionen av modulen.
    • RequiredVersion – Anger en exakt version av modulen som krävs. Detta kan inte användas med de andra versionsnycklarna.
Type:Object[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RequireLicenseAcceptance

Anger att en licensgodkännande krävs för modulen.

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

-RootModule

Anger modulens primära fil eller rotfil. Ange filnamnet för ett skript (.ps1), en skriptmodul (.psm1), ett modulmanifest (.psd1), en sammansättning (.dll) eller en XML-fil för cmdlet-definition (.cdxml). När modulen importeras importeras medlemmarna som exporteras från rotmodulen till anroparens sessionstillstånd.

Om en modul har en manifestfil och ingen fil anges i RootModule-nyckeln blir manifestet den primära filen för modulen. Modulen kallas för en manifestmodul (ModuleType = Manifest).

Om du vill exportera medlemmar från .psm1 eller .dll filer måste namnen på dessa filer anges i värdena för RootModule - eller NestedModules-nycklarna i manifestet.

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

-ScriptsToProcess

Anger skriptfiler (.ps1) som körs i anroparens sessionstillstånd när modulen importeras. Du kan använda dessa skript för att förbereda en miljö, precis som du kan använda ett inloggningsskript.

Om du vill ange skript som körs i modulens sessionstillstånd använder du nyckeln NestedModules .

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

-Tags

Anger en matris med taggar.

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

-TypesToProcess

Anger vilka typfiler (.ps1xml) som körs när modulen importeras.

När du importerar modulen kör PowerShell cmdleten Update-TypeData med de angivna filerna. Eftersom typfiler inte är begränsade påverkar de alla sessionstillstånd i sessionen.

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

-VariablesToExport

Anger de variabler som modulen exporterar. Jokertecken tillåts.

Använd den här parametern för att begränsa vilka variabler som exporteras av modulen.

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

Indata

None

Utdata

Object

Kommentarer

En fullständig beskrivning av modulmanifestfilen finns i about_Module_Manifests.