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>]

Descrição

Exemplos

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

Set-Variable -Name "desc" -Value "A description"
Get-Variable -Name "desc"

Name                           Value
----                           -----
desc                           A description

Exemplo 2: Definir uma variável global de apenas leitura

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

New-Variable -Name "counter" -Visibility Public -Value 26
$Counter

26

Get-Variable c*

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

Set-Variable -Name "counter" -Visibility Private
Get-Variable c*

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

$counter

"Cannot access the variable '$counter' because it is a private variable"

.\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 um array de itens que este 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-lhe criar uma variável com o mesmo nome de uma variável só leitura existente, ou alterar o valor de uma variável só leitura.

Por defeito, pode sobrescrever uma variável, a menos que a variável tenha um valor de opção de ReadOnly ou Constant. Para mais informações, consulte o parâmetro Opção .

Propriedades dos parâmetros

Conjuntos de parâmetros

-Include

Especifica um conjunto de itens que este cmdlet inclui na operação. O valor desse parâmetro qualifica o Name parâmetro. Introduza 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 Opções da variável.

Os valores válidos são:

• None: Não define opções. (None é o padrão.)
• ReadOnly: Pode ser apagado. Não pode ser alterado, exceto usando o parâmetro de Força.
• Constant: Não pode ser eliminado ou alterado. Constant é válido apenas quando está a criar uma variável. Não pode alterar as opções de uma variável existente para Constant.
• Private: A variável está disponível apenas no âmbito atual.
• AllScope: A variável é copiada para quaisquer novos escopos que sejam criados.

Esses valores são definidos como uma enumeração baseada em sinalizador. Você pode combinar vários valores juntos para definir vários sinalizadores usando esse parâmetro. Os valores podem ser passados ao parâmetro Option como um array de valores ou como uma cadeia separada por vírgulas desses valores. O cmdlet combinará os valores usando uma operação binary-OR. Passar valores como uma matriz é a opção mais simples e também permite que você use o preenchimento de tabulação nos valores.

Propriedades dos parâmetros

Conjuntos de parâmetros

-PassThru

Devolve 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 âmbito da variável. Os valores aceitáveis para este parâmetro são:

• Global
• Local
• Script
• Private
• Um número relativo ao âmbito atual (0 até ao número de telescópios, onde 0 é o âmbito atual e 1 é o 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 concebido para uso em scripts e comandos que serão entregues a outros utilizadores.

Os valores válidos são:

• Public: A variável é visível. (Public é o padrão.)
• Private: A variável não é visível.

Quando uma variável é privada, não aparece em listas de variáveis, como as devolvidas por Get-Variable, ou nos ecrãs da unidade Variable: . Os comandos para ler ou alterar o valor de uma variável privada devolvem um erro. No entanto, o utilizador pode executar comandos que utilizam 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

String

Saídas

None

PSVariable

Notas

Ligações Relacionadas

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