Update-PSModuleManifest
Aktualizacje pliku manifestu modułu.
Składnia
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>]
Opis
To polecenie cmdlet aktualizuje dane przechowywane w pliku manifestu modułu. Parametry umożliwiają określenie, które właściwości są aktualizowane.
Update-PSModuleManifest
zastępuje wszystkie istniejące wartości w manifeście modułu.
Polecenie cmdlet nie zwraca obiektu.
Przykłady
Przykład 1
Ten przykład zmienia właściwość Author w manifeście modułu na New Author
.
Update-PSModuleManifest -Path 'C:\MyModules\TestModule' -Author 'New Author'
Przykład 2
W tym przykładzie właściwość Prerelease zmienia wartość beta2
.
Update-PSModuleManifest -Path 'C:\MyModules\TestModule' -Prerelease 'beta2'
Przykład 3
Ten przykład aktualizuje wiele właściwości.
$parameters = @{
Path = 'C:\MyModules\TestModule'
Tags = 'Windows', 'Linux'
Description = 'A module for managing packages.'
}
Update-PSModuleManifest
Parametry
-AliasesToExport
Określa aliasy eksportowane przez moduł. Dozwolone są symbole wieloznaczne.
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) .NET Framework firmy Microsoft wymaganej 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.
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 zgodne psEditions modułu. Aby uzyskać informacje o programie 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 |
-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ę .NET Framework firmy Microsoft 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 Desired State Configuration (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: | True |
-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ą przetwarzane 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.
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.
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 służy do rozróżniania modułów 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 zaczyna się od http:
lub https:
.
Aby uzyskać więcej informacji, zobacz Updatable Help (Pomoc możliwa do zaktualizowania).
Typ: | Uri |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-IconUri
Określa identyfikator URI 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ą uwzględnione w module.
Wprowadź nazwę każdego modułu jako ciąg lub wartość skrótu z kluczami ModuleName i ModuleVersion . Tabela skrótu może również mieć opcjonalny klucz GUID . Ciągi i tabele skrótów można łączyć w wartości parametru.
Ten klucz jest przeznaczony do działania jako spisu modułów.
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 skryptów (.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ą wyświetlane.
Wprowadź nazwę każdego modułu jako ciąg lub wartość skrótu z kluczami ModuleName i ModuleVersion . Tabela skrótu może również mieć opcjonalny klucz GUID . Ciągi i tabele skrótów można łączyć w wartości parametru.
Typ: | Object[] |
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ź nazwę pliku z .psd1
rozszerzeniem pliku.
Typ: | String |
Position: | 0 |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-PowerShellHostName
Określa nazwę programu hosta programu PowerShell wymaganego przez moduł. Wprowadź nazwę programu hosta, na przykład PowerShell ISE Host lub ConsoleHost. Symbole wieloznaczne nie są dozwolone.
Nazwa programu hosta jest przechowywana w pliku $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 współpracuje z tym modułem. Można na przykład określić wersje, takie jak 5.1
lub 7.2
.
Typ: | Version |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-Prerelease
Określa wartość wersji wstępnej dołączoną do wersji modułu. Jeśli na przykład wersja wstępna to preview
, a parametr ModuleVersion to 1.0.0
, wersja modułu to 1.0.0-preview
.
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 po zaimportowaniu. Może to być dowolna wartość przechowywana w tabeli skrótowej.
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 dla tego parametru to:
Amd64
Arm
IA64
MSIL
-
None
(nieznany lub nieokreślony) X86
Typ: | ProcessorArchitecture |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-ProjectUri
Określa identyfikator URI 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 ciąg zawierający informacje o wersji lub komentarze dla modułu.
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
) wymagane przez moduł. 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 kluczu RootModule .
Użyj elementów RequiredAssemblies dla zestawów, które muszą zostać załadowane, aby zaktualizować wszystkie pliki formatowania lub typu wymienione w kluczach FormatsToProcess lub TypesToProcess , nawet jeśli te zestawy są również wymienione 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, Import-Module
polecenie kończy się niepowodzeniem.
Wartość może być tablicą zawierającą nazwy modułów lub specyfikacje modułów. Specyfikacja modułu jest tabelą skrótu zawierającą następujące klucze.
-
ModuleName
- Wymagane Określa nazwę modułu. -
GUID
- Opcjonalne Określa identyfikator GUID modułu. - Jest to również wymagane , aby określić co najmniej jeden z trzech poniższych kluczy.
-
ModuleVersion
— Określa minimalną akceptowalną wersję modułu. -
MaximumVersion
- Określa maksymalną akceptowalną wersję modułu. -
RequiredVersion
— Określa dokładną, wymaganą wersję modułu. Nie można jej używać z innymi kluczami wersji.
-
Typ: | Object[] |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-RequireLicenseAcceptance
Określa, że dla modułu wymagana jest akceptacja licencji.
Typ: | SwitchParameter |
Position: | Named |
Domyślna wartość: | False |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-RootModule
Określa podstawowy lub główny plik modułu. Wprowadź nazwę pliku skryptu (), moduł skryptu (.ps1
), manifest modułu (.psm1
), zestaw (.psd1
.dll
) lub plik XML definicji polecenia cmdlet (.cdxml
). Po zaimportowaniu modułu członkowie wyeksportowani z modułu głównego zostaną zaimportowani do stanu sesji obiektu wywołującego.
Jeśli moduł ma plik manifestu i nie określono pliku w kluczu RootModule , manifest staje się plikiem podstawowym modułu. Moduł jest nazywany modułem manifestu (ModuleType =
Manifest
).
Aby wyeksportować elementy członkowskie z .psm1
lub .dll
pliki, nazwy tych plików muszą być określone w wartościach kluczy RootModule lub NestedModules w manifeście.
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 po zaimportowaniu modułu.
Możesz użyć tych skryptów, aby przygotować środowisko, tak samo 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[] |
Aliasy: | Tag |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | 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.
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ł.
Typ: | String[] |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | True |
Dane wejściowe
None
Dane wyjściowe
Uwagi
Aby uzyskać pełny opis pliku manifestu modułu, zobacz about_Module_Manifests.