Udostępnij za pośrednictwem

Update-ModuleManifest

  • Odwołanie
Moduł:
PowerShellGet

Aktualizuje plik 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 cmdlet Update-ModuleManifest aktualizuje plik manifestu modułu (.psd1).

Przykłady

Przykład 1. Aktualizowanie manifestu modułu

W tym przykładzie zaktualizowano 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.

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

Update-ModuleManifest @Parms

$Parms toplata, która przechowuje wartości parametrów Path, Author, CompanyNamei Copyright. Update-ModuleManifest pobiera wartości parametrów z @Parms 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.

Typ:String[]
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:True

-Author

Określa autora modułu.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-ClrVersion

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

Typ:Version
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-CmdletsToExport

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

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

Typ:String[]
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:True

-CompanyName

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

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-CompatiblePSEditions

Określa zgodną psEditions modułu. Aby uzyskać informacje na temat PSEdition, zobacz moduły z zgodnymi wersjami programu PowerShell.

Typ:String[]
Dopuszczalne wartości:Desktop, Core
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-Confirm

Monituje o potwierdzenie przed uruchomieniem Update-ModuleManifest.

Typ:SwitchParameter
Aliasy:cf
Position:Named
Domyślna wartość:False
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-Copyright

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

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-DefaultCommandPrefix

Określa domyślny prefiks polecenia.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-Description

Określa opis modułu.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-DotNetFrameworkVersion

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

Typ:Version
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-DscResourcesToExport

Określa zasoby konfiguracji żądanego stanu (DSC), które eksportuje moduł. Dozwolone są symbole wieloznaczne.

Typ:String[]
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-ExternalModuleDependencies

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

Typ:String[]
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-FileList

Określa wszystkie elementy uwzględnione w module.

Typ:String[]
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-FormatsToProcess

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

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

Typ:String[]
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-FunctionsToExport

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

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

Typ:String[]
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:True

-Guid

Określa unikatowy identyfikator modułu. Identyfikator GUID może służyć do rozróżnienia między modułami o tej samej nazwie.

Typ:Guid
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-HelpInfoUri

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

Plik HelpInfo XML obsługuje funkcję Updatable Help, 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 ustawień regionalnych.

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

Typ:Uri
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-IconUri

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

Typ:Uri
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-LicenseUri

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

Typ:Uri
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-ModuleList

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

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

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

Typ:Object[]
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-ModuleVersion

Określa wersję modułu.

Typ:Version
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-NestedModules

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

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

Typ:Object[]
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-PackageManagementProviders

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

Typ:String[]
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-PassThru

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

Typ:SwitchParameter
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-Path

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

Jeśli określisz ścieżkę do istniejącego pliku, Update-ModuleManifest zastąpi plik bez ostrzeżenia, 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 rozszerzeniem .psd1.

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

Typ:String
Position:0
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych: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.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-PowerShellHostVersion

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

Typ:Version
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych: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.

Typ:Version
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-Prerelease

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

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-PrivateData

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

Typ:Hashtable
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-ProcessorArchitecture

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

Dopuszczalne wartości tego parametru to:

  • Amd64
  • Ramię
  • IA64
  • MSIL
  • Brak (nieznany lub nieokreślony)
  • X86
Typ:ProcessorArchitecture
Dopuszczalne wartości:None, MSIL, X86, IA64, Amd64, Arm
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-ProjectUri

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

Typ:Uri
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych: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.

Typ:String[]
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-RequiredAssemblies

Określa pliki zestawu (.dll), których wymaga moduł. Wprowadź nazwy plików zestawu. 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 plików formatowania lub typów wymienionych w FormatsToProcess lub TypesToProcess klucze, nawet jeśli te zestawy są również wymienione jako moduły binarne w kluczu NestedModules.

Typ:String[]
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-RequiredModules

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

Typ:Object[]
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-RequireLicenseAcceptance

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

Typ:SwitchParameter
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-RootModule

Określa plik podstawowy lub główny modułu. Wprowadź nazwę pliku skryptu (.ps1), moduł skryptu (.psm1), manifest modułu (.psd1), zestaw (.dll), plik XML definicji polecenia cmdlet (.cdxml) lub przepływ pracy (.xaml). Po zaimportowaniu modułu elementy członkowskie wyeksportowane z pliku głównego modułu 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 plików .psm1 lub .dll w module z manifestem, nazwy tych plików muszą być określone w wartościach RootModule lub NestedModules kluczy w manifeście. W przeciwnym razie ich członkowie nie są eksportowani.

W programie PowerShell 2.0 ten klucz nosił nazwę ModuleToProcess.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych: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.

Typ:String[]
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-Tags

Określa tablicę tagów.

Typ:String[]
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-TypesToProcess

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

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

Typ:String[]
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-VariablesToExport

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

Użyj tego parametru, aby ograniczyć zmienne eksportowane przez moduł. VariablesToExport może usunąć zmienne z listy wyeksportowanych zmiennych, ale nie może dodać zmiennych do listy.

Typ:String[]
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:True

-WhatIf

Pokazuje, co się stanie, jeśli Update-ModuleManifest działa. Polecenie cmdlet nie jest uruchamiane.

Typ:SwitchParameter
Aliasy:wi
Position:Named
Domyślna wartość:False
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

Dane wejściowe

String

Dane wyjściowe

Object

Uwagi

Ważny

Od kwietnia 2020 r. galeria programu PowerShell nie obsługuje już protokołu Transport Layer Security (TLS) w wersji 1.0 i 1.1. Jeśli nie używasz protokołu TLS 1.2 lub nowszego, podczas próby uzyskania dostępu do galerii programu PowerShell zostanie wyświetlony błąd. Użyj następującego polecenia, aby upewnić się, że używasz protokołu TLS 1.2:

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

Aby uzyskać więcej informacji, zobacz anons w blogu programu PowerShell.