Rename-ItemProperty

  • 参考
模块:
Microsoft.PowerShell.Management

重命名项的属性。

语法

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”项中的 config 注册表条目重命名为“oldconfig”。

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

参数

-Confirm

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

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

-Credential

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

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

警告

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

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

-Exclude

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

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

-Filter

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

筛选器的语法（包括通配符字符的使用），具体取决于提供程序。 筛选器比其他参数更有效，因为提供程序是在 cmdlet 获取对象时应用筛选器，而不是在检索对象后再让 PowerShell 筛选对象。

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

-Force

强制该 cmdlet 重命名用户不能以其他方式访问的对象属性。 不同提供程序有不同的实现。 有关详细信息，请参阅 about_Providers。

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

-Include

指定 cmdlet 只对这些项执行操作，排除其他所有项。 此参数值使 Path 参数有效。 请输入路径元素或模式，例如“*.txt”。 允许使用通配符。

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

-LiteralPath

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

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

-Name

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

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

-NewName

指定属性的新名称。

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

-PassThru

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

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

-Path

指定项的路径。

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

-UseTransaction

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

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

-WhatIf

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

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

输入

String

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

输出

None

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

PSCustomObject

如果使用 PassThru 参数，则此 cmdlet 返回一个 PSCustomObject 对象，该对象表示已重命名的项属性。

备注

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

  • rnp

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