about_PSModulePath

  • Artigo

Descrição breve

Este artigo descreve a finalidade e o uso da variável de $env:PSModulePath ambiente.

Descrição longa

A $env:PSModulePath variável de ambiente contém uma lista de locais de pastas que são pesquisados para localizar módulos e recursos. O PowerShell pesquisa recursivamente cada pasta em busca de arquivos de módulo (.psd1 ou .psm1).

Install-Module tem um parâmetro Scope que permite especificar se o módulo está instalado para o usuário atual ou para todos os usuários. Para obter mais informações, confira Install-Module.

Por padrão, os locais efetivos atribuídos são $env:PSModulePath :

  • Locais em todo o sistema: essas pastas contêm módulos que são fornecidos com o PowerShell. Esses módulos são armazenados na $PSHOME\Modules pasta.

    • No Windows, os módulos instalados no escopo AllUsers são armazenados no $env:ProgramFiles\WindowsPowerShell\Modules.
    • Em sistemas não Windows, os módulos instalados no escopo AllUsers são armazenados no /usr/local/share/powershell/Modules.

  • Módulos instalados pelo usuário: no Windows, os módulos instalados no escopo CurrentUser normalmente são armazenados na $HOME\Documents\WindowsPowerShell\Modules pasta. O local específico da pasta varia de acordo com a versão do Windows e quando você usa o Documents redirecionamento de pasta. Além disso, o Microsoft OneDrive pode alterar o local da sua Documents pasta. Você pode verificar a localização da sua Documents pasta usando o seguinte comando: [Environment]::GetFolderPath('MyDocuments').

    Em sistemas não Windows, os módulos instalados no escopo CurrentUser são armazenados na $HOME/.local/share/powershell/Modules pasta.

  • Módulos específicos do aplicativo: os programas de instalação podem instalar módulos em outros diretórios, como a Program Files pasta no Windows. O pacote do instalador pode ou não anexar o local ao $env:PSModulePath.

Construção do PowerShell PSModulePath

O valor de $env:PSModulePath é construído sempre que o PowerShell é iniciado. O valor varia de acordo com a versão do PowerShell e como ele é iniciado.

Inicialização do Windows PowerShell

O Windows PowerShell usa a seguinte lógica para construir o PSModulePath na inicialização:

  • Se PSModulePath não existir, combine CurrentUser, AllUsers e os caminhos dos $PSHOME módulos
  • Se PSModulePath existir:
    • Se PSModulePath contiver $PSHOME o caminho dos módulos:
      • O caminho dos módulos AllUsers é inserido antes do $PSHOME caminho dos módulos
    • mais:
      • Basta usar PSModulePath conforme definido, pois o usuário removeu deliberadamente o $PSHOME local

O caminho do módulo CurrentUser será prefixado somente se o escopo $env:PSModulePath do usuário não existir. Caso contrário, o escopo $env:PSModulePath do usuário será usado conforme definido.

Inicialização do PowerShell 7

No Windows, para a maioria das variáveis de ambiente, se a variável no escopo do usuário existir, um novo processo usará esse valor somente mesmo se existir uma variável no escopo do computador com o mesmo nome.

No PowerShell 7, PSModulePath é tratado de forma semelhante à forma como a Path variável de ambiente é tratada no Windows. No Windows, Path é tratado de forma diferente de outras variáveis de ambiente. Quando um processo é iniciado, o Windows combina o escopo Path do usuário com o escopo Pathdo computador.

  • Recupere o escopo do usuário PSModulePath
  • Comparar com a variável de ambiente herdada PSModulePath do processo
    • Se o mesmo:
      • Acrescente o AllUsers PSModulePath ao final seguindo a semântica Path da variável de ambiente
      • O caminho do Windows System32 vem do computador definido PSModulePath , portanto, não precisa ser adicionado explicitamente
    • Se for diferente, trate como se o usuário o tivesse modificado explicitamente e não acrescente AllUsers PSModulePath
  • Prefixo com usuário PS7, sistema e $PSHOME caminhos nessa ordem
    • Se powershell.config.json contiver um escopo de PSModulePathusuário , use-o em vez do padrão para o usuário
    • Se powershell.config.json contiver um escopo do PSModulePathsistema , use-o em vez do padrão para o sistema

Os sistemas Unix não têm uma separação de variáveis de ambiente de usuário e sistema. PSModulePath é herdado e os caminhos específicos do PS7 são prefixados, se ainda não estiverem definidos.

Iniciando o Windows PowerShell do PowerShell 7

Para esta discussão, Windows PowerShell significa powershell.exe e powershell_ise.exe.

O valor de é copiado $env:PSModulePath para com WinPSModulePath as seguintes modificações:

  • Remova PS7 o caminho do módulo do usuário
  • Remova PS7 o caminho do módulo do sistema
  • Remova PS7 o caminho do $PSHOME módulo

Os caminhos do PS7 são removidos para que os módulos do PS7 não sejam carregados no Windows PowerShell. O WinPSModulePath valor é usado ao iniciar o Windows PowerShell.

Iniciando o PowerShell 7 a partir do Windows PowerShell

A inicialização do PowerShell 7 continua no estado em que se encontra com a adição de caminhos herdados que o Windows PowerShell adicionou. Como os caminhos específicos do PS7 são prefixados, não há problema funcional.

Comportamento de pesquisa do módulo

O PowerShell pesquisa recursivamente cada pasta no PSModulePath em busca de arquivos de módulo (.psd1 ou .psm1). Esse padrão de pesquisa permite que várias versões do mesmo módulo sejam instaladas em pastas diferentes. Por exemplo:

    Directory: C:\Program Files\WindowsPowerShell\Modules\PowerShellGet

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
d----           8/14/2020  5:56 PM                1.0.0.1
d----           9/13/2019  3:53 PM                2.1.2

Por padrão, o PowerShell carrega o número de versão mais alto de um módulo quando várias versões são encontradas. Para carregar uma versão específica, use Import-Module com o parâmetro FullyQualifiedName . Para obter mais informações, consulte Import-Module.

Modificando PSModulePath

Para a maioria das situações, você deve instalar módulos nos locais de módulo padrão. No entanto, você pode ter a necessidade de alterar o valor da variável de PSModulePath ambiente.

Por exemplo, para adicionar temporariamente o C:\Program Files\Fabrikam\Modules diretório à $env:PSModulePath sessão atual, digite:

$Env:PSModulePath = $Env:PSModulePath+";C:\Program Files\Fabrikam\Modules"

O ponto-e-vírgula (;) no comando separa o novo caminho do caminho que o precede na lista. Em plataformas não Windows, os dois-pontos (:) separam os locais do caminho na variável de ambiente.

Modificando PSModulePath em não Windows

Para alterar o valor de PSModulePath para cada sessão em um ambiente não Windows, adicione o comando anterior ao seu perfil do PowerShell.

Modificando PSModulePath no Windows

Para alterar o valor de em cada sessão, edite a chave do PSModulePath Registro que armazena os PSModulePath valores. Os PSModulePath valores são armazenados no registro como cadeias de caracteres não expandidas . Para evitar salvar permanentemente os PSModulePath valores como cadeias de caracteres expandidas , use o método GetValue na subchave e edite o valor diretamente.

O exemplo a seguir adiciona o C:\Program Files\Fabrikam\Modules caminho ao valor da variável de PSModulePath ambiente sem expandir as cadeias de caracteres não expandidas.

$key = (Get-Item 'HKLM:\SYSTEM\CurrentControlSet\Control\Session Manager').OpenSubKey('Environment', $true)
$path = $key.GetValue('PSModulePath','','DoNotExpandEnvironmentNames')
$path += ';%ProgramFiles%\Fabrikam\Modules'
$key.SetValue('PSModulePath',$path,[Microsoft.Win32.RegistryValueKind]::ExpandString)

Para adicionar um caminho à configuração do usuário, altere o provedor de registro de HKLM:\ para HKCU:\.

$key = (Get-Item 'HKCU:\').OpenSubKey('Environment', $true)
$path = $key.GetValue('PSModulePath','','DoNotExpandEnvironmentNames')
$path += ';%ProgramFiles%\Fabrikam\Modules'
$key.SetValue('PSModulePath',$path,[Microsoft.Win32.RegistryValueKind]::ExpandString)

Confira também