Compartilhar via

Remove-Variable

Módulo:
Microsoft.PowerShell.Utility Module

Exclui uma variável e seu valor.

Sintaxe

Default (Padrã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. Você não pode usar esse cmdlet para excluir variáveis que são definidas como constantes ou aquelas que pertencem ao sistema.

Exemplos

Exemplo 1: remover uma variável

Remove-Variable Smp

Esse comando exclui a variável $Smp.

Parâmetros

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False
Aliases:cf

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Exclude

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

Propriedades do parâmetro

Tipo:

String[]

Valor padrão:None
Dá suporte a curingas:True
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Force

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

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Include

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

Propriedades do parâmetro

Tipo:

String[]

Valor padrão:None
Dá suporte a curingas:True
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Name

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

Propriedades do parâmetro

Tipo:

String[]

Valor padrão:None
Dá suporte a curingas:True
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:0
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-Scope

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

  • Mundial
  • Local
  • Script
  • Um número relativo ao escopo atual (variando de 0 até o número total de escopos, onde 0 é o escopo atual e 1 é o escopo pai)

Local é o padrão. Para obter mais informações, consulte about_Scopes.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-WhatIf

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

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False
Aliases:wi

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes: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 redirecionar um objeto variável para este cmdlet.

Saídas

None

Esse cmdlet não retorna nenhuma saída.

Observações

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.