Remove-ItemProperty

Exclui a propriedade e seu valor de um item.

Sintaxe

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

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

Descrição

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

Parâmetros

-Credential <PSCredential>

Especifica uma conta de usuário com permissão para executar essa ação. O padrão é o usuário atual.

Digite um nome de usuário, como "User01" ou "Domain01\User01", ou insira um objeto PSCredential, como aquele gerado pelo cmdlet Get-Credential. Uma senha será solicitada após a digitação do nome do usuário.

Este parâmetro não tem suporte em nenhum dos provedores instalados com o Windows PowerShell.

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	true (ByPropertyName)
Aceitar caracteres curinga?	false

-Exclude <string[]>

Omite os itens especificados. O valor desse parâmetro qualifica o parâmetro Path. Digite um elemento ou padrão do caminho, como "*.txt". Os caracteres curinga são permitidos.

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-Filter <string>

Especifica um filtro no formato ou no idioma do provedor. O valor desse parâmetro qualifica o parâmetro Path. A sintaxe do filtro, incluindo o uso dos caracteres curinga, depende do provedor. Os filtros são mais eficientes que outros parâmetros, porque o provedor os aplica durante a recuperação dos objetos, em vez de fazer com que o Windows PowerShell os filtre depois de recuperados.

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-Force

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

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-Include <string[]>

Exclui somente os itens especificados. O valor desse parâmetro qualifica o parâmetro Path. Digite um elemento ou padrão do caminho, como "*.txt". Os caracteres curinga são permitidos.

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-LiteralPath <string[]>

Especifica o caminho até a propriedade do item. O valor de LiteralPath é usado exatamente como é digitado. Nenhum caractere será interpretado como curinga. Se o caminho incluir caracteres de escape, coloque-os entre aspas simples. As aspas simples dizem ao Windows PowerShell para não interpretar quaisquer caracteres que tenham sequências de escape.

Necessário?	true
Posição?	1
Valor padrão
Aceitar entrada do pipeline?	true (ByPropertyName)
Aceitar caracteres curinga?	false

-Name <string[]>

Especifica os nomes das propriedades a serem recuperadas.

Necessário?	true
Posição?	2
Valor padrão
Aceitar entrada do pipeline?	true (ByPropertyName)
Aceitar caracteres curinga?	false

-Path <string[]>

Especifica o caminho até o item cujas propriedades estão sendo removidas. Os caracteres curinga são permitidos.

Necessário?	true
Posição?	1
Valor padrão
Aceitar entrada do pipeline?	true (ByValue, ByPropertyName)
Aceitar caracteres curinga?	false

-Confirm

Solicita confirmação antes da execução do comando.

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-WhatIf

Descreve o que aconteceria se você executasse o comando, sem executá-lo de fato.

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-UseTransaction

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

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

<CommonParameters>

Esse cmdlet oferece suporte aos parâmetros comuns: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer e -OutVariable. Para obter mais informações, consulte about_Commonparameters.

Entradas e saídas

O tipo de entrada é o tipo dos objetos que você pode canalizar para o cmdlet. O tipo de retorno é o tipo dos objetos que o cmdlet retorna.

Entradas	System.String Você pode enviar uma cadeia de caracteres que contém um caminho (mas não um caminho literal) para Remove-ItemProperty.
Saídas	Nenhum Este cmdlet não retorna nenhuma saída.

Observações

Você também pode fazer referência a Remove-ItemProperty usando seu alias interno, "rp". Para obter mais informações, consulte about_Alias.

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

O cmdlet Remove-ItemProperty foi desenvolvido para funcionar 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.

Exemplo 1

C:\PS>remove-itemproperty -path HKLM:\Software\SmpApplication -name SmpProperty

Descrição
-----------
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 (C:\PS>), utiliza o caminho exclusivo para a 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.

Exemplo 2

C:\PS>set-location HKCU:\Software\MyCompany\MyApp

PS HKCU:\Software\MyCompany\MyApp> remove-itemproperty -path . -Name Options -confirm

Descrição
-----------
Esse comando exclui o valor do Registro Options 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 o cmdlet Remove-Item para remover o valor do Registro Options e seus dados da subchave MyApp. Como o parâmetro Path é obrigatório, o comando usa um ponto (.) para indicar o local atual. Utiliza o parâmetro Name para especificar o valor do Registro a ser excluído. E usa o parâmetro Confirm para solicitar uma confirmação antes da exclusão do valor.

Exemplo 3

C:\PS>get-item -path HKLM:\Software\MyCompany | remove-itemproperty -name NoOfEmployees

Descrição
-----------
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 o cmdlet Remove-ItemProperty. Em seguida, ele usa o parâmetro Name de Remove-ItemProperty para especificar o nome do valor do Registro.

Consulte também

Conceitos

about_Providers
Clear-ItemProperty
Copy-ItemProperty
Get-ItemProperty
Move-ItemProperty
New-ItemProperty
Remove-Item
Rename-ItemProperty
Set-ItemProperty