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>]
      [-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 Remove-ItemProperty cmdlet exclui uma propriedade e seu valor de um item. Você pode usá-lo para excluir valores do Registro e os dados que eles armazenam.

Exemplos

Exemplo 1: Excluir um valor do Registro

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

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

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

Exemplo 2: Excluir um valor do Registro do local 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 Set-Location cmdlet para alterar o local atual para a unidade de HKEY_CURRENT_USER (HKCU:) e a Software\MyCompany\MyApp subchave.

O segundo comando é usado 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. O parâmetro Confirm solicita um prompt do usuário antes de excluir o valor.

Exemplo 3: Remover um valor do Registro usando o pipeline

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

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

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.

Parâmetros

-Confirm

Solicita a 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

Nota

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, 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 Exclude é efetivo somente quando o comando inclui o conteúdo de um item, como , onde C:\Windows\*o caractere curinga especifica o C:\Windows conteúdo do diretório.

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

-Filter

Especifica um filtro para qualificar o parâmetro Path . O provedor FileSystem é o único provedor PowerShell instalado que oferece suporte ao uso de filtros. Você pode encontrar a sintaxe para a linguagem de filtro FileSystem em about_Wildcards. 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 de outra forma. A implementação varia de fornecedor para fornecedor. 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 elemento ou padrão de caminho, como "*.txt". Caracteres curinga são permitidos. O parâmetro Include só é efetivo quando o comando inclui o conteúdo de um item, como , onde C:\Windows\*o caractere curinga especifica o C:\Windows conteúdo do diretório.

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

-LiteralPath

Especifica um caminho para um ou mais locais. 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. Aspas simples dizem ao PowerShell para não interpretar nenhum caractere como sequências de escape.

Para obter mais informações, consulte about_Quoting_Rules.

Type:String[]
Aliases:PSPath, LP
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

-WhatIf

Apresenta o que aconteceria mediante a execução do cmdlet. 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

Este cmdlet não retorna nenhuma saída.

Notas

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