about_Module_Manifests

Descrição curta

Descreve as configurações e práticas para escrever arquivos de manifesto do módulo.

Descrição longa

Um manifesto de módulo é um arquivo de dados do PowerShell (.psd1) que contém uma tabela de hash. Os pares chave-valor na tabela de hash descrevem o conteúdo e os atributos do módulo, definem os pré-requisitos e controlam como os componentes são processados.

Os manifestos não são necessários para carregar um módulo, mas são necessários para publicar um módulo na Galeria do PowerShell. Os manifestos também permitem que você separe a implementação do módulo de como ele é carregado. Com um manifesto, você pode definir requisitos, compatibilidade, ordem de carregamento e muito mais.

Quando você usa New-ModuleManifest sem especificar nenhum parâmetro para as configurações do manifesto, ele grava um arquivo de manifesto mínimo. O trecho abaixo mostra esta saída padrão, cortada de comentários e espaçamento para brevidade:

@{
# RootModule = ''
ModuleVersion = '1.0'
# CompatiblePSEditions = @()
GUID = 'e7184b71-2527-469f-a50e-166b612dfb3b'
Author = 'username'
CompanyName = 'Unknown'
Copyright = '(c) 2022 username. All rights reserved.'
# Description = ''
# PowerShellVersion = ''
# PowerShellHostName = ''
# PowerShellHostVersion = ''
# DotNetFrameworkVersion = ''
# CLRVersion = ''
# ProcessorArchitecture = ''
# RequiredModules = @()
# RequiredAssemblies = @()
# ScriptsToProcess = @()
# TypesToProcess = @()
# FormatsToProcess = @()
# NestedModules = @()
FunctionsToExport = @()
CmdletsToExport = @()
VariablesToExport = '*'
AliasesToExport = @()
# DscResourcesToExport = @()
# ModuleList = @()
# FileList = @()
PrivateData = @{
    PSData = @{
        # Tags = @()
        # LicenseUri = ''
        # ProjectUri = ''
        # IconUri = ''
        # ReleaseNotes = ''
        # ExternalModuleDependencies = @()
    } # End of PSData hashtable
} # End of PrivateData hashtable
# HelpInfoURI = ''
# DefaultCommandPrefix = ''
}

Você pode usar Test-ModuleManifest para validar um manifesto de módulo antes de publicá-lo. Test-ModuleManifest Retorna um erro se o manifesto for inválido ou se o módulo não puder ser importado para a sessão atual porque a sessão não atende aos requisitos definidos no manifesto.

Usando o código de script em um manifesto de módulo

Os valores atribuídos às configurações no arquivo de manifesto podem ser expressões avaliadas pelo PowerShell. Isso permite que você construa caminhos e atribua valores condicionalmente com base em variáveis.

Quando você importa um módulo usando Import-Moduleo , o manifesto é avaliado no Restricted modo de idioma. Restricted limita os comandos e variáveis que podem ser usados.

Comandos permitidos

• Import-LocalizedData
• ConvertFrom-StringData
• Write-Host
• Out-Host
• Join-Path

Variáveis permitidas

• $PSScriptRoot
• $PSEdition
• $EnabledExperimentalFeatures
• Quaisquer variáveis de ambiente, como $Env:TEMP

Para obter mais informações, consulte about_Language_Modes.

Configurações de manifesto

As seções a seguir detalham todas as configurações disponíveis em um manifesto de módulo e como você pode usá-las. Eles começam com uma sinopse do cenário e são seguidos por uma matriz que lista:

• Tipo de entrada: o tipo de objeto que você pode especificar para essa configuração no manifesto.
• Obrigatório: se esse valor for Yes, a configuração será necessária para importar o módulo e publicá-lo na Galeria do PowerShell. Se for No, não é necessário para nenhum dos dois. Se for PowerShell Gallery, ele só será necessário para publicar na Galeria do PowerShell.
• Valor se não definido: o valor que essa configuração tem quando importada e não definida explicitamente.
• Aceita curingas: se essa configuração pode assumir um valor curinga ou não.

Módulo raiz

Essa configuração especifica o arquivo primário ou raiz do módulo. Quando o módulo é importado, os membros exportados pelo arquivo do módulo raiz são importados para o estado de sessão do chamador.

O valor deve ser o caminho para um dos seguintes:

• um script (.ps1)
• um módulo de script (.psm1)
• um manifesto de módulo (.psd1)
• um assembly (.dll)
• um arquivo XML de definição de cmdlet (.cdxml)
• um fluxo de trabalho do Windows PowerShell 5.1 (.xaml)

O caminho deve ser relativo ao manifesto do módulo.

Se um manifesto de módulo não tiver nenhum arquivo raiz designado na chave RootModule , o manifesto se tornará o arquivo primário do módulo e o módulo se tornará um módulo de manifesto (ModuleType = Manifest). Quando RootModule é definido, o tipo do módulo é determinado a partir da extensão de arquivo usada:

• um .ps1 arquivo ou .psm1 faz com que o tipo de módulo Script
• um .psd1 arquivo faz com que o tipo de módulo Manifest
• um .dll arquivo torna o tipo de módulo Binário
• um .cdxml arquivo faz com que o módulo digite CIM
• um .xaml arquivo faz com que o tipo de módulo Fluxo de trabalho

Por padrão, todos os membros do módulo no RootModule são exportados.

Por exemplo, o ModuleType deste módulo é Manifest. Os únicos membros do módulo que esse módulo pode exportar são aqueles definidos nos módulos especificados com a configuração NestedModules .

@{
    RootModule = ''
}

Versão do módulo

Essa configuração especifica a versão do módulo. Quando existem várias versões de um módulo em um sistema, a versão mais recente é carregada por padrão quando você executa Import-Moduleo .

O valor dessa configuração deve ser conversível para System.Version quando você executa Import-Moduleo .

Por exemplo, esse manifesto declara a versão do módulo como '1.2.3'.

@{
    ModuleVersion = '1.2.3'
}

Ao importar o módulo e inspecionar a propriedade Version , observe que ele é um objeto System.Version e não uma cadeia de caracteres:

$ExampleModule = Import-Module example.psd1
$ExampleModule.Version
$ExampleModule.Version.GetType().Name

Major  Minor  Build  Revision
-----  -----  -----  --------
1      2      3      -1

Version

CompatiblePSEditions

Essa configuração especifica as PSEdições compatíveis do módulo.

Se o valor dessa configuração for $null, o módulo poderá ser importado independentemente do PSEdition da sessão. Você pode defini-lo como um ou mais dos valores aceitos.

Para obter informações sobre PSEdition, consulte:

• about_PowerShell_Editions
• Módulos com edições compatíveis do PowerShell.

Quando essa configuração é definida, o módulo só pode ser importado para uma sessão em que o $PSEdition valor da variável automática está incluído na configuração.

Por exemplo, você pode importar este manifesto de módulo em qualquer sessão:

@{
    # CompatiblePSEditions = @()
}

Com a configuração especificada, este módulo só pode ser importado em sessões em que o valor da $PSEdition variável automática é Core.

@{
    CompatiblePSEditions = @('Core')
}

GUID

Essa configuração especifica um identificador exclusivo para o módulo. O GUID é usado para distinguir entre módulos com o mesmo nome.

O valor dessa configuração deve ser conversível para System.Guid quando você executa Import-Moduleo .

Você pode criar um novo guid para usar em seu manifesto:

New-Guid | Select-Object -ExpandProperty Guid

8456b025-2fa5-4034-ae47-e6305f3917ca

@{
    GUID = '8456b025-2fa5-4034-ae47-e6305f3917ca'
}

Se houver outro módulo na máquina com o mesmo nome, você ainda poderá importar o que deseja especificando o nome totalmente qualificado do módulo:

Import-Module -FullyQualifiedName @{
    ModuleName    = 'Example'
    GUID          = '8456b025-2fa5-4034-ae47-e6305f3917ca'
    ModuleVersion = '1.0.0'
}

Autor

Essa configuração identifica o autor do módulo.

Esse manifesto declara que o autor do módulo é a Equipe de Experiência do Desenvolvedor da Contoso.

@{
    Author = 'Contoso Developer Experience Team'
}

CompanyName

Essa configuração identifica a empresa ou o fornecedor que criou o módulo.

Esse manifesto declara que o módulo foi criado pela Contoso, Ltd.

@{
    CompanyName = 'Contoso, Ltd.'
}

Direitos autorais

Essa configuração especifica uma declaração de direitos autorais para o módulo.

Este manifesto declara uma declaração de direitos autorais reservando todos os direitos à Contoso, Ltd. a partir de 2022.

@{
    Copyright = '(c) 2022 Contoso, Ltd. All rights reserved.'
}

Descrição

Essa configuração descreve o módulo em um alto nível.

Este manifesto inclui uma breve descrição. Você também pode usar uma cadeia de caracteres aqui para escrever uma descrição mais longa ou de várias linhas.

@{
    Description = 'Example commands to show a valid module manifest'
}

PowerShellVersion

Essa configuração especifica a versão mínima do PowerShell que esse módulo exige.

O valor dessa configuração deve ser conversível para System.Version quando você executa Import-Moduleo .

Se essa configuração não estiver definida, o PowerShell não restringirá a importação do módulo com base na versão atual.

Por exemplo, esse manifesto declara que o módulo é compatível com todas as versões do PowerShell e do Windows PowerShell.

@{
    # PowerShellVersion = ''
}

Com o PowerShellVersion definido como 7.2, você só pode importar o módulo no PowerShell 7.2 ou superior.

@{
    PowerShellVersion = '7.2'
}

Nome do host do PowerShell

Essa configuração especifica o nome do programa host do PowerShell que o módulo exige, como Windows PowerShell ISE Host ou ConsoleHost.

Você pode encontrar o nome do host de uma sessão com a $Host.Name instrução. Por exemplo, você pode ver que o host de uma sessão remota é ServerRemoteHost em vez de ConsoleHost:

$Host.Name
Enter-PSSession -ComputerName localhost
$Host.Name

ConsoleHost
[localhost]: PS C:\Users\username\Documents> $Host.Name
ServerRemoteHost

Este módulo pode ser importado para qualquer host.

@{
    # PowerShellHostName = ''
}

Com o PowerShellHostName definido como ServerRemoteHost, você só pode importar o módulo em uma sessão remota do PowerShell.

@{
    PowerShellHostName = 'ServerRemoteHost'
}

PowerShellHostVersion

Essa configuração especifica a versão mínima de um programa host do PowerShell que o módulo exige.

O valor dessa configuração deve ser conversível para System.Version quando você executa Import-Moduleo .

Por exemplo, o módulo desse manifesto pode ser importado de qualquer sessão do PowerShell em execução no ConsoleHost, independentemente da versão do host.

@{
    PowerShellHostName = 'ConsoleHost'
    # PowerShellHostVersion = ''
}

Com o PowerShellHostVersion definido como 5.1, você só pode importar o módulo de qualquer sessão do PowerShell em execução no ConsoleHost em que a versão do host seja 5.1 ou superior.

@{
    PowerShellHostName    = 'ConsoleHost'
    PowerShellHostVersion = '5.1'
}

DotNetFrameworkVersion

Essa configuração especifica a versão mínima do Microsoft .NET Framework que o módulo exige.

O valor dessa configuração deve ser conversível para System.Version quando você executa Import-Moduleo .

Por exemplo, esse manifesto declara que seu módulo pode ser importado em qualquer sessão do PowerShell ou do Windows PowerShell, independentemente da versão do Microsoft .NET Framework.

@{
    # DotNetFrameworkVersion = ''
}

Com DotNetFrameworkVersion definido como 4.0, você pode importar esse módulo em qualquer sessão do Windows PowerShell em que a versão mais recente disponível do Microsoft .NET Framework seja pelo menos 4.0. Você também pode importá-lo em qualquer sessão do PowerShell.

@{
    DotNetFrameworkVersion = '4.0'
}

CLRVersion

Essa configuração especifica a versão mínima do CLR (Common Language Runtime) do Microsoft .NET Framework que o módulo exige.

O valor dessa configuração deve ser conversível para System.Version quando você executa Import-Moduleo .

Por exemplo, esse manifesto declara que seu módulo pode ser importado em qualquer sessão do PowerShell ou do Windows PowerShell, independentemente da versão do CLR do Microsoft .NET Framework.

@{
    # CLRVersion = ''
}

Com o CLRVersion definido como 4.0, você pode importar esse módulo em qualquer sessão do Windows PowerShell em que a versão mais recente disponível do CLR seja pelo menos 4.0. Você também pode importá-lo em qualquer sessão do PowerShell.

@{
    CLRVersion = '4.0'
}

ProcessorArchitecture

Essa configuração especifica a arquitetura do processador que o módulo requer.

O valor dessa configuração deve ser conversível para System.Reflection.ProcessorArchitecture quando você executa Import-Moduleo .

Por exemplo, esse manifesto declara que seu módulo pode ser importado em qualquer sessão, independentemente da arquitetura do processador do sistema.

@{
    # ProcessorArchitecture = ''
}

Com ProcessorArchitecture definido como Amd64, você só pode importar esse módulo em uma sessão em execução em uma máquina com uma arquitetura correspondente.

@{
    ProcessorArchitecture = 'Amd64'
}

Módulos necessários

Essa configuração especifica os módulos que devem estar no estado de sessão global. Se os módulos necessários não estiverem no estado de sessão global, o PowerShell os importará. Se os módulos necessários não estiverem disponíveis, o Import-Module comando falhará.

As entradas para essa configuração podem ser um nome de módulo, uma especificação completa do módulo ou um caminho para um arquivo de módulo.

Quando o valor é um caminho, o caminho pode ser totalmente qualificado ou relativo.

Quando o valor é um nome ou especificação de módulo, o PowerShell pesquisa o PSModulePath para o módulo especificado.

Uma especificação de módulo é uma tabela de hash que tem as chaves a seguir.

• ModuleName - Obrigatório. Especifica o nome do módulo.
• GUID - Opcional. Especifica o GUID do módulo.
• Também é necessário especificar pelo menos uma das três chaves abaixo. A RequiredVersion chave não pode ser usada com as ModuleVersion teclas ou MaximumVersion . Você pode definir um intervalo de versão aceitável para o módulo especificando as ModuleVersion chaves e MaximumVersion juntas.
  • ModuleVersion - Especifica uma versão mínima aceitável do módulo.
  • RequiredVersion - Especifica uma versão exata e necessária do módulo.
  • MaximumVersion - Especifica a versão máxima aceitável do módulo.

Por exemplo, esse manifesto declara que seu módulo não requer nenhum outro módulo para sua funcionalidade.

@{
    # RequiredModules = @()
}

Esse manifesto declara que requer o módulo PSReadLine. Quando você executa Import-Module nesse manifesto, o PowerShell importa a versão mais recente do PSReadLine disponível para a sessão. Se nenhuma versão estiver disponível, a importação retornará um erro.

@{
    RequiredModules = @(
        'PSReadLine'
    )
}

Esse manifesto declara que requer uma versão do módulo PSReadLine vendida em sua própria pasta de módulo. Quando você executa Import-Module nesse manifesto, o PowerShell importa o PSReadLine fornecido do caminho especificado.

@{
    RequiredModules = @(
        'Vendored\PSReadLine\PSReadLine.psd1'
    )
}

Esse manifesto declara que ele requer especificamente a versão 2.0.0 do módulo PSReadLine. Quando você executa Import-Module nesse manifesto, o PowerShell importa a versão 2.0.0 do PSReadLine se ela estiver disponível. Se não estiver disponível, Import-Module retornará um erro.

@{
    RequiredModules = @(
        @{
            ModuleName      = 'PSReadLine'
            RequiredVersion = '2.0.0'
        }
    )
}

Esse manifesto declara que requer que o módulo PSReadLine seja importado na versão 2.0.0 ou superior.

@{
    RequiredModules = @(
        @{
            ModuleName    = 'PSReadLine'
            ModuleVersion = '2.0.0'
        }
    )
}

Esse manifesto declara que requer que o módulo PSReadLine seja importado na versão 2.0.0 ou inferior.

@{
    RequiredModules = @(
        @{
            ModuleName     = 'PSReadLine'
            MaximumVersion = '2.0.0'
        }
    )
}

Esse manifesto declara que requer que o módulo PSDesiredStateConfiguration seja importado em uma versão igual ou superior a 2.0.0, mas não superior a 2.99.99.

@{
    RequiredModules = @(
        @{
            ModuleName     = 'PSDesiredStateConfiguration'
            ModuleVersion  = '2.0.0'
            MaximumVersion = '2.99.99'
        }
    )
}

Assemblies necessários

Essa configuração especifica os arquivos de assembly (.dll) que o módulo requer. O PowerShell carrega os assemblies especificados antes de atualizar tipos ou formatos, importar módulos aninhados ou importar o arquivo de módulo especificado no valor da chave RootModule .

As entradas para essa configuração podem ser o nome de arquivo de um assembly ou o caminho para um. Liste todos os assemblies necessários, mesmo que eles também estejam listados como módulos binários na configuração NestedModules .

Esse manifesto requer o example.dll assembly. Antes de carregar qualquer arquivo de formatação ou tipo especificado neste manifesto, o PowerShell é carregado example.dll da Assemblies pasta localizada no mesmo diretório que o manifesto do módulo.

@{
    RequiredAssemblies = @(
        'Assemblies\Example.dll'
    )
}

ScriptsToProcess

Essa configuração especifica arquivos de script (.ps1) que são executados no estado de sessão do chamador quando o módulo é importado. Você pode usar esses scripts para preparar um ambiente, assim como você pode usar um script de logon.

Para especificar scripts que são executados no estado de sessão do módulo, use a chave NestedModules .

Quando você importa esse manifesto, o PowerShell executa o Initialize.ps1 em sua sessão atual.

@{
    ScriptsToProcess = @(
        'Scripts\Initialize.ps1'
    )
}

Por exemplo, se Initialize.ps1 escreve mensagens informativas e define a $ExampleState variável:

if ([string]::IsNullOrEmpty($ExampleState)) {
    Write-Information "Example not initialized."
    Write-Information "Initializing now..."
    $ExampleState = 'Initialized'
} else {
    Write-Information "Example already initialized."
}

Quando você importa o módulo, o script é executado, gravando essas mensagens e configurando $ExampleState em sua sessão.

$InformationPreference = 'Continue'
"Example State is: $ExampleState"
Import-Module .\example7x.psd1
"Example State is: $ExampleState"
Import-Module .\example7x.psd1 -Force

Example State is:

Example not initialized.
Initializing now...

Example State is: Initialized

Example already initialized.

TypesToProcess

Essa configuração especifica os arquivos de tipo (.ps1xml) que são executados quando o módulo é importado.

Quando você importa o módulo, o PowerShell executa o Update-TypeData cmdlet com os arquivos especificados. Como os arquivos de tipo não têm escopo, eles afetam todos os estados de sessão na sessão.

Para obter mais informações sobre arquivos de tipo, consulte about_Types.ps1xml

Por exemplo, quando você importa esse manifesto Example.ps1xml , o PowerShell carrega os tipos especificados no arquivo da Types pasta localizada no mesmo diretório que o manifesto do módulo.

@{
    TypesToProcess = @(
        'Types\Example.ps1xml'
    )
}

FormatsToProcess

Essa configuração especifica os arquivos de formatação (.ps1xml) que são executados quando o módulo é importado.

Quando você importa um módulo, o PowerShell executa o Update-FormatData cmdlet com os arquivos especificados. Como os arquivos de formatação não têm escopo, eles afetam todos os estados da sessão na sessão.

Para obter mais informações sobre arquivos de tipo, consulte about_Format.ps1xml

Por exemplo, quando você importa esse módulo, o Example.ps1xml PowerShell carrega os formatos especificados no arquivo da Formats pasta localizada no mesmo diretório que o manifesto do módulo.

@{
    FormatsToProcess = @(
        'Formats\Example.ps1xml'
    )
}

Módulos Aninhados

Essa configuração especifica módulos de script (.psm1) e módulos binários (.dll) que são importados para o estado de sessão do módulo. Você também pode especificar arquivos de script (.ps1). Os arquivos nessa configuração são executados na ordem em que estão listados.

As entradas para essa configuração podem ser um nome de módulo, uma especificação completa do módulo ou um caminho para um módulo ou arquivo de script.

Quando o valor é um caminho, o caminho pode ser totalmente qualificado ou relativo.

Quando o valor é um nome de módulo ou especificação, o PowerShell pesquisa o PSModulePath para o módulo especificado.

Uma especificação de módulo é uma tabela de hash que tem as chaves a seguir.

• ModuleName - Obrigatório. Especifica o nome do módulo.
• GUID - Opcional. Especifica o GUID do módulo.
• Também é necessário especificar pelo menos uma das três chaves abaixo. A RequiredVersion chave não pode ser usada com as ModuleVersion teclas ou MaximumVersion . Você pode definir um intervalo de versão aceitável para o módulo especificando as ModuleVersion chaves e MaximumVersion juntas.
  • ModuleVersion - Especifica uma versão mínima aceitável do módulo.
  • RequiredVersion - Especifica uma versão exata e necessária do módulo.
  • MaximumVersion - Especifica a versão máxima aceitável do módulo.

Todos os itens que precisam ser exportados de um módulo aninhado devem ser exportados pelo módulo aninhado usando o Export-ModuleMember cmdlet ou ser listados em uma das propriedades de exportação:

• FunçõesParaExportar
• CmdletsToExport
• VariáveisParaExportar
• AliasesToExport

Os módulos aninhados no estado de sessão do módulo estão disponíveis para o módulo raiz, mas não são retornados por um Get-Module comando no estado de sessão do chamador.

Os scripts (.ps1) listados nessa configuração são executados no estado de sessão do módulo, não no estado de sessão do chamador. Para executar um script no estado de sessão do chamador, liste o nome do arquivo de script na configuração ScriptsToProcess .

Por exemplo, quando você importa esse manifesto, o Helpers.psm1 módulo é carregado no estado de sessão do módulo raiz. Todos os cmdlets declarados no módulo aninhado são exportados, a menos que sejam restritos de outra forma.

@{
    NestedModules = @(
        'Helpers\Helpers.psm1'
    )
}

FunçõesParaExportar

Essa configuração especifica as funções que o módulo exporta. Você pode usar essa configuração para restringir as funções que são exportadas pelo módulo. Ele pode remover funções da lista de funções exportadas, mas não pode adicionar funções à lista.

Você pode especificar entradas nessa configuração com curingas. Todas as funções correspondentes na lista de funções exportadas são exportadas.

Por exemplo, quando você importa um módulo com a configuração comentada, todas as funções no módulo raiz e todos os módulos aninhados são exportados.

@{
    # FunctionsToExport = @()
}

Esse manifesto é funcionalmente idêntico a não especificar a configuração.

@{
    FunctionsToExport = '*'
}

Com FunctionsToExport definido como uma matriz vazia, quando você importa esse módulo, nenhuma função do módulo raiz ou qualquer exportação de módulos aninhados está disponível.

@{
    FunctionsToExport = @()
}

Com FunctionsToExport definido para incluir apenas a Get-Example função, quando você importa esse módulo, somente a Get-Example função é disponibilizada, mesmo que outras funções tenham sido exportadas pelo módulo raiz ou por qualquer módulo aninhado.

@{
    FunctionsToExport = @(
        'Get-Example'
    )
}

Com FunctionsToExport definido com uma cadeia de caracteres curinga, quando você importa esse módulo, qualquer função cujo nome termina com Example é disponibilizada, mesmo que outras funções tenham sido exportadas como membros do módulo pelo módulo raiz ou por qualquer módulo aninhado.

@{
    FunctionsToExport = @(
        '*Example'
    )
}

CmdletsToExport

Essa configuração especifica os cmdlets que o módulo exporta. Você pode usar essa configuração para restringir os cmdlets exportados pelo módulo. Ele pode remover cmdlets da lista de membros do módulo exportados, mas não pode adicionar cmdlets à lista.

Você pode especificar entradas nessa configuração com curingas. Todos os cmdlets correspondentes na lista de cmdlets exportados são exportados.

Por exemplo, quando você importa um módulo com essa configuração comentada, todos os cmdlets no módulo raiz e todos os módulos aninhados são exportados.

@{
    # CmdletsToExport = @()
}

Esse manifesto é funcionalmente idêntico a não especificar a configuração.

@{
    CmdletsToExport = '*'
}

Com CmdletsToExport definido como uma matriz vazia, quando você importa esse módulo, nenhum cmdlet, o módulo raiz ou qualquer exportação de módulos aninhados está disponível.

@{
    CmdletsToExport = @()
}

Com CmdletsToExport definido para incluir apenas o Get-Example cmdlet, quando você importa esse módulo, somente o Get-Example cmdlet é disponibilizado, mesmo que outros cmdlets tenham sido exportados pelo módulo raiz ou por qualquer módulo aninhado.

@{
    CmdletsToExport = @(
        'Get-Example'
    )
}

Com CmdletsToExport definido com uma cadeia de caracteres curinga, quando você importa esse módulo, qualquer cmdlet cujo nome termina com Example é disponibilizado, mesmo que outros cmdlets tenham sido exportados como membros do módulo pelo módulo raiz ou por qualquer módulo aninhado.

@{
    CmdletsToExport = @(
        '*Example'
    )
}

VariáveisParaExportar

Essa configuração especifica as variáveis que o módulo exporta. Você pode usar essa configuração para restringir as variáveis que são exportadas pelo módulo. Ele pode remover variáveis da lista de membros do módulo exportados, mas não pode adicionar variáveis à lista.

Você pode especificar entradas nessa configuração com curingas. Todas as variáveis correspondentes na lista de membros do módulo exportados são exportadas.

Por exemplo, quando você importa um módulo com essa configuração comentada, todas as variáveis no módulo raiz e todos os módulos aninhados são exportados.

@{
    # VariablesToExport = @()
}

Esse manifesto é funcionalmente idêntico a não especificar a configuração.

@{
    VariablesToExport = '*'
}

Com VariablesToExport definido como uma matriz vazia, quando você importa esse módulo, nenhuma variável do módulo raiz ou qualquer exportação de módulos aninhados está disponível.

@{
    VariablesToExport = @()
}

Com VariablesToExport definido para incluir apenas a SomeExample variável, quando você importa esse módulo, somente a $SomeExample variável é disponibilizada, mesmo que outras variáveis tenham sido exportadas pelo módulo raiz ou por qualquer módulo aninhado.

@{
    VariablesToExport = @(
        'SomeExample'
    )
}

Com VariablesToExport definido com uma cadeia de caracteres curinga, quando você importa esse módulo, qualquer variável cujo nome termina com Example é disponibilizada, mesmo que outras variáveis tenham sido exportadas como membros do módulo raiz ou por qualquer módulo aninhado.

@{
    VariablesToExport = @(
        '*Example'
    )
}

DscResourcesToExport

Essa configuração especifica os recursos de DSC que o módulo exporta. Você pode usar essa configuração para restringir os recursos de DSC baseados em classe que são exportados pelo módulo. Ele pode remover recursos de DSC da lista de membros de módulo exportados, mas não pode adicionar recursos de DSC à lista.

Você pode especificar entradas nessa configuração com curingas. Todos os recursos de DSC baseados em classe correspondentes no módulo são exportados.

Para obter mais informações sobre como criar e usar recursos de DSC, consulte a documentação do DSC.

Esse manifesto exporta todos os recursos de DSC baseados em classe e MOF definidos no módulo raiz e em todos os módulos aninhados.

@{
    # DscResourcesToExport = @()
}

Esse manifesto exporta todos os recursos de DSC baseados em MOF definidos no módulo raiz e todos os módulos aninhados, mas apenas um recurso de DSC baseado em classe, ExampleClassResource.

@{
    DscResourcesToExport = @(
        'ExampleClassResource'
    )
}

Esse manifesto exporta todos os recursos de DSC que ele inclui. Mesmo que o recurso baseado em MOF não estivesse listado, o módulo ainda o exportaria.

@{
    DscResourcesToExport = @(
        'ExampleClassResource'
        'ExampleMofResourceFirst'
    )
}

Lista de módulos

Essa configuração é uma lista de inventário informativa dos módulos incluídos nesta. Essa lista não afeta o comportamento do módulo.

As entradas para essa configuração podem ser um nome de módulo, uma especificação completa do módulo ou um caminho para um módulo ou arquivo de script.

Quando o valor é um caminho, o caminho pode ser totalmente qualificado ou relativo.

Quando o valor é um nome de módulo ou especificação, o PowerShell pesquisa o PSModulePath para o módulo especificado.

Uma especificação de módulo é uma tabela de hash que tem as chaves a seguir.

• ModuleName - Obrigatório. Especifica o nome do módulo.
• GUID - Opcional. Especifica o GUID do módulo.
• Também é necessário especificar pelo menos uma das três chaves abaixo. A RequiredVersion chave não pode ser usada com as ModuleVersion teclas ou MaximumVersion . Você pode definir um intervalo de versão aceitável para o módulo especificando as ModuleVersion chaves e MaximumVersion juntas.
  • ModuleVersion - Especifica uma versão mínima aceitável do módulo.
  • RequiredVersion - Especifica uma versão exata e necessária do módulo.
  • MaximumVersion - Especifica a versão máxima aceitável do módulo.

Esse manifesto não fornece uma lista informativa dos módulos que ele inclui. Pode ou não ter módulos. Mesmo que essa configuração não seja especificada, todos os módulos listados nas configurações de RootModule, ScriptsToProcess ou NestedModules ainda se comportam normalmente.

@{
    # ModuleList = @()
}

Esse manifesto declara que os únicos módulos incluídos são Example.psm1 os submódulos First.psm1 e Second.psm1 na Submodules pasta.

@{
    ModuleList = @(
        'Example.psm1'
        'Submodules\First.psm1'
        'Submodules\Second.psm1'
    )
}

FileList

Essa configuração é uma lista de inventário informativa dos arquivos incluídos neste módulo. Essa lista não afeta o comportamento do módulo.

As entradas para essa configuração devem ser o caminho relativo para um arquivo da pasta que contém o manifesto do módulo.

Quando um usuário chama Get-Module um manifesto com essa configuração definida, a propriedade FileList contém o caminho completo para esses arquivos, unindo o caminho do módulo ao caminho relativo de cada entrada.

Esse manifesto não inclui uma lista de seus arquivos.

@{
    # FileList = @()
}

Esse manifesto declara que os únicos arquivos incluídos estão listados nessa configuração.

@{
    FileList = @(
        'Example.psd1'
        'Example.psm1'
        'Assemblies\Example.dll'
        'Scripts\Initialize.ps1'
        'Submodules\First.psm1'
        'Submodules\Second.psm1'
    )
}

Dados Privados

Essa configuração define uma tabela de hash de dados que está disponível para qualquer comando ou função no escopo do módulo raiz.

Quando você exporta um manifesto do Crescendo para criar um novo módulo, o adiciona Export-CrescendoModule duas chaves a PrivateData

• CrescendoGenerated - carimbo de data/hora em que o módulo foi exportado
• CrescendoVersion - a versão do Crescendo usada para exportar o módulo

Você pode adicionar suas próprias chaves para armazenar metadados que deseja rastrear. Todas as chaves adicionadas a essa configuração estão disponíveis para funções e cmdlets no módulo raiz usando $MyInvocation.MyCommand.Module.PrivateData. A tabela de hash não está disponível no escopo do módulo em si, apenas nos cmdlets que você define no módulo.

Por exemplo, esse manifesto define a chave PublishedDate em PrivateData.

@{
    PrivateData = @{
        PublishedDate = '2022-06-01'
    }
}

Os cmdlets no módulo podem acessar esse valor com a $MyInvocation variável.

function Get-Stale {
    [CmdletBinding()]
    param()

    $PublishedDate = $MyInvocation.MyCommand.Module.PrivateData.PublishedDate
    $CurrentDate = Get-Date

    try {
        $PublishedDate = Get-Date -Date $PublishedDate -ErrorAction Stop
    } catch {
        # The date was set in the manifest, set to an invalid value, or
        # the script module was directly imported without the manifest.
        throw "Unable to determine published date. Check the module manifest."
    }

    if ($CurrentDate -gt $PublishedDate.AddDays(30)) {
        Write-Warning "This module version was published more than 30 days ago."
    } else {
        $TimeUntilStale = $PublishedDate.AddDays(30) - $CurrentDate
        "This module will be stale in $($TimeUntilStale.Days) days"
    }
}

Depois que o módulo é importado, a função usa o valor de PrivateData para determinar quando o módulo foi publicado.

Get-Stale -TestDate '2022-06-15'
Get-Stale -TestDate '2022-08-01'

This module will be stale in 16 days

WARNING: This module version was published more than 30 days ago.

PrivateData.PSData

A propriedade filho PSData define uma tabela de hash de valores que dão suporte a cenários de extensão específicos.

A propriedade filho PSData é usada para os seguintes cenários:

• Galeria do PowerShell – quando você cria um manifesto de módulo usando New-ModuleManifest o cmdlet pré-popula o hash PSData com chaves de espaço reservado necessárias ao publicar o módulo na Galeria do PowerShell. Para obter mais informações sobre manifestos de módulo e a publicação na Galeria do PowerShell, consulte Valores de manifesto do pacote que afetam a interface do usuário da Galeria do PowerShell.
• Recursos experimentais – os metadados sobre um recurso experimental são mantidos na propriedade ExperimentalFeatures do PSData. A propriedade ExperimentalFeatures é uma matriz de tabelas de hash que contém o nome e a descrição do recurso. Para obter mais informações, consulte Declarando recursos experimentais em módulos.
• Módulos Crescendo – quando você exporta um manifesto Crescendo para criar um novo módulo, Export-CrescendoModule adiciona o valor CrescendoBuilt à propriedade PSData.Tags. Você pode usar essa marca para localizar módulos na Galeria do PowerShell que foram criados usando o Crescendo. Para obter mais informações, consulte Export-CrescendoModule.
• A propriedade PSData.ExternalModuleDependencies é uma matriz de nomes de módulo que são dependências para este módulo. Essa propriedade é somente informativa e não afeta a instalação ou o carregamento do módulo.

AjudaInfoURI

Essa configuração especifica o endereço da Internet do arquivo XML HelpInfo para o módulo.

O valor dessa configuração deve ser um URI (Uniform Resource Identifier) que começa com http ou https.

O arquivo XML HelpInfo dá suporte ao recurso Ajuda atualizável que foi introduzido no PowerShell 3.0. Ele contém informações sobre o local dos arquivos de ajuda que podem ser baixados para o módulo e os números de versão dos arquivos de ajuda mais recentes para cada localidade com suporte.

Para obter informações sobre a Ajuda atualizável, consulte about_Updatable_Help. Para obter informações sobre o arquivo XML HelpInfo, consulte Suporte à Ajuda atualizável.

Por exemplo, este módulo suporta ajuda atualizável.

@{
    HelpInfoUri = 'http://https://go.microsoft.com/fwlink/?LinkID=603'
}

Prefixo de comando padrão

Essa configuração especifica um prefixo que é anexado aos substantivos de todos os comandos no módulo quando eles são importados para uma sessão. Os prefixos ajudam a evitar conflitos de nome de comando na sessão de um usuário.

Os usuários do módulo podem substituir esse prefixo especificando o parâmetro Prefix do Import-Module cmdlet.

Essa configuração foi introduzida no PowerShell 3.0.

Quando esse manifesto é importado, todos os cmdlets importados desse módulo são Example anexados ao substantivo em seu nome. Por exemplo, Get-Item é importado como Get-ExampleItem.

@{
    DefaultCommandPrefix = 'Example'
}

Consulte também

• about_PowerShell_Editions
• New-ModuleManifest
• Test-ModuleManifest
• Módulos com edições compatíveis do PowerShell
• Valores de manifesto do pacote que afetam a interface do usuário da Galeria do PowerShell
• Considerações sobre a criação de módulos do PowerShell