New-ModuleManifest

Sintassi

All

New-ModuleManifest
    [-Path] <String>
    [-NestedModules <Object[]>]
    [-Guid <Guid>]
    [-Author <String>]
    [-CompanyName <String>]
    [-Copyright <String>]
    [-RootModule <String>]
    [-ModuleVersion <Version>]
    [-Description <String>]
    [-ProcessorArchitecture <ProcessorArchitecture>]
    [-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[]>]
    [-CompatiblePSEditions <String[]>]
    [-PrivateData <Object>]
    [-Tags <String[]>]
    [-ProjectUri <Uri>]
    [-LicenseUri <Uri>]
    [-IconUri <Uri>]
    [-ReleaseNotes <String>]
    [-Prerelease <String>]
    [-RequireLicenseAcceptance]
    [-ExternalModuleDependencies <String[]>]
    [-HelpInfoUri <String>]
    [-PassThru]
    [-DefaultCommandPrefix <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Descrizione

Esempio

Esempio 1- Creare un nuovo manifesto del modulo

New-ModuleManifest -Path C:\ps-test\Test-Module\Test-Module.psd1 -PassThru

#
# Module manifest for module 'Test-Module'
#
# Generated by: ContosoAdmin
#
# Generated on: 7/12/2019
#

@{

# Script module or binary module file associated with this manifest.
# RootModule = ''

# Version number of this module.
ModuleVersion = '0.0.1'

# Supported PSEditions
# CompatiblePSEditions = @()

# ID used to uniquely identify this module
GUID = 'e1826c6e-c420-4eef-9ac8-185e3669ca6a'

# Author of this module
Author = 'ContosoAdmin'

# Company or vendor of this module
CompanyName = 'Unknown'

# Copyright statement for this module
Copyright = '(c) ContosoAdmin. All rights reserved.'

# Description of the functionality provided by this module
# Description = ''

# Minimum version of the PowerShell engine required by this module
# PowerShellVersion = ''

# Name of the PowerShell host required by this module
# PowerShellHostName = ''

# Minimum version of the PowerShell host required by this module
# PowerShellHostVersion = ''

# Minimum version of Microsoft .NET Framework required by this module. This prerequisite
# is valid for the PowerShell Desktop edition only.
# DotNetFrameworkVersion = ''

# Minimum version of the common language runtime (CLR) required by this module. This
# prerequisite is valid for the PowerShell Desktop edition only.
# CLRVersion = ''

# Processor architecture (None, X86, Amd64) required by this module
# ProcessorArchitecture = ''

# Modules that must be imported into the global environment prior to importing this module
# RequiredModules = @()

# Assemblies that must be loaded prior to importing this module
# RequiredAssemblies = @()

# Script files (.ps1) that are run in the caller's environment prior to importing this
# module.
# ScriptsToProcess = @()

# Type files (.ps1xml) to be loaded when importing this module
# TypesToProcess = @()

# Format files (.ps1xml) to be loaded when importing this module
# FormatsToProcess = @()

# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
# NestedModules = @()

# 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.
FunctionsToExport = @()

# 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.
CmdletsToExport = @()

# Variables to export from this module
VariablesToExport = '*'

# 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.
AliasesToExport = @()

# DSC resources to export from this module
# DscResourcesToExport = @()

# List of all modules packaged with this module
# ModuleList = @()

# List of all files packaged with this module
# FileList = @()

# Private data to pass to the module specified in RootModule/ModuleToProcess. This may
also contain a PSData hashtable with additional module metadata used by PowerShell.
PrivateData = @{

    PSData = @{

        # Tags applied to this module. These help with module discovery in online galleries.
        # Tags = @()

        # A URL to the license for this module.
        # LicenseUri = ''

        # A URL to the main website for this project.
        # ProjectUri = ''

        # A URL to an icon representing this module.
        # IconUri = ''

        # ReleaseNotes of this module
        # ReleaseNotes = ''

        # Prerelease string of this module
        # Prerelease = ''

        # Flag to indicate whether the module requires explicit user acceptance for install/update/save
        # RequireLicenseAcceptance = $false

        # External dependent modules of this module
        # ExternalModuleDependencies = @()

    } # End of PSData hashtable

} # End of PrivateData hashtable

# HelpInfo URI of this module
# HelpInfoURI = ''

# Default prefix for commands exported from this module. Override the default prefix
# using Import-Module -Prefix.
# DefaultCommandPrefix = ''

}

Esempio 2: Creare un nuovo manifesto con alcune impostazioni prepopolate

$moduleSettings = @{
    PowerShellVersion = 1.0
    Path   = 'C:\ps-test\ManifestTest.psd1'
    AliasesToExport   = @(
      'JKBC'
      'DRC'
      'TAC'
    )
}
New-ModuleManifest @moduleSettings

Esempio 3: Creare un manifesto che richiede altri moduli

$moduleSettings = @{
  RequiredModules = ("BitsTransfer", @{
    ModuleName="PSScheduledJob"
    ModuleVersion="1.0.0.0";
    GUID="50cdb55f-5ab7-489f-9e94-4ec21ff51e59"
  })
  Path = 'C:\ps-test\ManifestTest.psd1'
}
New-ModuleManifest @moduleSettings

Esempio 4 - Creare un manifesto che supporti la Guida aggiornabile

$moduleSettings = @{
  HelpInfoUri = 'http://https://go.microsoft.com/fwlink/?LinkID=603'
  Path = 'C:\ps-test\ManifestTest.psd1'
}
New-ModuleManifest @moduleSettings

Esempio 5 - Recupero delle informazioni sul modulo

Get-Module Microsoft.PowerShell.Diagnostics -List | Format-List -Property *

LogPipelineExecutionDetails : False
Name                        : Microsoft.PowerShell.Diagnostics
Path                        : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\Microsoft.PowerShell.Diagnostics\Micro
                              soft.PowerShell.Diagnostics.psd1
Definition                  :
Description                 :
Guid                        : ca046f10-ca64-4740-8ff9-2565dba61a4f
HelpInfoUri                 : https://go.microsoft.com/fwlink/?LinkID=210596
ModuleBase                  : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\Microsoft.PowerShell.Diagnostics
PrivateData                 :
Version                     : 3.0.0.0
ModuleType                  : Manifest
Author                      : Microsoft Corporation
AccessMode                  : ReadWrite
ClrVersion                  : 4.0
CompanyName                 : Microsoft Corporation
Copyright                   : Microsoft Corporation. All rights reserved.
DotNetFrameworkVersion      :
ExportedFunctions           : {}
ExportedCmdlets             : {[Get-WinEvent, Get-WinEvent], [Get-Counter, Get-Counter], [Import-Counter,
                              Import-Counter], [Export-Counter, Export-Counter]...}
ExportedCommands            : {[Get-WinEvent, Get-WinEvent], [Get-Counter, Get-Counter], [Import-Counter,
                              Import-Counter], [Export-Counter, Export-Counter]...}
FileList                    : {}
ModuleList                  : {}
NestedModules               : {}
PowerShellHostName          :
PowerShellHostVersion       :
PowerShellVersion           : 3.0
ProcessorArchitecture       : None
Scripts                     : {}
RequiredAssemblies          : {}
RequiredModules             : {}
RootModule                  :
ExportedVariables           : {}
ExportedAliases             : {}
ExportedWorkflows           : {}
SessionState                :
OnRemove                    :
ExportedFormatFiles         : {C:\Windows\system32\WindowsPowerShell\v1.0\Event.format.ps1xml,
                              C:\Windows\system32\WindowsPowerShell\v1.0\Diagnostics.format.ps1xml}
ExportedTypeFiles           : {C:\Windows\system32\WindowsPowerShell\v1.0\GetEvent.types.ps1xml}

Parametri

-AliasesToExport

Specifica gli alias che il modulo esporta. Sono consentiti i metacaratteri.

È possibile usare questo parametro per limitare gli alias esportati dal modulo. Può rimuovere alias dall'elenco di alias esportati, ma non può aggiungere alias all'elenco.

Se si omette questo parametro, New-ModuleManifest crea una chiave AliasesToExport con un valore * (tutto), ovvero tutti gli alias definiti nel modulo vengono esportati dal manifesto.

Proprietà dei parametri

Set di parametri

-Author

Specifica l'autore del modulo.

Se si omette questo parametro, New-ModuleManifest crea una chiave Author con il nome dell'utente corrente.

Proprietà dei parametri

Set di parametri

-ClrVersion

Specifica la versione minima di Common Language Runtime (CLR) di Microsoft .NET Framework richiesta dal modulo.

Proprietà dei parametri

Set di parametri

-CmdletsToExport

Specifica i cmdlet che il modulo esporta. Sono consentiti i metacaratteri.

È possibile usare questo parametro per limitare i cmdlet esportati dal modulo. Può rimuovere i cmdlet dall'elenco dei cmdlet esportati, ma non può aggiungere cmdlet all'elenco.

Se si omette questo parametro, New-ModuleManifest crea una chiave CmdletsToExport con un valore * (tutto), ovvero tutti i cmdlet definiti nel modulo vengono esportati dal manifesto.

Proprietà dei parametri

Set di parametri

-CompanyName

Identifica la società o il fornitore che ha creato il modulo.

Se si omette questo parametro, New-ModuleManifest crea una chiave CompanyName con il valore "Unknown".

Proprietà dei parametri

Set di parametri

-CompatiblePSEditions

Specifica le PSEditions compatibili del modulo. Per informazioni su PSEdition, vedere Moduli con edizioni PowerShell compatibili.

Proprietà dei parametri

Set di parametri

-Confirm

Richiede conferma prima di eseguire il cmdlet.

Proprietà dei parametri

Set di parametri

-Copyright

Specifica un'informativa sul copyright per il modulo.

Se si omette questo parametro, New-ModuleManifest crea una chiave copyright con valore (c) <year> <username>. All rights reserved. dove <year> è l'anno corrente e <username> è il valore della chiave autore.

Proprietà dei parametri

Set di parametri

-DefaultCommandPrefix

Specifica un prefisso aggiunto ai nomi di tutti i comandi del modulo quando vengono importati in una sessione. Immettere una stringa di prefisso. I prefissi impediscono conflitti di nomi di comando nella sessione di un utente.

Gli utenti del modulo possono sovrascrivere questo prefisso specificando il parametro Prefisso del cmdlet Import-Module.

Questo parametro è stato introdotto in PowerShell 3.0.

Proprietà dei parametri

Set di parametri

-Description

Descrive il contenuto del modulo.

Proprietà dei parametri

Set di parametri

-DotNetFrameworkVersion

Specifica la versione minima di Microsoft .NET Framework richiesta dal modulo.

Proprietà dei parametri

Set di parametri

-DscResourcesToExport

Specifica le risorse DSC (Desired State Configuration) esportate dal modulo. Sono consentiti i metacaratteri.

Proprietà dei parametri

Set di parametri

-ExternalModuleDependencies

Un elenco di moduli esterni da cui dipende questo modulo. Questo elenco viene usato solo per documentare le dipendenze del modulo e non viene applicato da PowerShell. Non viene usato dai comandi PowerShellGet o PSResourceGet o da PowerShell Gallery.

Proprietà dei parametri

Set di parametri

-FileList

Specifica tutti gli elementi inclusi nel modulo.

Questa chiave è progettata per fungere da inventario dei moduli. I file elencati nella chiave vengono inclusi quando il modulo viene pubblicato, ma tutte le funzioni non vengono esportate automaticamente.

Proprietà dei parametri

Set di parametri

-FormatsToProcess

Specifica i file di formattazione (.ps1xml) eseguiti quando il modulo viene importato.

Quando si importa un modulo, PowerShell esegue il cmdlet Update-FormatData con i file specificati. Poiché i file di formattazione non hanno ambito, influiscono su tutti gli stati della sessione.

Proprietà dei parametri

Set di parametri

-FunctionsToExport

Specifica le funzioni esportate dal modulo. Sono consentiti i metacaratteri.

È possibile usare questo parametro per limitare le funzioni esportate dal modulo. Può rimuovere le funzioni dall'elenco di alias esportati, ma non può aggiungere funzioni all'elenco.

Se si omette questo parametro, New-ModuleManifest crea una chiave FunctionsToExport con un valore ( * tutto), ovvero tutte le funzioni definite nel modulo vengono esportate dal manifesto.

Proprietà dei parametri

Set di parametri

-Guid

Specifica un identificatore univoco per il modulo. Il GUID può essere usato per distinguere tra i moduli con lo stesso nome.

Se si omette questo parametro, New-ModuleManifest crea una chiave GUID nel manifesto e genera un GUID per il valore.

Per creare un nuovo GUID in PowerShell, digita [guid]::NewGuid().

Proprietà dei parametri

Set di parametri

-HelpInfoUri

Specifica l'indirizzo Internet del file XML HelpInfo per il modulo. Immettere un URI (Uniform Resource Identifier) che inizia con http o https.

Il file XML HelpInfo supporta la funzionalità Guida aggiornabile introdotta in PowerShell 3.0. Contiene informazioni sul percorso dei file della Guida scaricabili per il modulo e i numeri di versione dei file della Guida più recenti per ogni impostazione locale supportata.

Per informazioni sulla Guida aggiornabile, vedere about_Updatable_Help. Per informazioni sul file XML HelpInfo, vedere Supporto della Guida aggiornabile.

Questo parametro è stato introdotto in PowerShell 3.0.

Proprietà dei parametri

Set di parametri

-IconUri

Specifica l'URL di un'icona per il modulo. L'icona specificata viene mostrata nella pagina web della raccolta per il modulo.

Proprietà dei parametri

Set di parametri

-LicenseUri

Specifica l'URL delle condizioni di licenza per il modulo.

Proprietà dei parametri

Set di parametri

-ModuleList

Elenca tutti i moduli inclusi in questo modulo.

Immettere ogni nome di modulo come stringa o come tabella hash con le chiavi ModuleName e ModuleVersion. La tabella hash può anche avere una chiave GUID facoltativa. È possibile combinare stringhe e tabelle hash nel valore del parametro.

Questa chiave è progettata per fungere da inventario dei moduli. I moduli elencati nel valore di questa chiave non vengono elaborati automaticamente.

Proprietà dei parametri

Set di parametri

-ModuleVersion

Specifica la versione del modulo.

Questo parametro non è obbligatorio, ma nel manifesto è necessaria una chiave ModuleVersion. Se si omette questo parametro, New-ModuleManifest crea una chiave ModuleVersion con valore 1,0.

Proprietà dei parametri

Set di parametri

-NestedModules

Specifica i moduli di script (.psm1) e i moduli binari (.dll) importati nello stato della sessione del modulo. I file nella chiave NestedModules vengono eseguiti nell'ordine in cui sono elencati nel valore della chiave.

Immettere ogni nome di modulo come stringa o come tabella hash con le chiavi ModuleName e ModuleVersion. La tabella hash può anche avere una chiave GUID facoltativa. È possibile combinare stringhe e tabelle hash nel valore del parametro.

In genere, i moduli annidati contengono comandi necessari al modulo radice per l'elaborazione interna. Per impostazione predefinita, i comandi nei moduli annidati vengono esportati dallo stato della sessione del modulo nello stato della sessione del chiamante, ma il modulo radice può limitare i comandi che esporta. Ad esempio, usando un comando Export-ModuleMember.

I moduli annidati nello stato della sessione del modulo sono disponibili per il modulo radice, ma non vengono restituiti da un comando Get-Module nello stato della sessione del chiamante.

Gli script (.ps1) elencati nella chiave NestedModules vengono eseguiti nello stato della sessione del modulo, non nello stato della sessione del chiamante. Per eseguire uno script nello stato della sessione del chiamante, elencare il nome del file di script nel valore della chiave ScriptsToProcess nel manifesto.

Proprietà dei parametri

Set di parametri

-PassThru

Scrive il manifesto del modulo risultante nella console e crea un file .psd1. Per impostazione predefinita, questo cmdlet non genera alcun output.

Proprietà dei parametri

Set di parametri

-Path

Specifica il percorso e il nome file del nuovo manifesto del modulo. Immettere un percorso e un nome di file con un'estensione di file .psd1, ad esempio $PSHOME\Modules\MyModule\MyModule.psd1. È necessario il parametro Path.

Se si specifica il percorso di un file esistente, New-ModuleManifest sostituisce il file senza avviso, a meno che il file non abbia l'attributo di sola lettura.

Il manifesto deve trovarsi nella directory del modulo e il nome del file manifesto deve essere uguale al nome della directory del modulo, ma con un'estensione del nome di file .psd1.

Proprietà dei parametri

Set di parametri

-PowerShellHostName

Specifica il nome del programma host di PowerShell richiesto dal modulo. Immettere il nome del programma host, ad esempio host di Windows PowerShell ISE o ConsoleHost. I caratteri jolly non sono consentiti.

Per trovare il nome di un programma host, nel programma digitare $Host.Name.

Proprietà dei parametri

Set di parametri

-PowerShellHostVersion

Specifica la versione minima del programma host di PowerShell che funziona con il modulo. Immettere un numero di versione, ad esempio 1.1.

Proprietà dei parametri

Set di parametri

-PowerShellVersion

Specifica la versione minima di PowerShell che funziona con questo modulo. Ad esempio, è possibile immettere 1.0, 2.0 o 3.0 come valore del parametro. Deve essere in formato X.X. Ad esempio, se si invia 5, PowerShell genererà un errore.

Proprietà dei parametri

Set di parametri

-Prerelease

Stringa provvisoria di questo modulo. L'aggiunta di una stringa di versione preliminare identifica il modulo come versione non definitiva. Quando il modulo viene pubblicato su PowerShell Gallery, questi dati vengono utilizzati per identificare i pacchetti in versione preliminare. Per acquisire pacchetti non definitivi dalla Galleria, è necessario usare il parametro AllowPrerelease con i comandi di PowerShellGet Find-Module, Install-Module, Update-Modulee Save-Module.

Proprietà dei parametri

Set di parametri

-PrivateData

Specifica i dati passati al modulo quando vengono importati.

Proprietà dei parametri

Set di parametri

-ProcessorArchitecture

Specifica l'architettura del processore richiesta dal modulo. I valori validi sono x86, AMD64, IA64, MSIL e Nessuno (sconosciuto o non specificato).

Proprietà dei parametri

Set di parametri

-ProjectUri

Specifica l'URL di una pagina Web relativa a questo progetto.

Proprietà dei parametri

Set di parametri

-ReleaseNotes

Specifica le note di rilascio.

Proprietà dei parametri

Set di parametri

-RequiredAssemblies

Specifica i file di assembly (.dll) richiesti dal modulo. Immettere i nomi dei file di assembly. PowerShell carica gli assembly specificati prima di aggiornare tipi o formati, importare moduli annidati o importare il file di modulo specificato nel valore della chiave RootModule.

Usare questo parametro per elencare tutti gli assembly richiesti dal modulo, inclusi gli assembly che devono essere caricati per aggiornare tutti i file di formattazione o di tipo elencati nella FormatsToProcess o TypesToProcess chiavi, anche se tali assembly sono elencati anche come moduli binari nella chiave NestedModules.

Proprietà dei parametri

Set di parametri

-RequiredModules

Specifica i moduli che devono trovarsi nello stato della sessione globale. Se i moduli necessari non sono nello stato della sessione globale, PowerShell li importa. Se i moduli necessari non sono disponibili, il comando Import-Module ha esito negativo.

Immettere ogni nome di modulo come stringa o come tabella hash con le chiavi ModuleName e ModuleVersion. La tabella hash può anche avere una chiave GUID facoltativa. È possibile combinare stringhe e tabelle hash nel valore del parametro.

Quando si installa un modulo usando i Install-Module comandi o Install-PSResource , questi comandi controllano questo elenco. Se i moduli necessari non sono installati, i comandi tentano di installare i moduli necessari.

Proprietà dei parametri

Set di parametri

-RequireLicenseAcceptance

Flag per indicare se il modulo richiede l'accettazione esplicita dell'utente per l'installazione, l'aggiornamento o il salvataggio.

Proprietà dei parametri

Set di parametri

-RootModule

Specifica il file primario o radice del modulo. Immettere il nome file di uno script (.ps1), un modulo script (.psm1), un manifesto del modulo (.psd1), un assembly (.dll), un file XML di definizione del cmdlet (.cdxml) o un flusso di lavoro (.xaml). Quando il modulo viene importato, i membri esportati dal file del modulo radice vengono importati nello stato della sessione del chiamante.

Se un modulo ha un file manifesto e non è stato designato alcun file radice nella chiave RootModule, il manifesto diventa il file primario per il modulo e il modulo diventa un modulo manifesto (ModuleType = Manifest).

Per esportare i membri da file .psm1 o .dll in un modulo con un manifesto, i nomi di tali file devono essere specificati nei valori di RootModule o nestedModules chiavi nel manifesto. In caso contrario, i loro membri non vengono esportati.

Proprietà dei parametri

Set di parametri

-ScriptsToProcess

Specifica i file script (.ps1) eseguiti nello stato della sessione del chiamante quando il modulo viene importato. È possibile usare questi script per preparare un ambiente, proprio come è possibile usare uno script di accesso.

Per specificare gli script eseguiti nello stato della sessione del modulo, usare la chiave nestedModules.

Proprietà dei parametri

Set di parametri

-Tags

Specifica una matrice di tag.

Proprietà dei parametri

Set di parametri

-TypesToProcess

Specifica i file di tipo (.ps1xml) eseguiti quando il modulo viene importato.

Quando si importa il modulo, PowerShell esegue il cmdlet Update-TypeData con i file specificati. Poiché i file di tipo non hanno ambito, influiscono su tutti gli stati della sessione.

Proprietà dei parametri

Set di parametri

-VariablesToExport

Specifica le variabili esportate dal modulo. Sono consentiti i metacaratteri.

È possibile usare questo parametro per limitare le variabili esportate dal modulo. Può rimuovere le variabili dall'elenco delle variabili esportate, ma non può aggiungere variabili all'elenco.

Se si omette questo parametro, New-ModuleManifest crea una chiave VariablesToExport con un valore * (tutto), ovvero tutte le variabili definite nel modulo vengono esportate dal manifesto.

Proprietà dei parametri

Set di parametri

-WhatIf

Mostra cosa accadrebbe se New-ModuleManifest venisse eseguito. Il cmdlet non viene eseguito.

Proprietà dei parametri

Set di parametri

CommonParameters

Input

None

Output

None

String

Note

Collegamenti correlati

• Export-ModuleMember
• Get-Module
• Import-Module
• Nuovo-Modulo
• Rimuovere il modulo (Remove-Module)
• Test-ModuleManifest
• Informazioni sui moduli