Rename-ItemProperty

  • 參考
模組:
Microsoft.PowerShell.Management

重新命名項目的屬性。

Syntax

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

Description

Cmdlet 會 Rename-ItemProperty 變更指定項目屬性的名稱。 屬性的值不會變更。 例如，您可以使用 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 物件，例如 Cmdlet 所產生的 Get-Credential 用戶名稱。 如果您輸入使用者名稱，系統會提示您輸入密碼。

警告

任何與 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。