Partilhar via

Remove-Variable

Módulo:
Microsoft.PowerShell.Utility Module

Exclui uma variável e seu valor.

Sintaxe

Default (Predefinição) 

Remove-Variable
    [-Name] <String[]>
    [-Include <String[]>]
    [-Exclude <String[]>]
    [-Force]
    [-Scope <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

O cmdlet Remove-Variable exclui uma variável e seu valor do escopo no qual ela é definida, como a sessão atual. Não é possível usar esse cmdlet para excluir variáveis definidas como constantes ou pertencentes ao sistema.

Exemplos

Exemplo 1: Remover uma variável

Remove-Variable Smp

Este comando exclui a variável $Smp.

Parâmetros

-Confirm

Solicita confirmação antes de executar o cmdlet.

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:False
Suporta carateres universais:False
NãoMostrar:False
Aliases:Cf.

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Exclude

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

Propriedades dos parâmetros

Tipo:

String[]

Default value:None
Suporta carateres universais:True
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Force

Indica que o cmdlet remove uma variável mesmo que ela seja somente leitura. Mesmo usando o parâmetro Force, o cmdlet não pode remover uma constante.

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Include

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

Propriedades dos parâmetros

Tipo:

String[]

Default value:None
Suporta carateres universais:True
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Name

Especifica o nome da variável a ser removida. O nome do parâmetro (Name) é opcional. Curingas são permitidos

Propriedades dos parâmetros

Tipo:

String[]

Default value:None
Suporta carateres universais:True
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:0
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-Scope

Obtém apenas as variáveis no escopo especificado. Os valores aceitáveis para este parâmetro são:

  • A nível mundial
  • Locais
  • Script
  • 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

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-WhatIf

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

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:False
Suporta carateres universais:False
NãoMostrar:False
Aliases:Wi

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

PSVariable

Você pode canalizar um objeto variável para esse cmdlet.

Saídas

None

Este cmdlet não retorna nenhuma saída.

Notas

O PowerShell inclui os seguintes aliases para Remove-Variable:

  • Todas as plataformas:

    • rv

  • As alterações afetam apenas o escopo atual, como uma sessão. Para excluir uma variável de todas as sessões, adicione um comando Remove-Variable ao seu perfil do PowerShell.