Rename-Item

参考

模块:: Microsoft.PowerShell.Management

重命名 PowerShell 提供程序命名空间中的项。

语法

Rename-Item
      [-Path] <String>
      [-NewName] <String>
      [-Force]
      [-PassThru]
      [-Credential <PSCredential>]
      [-WhatIf]
      [-Confirm] 
      [<CommonParameters>]

Rename-Item
      -LiteralPath <String>
      [-NewName] <String>
      [-Force]
      [-PassThru]
      [-Credential <PSCredential>]
      [-WhatIf]
      [-Confirm] 
      [<CommonParameters>]

说明

Rename-Item cmdlet 更改指定项的名称。此 cmdlet 不会影响正在重命名的项的内容。

不能使用 Rename-Item 来移动项，例如通过指定路径以及新名称。若要移动和重命名项，请使用 Move-Item cmdlet。

示例

示例 1：重命名文件

此命令将文件 daily_file.txt 重命名为 monday_file.txt。

Rename-Item -Path "c:\logfiles\daily_file.txt" -NewName "monday_file.txt"

示例 2：重命名和移动项

不能使用 Rename-Item 来重命名和移动项。具体而言，不能提供 NewName 参数值的路径，除非路径与 Path 参数中指定的路径相同。否则，只允许使用新名称。

Rename-Item -Path "project.txt" -NewName "d:\archive\old-project.txt"

Rename-Item : can't rename because the target specified represents a path or device name.
At line:1 char:12
+ Rename-Item <<<<  -path project.txt -NewName d:\archive\old-project.txt
+ CategoryInfo          : InvalidArgument: (:) [Rename-Item], PS>  Move-Item -Path "project.txt" -De
stination "d:\archive\old-project.txt"

此示例尝试将当前目录中的 project.txt 文件重命名为 D:\Archive 目录中的 old-project.txt。结果是输出中显示的错误。

请改用 Move-Item cmdlet。

示例 3：重命名注册表项

本示例将广告的注册表项重命名为 Marketing。命令完成后，将重命名密钥，但密钥中的注册表项保持不变。

Rename-Item -Path "HKLM:\Software\MyCompany\Advertising" -NewName "Marketing"

示例 4：重命名多个文件

此示例将当前目录中的所有 *.txt 文件重命名为 *.log。

Get-ChildItem *.txt

Directory: C:\temp\files

Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        10/3/2019   7:47 AM           2918 Friday.TXT
-a----        10/3/2019   7:46 AM           2918 Monday.Txt
-a----        10/3/2019   7:47 AM           2918 Wednesday.txt

Get-ChildItem *.txt | Rename-Item -NewName { $_.Name -replace '.txt','.log' }
Get-ChildItem *.log

Directory: C:\temp\files

Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        10/3/2019   7:47 AM           2918 Friday.log
-a----        10/3/2019   7:46 AM           2918 Monday.log
-a----        10/3/2019   7:47 AM           2918 Wednesday.log

Get-ChildItem cmdlet 获取当前文件夹中具有 .txt 文件扩展名的所有文件，然后通过管道将其传递给 Rename-Item。 NewName 的值是在将值提交到 NewName 参数之前运行的脚本块。

在脚本块中，$_ 自动变量表示通过管道访问命令时的每个文件对象。脚本块使用 -replace 运算符将每个文件的文件扩展名替换为 .log。请注意，使用 -replace 运算符进行匹配并不区分大小写。

参数

-Confirm

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

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

-Credential

注意

任何随 PowerShell 一起安装的提供程序都不支持此参数。若要模拟其他用户，或在运行此 cmdlet 时提升凭据，请使用 Invoke-Command。

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

-Force

强制 cmdlet 重命名无法更改的项，例如隐藏或只读文件或只读别名或变量。 cmdlet 无法更改常量别名或变量。实现因提供程序而异。有关详细信息，请参阅 about_Providers。

即使使用 Force 参数，cmdlet 也不能替代安全限制。

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

-LiteralPath

指定一个或多个位置的路径。 LiteralPath 的值与类型化完全相同。不会将任何字符解释为通配符。如果路径包含转义字符，请将它括在单引号中。单引号告知 PowerShell 不要将任何字符解释为转义序列。

有关详细信息，请参阅 about_Quoting_Rules。

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

-NewName

指定项的新名称。仅输入一个名称，而不是路径和名称。如果输入的路径与 Path 参数中指定的路径不同，Rename-Item 将生成错误。若要重命名和移动项，请使用 Move-Item。

不能在 NewName 参数的值中使用通配符。若要为多个文件指定名称，请在正则表达式中使用 Replace 运算符。有关 Replace 运算符的详细信息，请参阅 about_Comparison_Operators。

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

-PassThru

返回一个对象，该对象表示管道中的项。默认情况下，此 cmdlet 不生成任何输出。

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

-Path

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

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

-WhatIf

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

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

输入

String

可以通过管道传递包含此 cmdlet 路径的字符串。

输出

None

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

PSObject

使用 PassThru 参数时，此 cmdlet 返回表示重命名项的对象。

备注

PowerShell 包含以下 Rename-Item别名：

所有平台：
- ren
- rni

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

通过