about_Scopes

Descrição curta

Explica o conceito de escopo no PowerShell e mostra como definir e alterar o escopo dos elementos.

Descrição longa

O PowerShell protege o acesso a variáveis, aliases, funções e unidades do PowerShell (PSDrives) limitando onde elas podem ser lidas e alteradas. O PowerShell usa regras de escopo para garantir que você não faça alterações não intencionais em itens em outros escopos.

Regras de escopo

Quando você inicia o PowerShell, o host (pwsh.exe) cria um runspace do PowerShell. Os processos de host podem ter vários runspaces. Cada runspace tem seu próprio estado de sessão e contêineres de escopo. O estado e os escopos da sessão não podem ser acessados entre instâncias de runspace.

Veja a seguir as regras básicas de escopo:

• Escopos podem aninhar. Um escopo externo é conhecido como um escopo pai. Quaisquer escopos aninhados são escopos filho desse pai.
• Um item é visível no escopo que foi criado e em qualquer escopo filho, a menos que você o torne explicitamente privado.
• Você pode declarar variáveis, aliases, funções e unidades do PowerShell para um escopo fora do escopo atual.
• Um item criado dentro de um escopo só pode ser alterado no escopo no qual ele foi criado, a menos que você especifique explicitamente um escopo diferente.
• Quando o código em execução em um runspace faz referência a um item, o PowerShell pesquisa a hierarquia de escopo, começando com o escopo atual e continuando por cada escopo pai. Se o item não for encontrado, um novo item será criado no escopo atual. Se encontrar uma correspondência, o valor do item será recuperado do escopo em que foi encontrado. Se você alterar o valor, o item será copiado para o escopo atual para que a alteração afete apenas o escopo atual.
• Se você criar explicitamente um item que compartilha seu nome com um item em um escopo diferente, o item original poderá estar oculto pelo novo item, mas ele não será substituído ou alterado.

Escopos pai e filho

Você pode criar um novo escopo filho chamando um script ou função. O escopo de chamada é o escopo pai. O script ou função chamado é o escopo filho. As funções ou scripts chamados podem chamar outras funções, criando uma hierarquia de escopos filho cujo escopo raiz é o escopo global.

Quando um escopo secundário é criado, ele inclui todos os aliases e variáveis que têm a opção AllScope, além de algumas variáveis automáticas. Essa opção é discutida posteriormente neste artigo.

A menos que você torne explicitamente os itens privados, os itens no escopo pai estão disponíveis para o escopo filho. Os itens criados ou alterados em um escopo filho não afetam o escopo pai, a menos que você especifique explicitamente o escopo ao criar os itens.

Para localizar os itens em um escopo específico, use o parâmetro Scope de Get-Variable ou Get-Alias.

Por exemplo, para obter todas as variáveis no escopo local, digite:

Get-Variable -Scope local

Para obter todas as variáveis no escopo global, digite:

Get-Variable -Scope global

Quando uma referência é feita a uma variável, alias ou função, o PowerShell pesquisa o escopo atual. Se o item não for encontrado, o escopo pai será pesquisado. Essa pesquisa é repetida até o escopo global. Se uma variável for privada em um escopo pai, a pesquisa continuará por meio da cadeia de escopo. exemplo 4 mostra o efeito de uma variável privada em uma pesquisa de escopo.

Nomes de escopos do PowerShell

O PowerShell define nomes para alguns escopos para permitir acesso mais fácil a esse escopo. O PowerShell define os seguintes escopos nomeados:

• Global: o escopo que está em vigor quando o PowerShell é iniciado ou quando você cria uma sessão ou um runspace. Variáveis e funções presentes quando o PowerShell é iniciado, como variáveis automáticas e variáveis de preferência, são criadas no escopo global. As variáveis, os aliases e as funções em seus perfis do PowerShell também são criados no escopo global. O escopo global é o escopo pai raiz em um runspace.
• Local: o escopo atual. O escopo local pode ser o escopo global ou qualquer outro escopo.
• Script: o escopo criado enquanto um arquivo de script é executado. Os comandos no script são executados no escopo do script. Para os comandos em um script, o escopo do script é o escopo local.

Para cmdlets que dão suporte a escopos, os escopos podem ser referenciados por um número que descreve a posição relativa de um escopo para outro. O escopo 0 indica o escopo atual (local), o escopo 1 é o pai do escopo atual, o escopo 2 é o avô do escopo atual. Esse padrão continua até que você alcance o escopo raiz.

Modificadores de escopo

Uma variável, um alias ou um nome de função pode incluir qualquer um dos seguintes modificadores de escopo opcionais:

• global: – Especifica que o nome existe no escopo Global.

• local: – Especifica que o nome existe no escopo Local. O escopo atual é sempre o escopo Local.

• private: – Especifica que o nome é Privado e fica visível apenas para o escopo atual.

  Nota

  private: não é um escopo. É uma opção que altera a acessibilidade de um item fora do escopo no qual ele é definido.

• script: – Especifica que o nome existe no escopo do Script. O escopoScript é o escopo do arquivo de script ancestral mais próximo ou Global se não houver um arquivo de script ancestral mais próximo.

• using: - Usado para acessar variáveis definidas em outro escopo durante a execução de scripts por meio de cmdlets como Start-Job e Invoke-Command.

• workflow: - Especifica que o nome existe em um fluxo de trabalho. Observação: não há suporte para fluxos de trabalho no PowerShell v6 e superior.

• <variable-namespace> – Um modificador criado por um provedor PSDrive do PowerShell. Por exemplo:

  Namespace	Descrição
  Alias:	Aliases definidos no escopo atual
  Env:	Variáveis de ambiente definidas no escopo atual
  Function:	Funções definidas no escopo atual
  Variable:	Variáveis definidas no escopo atual

O escopo padrão para scripts é o escopo do script. O escopo padrão para funções e aliases é o escopo local, mesmo que sejam definidos em um script.

Usando modificadores de escopo

Para especificar o escopo de uma nova variável, alias ou função, use um modificador de escopo.

A sintaxe de um modificador de escopo em uma variável é:

$[<scope-modifier>:]<name> = <value>

A sintaxe de um modificador de escopo em uma função é:

function [<scope-modifier>:]<name> {<function-body>}

O comando a seguir, que não usa um modificador de escopo, cria uma variável no escopo atual ou local :

$a = "one"

Para criar a mesma variável no escopo global , use o modificador de escopo global::

$global:a = "one"
Get-Variable a | Format-List *

Observe os valores das propriedades Visibility e Options.

Name        : a
Description :
Value       : one
Visibility  : Public
Module      :
ModuleName  :
Options     : None
Attributes  : {}

Compare isso com uma variável privada:

$private:pVar = 'Private variable'
Get-Variable pVar | Format-List *

Usar o modificador de escopo private define a propriedade Options como Private.

Name        : pVar
Description :
Value       : Private variable
Visibility  : Public
Module      :
ModuleName  :
Options     : Private
Attributes  : {}

Para criar a mesma variável no escopo de script, use o modificador de escopo script::

$script:a = "one"

Você também pode usar um modificador de escopo com funções. A seguinte definição de função cria uma função no escopo global:

function global:Hello {
  Write-Host "Hello, World"
}

Você também pode usar modificadores de escopo para se referir a uma variável em um escopo diferente. O comando a seguir refere-se à variável $test, primeiro no escopo local e depois no escopo global:

$test
$global:test

O modificador de escopo using:

Usar é um modificador de escopo especial que identifica uma variável local em um comando remoto. Sem um modificador, o PowerShell espera que variáveis em comandos remotos sejam definidas na sessão remota.

O modificador de escopo using é introduzido no PowerShell 3.0.

Para qualquer script ou comando executado fora da sessão, você precisa do modificador de escopo using para inserir valores variáveis do escopo da sessão de chamada, para que o código fora da sessão possa acessá-los. O modificador de escopo using tem suporte nos seguintes contextos:

• Comandos executados remotamente, iniciados com Invoke-Command usando os parâmetros ComputerName, HostName, SSHConnection ou Session (sessão remota)
• Trabalhos em segundo plano, iniciados com Start-Job (sessão fora do processo)
• Trabalhos de thread, iniciados através de Start-ThreadJob ou ForEach-Object -Parallel (sessão de thread separada)

Dependendo do contexto, os valores de variável inseridas são cópias independentes dos dados no escopo do chamador ou referências a ele. Em sessões remotas e fora de processo, elas são sempre cópias independentes.

Para obter mais informações, consulte about_Remote_Variables.

Em sessões de thread, elas são passadas por referência. Isso significa que é possível modificar variáveis de escopo filho em um thread diferente. Para modificar variáveis com segurança, requer sincronização de thread.

Para obter mais informações, confira:

• Start-ThreadJob
• Objeto ForEach

Serialização de valores variáveis

Comandos executados remotamente e trabalhos em segundo plano são executados fora do processo. Sessões fora de processo usam serialização e desserialização baseadas em XML para disponibilizar os valores das variáveis entre os limites do processo. O processo de serialização converte objetos em um PSObject que contém as propriedades de objetos originais, mas não seus métodos.

Para um conjunto limitado de tipos, a desserialização reidrata objetos de volta ao tipo original. O objeto reidratado é uma cópia da instância de objeto original. Ele tem as propriedades e os métodos de tipo. Para tipos simples, como System.Version, a cópia é exata. Para tipos complexos, a cópia é imperfeita. Por exemplo, objetos de certificado reidratados não incluem a chave privada.

As instâncias de todos os outros tipos são instâncias de PSObject. A propriedade PSTypeNames contém o nome original do tipo com o prefixo Deserialized, por exemplo, Deserialized.System.Data.DataTable

A opção AllScope

Variáveis e aliases têm uma propriedade Option que pode usar um valor de AllScope. Os itens que têm a propriedade AllScope tornam-se parte de quaisquer escopos secundários criados, embora não sejam herdados retroativamente por escopos primários.

Um item que tem a propriedade AllScope fica visível no escopo secundário e faz parte dele. As alterações no item em qualquer escopo afetam todos os escopos nos quais a variável é definida.

Gerenciando o escopo

Vários cmdlets têm um parâmetro Scope que permite obter ou definir itens (criar e alterar) em um escopo específico. Use o seguinte comando para localizar todos os cmdlets em sua sessão que têm um parâmetro Scope:

Get-Help * -Parameter scope

Para localizar as variáveis visíveis em um escopo específico, use o parâmetro Scope de Get-Variable. As variáveis visíveis incluem variáveis globais, variáveis no escopo pai e variáveis no escopo atual.

Por exemplo, o comando a seguir obtém as variáveis visíveis no escopo local:

Get-Variable -Scope local

Para criar uma variável em um escopo específico, use um modificador de escopo ou o parâmetro Scope de Set-Variable. O comando a seguir cria uma variável no escopo global:

New-Variable -Scope global -Name a -Value "One"

Você também pode usar o parâmetro Scope dos cmdlets New-Alias, Set-Aliasou Get-Alias para especificar o escopo. O comando a seguir cria um alias no escopo global:

New-Alias -Scope global -Name np -Value Notepad.exe

Para obter as funções em um escopo específico, use o cmdlet Get-Item quando estiver dentro desse escopo. O cmdlet Get-Item não tem um parâmetro Scope.

Usando notação de origem de ponto com escopo

Scripts e funções seguem as regras de escopo. Você os cria em um escopo específico e eles afetam somente esse escopo, a menos que você use um parâmetro cmdlet ou um modificador de escopo para alterar esse escopo.

Porém, você pode adicionar o conteúdo de um script ou função ao escopo atual usando notação de origem de ponto. Quando você executa um script ou função usando notação de origem de ponto, ele é executado no escopo atual. Quaisquer funções, aliases e variáveis no script ou função são adicionados ao escopo atual.

Por exemplo, para executar o script Sample.ps1 do diretório C:\Scripts no escopo do script (o padrão para scripts), basta inserir o caminho completo para o arquivo de script na linha de comando.

c:\scripts\sample.ps1

Um arquivo de script deve ter uma extensão de arquivo .ps1 para ser executável. Os arquivos que têm espaços em seu caminho devem ser colocados entre aspas. Se você tentar executar o caminho entre aspas, o PowerShell exibirá o conteúdo da cadeia de caracteres entre aspas em vez de executar o script. O operador de chamada (&) permite que você execute o conteúdo da cadeia de caracteres que contém o nome do arquivo.

Usar o operador de chamada para executar uma função ou script a executa no escopo do script. Usar o operador de chamada não é diferente de executar o script pelo nome.

& c:\scripts\sample.ps1

Você pode ler mais sobre o operador de chamada em about_Operators.

Para executar o script Sample.ps1 no escopo local, digite um ponto e um espaço (. ) antes do caminho para o script:

. c:\scripts\sample.ps1

Agora, quaisquer funções, aliases ou variáveis definidas no script são adicionadas ao escopo atual.

Restringir sem escopo

O PowerShell tem algumas opções e recursos semelhantes ao escopo e podem interagir com escopos. Esses recursos podem ser confundidos com o escopo ou o comportamento do escopo.

Sessões, módulos e prompts aninhados são ambientes independentes, não escopos filho do escopo global na sessão.

Sessões

Uma sessão é um ambiente no qual o PowerShell é executado. Quando você cria uma sessão em um computador remoto, o PowerShell estabelece uma conexão persistente com o computador remoto. A conexão persistente permite que você use a sessão para vários comandos relacionados.

Como uma sessão é um ambiente contido, ela tem seu próprio escopo, mas uma sessão não é um escopo filho da sessão na qual foi criada. A sessão começa com seu próprio escopo global. Esse escopo é independente do escopo global da sessão. Você pode criar escopos filho na sessão. Por exemplo, você pode executar um script para criar um escopo filho em uma sessão.

Módulos

Você pode usar um módulo do PowerShell para compartilhar e fornecer ferramentas do PowerShell. Um módulo é uma unidade que pode conter cmdlets, scripts, funções, variáveis, aliases e outros itens úteis. A menos que sejam exportados explicitamente (usando Export-ModuleMember ou o manifesto do módulo), os itens em um módulo não poderão ser acessados fora do módulo. Portanto, você pode adicionar o módulo à sessão e usar os itens públicos sem se preocupar que os outros itens possam substituir os cmdlets, scripts, funções e outros itens em sua sessão.

Por padrão, os módulos são carregados no escopo de nível raiz (global) do runspace. Importar um módulo não altera o escopo. Na sessão, os módulos têm seu próprio escopo. Considere o seguinte módulo C:\temp\mod1.psm1:

$a = "Hello"

function foo {
    "`$a = $a"
    "`$global:a = $global:a"
}

Agora, criamos uma variável global $a, damos a ela um valor e chamamos a função foo.

$a = "Goodbye"
foo

O módulo declara a variável $a no escopo do módulo e, em seguida, a função foo gera o valor da variável em ambos os escopos.

$a = Hello
$global:a = Goodbye

Os módulos criam contêineres de escopo paralelo vinculados ao escopo no qual foram importados. Os itens exportados pelo módulo estão disponíveis a partir do nível do escopo no qual são importados. Os itens não exportados do módulo só estão disponíveis no contêiner de escopo do módulo. As funções no módulo podem acessar itens no escopo em que foram importados, bem como itens no contêiner de escopo do módulo.

Se você carregar Module2 de emModule1, Module2 será carregado no contêiner de escopo de Module1. Todas as exportações de Module2 são colocadas no escopo do módulo atual de Module1. Se você usar Import-Module -Scope local, as exportações serão colocadas no objeto de escopo atual e não no nível superior. Se você estiver em um módulo e carregar outro módulo usando Import-Module -Scope global (ou Import-Module -Global), esse módulo e suas exportações serão carregados no escopo global e não no escopo local do módulo. A funcionalidade WindowsCompatibility faz isso para importar módulos proxy no estado de sessão global.

Prompts aninhados

Os prompts aninhados não têm seu próprio escopo. Quando você insere um prompt aninhado, o prompt aninhado é um subconjunto do ambiente. Mas, você permanece dentro do escopo local.

Os scripts têm seu próprio escopo. Se você estiver depurando um script e chegar a um ponto de interrupção no script, insira o escopo do script.

Opção privada

Aliases e variáveis têm uma propriedade Option que pode usar um valor de Private. Os itens que têm a opção Private podem ser exibidos e alterados no escopo no qual são criados, mas não podem ser exibidos ou alterados fora desse escopo.

Por exemplo, se você criar uma variável que tenha uma opção privada no escopo global e, em seguida, executar um script, Get-Variable comandos no script não exibirão a variável privada. O uso do modificador de escopo global nesta instância não exibe a variável privada.

Você pode usar o parâmetro Option dos cmdlets New-Variable, Set-VariableNew-Alias e Set-Alias para definir o valor da propriedade Option como Privado.

Visibilidade

A propriedade Visibility de uma variável ou alias determina se você pode ver o item fora do contêiner, no qual ele foi criado. Um contêiner pode ser um módulo, um script ou um snap-in. A visibilidade é projetada para contêineres da mesma forma que o valor Private da propriedade Option é projetado para escopos.

A propriedade Visibility usa os valores Public e Private. Os itens que têm visibilidade privada podem ser exibidos e alterados somente no contêiner no qual foram criados. Se o contêiner for adicionado ou importado, os itens que têm visibilidade privada não poderão ser exibidos ou alterados.

Como a visibilidade foi projetada para contêineres, ela funciona de forma diferente em um escopo.

• Se você criar um item que tenha visibilidade privada no escopo global, não poderá exibir ou alterar o item em qualquer escopo.
• Se você tentar exibir ou alterar o valor de uma variável que tenha visibilidade privada, o PowerShell retornará uma mensagem de erro.

Você pode usar os cmdlets New-Variable e Set-Variable para criar uma variável que tenha visibilidade privada.

Exemplos

Exemplo 1: alterar um valor de variável somente em um script

O comando a seguir altera o valor da variável $ConfirmPreference em um script. A alteração não afeta o escopo global.

Primeiro, para exibir o valor da variável $ConfirmPreference no escopo local, use o seguinte comando:

PS>  $ConfirmPreference
High

Crie um script Scope.ps1 que contenha os seguintes comandos:

$ConfirmPreference = "Low"
"The value of `$ConfirmPreference is $ConfirmPreference."

Execute o script. O script altera o valor da variável $ConfirmPreference e, em seguida, relata seu valor no escopo do script. A saída deve ser semelhante à seguinte saída:

The value of $ConfirmPreference is Low.

Em seguida, teste o valor atual da variável $ConfirmPreference no escopo atual.

PS>  $ConfirmPreference
High

Este exemplo mostra que as alterações no valor de uma variável no escopo do script não afetam o valor da variável no escopo pai.

Exemplo 2: exibir um valor variável em escopos diferentes

Você pode usar modificadores de escopo para exibir o valor de uma variável no escopo local e em um escopo pai.

Primeiro, defina uma variável $test no escopo global.

$test = "Global"

Em seguida, crie um script Sample.ps1 que defina a variável $test. No script, use um modificador de escopo para se referir às versões globais ou locais da variável $test.

Em Sample.ps1:

$test = "Local"
"The local value of `$test is $test."
"The global value of `$test is $global:test."

Quando você executa Sample.ps1, a saída deve ser semelhante à seguinte saída:

The local value of $test is Local.
The global value of $test is Global.

Quando o script é concluído, somente o valor global de $test é definido na sessão.

PS> $test
Global

Exemplo 3: alterar o valor de uma variável em um escopo pai

A menos que você proteja um item usando a opção Privada ou outro método, você pode exibir e alterar o valor de uma variável em um escopo pai.

Primeiro, defina uma variável $test no escopo global.

$test = "Global"

Em seguida, crie um script Sample.ps1 que defina a variável $test. No script, use um modificador de escopo para se referir às versões globais ou locais da variável $test.

Em Sample.ps1:

$global:test = "Local"
"The global value of `$test is $global:test."

Quando o script é concluído, o valor global de $test é alterado.

PS> $test
Local

Exemplo 4: Criando uma variável privada

Uma variável pode ser tornada privada usando o modificador de escopo private: ou criando a variável com a propriedade option definida como Private. Variáveis privadas só podem ser visualizadas ou alteradas no escopo em que foram criadas.

Neste exemplo, o script ScopeExample.ps1 cria cinco funções. A primeira função chama a próxima função, que cria um escopo filho. Uma das funções tem uma variável privada que só pode ser vista no escopo em que foi criada.

PS> Get-Content ScopeExample.ps1
# Start of ScopeExample.ps1
function funcA {
    "Setting `$funcAVar1 to 'Value set in funcA'"
    $funcAVar1 = "Value set in funcA"
    funcB
}

function funcB {
    "In funcB before set -> '$funcAVar1'"
    $private:funcAVar1 = "Locally overwrite the value - child scopes can't see me!"
    "In funcB after set  -> '$funcAVar1'"
    funcC
}

function funcC {
    "In funcC before set -> '$funcAVar1' - should be the value set in funcA"
    $funcAVar1 = "Value set in funcC - Child scopes can see this change."
    "In funcC after set  -> '$funcAVar1'"
    funcD
}

function funcD {
    "In funcD before set -> '$funcAVar1' - should be the value from funcC."
    $funcAVar1 = "Value set in funcD"
    "In funcD after set  -> '$funcAVar1'"
    '-------------------'
    ShowScopes
}

function ShowScopes {
    $funcAVar1 = "Value set in ShowScopes"
    "Scope [0] (local)  `$funcAVar1 = '$(Get-Variable funcAVar1 -Scope 0 -ValueOnly)'"
    "Scope [1] (parent) `$funcAVar1 = '$(Get-Variable funcAVar1 -Scope 1 -ValueOnly)'"
    "Scope [2] (parent) `$funcAVar1 = '$(Get-Variable funcAVar1 -Scope 2 -ValueOnly)'"
    "Scope [3] (parent) `$funcAVar1 = '$(Get-Variable funcAVar1 -Scope 3 -ValueOnly)'"
    "Scope [4] (parent) `$funcAVar1 = '$(Get-Variable funcAVar1 -Scope 4 -ValueOnly)'"
}
funcA
# End of ScopeExample.ps1
PS> .\ScopeExample.ps1

A saída mostra o valor da variável em cada escopo. Você pode ver que a variável privada só está visível em funcB, o escopo no qual ela foi criada.

Setting $funcAVar1 to 'Value set in funcA'
In funcB before set -> 'Value set in funcA'
In funcB after set  -> 'Locally overwrite the value - child scopes can't see me!'
In funcC before set -> 'Value set in funcA' - should be the value set in funcA
In funcC after set  -> 'Value set in funcC - Child scopes can see this change.'
In funcD before set -> 'Value set in funcC - Child scopes can see this change.' - should be the value from funcC.
In funcD after set  -> 'Value set in funcD'
-------------------
Scope [0] (local)  $funcAVar1 = 'Value set in ShowScopes'
Scope [1] (parent) $funcAVar1 = 'Value set in funcD'
Scope [2] (parent) $funcAVar1 = 'Value set in funcC - Child scopes can see this change.'
Scope [3] (parent) $funcAVar1 = 'Locally overwrite the value - child scopes can't see me!'
Scope [4] (parent) $funcAVar1 = 'Value set in funcA'

Conforme mostrado pela saída de ShowScopes, você pode acessar variáveis de outros escopos usando Get-Variable e especificando um número de escopo.

Exemplo 5: Usando uma variável local em um comando remoto

Para variáveis em um comando remoto criado na sessão local, use o modificador de escopo using. O PowerShell pressupõe que as variáveis em comandos remotos foram criadas na sessão remota.

A sintaxe é:

$using:<VariableName>

Por exemplo, os comandos a seguir criam uma variável $Cred na sessão local e usam a variável $Cred em um comando remoto:

$Cred = Get-Credential
Invoke-Command $s {Remove-Item .\Test*.ps1 -Credential $using:Cred}

O modificador de escopo using foi introduzido no PowerShell 3.0.

Consulte também

• about_Variables
• about_Environment_Variables
• about_Functions
• about_Script_Blocks
• Start-ThreadJob