PowerShell Cmdlet - Set-Item
 記事記号:[mg1986] 初版:2011/Sep/30

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

名前
    Set-Item
    
概要
    項目の値を、コマンドで指定した値に変更します。
    
構文
    Set-Item [-LiteralPath] <string[]> [[-Value] <Object>] [-Credential <PSCrede
    ntial>] [-Exclude <string[]>] [-Filter <string>] [-Force] [-Include <string[
    ]>] [-PassThru] [-Confirm] [-WhatIf] [-UseTransaction] [<CommonParameters>]
    
    Set-Item [-Path] <string[]> [[-Value] <Object>] [-Credential <PSCredential>] 
    [-Exclude <string[]>] [-Filter <string>] [-Force] [-Include <string[]>] [-Pa
    ssThru] [-Confirm] [-WhatIf] [-UseTransaction] [<CommonParameters>]
    
説明
    Set-Item コマンドレットは、変数やレジストリ キーなどの項目の値を、コマンドで
    指定した値に変更します。

パラメーター
    -Credential <PSCredential>
        この処理を実行するアクセス許可を持つユーザー アカウントを指定します。既
        定値は現在のユーザーです。
        
        "User01" や "Domain01\User01" のようなユーザー名を入力するか、Get-Creden
        tial コマンドレットで生成されるような PSCredential オブジェクトを入力し
        ます。ユーザー名を入力すると、パスワードの入力を促すメッセージが表示され
        ます。
        
        このパラメーターは、Windows PowerShell でインストールされるプロバイダー
        ではサポートされていません。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   true (ByPropertyName)
        ワイルドカード文字を許可する false
        
    -Exclude <string[]>
        指定した項目を除外します。このパラメーターの値は、Path パラメーターを修
        飾します。"*.txt" などのパス要素またはパターンを入力します。ワイルドカー
        ドを使用できます。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Filter <string>
        プロバイダーの形式や言語でフィルターを指定します。このパラメーターの値は、
        Path パラメーターを修飾します。ワイルドカードを使用できるかどうかなど、
        フィルターの構文はプロバイダーによって異なります。フィルターは他のパラメ
        ーターよりも効率が良い方法です。これは、オブジェクトを取得した後に Windo
        ws PowerShell がオブジェクトをフィルターするのではなく、オブジェクトを取
        得する際にプロバイダーがフィルターを適用するためです。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Force [<SwitchParameter>]
        読み取り専用のエイリアスまたは変数など、設定しないと変更できない項目をコ
        マンドレットで設定できるようにします。コマンドレットでは、定数のエイリア
        スまたは変数は変更できません。実装はプロバイダーごとに異なります。詳細に
        ついては、「about_Providers」を参照してください。Force パラメーターを使
        用しても、コマンドレットはセキュリティ制限を上書きできません。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Include <string[]>
        指定した項目だけを変更します。このパラメーターの値は、Path パラメーター
        を修飾します。"*.txt" などのパス要素またはパターンを入力します。ワイルド
        カードを使用できます。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -LiteralPath <string[]>
        新しい項目の場所のパスを指定します。Path と異なり、LiteralPath の値は入
        力したとおりに使用されます。ワイルドカードとして解釈される文字はありませ
        ん。パスにエスケープ文字が含まれている場合は、単一引用符で囲みます。単一
        引用符で囲んだ文字はエスケープ シーケンスとして解釈されません。
        
        必須                         true
        位置                         1
        既定値                       
        パイプライン入力を許可する   true (ByPropertyName)
        ワイルドカード文字を許可する false
        
    -PassThru [<SwitchParameter>]
        項目を表すオブジェクトをパイプラインに渡します。既定では、このコマンドレ
        ットによる出力はありません。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    -Path <string[]>
        新しい項目の場所のパスを指定します。ワイルドカードを使用できます。
        
        必須                         true
        位置                         1
        既定値                       
        パイプライン入力を許可する   true (ByPropertyName)
        ワイルドカード文字を許可する false
        
    -Value <Object>
        項目の新しい値を指定します。
        
        必須                         false
        位置                         2
        既定値                       
        パイプライン入力を許可する   true (ByValue, 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」と入力してヘルプを参照してください。
    
入力
    System.Object
        パイプを使用して項目の新しい値を表すオブジェクトを Set-Item に渡すことが
        できます。
    
出力
    なし、または新しい項目か変更された項目を表すオブジェクト。
        Passthru パラメーターを使用すると、Set-Item は項目を表すオブジェクトを生
        成します。それ以外の場合、このコマンドレットによる出力はありません。
    
メモ
        Set-Item は、その組み込みエイリアスである "si" で参照することもできます。
        詳細については、「about_Aliases」を参照してください。
        
        Set-Item コマンドレットは、Windows PowerShell FileSystem プロバイダーで
        はサポートされません。ファイル システム中の項目の値を変更するには、Set-C
        ontent を使用してください。
        
        レジストリ ドライブ HKLM: と HKCU: では、Set-Item はレジストリ キーの (
        既定の) 値のデータを変更します。レジストリ キーの名前の作成と変更を行う
        には、New-Item と Rename-Item を使用します。レジストリ値の名前およびデー
        タを変更するには、New-ItemProperty、Set-ItemProperty、および Rename-Item
        Property を使用します。
        
        Set-Item コマンドレットは、プロバイダーによって公開されているデータを使
        用するように設計されています。セッションで使用可能なプロバイダーの一覧を
        表示するには、「Get-PsProvider」と入力します。詳細については、「about_Pr
        oviders」を参照してください。
    
    -------------------------- 例 1 --------------------------
    
    C:\PS>set-item -path alias:np -value c:\windows\notepad.exe
    
    説明
    -----------
    このコマンドを実行すると、Notepad のエイリアス np が作成されます。
    
    -------------------------- 例 2 --------------------------
    
    C:\PS>set-item -path env:UserRole -value Administrator
    
    説明
    -----------
    このコマンドは、Set-Item コマンドレットを使用して、環境変数 "UserRole" の値
    を "Administrator" に変更します。
    
    -------------------------- 例 3 --------------------------
    
    C:\PS>set-item -path function:prompt -value {'PS '+ $(Get-Date -format t) + 
    " " + $(Get-Location) + '> '}
    
    説明
    -----------
    次のコマンドは、Set-Item コマンドレットを使用してパスの前に時刻を表示するよ
    うに prompt 関数を変更します。
    
    -------------------------- 例 4 --------------------------
    
    C:\PS>set-item -path function:prompt -options "AllScope,ReadOnly"
    
    説明
    -----------
    このコマンドは、prompt 関数の AllScope オプションと ReadOnly オプションを設
    定します。このコマンドは、Set-Item コマンドレットの Options 動的パラメーター
    を使用します。Options パラメーターを Set-Item で使用できるのは、Alias プロバ
    イダーまたは Function プロバイダーと共に使用した場合のみです。
    
関連するリンク
    Online version: http://go.microsoft.com/fwlink/?LinkID=113395
    about_Providers 
    Get-Item 
    New-Item 
    Remove-Item 
    Clear-Item 
    Invoke-Item 
    Rename-Item 
    Move-Item 
    Copy-Item 
    	
記事で解説しているパソコンの環境
 基本ソフト: Windows 7
 キーワード: Windows PowerShell、ヘルプ、Cmdlet、Set-Item
ご利用数: 1856895
感想・要望・問い合わせは こちら