Partilhar via

Rename-ItemProperty

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

Renomeia uma propriedade de um item.

Syntax

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

Description

O Rename-ItemProperty cmdlet altera o nome de uma propriedade de item especificada. O valor da propriedade não é alterado. Por exemplo, você pode usar Rename-ItemProperty para alterar o nome de uma entrada do Registro.

Exemplos

Exemplo 1: Renomear uma entrada do Registro

Este comando renomeia a entrada do Registro config contida na chave "HKEY_LOCAL_MACHINE\Software\SmpApplication" para "oldconfig".

Rename-ItemProperty -Path HKLM:\Software\SmpApplication -Name config -NewName oldconfig

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

Especifica uma conta de usuário que tem permissão para executar essa ação. A predefinição é o utilizador atual.

Digite um nome de usuário, como "User01" ou "Domain01\User01", ou insira um objeto PSCredential , como um Get-Credential gerado pelo cmdlet. Se escrever um nome de utilizador, ser-lhe-á solicitada uma palavra-passe.

Aviso

Esse parâmetro não é suportado por nenhum provedor instalado com o Windows PowerShell.

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

-Exclude

Especifica os itens que este 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.

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 renomear 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 apenas os itens sobre os quais o cmdlet atua, excluindo todos os outros. 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.

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

-LiteralPath

Especifica um caminho para o item. 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. 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 o nome atual da propriedade a ser renomeada.

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

-NewName

Especifica o novo nome para a propriedade.

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

-PassThru

Retorna um objeto que representa a propriedade item. Por padrão, esse cmdlet não gera nenhuma saída.

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

-Path

Especifica um caminho para o item.

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

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

Por padrão, esse cmdlet não retorna nenhuma saída.

PSCustomObject

Quando você usa o parâmetro PassThru , esse cmdlet retorna um PSCustomObject que representa a propriedade item renomeado.

Notas

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

  • rnp

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