Compartilhar via

Remove-ItemProperty

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

Exclui a propriedade e seu valor de um item.

Sintaxe

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

Description

O cmdlet Remove-ItemProperty 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.

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

Como o comando é emitido 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".

Exemplo 2: excluir um valor do registro do local do HKCU

Esses comandos excluem o valor do registro "Opções" e seus dados da subchave "MyApp" de "HKEY_CURRENT_USER\Software\MyCompany".

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

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

O segundo comando usa Remove-ItemProperty para remover o valor do registro "Opções" e seus dados da subchave "MyApp". Como de Caminho é necessário, o comando usa um ponto (.) para indicar o local atual. O parâmetro Confirme solicita um prompt de usuário antes de excluir o valor.

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.

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

O comando usa o cmdlet Get-Item 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.

Parâmetros

-Confirm

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

Tipo:SwitchParameter
Aliases:cf
Cargo:Named
Valor padrão:False
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Credential

Nota

Esse parâmetro não tem suporte para nenhum provedor instalado com o PowerShell. Para representar outro usuário ou elevar suas credenciais ao executar este cmdlet, use Invoke-Command.

Tipo:PSCredential
Cargo:Named
Valor padrão:Current user
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Exclude

Especifica, como uma matriz de cadeia de caracteres, um item ou itens que esse cmdlet exclui na operação. O valor desse parâmetro qualifica o parâmetro Path. Insira um elemento ou padrão de caminho, como *.txt. Caracteres curinga são permitidos. O parâmetro Excluir só é eficaz quando o comando inclui o conteúdo de um item, como C:\Windows\*, em que o caractere curinga especifica o conteúdo do diretório C:\Windows.

Tipo:String[]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:True

-Filter

Especifica um filtro para qualificar o parâmetro Path. O provedor FileSystem é o único provedor do PowerShell instalado que dá suporte ao uso de filtros. Você pode encontrar a sintaxe da linguagem de filtragem FileSystem no about_Wildcards. Os filtros são mais eficientes do que outros parâmetros, pois o provedor os aplica quando o cmdlet obtém os objetos em vez de ter o PowerShell filtrar os objetos depois que eles são recuperados.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:True

-Force

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

Tipo:SwitchParameter
Cargo:Named
Valor padrão:False
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga: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 elemento ou padrão de caminho, como "*.txt". Caracteres curinga são permitidos. O parâmetro Include só é eficaz quando o comando inclui o conteúdo de um item, como C:\Windows\*, em que o caractere curinga especifica o conteúdo do diretório C:\Windows.

Tipo:String[]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:True

-LiteralPath

Especifica um caminho para um ou mais locais. 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 permitem que o PowerShell não interprete qualquer caractere como sequências de escape.

Para obter mais informações, consulte about_Quoting_Rules.

Tipo:String[]
Aliases:PSPath, LP
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Name

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

Tipo:String[]
Aliases:PSProperty
Cargo:1
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:True

-Path

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

Tipo:String[]
Cargo:0
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:True

-WhatIf

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

Tipo:SwitchParameter
Aliases:wi
Cargo:Named
Valor padrão:False
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

Entradas

String

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

Saídas

None

Esse cmdlet não retorna nenhuma saída.

Observações

O PowerShell inclui os seguintes aliases para Remove-ItemProperty:

  • Todas as plataformas:

    • 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 foi projetado para trabalhar com os dados expostos por qualquer provedor. Para listar os provedores disponíveis na sessão, digite Get-PSProvider. Para obter mais informações, consulte about_Providers.