Compartilhar via

Remove-ItemProperty

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

Exclui a propriedade e seu valor de um item.

Syntax

Remove-ItemProperty
      [-Path] <String[]>
      [-Name] <String[]>
      [-Force]
      [-Filter <String>]
      [-Include <String[]>]
      [-Exclude <String[]>]
      [-Credential <PSCredential>]
      [-WhatIf]
      [-Confirm]
      [-UseTransaction]
      [<CommonParameters>]
Remove-ItemProperty
      -LiteralPath <String[]>
      [-Name] <String[]>
      [-Force]
      [-Filter <String>]
      [-Include <String[]>]
      [-Exclude <String[]>]
      [-Credential <PSCredential>]
      [-WhatIf]
      [-Confirm]
      [-UseTransaction]
      [<CommonParameters>]

Description

O Remove-ItemProperty cmdlet exclui uma propriedade e seu valor de um item. Você pode usá-lo para excluir os valores do registro e os dados que eles armazenam.

Exemplos

Exemplo 1: Excluir um valor do Registro

Esse comando exclui o valor do Registro "SmpProperty" e seus dados da subchave "SmpApplication" da chave do Registro "HKEY_LOCAL_MACHINE\Software".

Como o comando é emitido a partir de uma unidade do sistema de arquivos (PS C:\>), ele inclui o caminho totalmente qualificado da subchave "SmpApplication", incluindo a unidade HKLM:e a chave "Software".

Ele usa o parâmetro Name para identificar o valor do Registro que está sendo excluído.

Remove-ItemProperty -Path "HKLM:\Software\SmpApplication" -Name "SmpProperty"

Exemplo 2: Excluir um valor do Registro do local HKCU

Esses comandos excluem o valor do Registro "Options" e seus dados da subchave "MyApp" de "HKEY_CURRENT_USER\Software\MyCompany".

O primeiro comando usa o Set-Location cmdlet para alterar o local atual para a unidade de HKEY_CURRENT_USER (HKCU:) e a subchave "Software\MyCompany\MyApp".

O segundo comando usa Remove-ItemProperty para remover o valor do Registro "Options" e seus dados da subchave "MyApp". Como Path é necessário, o comando usa um ponto ('.') para indicar o local atual. Ele usa Name para especificar qual valor do Registro excluir. Ele usa o parâmetro Confirm para solicitar um prompt do usuário antes de excluir o valor.

PS C:\> Set-Location HKCU:\Software\MyCompany\MyApp
PS HKCU:\Software\MyCompany\MyApp> Remove-ItemProperty -Path . -Name "Options" -Confirm

Exemplo 3: Remover um valor do Registro usando o pipeline

Esse comando exclui o valor do Registro "NoOfEmployees" e seus dados da chave do Registro "HKLM\Software\MyCompany".

O comando usa o Get-Item cmdlet para obter um item que representa a chave do Registro. Ele usa um operador de pipeline (|) para enviar o objeto para Remove-ItemProperty. Em seguida, ele usa o parâmetro Name de Remove-ItemProperty para especificar o nome do valor do Registro.

Get-Item -Path HKLM:\Software\MyCompany | Remove-ItemProperty -Name NoOfEmployees

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

-Credential

Observação

Esse parâmetro não é suportado por nenhum provedor instalado com o PowerShell. Para representar outro usuário ou elevar suas credenciais ao executar esse cmdlet, use Invoke-Command.

Type:PSCredential
Position:Named
Default value:Current user
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Exclude

Especifica itens que esse cmdlet omite. O valor desse parâmetro qualifica o parâmetro Path . Insira um padrão ou elemento de caminho, como "*.txt". Caracteres curinga são permitidos.

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

-Filter

Especifica um filtro no formato ou idioma do provedor. O valor desse parâmetro qualifica o parâmetro Path .

A sintaxe do filtro, incluindo o uso de caracteres curinga, depende do provedor. Os filtros são mais eficientes do que outros parâmetros, porque o provedor os aplica quando o cmdlet obtém os objetos, em vez de fazer com que o PowerShell filtre os objetos depois que eles são recuperados.

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

-Force

Força o cmdlet a remover uma propriedade de um objeto que não pode ser acessado pelo usuário. A implementação varia de provedor para provedor. Para obter mais informações, consulte about_Providers.

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

-Include

Especifica, como uma matriz de cadeia de caracteres, um item ou itens que esse cmdlet inclui na operação. O valor desse parâmetro qualifica o parâmetro Path . Insira um padrão ou elemento de caminho, como "*.txt". Caracteres curinga são permitidos.

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

-LiteralPath

Especifica o caminho para o local atual da propriedade. Ao contrário do parâmetro Path , o valor de LiteralPath é usado exatamente como é digitado. Nenhum caractere é interpretado como caractere curinga. Se o caminho incluir caracteres de escape, coloque-o entre aspas simples. Aspas simples dizem ao PowerShell para não interpretar nenhum caractere como sequências de escape.

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

-Name

Especifica os nomes das propriedades a serem removidas. Caracteres curinga são permitidos.

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

-Path

Especifica o caminho do item cujas propriedades estão sendo removidas. Caracteres curinga são permitidos.

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

-UseTransaction

Inclui o comando na transação ativa. Este parâmetro é válido somente quando uma transação está em andamento. Para obter mais informações, consulte about_Transactions.

Type:SwitchParameter
Aliases:usetx
Position:Named
Default value:False
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

String

Você pode canalizar uma cadeia de caracteres que contém um caminho, mas não um caminho literal, para esse cmdlet.

Saídas

None

Esse cmdlet não retorna nenhuma saída.

Observações

O Windows PowerShell inclui os seguintes aliases para Remove-ItemProperty:

  • rp

No provedor do Registro do PowerShell, os valores do Registro são considerados propriedades de uma chave ou subchave do Registro. Você pode usar os cmdlets ItemProperty para gerenciar esses valores.

Remove-ItemProperty é projetado para trabalhar com os dados expostos por qualquer provedor. Para listar os provedores disponíveis em sua sessão, digite Get-PSProvider. Para obter mais informações, consulte about_Providers.