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>]
      [-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 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".

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

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 do HKCU

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

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 caminho é necessário, o comando usa um ponto ('.') para indicar o local atual. Ele usa Name para especificar qual valor do Registro deve ser excluído. Ele usa o parâmetro Confirm para solicitar um prompt de 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 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.

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

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 esse 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 os itens que esse cmdlet omite. 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.

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

Tipo:String[]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga: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 curinga. Se o caminho incluir caracteres de escape, coloque-o entre aspas simples. As aspas simples dizem ao PowerShell para não interpretar nenhum caractere como sequências de escape.

Tipo:String[]
Aliases:PSPath
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

-UseTransaction

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

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

-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

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.