Share via

Remove-Variable

  • Referência
Módulo:
Microsoft.PowerShell.Utility

Exclui uma variável e seu valor.

Syntax

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

Description

O Remove-Variable cmdlet exclui uma variável e seu valor do escopo no qual ela é definida, como a sessão atual. Não é possível utilizar este cmdlet para excluir as variáveis que são definidas como constantes ou aqueles que são de propriedade do sistema.

Exemplos

Exemplo 1: remover uma variável

Remove-Variable Smp

Esse comando exclui a $Smp variável.

Parâmetros

-Confirm

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

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters: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 Name ou padrão, como "*s". Caracteres curinga são permitidos.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-Name

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

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:True

-Scope

Ele obtém somente as variáveis no escopo especificado. Os valores aceitáveis para esse parâmetro são:

  • Global
  • Local
  • Script
  • Um número relativo ao escopo atual (0 pelo número de escopos, em que 0 é o escopo atual e 1 é seu pai)

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entradas

PSVariable

Você pode redirecionar um objeto de variável para Remove-Variable.

Saídas

None

Este cmdlet não retorna nenhuma saída.

Observações

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

  • Você também pode consultar por seu alias Remove-Variable interno, rv. Para obter mais informações, consulte about_Aliases.