Rename-Item

參考

模組:: Microsoft.PowerShell.Management

重新命名 PowerShell 提供者命名空間中的專案。

Syntax

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

Description

Cmdlet 會 Rename-Item 變更指定專案的名稱。這個 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 來重新命名和移動專案。具體來說，除非路徑與Path參數中指定的路徑相同，否則您無法提供NewName參數值的路徑。否則只允許新名稱。

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 為 old-project.txt 目錄中的 D:\Archive 檔案。結果是顯示在輸出中的錯誤。

請改用 Move-Item Cmdlet。

範例 3：重新命名登錄機碼

此範例會將登錄機碼從 Advertising 重新命名為 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

Cmdlet Get-ChildItem 會取得目前資料夾中具有 .txt 副檔名的所有檔案，然後將這些檔案傳送至 Rename-Item 。 NewName的值是在將值提交至NewName參數之前執行的腳本區塊。

在腳本區塊中 $_ ，自動變數代表每個檔案物件，因為它會透過管線傳入命令。腳本區塊會 -replace 使用運算子，將每個檔案的副檔名取代為 .log 。請注意，使用運算子比對 -replace 不區分大小寫。

參數

-Confirm

在執行 Cmdlet 前提示您確認。

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

-Credential

注意

任何與 PowerShell 一起安裝的提供者都不支援此參數。若要在執行此 Cmdlet 時模擬其他使用者，或提高您的認證，請使用 Invoke-Command。

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

-Force

強制 Cmdlet 重新命名無法變更的專案，例如隱藏或唯讀檔案或唯讀別名或變數。 Cmdlet 無法變更常數別名或變數。實作會依提供者而異。如需詳細資訊，請參閱 about_Providers。

即使使用 Force 參數，Cmdlet 也無法覆寫安全性限制。

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

-LiteralPath

指定一個或多個位置的路徑。 LiteralPath的值會與類型完全相同使用。沒有字元會被視為萬用字元。如果路徑包含逸出字元，請將它括在單引號中。單引號會指示 PowerShell 不要將任何字元解譯為逸出序列。

如需詳細資訊，請參閱 about_Quoting_Rules。

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

-NewName

指定項目的新名稱。只能輸入名稱，而非路徑和名稱。如果您輸入的路徑與 Path 參數中指定的路徑不同， Rename-Item 則會產生錯誤。若要重新命名和移動專案，請使用 Move-Item 。

您無法在 NewName 參數的值中使用萬用字元。若要指定多個檔案的名稱，請在正則運算式中使用 Replace 運算子。如需 Replace 運算子的詳細資訊，請參閱 about_Comparison_Operators。

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

-PassThru

傳回物件，表示管線的專案。根據預設，此 Cmdlet 不會產生任何輸出。

Type:	SwitchParameter
Position:	Named
Default value:	False
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:	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 or an object that represents the renamed item.

如果您指定 PassThru 參數，此 Cmdlet 會產生代表已重新命名專案的物件。否則，此 Cmdlet 不會產生任何輸出。

備註

Rename-Item 是設計來使用任何提供者所公開的資料。若要列出工作階段中可用的提供者，請輸入 Get-PsProvider。如需詳細資訊，請參閱 about_Providers。