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 コマンドレットは、指定した項目プロパティの名前を変更します。プロパティの値は変更されません。たとえば、Rename-ItemProperty を使用してレジストリエントリの名前を変更できます。

例

例 1: レジストリエントリの名前を変更する

このコマンドは、"HKEY_LOCAL_MACHINE\Software\SmpApplication" キーに含まれる構成レジストリエントリの名前を "oldconfig" に変更します。

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

パラメーター

-Confirm

コマンドレットを実行する前に確認を求めるメッセージが表示されます。

型:	SwitchParameter
Aliases:	cf
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Credential

このアクションを実行するアクセス許可を持つユーザーアカウントを指定します。既定値は現在のユーザーです。

"User01" や "Domain01\User01" などのユーザー名を入力するか、PSCredential オブジェクト (Get-Credential コマンドレットによって生成されたものなど) を入力します。ユーザー名を入力すると、パスワードの入力を求められます。

警告

このパラメーターは、Windows PowerShell でインストールされているプロバイダーではサポートされていません。

型:	PSCredential
配置:	Named
規定値:	Current user
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Exclude

このコマンドレットが省略する項目を指定します。このパラメーターの値は、Path パラメーターを修飾します。 "*.txt" などのパス要素またはパターンを入力します。ワイルドカード文字を使用できます。

型:	String[]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	True

-Filter

プロバイダーの形式または言語でフィルターを指定します。このパラメーターの値は、Path パラメーターを修飾します。

ワイルドカード文字の使用を含むフィルターの構文は、プロバイダーによって異なります。フィルターは、取得後に PowerShell でオブジェクトをフィルター処理するのではなく、コマンドレットがオブジェクトを取得するときにプロバイダーによって適用されるため、他のパラメーターよりも効率的です。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	True

-Force

ユーザーがアクセスできないオブジェクトのプロパティの名前をコマンドレットで強制的に変更します。実装はプロバイダーによって異なります。詳細については、about_Providersを参照してください。

型:	SwitchParameter
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Include

コマンドレットが動作する項目のみを指定します。他の項目はすべて除いています。このパラメーターの値は、Path パラメーターを修飾します。 "*.txt" などのパス要素またはパターンを入力します。ワイルドカード文字を使用できます。

型:	String[]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	True

-LiteralPath

項目へのパスを指定します。 Path パラメーターとは異なり、LiteralPath の値は、型指定されたとおりに使用されます。ワイルドカードとして解釈される文字はありません。パスにエスケープ文字が含まれている場合は、単一引用符で囲みます。単一引用符は、エスケープシーケンスとして文字を解釈しないように PowerShell に指示します。

型:	String
Aliases:	PSPath
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Name

名前を変更するプロパティの現在の名前を指定します。

型:	String
Aliases:	PSProperty
配置:	1
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-NewName

プロパティの新しい名前を指定します。

型:	String
配置:	2
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-PassThru

item プロパティを表すオブジェクトを返します。既定では、このコマンドレットは出力を生成しません。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Path

項目へのパスを指定します。

型:	String
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	True

-UseTransaction

アクティブなトランザクションにコマンドを含みます。このパラメーターは、トランザクションが進行中の場合にのみ有効です。詳細については、about_Transactionsを参照してください。

型:	SwitchParameter
Aliases:	usetx
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WhatIf

コマンドレットを実行した場合の動作を示します。コマンドレットは実行されません。

型:	SwitchParameter
Aliases:	wi
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

入力

String

リテラルパスではなくパスを含む文字列をこのコマンドレットにパイプできます。

出力

None

既定では、このコマンドレットは出力を返しません。

PSCustomObject

PassThru パラメーターを使用すると、このコマンドレットは、名前が変更された項目プロパティを表す PSCustomObject を返します。

メモ

Windows PowerShell には、Rename-ItemPropertyの次のエイリアスが含まれています。

rnp

Rename-ItemProperty は、任意のプロバイダーによって公開されるデータを操作するように設計されています。セッションで使用可能なプロバイダーを一覧表示するには、「Get-PSProvider」と入力します。詳細については、about_Providersを参照してください。