Set-ItemProperty

モジュール:

Microsoft.PowerShell.Management

項目のプロパティの値を作成または変更します。

構文

Set-ItemProperty
   [-Path] <string[]>
   [-Name] <string>
   [-Value] <Object>
   [-PassThru]
   [-Force]
   [-Filter <string>]
   [-Include <string[]>]
   [-Exclude <string[]>]
   [-Credential <pscredential>]
   [-WhatIf]
   [-Confirm]
   [-UseTransaction]
   [<CommonParameters>]

Set-ItemProperty
   [-Path] <string[]>
   -InputObject <psobject>
   [-PassThru]
   [-Force]
   [-Filter <string>]
   [-Include <string[]>]
   [-Exclude <string[]>]
   [-Credential <pscredential>]
   [-WhatIf]
   [-Confirm]
   [-UseTransaction]
   [<CommonParameters>]

Set-ItemProperty
   [-Name] <string>
   [-Value] <Object>
   -LiteralPath <string[]>
   [-PassThru]
   [-Force]
   [-Filter <string>]
   [-Include <string[]>]
   [-Exclude <string[]>]
   [-Credential <pscredential>]
   [-WhatIf]
   [-Confirm]
   [-UseTransaction]
   [<CommonParameters>]

Set-ItemProperty
   -LiteralPath <string[]>
   -InputObject <psobject>
   [-PassThru]
   [-Force]
   [-Filter <string>]
   [-Include <string[]>]
   [-Exclude <string[]>]
   [-Credential <pscredential>]
   [-WhatIf]
   [-Confirm]
   [-UseTransaction]
   [<CommonParameters>]

Set-ItemProperty
   [-Path] <string[]>
   [-Name] <string>
   [-Value] <Object>
   [-PassThru]
   [-Force]
   [-Filter <string>]
   [-Include <string[]>]
   [-Exclude <string[]>]
   [-Credential <pscredential>]
   [-WhatIf]
   [-Confirm]
   [-UseTransaction]
   [-Type <RegistryValueKind>]
   [<CommonParameters>]

Set-ItemProperty
   [-Path] <string[]>
   -InputObject <psobject>
   [-PassThru]
   [-Force]
   [-Filter <string>]
   [-Include <string[]>]
   [-Exclude <string[]>]
   [-Credential <pscredential>]
   [-WhatIf]
   [-Confirm]
   [-UseTransaction]
   [-Type <RegistryValueKind>]
   [<CommonParameters>]

Set-ItemProperty
   [-Name] <string>
   [-Value] <Object>
   -LiteralPath <string[]>
   [-PassThru]
   [-Force]
   [-Filter <string>]
   [-Include <string[]>]
   [-Exclude <string[]>]
   [-Credential <pscredential>]
   [-WhatIf]
   [-Confirm]
   [-UseTransaction]
   [-Type <RegistryValueKind>]
   [<CommonParameters>]

Set-ItemProperty
   -LiteralPath <string[]>
   -InputObject <psobject>
   [-PassThru]
   [-Force]
   [-Filter <string>]
   [-Include <string[]>]
   [-Exclude <string[]>]
   [-Credential <pscredential>]
   [-WhatIf]
   [-Confirm]
   [-UseTransaction]
   [-Type <RegistryValueKind>]
   [<CommonParameters>]

説明

Set-ItemProperty コマンドレットは、指定した項目のプロパティの値を変更します。 コマンドレットを使用して、項目のプロパティを作成または変更できます。 たとえば、 Set-ItemProperty を使用して、ファイル オブジェクトの IsReadOnly プロパティの値を $Trueに設定できます。

Set-ItemPropertyを使用して、レジストリ値とデータを作成および変更することもできます。 たとえば、新しいレジストリ エントリをキーに追加し、その値を設定または変更できます。

例

例 1: ファイルのプロパティを設定する

このコマンドは、"final.doc" ファイルの IsReadOnly プロパティの値を "true" に設定します。 Path を使用してファイルを指定し、Name プロパティの名前を指定し、Value パラメーターを使用して新しい値を指定します。

ファイルは System.IO.FileInfo オブジェクトであり、 IsReadOnly はそのプロパティの 1 つです。 すべてのプロパティを表示するには、「 Get-Item C:\GroupFiles\final.doc | Get-Member -MemberType Property」と入力します。

$true自動変数は、"TRUE" の値を表します。 詳細については、「about_Automatic_Variables」を参照してください。

Set-ItemProperty -Path C:\GroupFiles\final.doc -Name IsReadOnly -Value $true

例 2: レジストリ エントリと値を作成する

この例では、 Set-ItemProperty を使用して新しいレジストリ エントリを作成し、エントリに値を割り当てる方法を示します。 HKLM\Software キーの "ContosoCompany" キーに "NoOfEmployees" エントリを作成し、その値を 823 に設定します。

レジストリ エントリは、項目であるレジストリ キーのプロパティと見なされるため、 Set-ItemProperty を使用してレジストリ エントリを作成し、その値を確立および変更します。

Set-ItemProperty -Path "HKLM:\Software\ContosoCompany" -Name "NoOfEmployees" -Value 823
Get-ItemProperty -Path "HKLM:\Software\ContosoCompany"

PSPath        : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\software\contosocompany
PSParentPath  : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\software
PSChildName   : contosocompany
PSDrive       : HKLM
PSProvider    : Microsoft.PowerShell.Core\Registry
NoOfLocations : 2
NoOfEmployees : 823

Set-ItemProperty -Path "HKLM:\Software\ContosoCompany" -Name "NoOfEmployees" -Value 824
Get-ItemProperty -Path "HKLM:\Software\ContosoCompany"

PSPath        : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\software\contosocompany
PSParentPath  : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\software
PSChildName   : contosocompany
PSDrive       : HKLM
PSProvider    : Microsoft.PowerShell.Core\Registry
NoOfLocations : 2
NoOfEmployees : 824

最初のコマンドは、レジストリ エントリを作成します。 Path を使用して、HKLM: ドライブのパスとSoftware\MyCompany キーを指定します。 このコマンドでは、 Name を使用してエントリ名を指定し、 Value を使用して値を指定します。

2 番目のコマンドでは、 Get-ItemProperty コマンドレットを使用して新しいレジストリ エントリを表示します。 Get-ItemまたはGet-ChildItemコマンドレットを使用する場合、項目または子項目ではなく、キーのプロパティであるため、エントリは表示されません。

3 番目のコマンドは、 NoOfEmployees エントリの値を 824 に変更します。

New-ItemProperty コマンドレットを使用してレジストリ エントリとその値を作成し、Set-ItemPropertyを使用して値を変更することもできます。

HKLM: ドライブの詳細については、「Get-Help Get-PSDrive」と入力します。 PowerShell を使用してレジストリを管理する方法の詳細については、「 Get-Help Registry」と入力します。

例 3: パイプラインを使用して項目を変更する

次の例では、 Get-ChildItem を使用して weekly.txt ファイルを取得します。 ファイル オブジェクトは、 Set-ItemPropertyにパイプ処理されます。 Set-ItemProperty コマンドでは、Name パラメーターと Value パラメーターを使用して、プロパティとその新しい値を指定します。

Get-ChildItem weekly.txt | Set-ItemProperty -Name IsReadOnly -Value $True

パラメーター

-Confirm

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

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

-Credential

Note

このパラメーターは、PowerShell でインストールされているプロバイダーではサポートされていません。 別のユーザーを偽装したり、このコマンドレットの実行時に資格情報を昇格したりするには、 Invoke-Command を使用します。

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

-Exclude

文字列配列として、このコマンドレットが操作で除外する項目を指定します。 このパラメーターの値は、 Path パラメーターを修飾します。 パス要素またはパターン ( *.txtなど) を入力します。 ワイルドカード文字を使用できます。 Exclude パラメーターは、コマンドに項目の内容 (ワイルドカード文字がC:\Windows ディレクトリの内容を指定するC:\Windows\*など) が含まれている場合にのみ有効です。

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

-Filter

Path パラメーターを修飾するフィルターを指定します。 FileSystem プロバイダーは、フィルターの使用をサポートする唯一のインストール済み PowerShell プロバイダーです。 FileSystem フィルター言語の構文は、about_Wildcardsにあります。 フィルターは、取得後に PowerShell でオブジェクトをフィルター処理するのではなく、コマンドレットがオブジェクトを取得するときにプロバイダーによって適用されるため、他のパラメーターよりも効率的です。

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

-Force

ユーザーがアクセスできない項目に対してプロパティを設定するようにコマンドレットに強制します。 実装はプロバイダーによって異なります。 詳細については、「 about_Providers」を参照してください。

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

-Include

文字列配列として、このコマンドレットが操作に含める項目を指定します。 このパラメーターの値は、 Path パラメーターを修飾します。 パス要素またはパターン ( "*.txt"など) を入力します。 ワイルドカード文字を使用できます。 Include パラメーターは、コマンドに項目の内容 (ワイルドカード文字がC:\Windows ディレクトリの内容を指定するC:\Windows\*など) が含まれている場合にのみ有効です。

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

-InputObject

このコマンドレットが変更するプロパティを持つオブジェクトを指定します。 オブジェクトが格納されている変数、またはオブジェクトを取得するコマンドを入力します。

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

-LiteralPath

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

詳細については、「 about_Quoting_Rules」を参照してください。

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

-Name

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

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

-PassThru

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

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

-Path

変更するプロパティを持つ項目のパスを指定します。 ワイルドカード文字を使用できます。

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

-Type

これは、 Registry プロバイダーによって使用できる動的パラメーターです。 Registry プロバイダーとこのパラメーターは、Windows でのみ使用できます。

このコマンドレットが追加するプロパティの種類を指定します。 このパラメーターの有効値は、次のとおりです。

• String: null で終わる文字列を指定します。 REG_SZ値に使用されます。
• ExpandString: 値の取得時に展開される環境変数への展開されていない参照を含む null で終わる文字列を指定します。 REG_EXPAND_SZ値に使用されます。
• Binary: 任意の形式のバイナリ データを指定します。 REG_BINARY値に使用されます。
• DWord: 32 ビットの 2 進数を指定します。 REG_DWORD値に使用されます。
• MultiString: 2 つの null 文字で終わる null で終わる文字列の配列を指定します。 REG_MULTI_SZ値に使用されます。
• Qword: 64 ビットの 2 進数を指定します。 REG_QWORD値に使用されます。
• Unknown: REG_RESOURCE_LIST 値など、サポートされていないレジストリ データ型を示します。

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

-UseTransaction

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

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

-Value

プロパティの値を指定します。

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

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

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

入力

PSObject

このコマンドレットにオブジェクトをパイプできます。

出力

None

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

PSCustomObject

PassThru パラメーターを使用すると、このコマンドレットは、変更された項目とその新しいプロパティ値を表すPSCustomObject オブジェクトを返します。

メモ

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

• sp

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

関連リンク

• Clear-ItemProperty
• Copy-ItemProperty
• Get-ItemProperty
• Move-ItemProperty
• New-ItemProperty
• Remove-ItemProperty
• Rename-ItemProperty
• about_Providers