Set-Variable

Sintaxe

Default (Predefinição)

Set-Variable
    [-Name] <String[]>
    [[-Value] <Object>]
    [-Include <String[]>]
    [-Exclude <String[]>]
    [-Description <String>]
    [-Option <ScopedItemOptions>]
    [-Force]
    [-Visibility <SessionStateEntryVisibility>]
    [-PassThru]
    [-Scope <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Exemplos

Exemplo 1: Definir uma variável e obter seu valor

PS C:\> Set-Variable -Name "desc" -Value "A description"
PS C:\> Get-Variable -Name "desc"

Exemplo 2: Definir uma variável global somente leitura

PS C:\> Set-Variable -Name "processes" -Value (Get-Process) -Option constant -Scope global -Description "All processes" -PassThru | Format-List -Property *

Exemplo 3: Compreender as variáveis públicas vs. privadas

PS C:\> New-Variable -Name "counter" -Visibility Public -Value 26
PS C:\> $Counter
26
PS C:\> Get-Variable c*

Name                  Value
----                  -----
Culture               en-US
ConsoleFileName
ConfirmPreference     High
CommandLineParameters {}
Counter               26

PS C:\> Set-Variable -Name "counter" -Visibility Private
PS C:\> Get-Variable c*

Name                  Value
----                  -----
Culture               en-US
ConsoleFileName
ConfirmPreference     High
CommandLineParameters {}

 PS C:\> $counter
"Cannot access the variable '$counter' because it is a private variable"

PS C:\> .\use-counter.ps1
#Commands completed successfully.

Parâmetros

-Confirm

Solicita confirmação antes de executar o cmdlet.

Propriedades dos parâmetros

Conjuntos de parâmetros

-Description

Especifica a descrição da variável.

Propriedades dos parâmetros

Conjuntos de parâmetros

-Exclude

Especifica uma matriz de itens que esse cmdlet exclui da operação. O valor desse parâmetro qualifica o parâmetro Path. Insira um elemento ou padrão de caminho, como *.txt. Curingas são permitidos.

Propriedades dos parâmetros

Conjuntos de parâmetros

-Force

Permite criar uma variável com o mesmo nome de uma variável somente leitura existente ou alterar o valor de uma variável somente leitura.

Por padrão, você pode substituir uma variável, a menos que a variável tenha um valor de opção Somente leitura ou Constante. Para obter mais informações, consulte o parâmetro Option.

Propriedades dos parâmetros

Conjuntos de parâmetros

-Include

Especifica uma matriz de itens que esse cmdlet inclui na operação. O valor desse parâmetro qualifica o Name parâmetro. Insira um nome ou padrão de nome, como c*. Curingas são permitidos.

Propriedades dos parâmetros

Conjuntos de parâmetros

-Name

Especifica o nome da variável.

Propriedades dos parâmetros

Conjuntos de parâmetros

-Option

Especifica o valor da propriedade Options da variável.

Os valores válidos são:

• Nenhum: não define opções. ("Nenhum" é o padrão.)
• ReadOnly: Pode ser excluído. Não pode ser alterado, exceto usando o parâmetro Force.
• Constante: Não pode ser excluída ou alterada. "Constante" é válido somente quando você está criando uma variável. Não é possível alterar as opções de uma variável existente para "Constante".
• Privado: A variável está disponível apenas no escopo atual.
• AllScope: A variável é copiada para todos os novos escopos criados.

Para ver a propriedade Options de todas as variáveis na sessão, digite Get-Variable | Format-Table -Property name, options -Autosize.

Propriedades dos parâmetros

Conjuntos de parâmetros

-PassThru

Retorna um objeto que representa a nova variável. Por padrão, esse cmdlet não gera nenhuma saída.

Propriedades dos parâmetros

Conjuntos de parâmetros

-Scope

Especifica o escopo da variável. Os valores aceitáveis para este parâmetro são:

• A nível mundial
• Locais
• Script
• Privado
• Um número relativo ao escopo atual (0 através do número de escopos, onde 0 é o escopo atual e 1 é seu pai).

Local é o padrão.

Para obter mais informações, consulte about_Scopes.

Propriedades dos parâmetros

Conjuntos de parâmetros

-Value

Especifica o valor da variável.

Propriedades dos parâmetros

Conjuntos de parâmetros

-Visibility

Determina se a variável é visível fora da sessão em que foi criada. Este parâmetro foi projetado para uso em scripts e comandos que serão entregues a outros usuários.

Os valores válidos são:

• Público: A variável é visível. ("Público" é o padrão.)
• Private: A variável não está visível.

Quando uma variável é privada, ela não aparece em listas de variáveis, como as retornadas por Get-Variable, ou em exibições da unidade Variable:. Os comandos para ler ou alterar o valor de uma variável privada retornam um erro. No entanto, o usuário pode executar comandos que usam uma variável privada se os comandos foram escritos na sessão em que a variável foi definida.

Propriedades dos parâmetros

Conjuntos de parâmetros

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Propriedades dos parâmetros

Conjuntos de parâmetros

CommonParameters

Entradas

Object

Saídas

None or System.Management.Automation.PSVariable

Ligações Relacionadas

• Clear-Variable
• Get-Variable
• Nova-Variável
• Remove-Variable