Rename-ItemProperty

重命名项的属性。

语法

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>]

说明

Rename-ItemProperty cmdlet 更改指定项属性的名称。 属性的值不会更改。 例如,可以使用 Rename-ItemProperty 更改注册表项的名称。

示例

示例 1:重命名注册表项

此命令将“HKEY_LOCAL_MACHINE\Software\SmpApplication”项中包含的配置注册表项重命名为“oldconfig”。

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

参数

-Confirm

在运行 cmdlet 之前,提示你进行确认。

类型:SwitchParameter
别名:cf
Position:Named
默认值:False
必需:False
接受管道输入:False
接受通配符:False

-Credential

指定有权执行此作的用户帐户。 默认值为当前用户。

键入用户名(如“User01”或“Domain01\User01”),或输入 PSCredential 对象,例如由 Get-Credential cmdlet 生成的用户名。 如果键入用户名,系统会提示输入密码。

警告

随 Windows PowerShell 一起安装的任何提供程序都不支持此参数。

类型:PSCredential
Position:Named
默认值:Current user
必需:False
接受管道输入:True
接受通配符:False

-Exclude

指定此 cmdlet 省略的项。 此参数的值限定 Path 参数。 输入路径元素或模式,例如“*.txt”。 允许使用通配符。

类型:String[]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:True

-Filter

以提供程序的格式或语言指定筛选器。 此参数的值限定 Path 参数。

筛选器的语法(包括通配符的使用)取决于提供程序。 筛选器比其他参数更有效,因为提供程序在 cmdlet 获取对象时应用它们,而不是在检索对象后让 PowerShell 筛选对象。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:True

-Force

强制 cmdlet 重命名用户无法访问的对象的属性。 实现因提供程序而异。 有关详细信息,请参阅 about_Providers

类型:SwitchParameter
Position:Named
默认值:False
必需:False
接受管道输入:False
接受通配符:False

-Include

仅指定 cmdlet 对其执行作的那些项,不包括所有其他项。 此参数的值限定 Path 参数。 输入路径元素或模式,例如“*.txt”。 允许使用通配符。

类型:String[]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:True

-LiteralPath

指定项的路径。 与 Path 参数不同,LiteralPath 的值与键入时完全相同。 不会将任何字符解释为通配符。 如果路径包含转义字符,请将它括在单引号中。 单引号告知 PowerShell 不要将任何字符解释为转义序列。

类型:String
别名:PSPath
Position:Named
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-Name

指定要重命名的属性的当前名称。

类型:String
别名:PSProperty
Position:1
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-NewName

指定属性的新名称。

类型:String
Position:2
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-PassThru

返回一个表示项属性的对象。 默认情况下,此 cmdlet 不生成任何输出。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Path

指定项的路径。

类型:String
Position:0
默认值:None
必需:True
接受管道输入:True
接受通配符:True

-UseTransaction

在活动事务中包含该命令。 此参数仅在事务正在进行时有效。 有关详细信息,请参阅 about_Transactions

类型:SwitchParameter
别名:usetx
Position:Named
默认值:False
必需:False
接受管道输入:False
接受通配符:False

-WhatIf

显示 cmdlet 运行时会发生什么情况。 cmdlet 未运行。

类型:SwitchParameter
别名:wi
Position:Named
默认值:False
必需:False
接受管道输入:False
接受通配符:False

输入

String

可以通过管道将包含路径(而不是文本路径)的字符串传递给此 cmdlet。

输出

None

默认情况下,此 cmdlet 不返回任何输出。

PSCustomObject

使用 PassThru 参数时,此 cmdlet 将返回表示重命名的项属性的 PSCustomObject

备注

Windows PowerShell 包含以下 Rename-ItemProperty别名:

  • rnp

Rename-ItemProperty 旨在处理任何提供程序公开的数据。 若要列出会话中可用的提供程序,请键入 Get-PSProvider。 有关详细信息,请参阅 about_Providers