PowerShell Cmdlet - New-ItemProperty
 記事記号:[mg1926] 初版:2011/Sep/30

この文書は、Windows PowerShellのヘルプ機能で表示される内容を再構成したものです。

名前
    New-ItemProperty
    
概要
    項目の新しいプロパティを作成し、その値を設定します。たとえば、New-ItemProper
    ty を使用して、レジストリの値とデータの作成および変更を行うことができます。
    レジストリの値とデータはレジストリ キーのプロパティになります。
    
構文
    New-ItemProperty [-LiteralPath] <string[]> [-Name] <string> [-Credential <PS
    Credential>] [-Exclude <string[]>] [-Filter <string>] [-Force] [-Include <st
    ring[]>] [-PropertyType <string>] [-Value <Object>] [-Confirm] [-WhatIf] [-U
    seTransaction] [<CommonParameters>]
    
    New-ItemProperty [-Path] <string[]> [-Name] <string> [-Credential <PSCredent
    ial>] [-Exclude <string[]>] [-Filter <string>] [-Force] [-Include <string[]>
    ] [-PropertyType <string>] [-Value <Object>] [-Confirm] [-WhatIf] [-UseTrans
    action] [<CommonParameters>]
    
説明
    New-ItemProperty コマンドレットは、指定された項目に新しいプロパティを作成し、
    その値を設定します。通常、レジストリ値がレジストリ キー項目のプロパティにな
    るため、このコマンドレットを使用して新しいレジストリ値が作成されます。
    
    このコマンドレットではプロパティがオブジェクトに追加されません。オブジェクト
    のインスタンスにプロパティを追加するには、Add-Member コマンドレットを使用し
    ます。特定の種類のすべてのオブジェクトにプロパティを追加するには、Types.ps1
    xml ファイルを編集します。

パラメーター
    -Credential <PSCredential>
        この処理を実行するアクセス許可を持つユーザー アカウントを指定します。既
        定値は現在のユーザーです。
        
        "User01" や "Domain01\User01" のようなユーザー名を入力するか、Get-Crede
        ntial コマンドレットで生成されるような PSCredential オブジェクトを入力し
        ます。ユーザー名を入力すると、パスワードの入力を促すメッセージが表示され
        ます。
        
        このパラメーターは、Windows PowerShell でインストールされるプロバイダー
        ではサポートされていません。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   true (ByPropertyName)
        ワイルドカード文字を許可する false
        
    -Exclude <string[]>
        指定した項目を除外します。ワイルドカードを使用できます。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Filter <string>
        プロバイダーの形式や言語でフィルターを指定します。このパラメーターの値は、
        Path パラメーターを修飾します。
        
        ワイルドカードを使用できるかどうかなど、フィルターの構文はプロバイダーに
        よって異なります。フィルターは他のパラメーターよりも効率が良い方法です。
        これは、オブジェクトを取得した後に Windows PowerShell がオブジェクトをフ
        ィルターするのではなく、オブジェクトを取得する際にプロバイダーがフィルタ
        ーを適用するためです。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Force [<SwitchParameter>]
        設定しないとユーザーがアクセスできないオブジェクトのプロパティをコマンド
        レットで作成できるようにします。実装はプロバイダーごとに異なります。詳細
        については、「about_Providers」を参照してください。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Include <string[]>
        このパラメーターの値は、Path パラメーターを修飾します。"*.txt" などのパ
        ス要素またはパターンを入力します。ワイルドカードを使用できます。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -LiteralPath <string[]>
        項目プロパティへのパスを指定します。LiteralPath の値は、入力した内容のま
        ま使用されます。ワイルドカードとして解釈される文字はありません。パスにエ
        スケープ文字が含まれている場合は、単一引用符で囲みます。単一引用符で囲ん
        だ文字はエスケープ シーケンスとして解釈されません。
        
        必須                         true
        位置                         1
        既定値                       
        パイプライン入力を許可する   true (ByPropertyName)
        ワイルドカード文字を許可する false
        
    -Name <string>
        新しいプロパティの名前を指定します。プロパティがレジストリ エントリであ
        る場合、このパラメーターはエントリの名前を指定します。
        
        必須                         true
        位置                         2
        既定値                       
        パイプライン入力を許可する   true (ByPropertyName)
        ワイルドカード文字を許可する false
        
    -Path <string[]>
        項目のパスを指定します。このパラメーターは、新しいプロパティが追加され
        る項目を識別します。
        
        必須                         true
        位置                         1
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -PropertyType <string>
        追加するプロパティの種類を指定します。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   true (ByPropertyName)
        ワイルドカード文字を許可する false
        
    -Value <Object>
        プロパティ値を指定します。プロパティがレジストリ エントリである場合、こ
        のパラメーターはエントリの値を指定します。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   true (ByPropertyName)
        ワイルドカード文字を許可する false
        
    -Confirm [<SwitchParameter>]
        コマンドを実行する前に確認メッセージを表示します。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -WhatIf [<SwitchParameter>]
        実際にコマンドを実行せずに、コマンドを実行すると何が起きるかを出力します。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -UseTransaction [<SwitchParameter>]
        コマンドを有効なトランザクションに含めます。このパラメーターは、トランザ
        クションの進行中のみ有効です。詳細については、「about_Transactions」を参
        照してください。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    <CommonParameters>
        このコマンドレットは、次の共通パラメーターをサポートします: Verbose、
        Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、
        OutBuffer、および OutVariable。詳細については、
        「get-help about_commonparameters」と入力してヘルプを参照してください。
    
入力
    なし
        パイプを使用して入力を New-ItemProperty に渡すことはできません。
    
出力
    System.Management.Automation.PSCustomObject
        New-ItemProperty は、新しいプロパティを格納するカスタム オブジェクトを返
        します。
    
メモ
        New-ItemProperty コマンドレットは、プロバイダーによって公開されているデ
        ータを使用するように設計されています。セッションで使用可能なプロバイダー
        の一覧を表示するには、「Get-PSProvider」と入力します。詳細については、「
        about_Providers」を参照してください。
    
    -------------------------- 例 1 --------------------------
    
    C:\PS>new-itemproperty -path HKLM:\Software\MyCompany -name NoOfEmployees -v
    alue 822
    
    C:\PS> get-itemproperty hklm:\software\mycompany
    
    PSPath        : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\softw
                    are\mycompany
    PSParentPath  : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\softw
                    are
    PSChildName   : mycompany
    PSDrive       : HKLM
    PSProvider    : Microsoft.PowerShell.Core\Registry
    NoOfLocations : 2
    NoOfEmployees : 822
    
    説明
    -----------
    このコマンドは、新しいレジストリ エントリ NoOfEmployees を HKLM:\Software ハ
    イブの MyCompany キーに追加します。
    
    最初のコマンドは Path パラメーターを使用して、MyCompany レジストリ キーのパ
    スを指定します。また、エントリの名前の指定には Name パラメーター、その値の指
    定には Value パラメーターをそれぞれ使用します。
    
    2 番目のコマンドは、Get-ItemProperty コマンドレットを使用して、新しいレジス
    トリ エントリを表示します。
    
    -------------------------- 例 2 --------------------------
    
    C:\PS>get-item -path HKLM:\Software\MyCompany | new-Itemproperty -name NoOfL
    ocations -value 3
    
    説明
    -----------
    このコマンドは、新しいレジストリ エントリをレジストリ キーに追加します。キー
    を指定するには、パイプライン演算子 (|) を使用してキーを表すオブジェクトを Ne
    w-ItemProperty コマンドレットに送信します。
    
    コマンドの最初の部分は Get-Item コマンドレットを使用して、MyCompany レジスト
    リ キーを取得します。パイプライン演算子 (|) はコマンドの結果を New-ItemPrope
    rty コマンドレットに送信し、新しいレジストリ エントリ NoOfLocations およびそ
    の値となる 3 が MyCompany キーに追加されます。
    
    このコマンドが実行されるのは、Windows PowerShell のパラメーター バインド機能
    では Get-Item が返す RegistryKey オブジェクトのパスが New-ItemProperty の Li
    teralPath パラメーターと関連付けられるからです。詳細については、「about_Pipe
    lines」を参照してください。
    
関連するリンク
    Online version: http://go.microsoft.com/fwlink/?LinkID=113354
    about_Providers 
    Clear-ItemProperty 
    Copy-ItemProperty 
    Move-ItemProperty 
    Rename-ItemProperty 
    Get-ItemProperty 
    Set-ItemProperty 
    Remove-ItemProperty 
    	
記事で解説しているパソコンの環境
 基本ソフト: Windows 7
 キーワード: Windows PowerShell、ヘルプ、Cmdlet、New-ItemProperty
ご利用数: 1912612
感想・要望・問い合わせは こちら