Add-ModuleManifestData¶
SYNOPSIS¶
Add data to a module manifest file property
SYNTAX¶
Add-ModuleManifestData [-Path] <String> [[-RequiredModules] <Object[]>] [[-CompatiblePSEditions] <String[]>]
[[-RequiredAssemblies] <String[]>] [[-ScriptsToProcess] <String[]>] [[-TypesToProcess] <String[]>]
[[-FormatsToProcess] <String[]>] [[-NestedModules] <Object[]>] [[-FunctionsToExport] <String[]>]
[[-CmdletsToExport] <String[]>] [[-VariablesToExport] <String[]>] [[-AliasesToExport] <String[]>]
[[-DscResourcesToExport] <String[]>] [[-ModuleList] <Object[]>] [[-FileList] <String[]>] [[-Tags] <String[]>]
[[-ExternalModuleDependencies] <String[]>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION¶
This function adds data to a module manifest file property. If the property doesn't exist, it will be created. If it does exist, the new data will be appended to the existing data.
EXAMPLES¶
EXAMPLE 1¶
Add-ModuleManifestData -Path 'MyModule.psd1' -RequiredModules 'pester', 'platyPS'
Adds the modules 'pester' and 'platyPS' to the RequiredModules property of the module manifest file 'MyModule.psd1'.
PARAMETERS¶
-Path¶
{{ Fill Path Description }}
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RequiredModules¶
Modules that must be imported into the global environment prior to importing this module.
Type: Object[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CompatiblePSEditions¶
Compatible editions of PowerShell.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RequiredAssemblies¶
Assemblies that must be loaded prior to importing this module.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ScriptsToProcess¶
Script files (.ps1) that are run in the caller's environment prior to importing this module.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-TypesToProcess¶
Type files (.ps1xml) to be loaded when importing this module.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FormatsToProcess¶
Format files (.ps1xml) to be loaded when importing this module.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-NestedModules¶
Modules to import as nested modules of the module specified in RootModule/ModuleToProcess.
Type: Object[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FunctionsToExport¶
Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CmdletsToExport¶
Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-VariablesToExport¶
Variables to export from this module.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-AliasesToExport¶
Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DscResourcesToExport¶
DSC resources to export from this module.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 13
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ModuleList¶
List of all modules packaged with this module.
Type: Object[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 14
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FileList¶
List of all files packaged with this module.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 15
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Tags¶
Tags applied to this module. These help with module discovery in online galleries.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 16
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ExternalModuleDependencies¶
External dependent modules of this module.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 17
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction¶
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters¶
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.