Udostępnij za pośrednictwem

Update-ModuleManifest

  • Odwołanie
Moduł:
PowerShellGet

Aktualizacje pliku manifestu modułu.

Składnia

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

Opis

Polecenie Update-ModuleManifest cmdlet aktualizuje plik manifestu modułu (.psd1).

Jest to polecenie cmdlet serwera proxy dla Update-PSModuleManifest polecenia cmdlet w elemecie Microsoft.PowerShell.PSResourceGet. Aby uzyskać więcej informacji, zobacz Update-PSModuleManifest.

Przykłady

Przykład 1. Aktualizowanie manifestu modułu

W tym przykładzie jest aktualizowany istniejący plik manifestu modułu. Splatting służy do przekazywania wartości parametrów do Update-ModuleManifest. Aby uzyskać więcej informacji, zobacz about_Splatting.

$Params = @{
  Path = "C:\Test\TestManifest.psd1"
  Author = "TestUser1"
  CompanyName = "Contoso Corporation"
  Copyright = "(c) 2019 Contoso Corporation. All rights reserved."
}

Update-ModuleManifest @Params

$Params jest tablicą, która przechowuje wartości parametrów dla ścieżki, autora, nazwy firmy i praw autorskich. Update-ModuleManifest Pobiera wartości parametrów z @Params i aktualizuje manifest modułu TestManifest.psd1.

Parametry

-AliasesToExport

Określa aliasy eksportowane przez moduł. Dozwolone są symbole wieloznaczne.

Użyj tego parametru, aby ograniczyć aliasy eksportowane przez moduł. AliasesToExport może usunąć aliasy z listy wyeksportowanych aliasów, ale nie może dodać aliasów do listy.

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

-Author

Określa autora modułu.

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

-ClrVersion

Określa minimalną wersję środowiska uruchomieniowego języka wspólnego (CLR) .NET Framework firmy Microsoft wymaganej przez moduł.

Uwaga

To ustawienie jest prawidłowe tylko dla wersji programu PowerShell Desktop, takiej jak Windows PowerShell 5.1, i dotyczy tylko wersji .NET Framework starszych niż 4,5. To wymaganie nie ma wpływu na nowsze wersje programu PowerShell lub .NET Framework.

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

-CmdletsToExport

Określa polecenia cmdlet eksportowane przez moduł. Dozwolone są symbole wieloznaczne.

Użyj tego parametru, aby ograniczyć polecenia cmdlet wyeksportowane przez moduł. Polecenia cmdletsToExport mogą usuwać polecenia cmdlet z listy wyeksportowanych poleceń cmdlet, ale nie może dodawać poleceń cmdlet do listy.

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

-CompanyName

Określa firmę lub dostawcę, który utworzył moduł.

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

-CompatiblePSEditions

Określa zgodne psEditions modułu. Aby uzyskać informacje o programie PSEdition, zobacz Moduły z zgodnymi wersjami programu PowerShell.

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

-Confirm

Monituje o potwierdzenie przed uruchomieniem polecenia Update-ModuleManifest.

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

-Copyright

Określa oświadczenie o prawach autorskich dla modułu.

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

-DefaultCommandPrefix

Określa domyślny prefiks polecenia.

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

-Description

Określa opis modułu.

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

-DotNetFrameworkVersion

Określa minimalną wersję .NET Framework firmy Microsoft wymaganą przez moduł.

Uwaga

To ustawienie jest prawidłowe tylko dla wersji programu PowerShell Desktop, takiej jak Windows PowerShell 5.1, i dotyczy tylko wersji .NET Framework starszych niż 4,5. To wymaganie nie ma wpływu na nowsze wersje programu PowerShell lub .NET Framework.

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

-DscResourcesToExport

Określa zasoby Desired State Configuration (DSC), które eksportuje moduł. Dozwolone są symbole wieloznaczne.

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

-ExternalModuleDependencies

Określa tablicę zależności modułu zewnętrznego.

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

-FileList

Określa wszystkie elementy uwzględnione w module.

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

-FormatsToProcess

Określa pliki formatowania (.ps1xml), które są uruchamiane podczas importowania modułu.

Podczas importowania modułu program PowerShell uruchamia Update-FormatData polecenie cmdlet z określonymi plikami. Ponieważ pliki formatowania nie są ograniczone, mają wpływ na wszystkie stany sesji w sesji.

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

-FunctionsToExport

Określa funkcje eksportowane przez moduł. Dozwolone są symbole wieloznaczne.

Użyj tego parametru, aby ograniczyć funkcje eksportowane przez moduł. Funkcja FunctionsToExport może usuwać funkcje z listy wyeksportowanych aliasów, ale nie może dodawać funkcji do listy.

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

-Guid

Określa unikatowy identyfikator modułu. Identyfikator GUID może służyć do odróżnienia modułów o tej samej nazwie.

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

-HelpInfoUri

Określa adres internetowy pliku XML HelpInfo modułu. Wprowadź identyfikator URI (Uniform Resource Identifier), który rozpoczyna się od ciągu http lub https.

Plik XML HelpInfo obsługuje funkcję Pomoc do aktualizowania, która została wprowadzona w programie PowerShell w wersji 3.0. Zawiera on informacje o lokalizacji plików pomocy do pobrania modułu oraz numery wersji najnowszych plików pomocy dla każdego obsługiwanego ustawienia regionalne.

Aby uzyskać informacje o aktualizowalnej pomocy, zobacz about_Updatable_Help. Aby uzyskać informacje na temat pliku XML HelpInfo , zobacz Obsługa aktualizowalnej pomocy.

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

-IconUri

Określa adres URL ikony modułu. Określona ikona jest wyświetlana na stronie internetowej galerii modułu.

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

-LicenseUri

Określa adres URL postanowień licencyjnych dla modułu.

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

-ModuleList

Określa tablicę modułów, które są zawarte w module.

Wprowadź nazwę każdego modułu jako ciąg lub jako tabelę skrótów z kluczami ModuleName i ModuleVersion . Tabela skrótów może również mieć opcjonalny klucz GUID . W wartości parametru można łączyć ciągi i tabele skrótów.

Ten klucz jest przeznaczony do działania jako spisu modułów. Moduły wymienione w wartości tego klucza nie są automatycznie przetwarzane.

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

-ModuleVersion

Określa wersję modułu.

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

-NestedModules

Określa moduły skryptu (.psm1) i moduły binarne (.dll), które są importowane do stanu sesji modułu. Pliki w kluczu NestedModules są uruchamiane w kolejności, w której są one wymienione w wartości.

Wprowadź nazwę każdego modułu jako ciąg lub jako tabelę skrótów z kluczami ModuleName i ModuleVersion . Tabela skrótów może również mieć opcjonalny klucz GUID . W wartości parametru można łączyć ciągi i tabele skrótów.

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

-PackageManagementProviders

Określa tablicę dostawców zarządzania pakietami.

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

-PassThru

Zwraca obiekt reprezentujący element, z którym pracujesz. Domyślnie Update-ModuleManifest nie generuje żadnych danych wyjściowych.

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

-Path

Określa ścieżkę i nazwę pliku manifestu modułu. Wprowadź ścieżkę i nazwę pliku z .psd1 rozszerzeniem nazwy pliku, takim jak $PSHOME\Modules\MyModule\MyModule.psd1.

Jeśli określisz ścieżkę do istniejącego pliku, zastąpi go bez ostrzeżenia, Update-ModuleManifest chyba że plik ma atrybut tylko do odczytu.

Manifest powinien znajdować się w katalogu modułu, a nazwa pliku manifestu powinna być taka sama jak nazwa katalogu modułu, ale z .psd1 rozszerzeniem.

Nie można używać zmiennych, takich jak $PSHOME lub $HOME, w odpowiedzi na monit o wartość parametru Path . Aby użyć zmiennej, dołącz parametr Path w poleceniu .

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

-PowerShellHostName

Określa nazwę programu hosta programu PowerShell wymaganego przez moduł. Wprowadź nazwę programu hosta, na przykład Host ISE programu PowerShell lub ConsoleHost. Symbole wieloznaczne nie są dozwolone.

Aby znaleźć nazwę programu hosta, w programie wpisz $Host.Name.

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

-PowerShellHostVersion

Określa minimalną wersję programu hosta programu PowerShell, który współpracuje z modułem. Wprowadź numer wersji, taki jak 1.1.

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

-PowerShellVersion

Określa minimalną wersję programu PowerShell, która będzie działać z tym modułem. Można na przykład określić wartość 3.0, 4.0 lub 5.0 jako wartość tego parametru.

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

-Prerelease

Wskazuje, że moduł jest w wersji wstępnej.

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

-PrivateData

Określa dane przekazywane do modułu podczas importowania.

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

-ProcessorArchitecture

Określa architekturę procesora wymaganą przez moduł.

Dopuszczalne wartości dla tego parametru to:

  • Amd64
  • Ramię
  • IA64
  • MSIL
  • Brak (nieznany lub nieokreślony)
  • 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

Określa adres URL strony internetowej dotyczącej tego projektu.

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

-ReleaseNotes

Określa tablicę ciągów zawierającą informacje o wersji lub komentarze, które mają być dostępne dla tej wersji skryptu.

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

-RequiredAssemblies

Określa pliki zestawu (.dll), których wymaga moduł. Wprowadź nazwy plików zestawów. Program PowerShell ładuje określone zestawy przed aktualizacją typów lub formatów, importowaniem zagnieżdżonych modułów lub importowaniem pliku modułu określonego w wartości klucza RootModule .

Użyj tego parametru, aby określić wszystkie zestawy wymagane przez moduł, w tym zestawy, które muszą zostać załadowane w celu zaktualizowania dowolnych plików formatowania lub typów wymienionych w kluczach FormatsToProcess lub TypesToProcess , nawet jeśli te zestawy są również wymienione jako moduły binarne w kluczu NestedModules .

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

-RequiredModules

Określa moduły, które muszą być w stanie sesji globalnej. Jeśli wymagane moduły nie są w stanie sesji globalnej, program PowerShell je zaimportuje. Jeśli wymagane moduły nie są dostępne, Import-Module polecenie zakończy się niepowodzeniem.

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

-RequireLicenseAcceptance

Określa, że akceptacja licencji jest wymagana dla modułu.

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

-RootModule

Określa plik podstawowy lub główny modułu. Wprowadź nazwę pliku skryptu (), moduł skryptu (.ps1), manifest modułu (.psd1), zestaw (), plik XML definicji polecenia cmdlet (.dll.cdxml) lub przepływ pracy (.xaml)..psm1 Po zaimportowaniu modułu elementy członkowskie wyeksportowane z pliku modułu głównego są importowane do stanu sesji obiektu wywołującego.

Jeśli moduł ma plik manifestu i nie określono pliku głównego w kluczu RootModule , manifest staje się plikiem podstawowym modułu. Moduł staje się modułem manifestu (ModuleType = Manifest).

Aby wyeksportować elementy członkowskie z .psm1 modułu lub .dll pliki z manifestem, nazwy tych plików muszą być określone w wartościach kluczy RootModule lub NestedModules w manifeście. W przeciwnym razie ich członkowie nie są eksportowani.

W programie PowerShell 2.0 ten klucz nosi nazwę ModuleToProcess.

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

-ScriptsToProcess

Określa pliki skryptu (.ps1), które są uruchamiane w stanie sesji wywołującego podczas importowania modułu. Tych skryptów można użyć do przygotowania środowiska, tak jak skrypt logowania.

Aby określić skrypty uruchamiane w stanie sesji modułu, użyj klucza NestedModules .

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

-Tags

Określa tablicę tagów.

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

-TypesToProcess

Określa pliki typu (.ps1xml), które są uruchamiane podczas importowania modułu.

Podczas importowania modułu program PowerShell uruchamia Update-TypeData polecenie cmdlet z określonymi plikami. Ponieważ pliki typów nie są ograniczone, mają wpływ na wszystkie stany sesji w sesji.

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

-VariablesToExport

Określa zmienne eksportowane przez moduł. Dozwolone są symbole wieloznaczne.

Użyj tego parametru, aby ograniczyć zmienne eksportowane przez moduł. ZmienneToExport mogą usuwać zmienne z listy wyeksportowanych zmiennych, ale nie mogą dodawać zmiennych do listy.

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

-WhatIf

Pokazuje, co się stanie w przypadku Update-ModuleManifest uruchomienia. Polecenie cmdlet nie jest uruchamiane.

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

Dane wejściowe

String

Dane wyjściowe

Object