HOME > Variable系コマンドレット > Set-Variable
Set-Variable
Set-Variableは、変数を設定するコマンドです。
エイリアスsv、set
解説
既存の変数に値をセットします。
存在しない変数名を指定した場合は、新規の変数として定義されます。
既に存在する変数名を指定した場合は、既存変数の値が更新されます。
構文
- （構文）
- Set-Variable [-Name] <string[]> [[-Value] <Object>] [<CommonParameters>]
| パラメータ | 説明 |
|---|---|
| -Name 変数名 | 対象の変数を指定する |
| -Value 値 | 値を指定する |
| -Include 文字列 | 指定した文字列を対象に含める （ワイルドカード使用可） |
| -Exclude 文字列 | 指定した文字列を対象から除外する （ワイルドカード使用可） |
| -Description 値 | 説明を指定する |
| -Option 値 | 変数のオプションを指定する ・None：何も指定しない（デフォルト） ・Constant：定数 ・Private：プライベートスコープのみ対象 ・ReadOnly：読取専用 ・AllScope：全てのスコープにコピーする |
| -Force | 強制的に実行する |
| -Visibility 値 | セッション外で表示するかどうかを指定する ・Public：表示される（デフォルト） ・Private：表示されない |
| -PassThru | 通常は出力しない値を出力るようにする |
| -Scope 値 | 対象とするスコープを指定する ・Global：どこからでもアクセス可能 ・Local：現在のスコープのみアクセス可能（デフォルト） ・Script：スクリプト内のみアクセス可能 |
| -WhatIf | 実行はせずに実行結果の確認のみ行う |
| -Confirm | 実行前に確認メッセージの表示を行う |
共通的なパラメータは「共通パラメータ」をご覧ください。
サンプル
変数aに対して値ABCをセットする
Set-Variable -Name a -Value "ABC"
定数（名称：MAX_NUM 値：30）を定義する
Set-Variable -Name MAX_NUM -Value 30 -Option Constant
コマンドのヘルプを表示する
Get-Help Set-Variable
備考
- パラメータ名の「Name」と「Value」は省略可能です。
関連項目
- Variable系コマンドレット
- Get-Variable：変数を取得する
- Set-Variable：変数を設定する
- New-Variable：変数を作成する
- Clear-Variable：変数の値をクリアする
- Remove-Variable：変数の定義を削除する
