重命名项的属性。

语法

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

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

说明

Rename-ItemProperty cmdlet 更改指定项属性的名称。属性的值未更改。例如，可以使用 Rename-ItemProperty 更改注册表条目的名称。

参数

-Credential <PSCredential>

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

键入用户名，如“User01”或“Domain01\User01”；或输入 PSCredential 对象，如 Get-Credential cmdlet 输入的一个 PSCredential 对象。如果键入用户名，则将提示您输入密码。

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

是否为必需？

false

位置？

named

默认值

是否接受管道输入？

true (ByPropertyName)

是否接受通配符？

false

-Exclude <string[]>

忽略指定项。允许使用通配符。

是否为必需？

false

位置？

named

默认值

是否接受管道输入？

false

是否接受通配符？

false

-Filter <string>

以提供程序的格式或语言指定筛选器。此参数的值对 Path 参数进行限定。筛选器的语法（包括通配符的使用）取决于提供程序。筛选器比其他参数更有效，因为提供程序是在检索对象时应用筛选器，而不是在检索对象后再由 Windows PowerShell 筛选对象。

是否为必需？

false

位置？

named

默认值

是否接受管道输入？

false

是否接受通配符？

false

-Force

允许该 cmdlet 重命名用户非此不能访问的对象的属性。不同提供程序有不同的实现。有关详细信息，请参阅 about_Providers。

是否为必需？

false

位置？

named

默认值

是否接受管道输入？

false

是否接受通配符？

false

-Include <string[]>

指定 cmdlet 只对这些项执行操作，排除其他所有项。

是否为必需？

false

位置？

named

默认值

是否接受管道输入？

false

是否接受通配符？

false

-LiteralPath <string>

指定指向项属性的路径。LiteralPath 的值严格按照所键入的形式使用。不会将任何字符解释为通配符。如果路径包括转义符，请将其括在单引号中。单引号会告知 Windows PowerShell 不要将所有字符都解释为转义序列。

是否为必需？

true

位置？

1

默认值

是否接受管道输入？

true (ByPropertyName)

是否接受通配符？

false

-Name <string>

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

是否为必需？

true

位置？

2

默认值

是否接受管道输入？

true (ByPropertyName)

是否接受通配符？

false

-NewName <string>

指定属性的新名称。

是否为必需？

true

位置？

3

默认值

是否接受管道输入？

true (ByPropertyName)

是否接受通配符？

false

-PassThru

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

是否为必需？

false

位置？

named

默认值

是否接受管道输入？

false

是否接受通配符？

false

-Path <string>

指定要重新命名的项的路径。

是否为必需？

true

位置？

1

默认值

是否接受管道输入？

true (ByValue, ByPropertyName)

是否接受通配符？

false

-Confirm

在执行命令之前提示您进行确认。

是否为必需？

false

位置？

named

默认值

是否接受管道输入？

false

是否接受通配符？

false

-WhatIf

描述如果执行该命令会发生什么情况（无需实际执行该命令）。

是否为必需？

false

位置？

named

默认值

是否接受管道输入？

false

是否接受通配符？

false

-UseTransaction

将命令包含在活动事务中。仅当正在执行事务时，此参数才有效。有关详细信息，请参阅 about_Transactions。

是否为必需？

false

位置？

named

默认值

是否接受管道输入？

false

是否接受通配符？

false

<CommonParameters>

此 cmdlet 支持通用参数：-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer 和 -OutVariable。有关详细信息，请参阅 about_Commonparameters.

输入和输出

输入类型是指可通过管道传递给 cmdlet 的对象的类型。返回类型是指 Cmdlet 所返回对象的类型。

输入

System.String

可以通过管道将包含路径（但不是文本路径）的字符串传递给 Rename-ItemProperty。

输出

None 或 System.Management.Automation.PSCustomObject

如果使用 PassThru 参数，则 Rename-ItemProperty 生成一个 PSCustomObject 对象，该对象表示已重命名的项属性。否则，此 cmdlet 将不产生任何输出。

说明

Remove-ItemProperty cmdlet 用于处理由任何提供程序公开的数据。要列出会话中可用的提供程序，请键入“Get-PSProvider”。有关详细信息，请参阅 about_Providers。

示例 1

C:\PS>rename-itemproperty -path HKLM:\Software\SmpApplication -name config -newname oldconfig

说明
-----------
此命令将包含在 HKEY_LOCAL_MACHINE\Software\SmpApplication 项中的 config 注册表条目重命名为 oldconfig。

另请参阅



目录