Update-ModuleManifest
Uppdateringar en modulmanifestfil.
Syntax
Update-ModuleManifest
[-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[]>]
[-PrivateData <Hashtable>]
[-Tags <String[]>]
[-ProjectUri <Uri>]
[-LicenseUri <Uri>]
[-IconUri <Uri>]
[-ReleaseNotes <String[]>]
[-Prerelease <String>]
[-HelpInfoUri <Uri>]
[-PassThru]
[-DefaultCommandPrefix <String>]
[-ExternalModuleDependencies <String[]>]
[-PackageManagementProviders <String[]>]
[-RequireLicenseAcceptance]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Cmdleten Update-ModuleManifest
uppdaterar en modulmanifestfil (.psd1
).
Exempel
Exempel 1: Uppdatera ett modulmanifest
I det här exemplet uppdateras en befintlig modulmanifestfil. Splatting används för att skicka parametervärden till Update-ModuleManifest
. Mer information finns i about_Splatting.
$Parms = @{
Path = "C:\Test\TestManifest.psd1"
Author = "TestUser1"
CompanyName = "Contoso Corporation"
Copyright = "(c) 2019 Contoso Corporation. All rights reserved."
}
Update-ModuleManifest @Parms
$Parms
är en splat som lagrar parametervärdena för Path, Author, CompanyName och Copyright. Update-ModuleManifest
hämtar parametervärdena från @Parms
och uppdaterar modulmanifestet , TestManifest.psd1.
Parametrar
-AliasesToExport
Anger de alias som modulen exporterar. Jokertecken tillåts.
Använd den här parametern för att begränsa de alias som exporteras av modulen. AliasesToExport kan ta bort alias från listan över exporterade alias, men det kan inte lägga till alias i listan.
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 CLR (Common Language Runtime) för Microsoft .NET Framework som krävs för 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.
Använd den här parametern för att begränsa de cmdletar som exporteras av modulen. CmdletsToExport kan ta bort cmdletar från listan över exporterade cmdletar, men det går inte att lägga till cmdletar i listan.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | True |
-CompanyName
Anger det företag eller den leverantör som skapade modulen.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-CompatiblePSEditions
Anger modulens kompatibla PSEditions . Information om PSEdition finnsi 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 |
-Confirm
Du uppmanas att bekräfta innan du kör Update-ModuleManifest
.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Copyright
Anger ett upphovsrättsmeddelande 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 version av Microsoft .NET Framework som modulen kräver.
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: | False |
-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 körs när modulen importeras.
När du importerar en modul kör PowerShell cmdleten Update-FormatData
med de angivna filerna.
Eftersom formateringsfiler 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.
Använd den här parametern för att begränsa de funktioner som exporteras av modulen. FunctionsToExport kan ta bort funktioner från listan över exporterade alias, men det kan inte lägga till funktioner i listan.
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 kan användas 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.
XML-filen HelpInfo stöder funktionen Uppdateringsbar hjälp som introducerades i PowerShell version 3.0. Den innehåller information om platsen för modulens nedladdningsbara hjälpfiler och versionsnumren för de senaste hjälpfilerna för varje språk som stöds.
Information om uppdateringsbar hjälp finns i about_Updatable_Help. Information om XML-filen HelpInfo finns i Stöd för uppdateringsbar hjälp.
Type: | Uri |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-IconUri
Anger URL:en 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 hash-tabell med ModuleName - och ModuleVersion-nycklar . Hash-tabellen kan också ha en valfri GUID-nyckel . Du kan kombinera strängar och hash-tabeller i parametervärdet.
Den här nyckeln är utformad för att fungera som en modulinventering. Modulerna som anges i värdet för den här nyckeln bearbetas inte automatiskt.
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 nyckeln NestedModules körs i den ordning som de visas i värdet.
Ange varje modulnamn som en sträng eller som en hash-tabell med ModuleName - och ModuleVersion-nycklar . Hash-tabellen kan också ha en valfri GUID-nyckel . Du kan kombinera strängar och hash-tabeller i parametervärdet.
Type: | Object[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PackageManagementProviders
Anger en matris med pakethanteringsproviders.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PassThru
Returnerar ett objekt som representerar det objekt som du arbetar med. Som standard Update-ModuleManifest
genererar inte några utdata.
Type: | SwitchParameter |
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 en sökväg och ett filnamn med filnamnstillägget .psd1
, till exempel $PSHOME\Modules\MyModule\MyModule.psd1
.
Om du anger sökvägen till en befintlig fil Update-ModuleManifest
ersätter den utan varning såvida inte filen har det skrivskyddade attributet.
Manifestet ska finnas i modulens katalog och manifestfilens namn ska vara samma som modulkatalognamnet, men med ett .psd1
tillägg.
Du kan inte använda variabler, till exempel $PSHOME
eller $HOME
, som svar på en fråga om parametervärdet Path . Om du vill använda en variabel tar du med parametern Path i kommandot .
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-PowerShellHostName
Anger namnet på Det PowerShell-värdprogram som krävs för modulen. Ange namnet på värdprogrammet, till exempel PowerShell ISE-värd eller ConsoleHost. Jokertecken tillåts inte.
Om du vill hitta namnet på ett värdprogram skriver du i programmet $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 3.0, 4.0 eller 5.0 som värdet för den här parametern.
Type: | Version |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Prerelease
Anger att modulen är förhandsversion.
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.
Type: | Hashtable |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ProcessorArchitecture
Anger processorarkitekturen som modulen kräver.
De acceptabla värdena för den här parametern är:
- Amd64
- Arm
- IA64
- MSIL
- Ingen (okänd eller ospecificerad)
- X86
Type: | ProcessorArchitecture |
Accepted values: | None, MSIL, X86, IA64, Amd64, Arm |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ProjectUri
Anger URL:en 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ängmatris som innehåller viktig information eller kommentarer som du vill ska vara tillgängliga för den här versionen av skriptet.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RequiredAssemblies
Anger de sammansättningsfiler (.dll
) som modulen kräver. Ange sammansättningsfilnamnen.
PowerShell läser in de angivna sammansättningarna innan du uppdaterar typer eller format, importerar kapslade moduler eller importerar modulfilen som anges i värdet för RootModule-nyckeln .
Använd den här parametern för att ange alla sammansättningar som modulen kräver, inklusive 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 som binära moduler 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 globalt sessionstillstånd. 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 misslyckas Import-Module
kommandot.
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: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RootModule
Anger den primära filen eller rotfilen för modulen. Ange filnamnet för ett skript (.ps1
), en skriptmodul (.psm1
), ett modulmanifest (.psd1
), en sammansättning (.dll
), en XML-fil för cmdlet-definition (.cdxml
) eller ett arbetsflöde (.xaml
). När modulen importeras importeras de medlemmar som exporteras från rotmodulfilen till anroparens sessionstillstånd.
Om en modul har en manifestfil och ingen rotfil har angetts i RootModule-nyckeln blir manifestet den primära filen för modulen. Och modulen blir en manifestmodul (ModuleType = Manifest).
Om du vill exportera medlemmar från .psm1
eller .dll
filer i en modul som har ett manifest måste namnen på dessa filer anges i värdena för RootModule - eller NestedModules-nycklarna i manifestet. Annars exporteras inte deras medlemmar.
I PowerShell 2.0 kallades den här nyckeln ModuleToProcess.
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[] |
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 de variabler som exporteras av modulen. VariablesToExport kan ta bort variabler från listan över exporterade variabler, men det kan inte lägga till variabler i listan.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | True |
-WhatIf
Visar vad som skulle hända om Update-ModuleManifest
körs. Cmdleten körs inte.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Indata
Utdata
Kommentarer
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 tillkännagivandet i PowerShell-bloggen.