Rename-ItemProperty

[アーティクル]
10/30/2009

項目のプロパティの名前を変更します。

構文

Rename-ItemProperty [-LiteralPath] <string> [-Name] <string> [-NewName] <string> [-Credential <PSCredential>] [-Exclude <string[]>] [-Filter <string>] [-Force] [-Include <string[]>] [-PassThru] [-Confirm] [-WhatIf] [-UseTransaction] [<CommonParameters>]

Rename-ItemProperty [-Path] <string> [-Name] <string> [-NewName] <string> [-Credential <PSCredential>] [-Exclude <string[]>] [-Filter <string>] [-Force] [-Include <string[]>] [-PassThru] [-Confirm] [-WhatIf] [-UseTransaction] [<CommonParameters>]

説明

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

パラメーター

-Credential <PSCredential>

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

"User01" や "Domain01\User01" のようなユーザー名を入力するか、Get-Credential コマンドレットで生成されるような PSCredential オブジェクトを入力します。ユーザー名を入力すると、パスワードの入力を促すメッセージが表示されます。

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

必須	false
位置	named
既定値
パイプライン入力を許可する	true (ByPropertyName)
ワイルドカード文字を許可する	false

-Exclude <string[]>

指定した項目を除外します。ワイルドカードを使用できます。

必須	false
位置	named
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-Filter <string>

プロバイダーの形式や言語でフィルターを指定します。このパラメーターの値は、Path パラメーターを修飾します。ワイルドカードを使用できるかどうかなど、フィルターの構文はプロバイダーによって異なります。フィルターは他のパラメーターよりも効率が良い方法です。これは、オブジェクトを取得した後に Windows PowerShell がオブジェクトをフィルターするのではなく、オブジェクトを取得する際にプロバイダーがフィルターを適用するためです。

必須	false
位置	named
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-Force

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

必須	false
位置	named
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-Include <string[]>

コマンドレットの処理対象とする項目を指定し、それ以外の項目は除外します。

必須	false
位置	named
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-LiteralPath <string>

項目プロパティへのパスを指定します。LiteralPath の値は、入力した内容のまま使用されます。ワイルドカードとして解釈される文字はありません。パスにエスケープ文字が含まれている場合は、単一引用符で囲みます。単一引用符で囲んだ文字はエスケープシーケンスとして解釈されません。

必須	true
位置	1
既定値
パイプライン入力を許可する	true (ByPropertyName)
ワイルドカード文字を許可する	false

-Name <string>

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

必須	true
位置	2
既定値
パイプライン入力を許可する	true (ByPropertyName)
ワイルドカード文字を許可する	false

-NewName <string>

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

必須	true
位置	3
既定値
パイプライン入力を許可する	true (ByPropertyName)
ワイルドカード文字を許可する	false

-PassThru

項目プロパティを表すオブジェクトを返します。既定では、このコマンドレットによる出力はありません。

必須	false
位置	named
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-Path <string>

名前を変更する項目のパスを指定します。

必須	true
位置	1
既定値
パイプライン入力を許可する	true (ByValue, ByPropertyName)
ワイルドカード文字を許可する	false

-Confirm

コマンドを実行する前に確認メッセージを表示します。

必須	false
位置	named
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-WhatIf

実際にコマンドを実行せずに、コマンドを実行すると何が起きるかを出力します。

必須	false
位置	named
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-UseTransaction

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

必須	false
位置	named
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

<CommonParameters>

このコマンドレットは、次の共通パラメーターをサポートします: -Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable。詳細については、次を参照してください: about_Commonparameters.

入力と出力

入力値の型は、コマンドレットへのパイプが可能なオブジェクトの型です。戻り値の型は、コマンドレットによって返されるオブジェクトの型です。

入力

System.String

パイプを使用してパス (リテラルパスではない) を含む文字列を Rename-ItemProperty に渡すことができます。

出力

なし、または System.Management.Automation.PSCustomObject

PassThru パラメーターを使用する場合は、Rename-ItemProperty によって、名前が変更された項目のプロパティを表す PSCustomObject が生成されます。それ以外の場合、このコマンドレットによる出力はありません。

注

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

例 1

C:\PS>rename-itemproperty -path HKLM:\Software\SmpApplication -name config -newname oldconfig

説明
-----------
このコマンドを実行すると、HKEY_LOCAL_MACHINE\Software\SmpApplication キーに格納されているレジストリ エントリ config の名前が、oldconfig に変更されます。

次の方法で共有