about_Modules

Artigo
03/19/2024

Breve descrição

Explica como instalar, importar e usar módulos do PowerShell.

Descrição longa

O PowerShell é uma linguagem de script e um shell de comando. A linguagem é composta por palavras-chave, que fornecem a estrutura e a lógica de processamento, e comandos que executam o trabalho. Os comandos no PowerShell são implementados como scripts, funções ou cmdlets.

Um módulo é uma unidade reutilizável independente que pode conter cmdlets, provedores, funções, variáveis e outros tipos de recursos que podem ser importados como uma única unidade.

O PowerShell vem com um conjunto básico de módulos. Você também pode instalar mais módulos conforme necessário. Por padrão, os módulos instalados são carregados automaticamente na primeira vez que você usa um comando de um módulo. Use a variável para ativar, desativar e configurar o $PSModuleAutoloadingPreference carregamento automático de módulos. Para obter mais informações, consulte about_Preference_Variables.

Você pode descarregar ou recarregar durante uma sessão. Use o Remove-Module cmdlet para descarregar um módulo da sessão. Use o Import-Module cmdlet para carregar um módulo.

Os módulos podem ser criados como assemblies .NET compilados escritos em C# ou módulos baseados em script escritos em PowerShell. Este tópico explica como usar módulos do PowerShell. Para obter informações sobre como escrever módulos do PowerShell, consulte Escrevendo um módulo do PowerShell.

Nota

Antes do PowerShell 3.0, cmdlets e provedores eram empacotados em snap-ins do PowerShell. A partir do PowerShell 3.0, o snap-in Microsoft.PowerShell.Core é adicionado a todas as sessões por padrão. Este é o único snap-in restante no PowerShell. Todos os outros snap-ins foram convertidos em módulos. A criação de novos snap-ins não é mais suportada.

Instalar um módulo publicado

Um módulo publicado é um módulo que está disponível em um repositório registrado, como a Galeria do PowerShell. Os módulos PowerShellGet e Microsoft.PowerShell.PSResourceGet fornecem cmdlets para localizar, instalar e publicar módulos do PowerShell em um repositório registrado.

O módulo PowerShellGet está incluído no PowerShell 5.0 e versões posteriores. O módulo Microsoft.PowerShell.PSResourceGet está incluído no PowerShell 7.4 e versões posteriores. Microsoft.PowerShell.PSResourceGet é o novo gerenciador de pacotes preferido para PowerShell e pode ser instalado em versões anteriores do PowerShell. Use o Install-Module cmdlet ou Install-PSResource para instalar módulos da Galeria do PowerShell.

 Get-Command Install-Module, Install-PSResource

CommandType  Name                Version    Source
-----------  ----                -------    ------
Function     Install-Module      2.9.0      PowerShellGet
Cmdlet       Install-PSResource  1.0.0      Microsoft.PowerShell.PSResourceGet

Para obter mais informações, consulte Visão geral do PowerShellGet.

Instalar manualmente um módulo

Se você receber um módulo como uma pasta com arquivos nele, precisará instalá-lo em seu computador antes de poder usá-lo no PowerShell.

O PowerShell vem com vários módulos pré-instalados. Em computadores baseados no Windows, muitos recursos do Windows incluem módulos para gerenciar o recurso. Esses módulos são instalados quando o recurso é instalado. Outros módulos podem vir em um instalador ou programa de instalação que instala o módulo.

Por padrão, a Modules pasta para o usuário atual não existe. Se você instalou um módulo no CurrentUser escopo usando Install-Module ou Install-PSResource, esses cmdlets criarão a Modules pasta para o usuário atual. Se a pasta não existir, você poderá criá-la manualmente.

Use o seguinte comando para criar uma Modules pasta para o usuário atual:

$folder = New-Item -Type Directory -Path $HOME\Documents\PowerShell\Modules

Copie toda a pasta do módulo para a nova pasta criada. No PowerShell, use o Copy-Item cmdlet. Por exemplo, execute o seguinte comando para copiar a MyModule pasta de para a pasta que você acabou de C:\PSTest criar:

Copy-Item -Path C:\PSTest\MyModule -Destination $folder

Você pode instalar um módulo em qualquer local, mas instalar seus módulos em um local de módulo padrão os torna mais fáceis de gerenciar. Para obter mais informações sobre os locais de módulo padrão, consulte about_PSModulePath.

Carregamento automático do módulo

Na primeira vez que você executa um comando de um módulo instalado, o PowerShell importa automaticamente (carrega) esse módulo. O módulo deve ser armazenado nos locais especificados na $env:PSModulePath variável de ambiente. Os módulos em outros locais devem ser importados usando o Import-Module cmdlet.

O carregamento automático do módulo permite que você use comandos em um módulo sem qualquer configuração de configuração ou perfil. Não há necessidade de gerenciar módulos depois de instalá-los no seu computador.

Cada um dos exemplos a seguir faz com que o módulo CimCmdlets , que contém Get-CimInstance, seja importado para sua sessão.

Execute o comando
```
Get-CimInstance Win32_OperatingSystem
```
Obter o comando
```
Get-Command Get-CimInstance
```
Obter ajuda para o comando
```
Get-Help Get-CimInstance
```

Você pode usar o Get-Command cmdlet listar os comandos em todos os módulos instalados, mesmo que eles ainda não estejam na sessão. Quando você usa Get-Command com um caractere curinga (*), o PowerShell não importa nenhum módulo. Você pode usar curingas para descoberta de comandos sem carregar módulos que talvez não sejam necessários em sua sessão.

Além disso, os comandos que usam provedores do PowerShell não importam automaticamente um módulo. Por exemplo, se você usar um comando que exija a WSMan: unidade, como o Get-PSSessionConfiguration cmdlet, talvez seja necessário executar o Import-Module cmdlet para importar o módulo Microsoft.WSMan.Management que inclui a WSMan: unidade.

Importar manualmente um módulo

A importação manual de um módulo é necessária quando um módulo não está instalado nos locais especificados pela variável de $env:PSModulePath ambiente ou quando o módulo é fornecido como um arquivo ou .dll.psm1 autônomo, em vez de um módulo empacotado.

Você também pode querer alterar a forma como o módulo é importado em sua sessão. Por exemplo, o parâmetro Prefix de Import-Module adiciona um prefixo distinto à parte nominal dos cmdlets importados do módulo. O parâmetro NoClobber impede que o módulo adicione comandos que ocultariam ou substituiriam comandos existentes na sessão. Para obter mais informações, consulte Gerenciar conflitos de nome.

Você pode importar um módulo instalado no seu $env:PSModulePath especificando o nome do módulo. Por exemplo, o comando a seguir importa o módulo BitsTransfer para a sessão atual.

Import-Module BitsTransfer

Para importar um módulo que não esteja no seu $env:PSModulePath, use o caminho totalmente qualificado para a pasta do módulo. Por exemplo, para adicionar o módulo TestCmdlets no C:\ps-test diretório à sua sessão, digite:

Import-Module C:\ps-test\TestCmdlets

Para importar um arquivo de módulo que não esteja contido em uma pasta de módulo, use o caminho totalmente qualificado para o arquivo de módulo no comando. Por exemplo, para adicionar o módulo TestCmdlets.dll no diretório à C:\ps-test sua sessão, digite:

Import-Module C:\ps-test\TestCmdlets.dll

Para obter mais informações sobre como adicionar módulos à sua sessão, consulte Import-Module.

Importar um módulo no início de cada sessão

O Import-Module comando importa módulos para sua sessão atual do PowerShell. Para importar um módulo para cada sessão do PowerShell que você iniciar, adicione o Import-Module comando ao seu perfil do PowerShell.

Para obter mais informações sobre perfis, consulte about_Profiles.

Localizar módulos instalados

O Get-Module cmdlet obtém os módulos do PowerShell que foram importados em sua sessão.

Get-Module

Os módulos listados podem incluir módulos que foram importados de qualquer local, não apenas do $env:PSModulePath.

Use o seguinte comando para listar os $env:PSModulePathmódulos instalados no :

Get-Module -ListAvailable

Este comando obtém todos os módulos instalados no $env:PSModulePath, não apenas os módulos importados para a sessão atual. Este comando não lista módulos instalados em outros locais.

Para obter mais informações, consulte Get-Module.

Listar os comandos em um módulo

Use o Get-Command cmdlet para localizar todos os comandos disponíveis. Você pode usar os parâmetros do Get-Command cmdlet para filtrar comandos como por módulo, nome e substantivo.

Para localizar todos os comandos em um módulo, digite:

Get-Command -Module <module-name>

Por exemplo, para localizar os comandos no módulo BitsTransfer , digite:

Get-Command -Module BitsTransfer

Para obter mais informações sobre o Get-Command cmdlet, consulte Get-Command.

Remover um módulo

Quando você remove um módulo, os comandos que o módulo adicionou são excluídos da sessão. Por exemplo, o comando a seguir remove o módulo BitsTransfer da sessão atual.

Remove-Module BitsTransfer

A remoção de um módulo reverte a operação de importação de um módulo. A remoção de um módulo não o desinstala. Para obter mais informações, consulte Remove-Module.

Os comandos podem ser adicionados à sua sessão a partir de módulos e snap-ins. Os módulos podem adicionar todos os tipos de comandos, incluindo cmdlets, provedores e funções, e itens, como variáveis, aliases e unidades do PowerShell. Os snap-ins podem adicionar apenas cmdlets e provedores.

Antes de remover um módulo da sessão, use os seguintes comandos para determinar qual módulo você deseja remover.

Por exemplo, use o seguinte comando para localizar a origem dos Get-Date cmdlets e Get-Help :

Get-Command Get-Date, Get-Help -All |
    Select-Object -Property Name, CommandType, Module ,PSSnapIn

A saída a seguir mostra que o Get-Help cmdlet está no snap-in Microsoft.PowerShell.Core . Este snap-in não pode ser removido da sessão.

Name     CommandType Module                       PSSnapIn
----     ----------- ------                       --------
Get-Date    Function
Get-Date      Cmdlet Microsoft.PowerShell.Utility
Get-Help      Cmdlet                              Microsoft.PowerShell.Core

Existem duas fontes para Get-Date. Um é uma função e o outro é um cmdlet no módulo Microsoft.PowerShell.Utility . Você pode remover o módulo usando Remove-Module. Para remover a função, você pode excluí-lo da Function: unidade.

Remove-Item Function:Get-Date

Para obter mais informações sobre a Function: unidade, consulte about_Function_Provider.

Gerenciar conflitos de nomes

Os conflitos de nome ocorrem quando mais de um comando na sessão tem o mesmo nome. A importação de um módulo causa um conflito de nomes quando os comandos no módulo têm os mesmos nomes que os comandos ou itens na sessão.

Import-Module pode adicionar comandos que ocultam e substituem comandos na sessão atual. Os conflitos de nomes podem resultar em comandos ocultos ou substituídos. A substituição de comandos ocorre quando o módulo importado contém um comando com o mesmo nome de um comando existente na sessão. O comando recém-importado substitui tem precedência sobre o comando existente.

Por exemplo, quando uma sessão inclui uma função e um cmdlet com o mesmo nome, o PowerShell executa a função por padrão. Quando a sessão inclui comandos do mesmo tipo com o mesmo nome, como dois cmdlets com o mesmo nome, por padrão, ela executa o comando adicionado mais recentemente.

Para obter mais informações, incluindo uma explicação das regras de precedência e instruções para executar comandos ocultos, consulte about_Command_Precedence.

Você pode executar um comando que foi oculto ou substituído qualificando o nome do comando. Para qualificar o nome do comando, adicione o nome do módulo que contém a versão do comando desejada. Por exemplo:

Microsoft.PowerShell.Utility\Get-Date

A execução Get-Date com o prefixo do nome do módulo garante que estão executando a versão do módulo Microsoft.PowerShell.Utility .

Para detetar conflitos de nome, use o Get-Command parâmetro All do cmdlet. Por padrão, Get-Command obtém apenas os comandos que são executados quando você digita o nome do comando. O parâmetro All obtém todos os comandos com o nome específico na sessão.

Para evitar conflitos de nome, use os parâmetros NoClobber ou Prefix do Import-Module cmdlet. O parâmetro Prefix adiciona um prefixo aos nomes dos comandos importados para que eles sejam exclusivos na sessão. O parâmetro NoClobber não importa nenhum comando que oculte ou substitua comandos existentes na sessão.

Você também pode usar os parâmetros Alias, Cmdlet, Function e Variable para Import-Module selecionar apenas os comandos que deseja importar e excluir comandos que causam conflitos de nome em sua sessão.

Os autores do módulo podem evitar conflitos de nome usando a propriedade DefaultCommandPrefix do manifesto do módulo para adicionar um prefixo padrão a todos os nomes de comando. O valor do parâmetro Prefix tem precedência sobre o valor de DefaultCommandPrefix.