次の方法で共有

Set-Variable

  • リファレンス
モジュール:
Microsoft.PowerShell.Utility

変数の値を設定します。 要求された名前の変数が存在しない場合は、変数を作成します。

構文

Set-Variable
   [-Name] <String[]>
   [[-Value] <Object>]
   [-Include <String[]>]
   [-Exclude <String[]>]
   [-Description <String>]
   [-Option <ScopedItemOptions>]
   [-Force]
   [-Visibility <SessionStateEntryVisibility>]
   [-PassThru]
   [-Scope <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

Set-Variable コマンドレットは、指定した変数に値を割り当てるか、現在の値を変更します。 変数が存在しない場合は、コマンドレットによって作成されます。

例

例 1: 変数を設定し、その値を取得する

これらのコマンドは、$desc 変数の値を A descriptionに設定し、変数の値を取得します。

Set-Variable -Name "desc" -Value "A description"
Get-Variable -Name "desc"

Name                           Value
----                           -----
desc                           A description

例 2: グローバルな読み取り専用変数を設定する

この例では、システム上のすべてのプロセスを含むグローバルな読み取り専用変数を作成し、変数のすべてのプロパティを表示します。

Set-Variable -Name "processes" -Value (Get-Process) -Option constant -Scope global -Description "All processes" -PassThru |
    Format-List -Property *

このコマンドでは、Set-Variable コマンドレットを使用して変数を作成します。 PassThru パラメーターを使用して新しい変数を表すオブジェクトを作成し、パイプライン演算子 (|) を使用してオブジェクトを Format-List コマンドレットに渡します。 新しく作成された変数のすべてのプロパティを表示するには、Format-List の Property パラメーターと all (*) の値を使用します。

(Get-Process)値は、変数に格納される前に実行されるようにかっこで囲まれています。 それ以外の場合、変数には Get-Process単語が含まれます。

例 3: パブリック変数とプライベート変数を理解する

この例では、変数の可視性を Privateに変更する方法を示します。 この変数は、必要なアクセス許可を持つスクリプトで読み取りおよび変更できますが、ユーザーには表示されません。

New-Variable -Name "counter" -Visibility Public -Value 26
$Counter

26

Get-Variable c*

Name                  Value
----                  -----
Culture               en-US
ConsoleFileName
ConfirmPreference     High
CommandLineParameters {}
Counter               26

Set-Variable -Name "counter" -Visibility Private
Get-Variable c*

Name                  Value
----                  -----
Culture               en-US
ConsoleFileName
ConfirmPreference     High
CommandLineParameters {}

$counter

"Cannot access the variable '$counter' because it is a private variable"

.\use-counter.ps1
#Commands completed successfully.

このコマンドは、変数の可視性を Private に変更する方法を示します。 この変数は、必要なアクセス許可を持つスクリプトで読み取りおよび変更できますが、ユーザーには表示されません。

パラメーター

-Confirm

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

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

-Description

変数の説明を指定します。

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

-Exclude

このコマンドレットが操作から除外する項目の配列を指定します。 このパラメーターの値は、Path パラメーターを修飾します。 パス要素またはパターン (*.txtなど) を入力します。 ワイルドカードを使用できます。

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

-Force

既存の読み取り専用変数と同じ名前の変数を作成したり、読み取り専用変数の値を変更することができます。

既定では、変数に ReadOnly または Constantのオプション値がない限り、変数を上書きできます。 詳細については、Option パラメーターを参照してください。

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

-Include

このコマンドレットが操作に含める項目の配列を指定します。 このパラメーターの値は、Name パラメーターを修飾します。 c*など、名前または名前のパターンを入力します。 ワイルドカードを使用できます。

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

-Name

変数名を指定します。

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

-Option

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

有効な値は次のとおりです。

  • None: オプションを設定しません。 (None が既定値です)。
  • ReadOnly: 削除できます。 Force パラメーターを使用する場合を除き、変更できません。
  • Constant: 削除または変更できません。 Constant は、変数を作成する場合にのみ有効です。 既存の変数のオプションを Constantに変更することはできません。
  • Private: 変数は現在のスコープでのみ使用できます。
  • AllScope: 変数は、作成された新しいスコープにコピーされます。

これらの値は、フラグ ベースの列挙体として定義されます。 このパラメーターを使用して、複数の値を組み合わせて複数のフラグを設定できます。 値は、Option パラメーターに値の配列として、またはそれらの値のコンマ区切り文字列として渡すことができます。 コマンドレットは、バイナリ OR 操作を使用して値を結合します。 配列として値を渡すことは最も簡単なオプションであり、値にタブ補完を使用することもできます。

型:ScopedItemOptions
指定可能な値:None, ReadOnly, Constant, Private, AllScope, Unspecified
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-PassThru

新しい変数を表すオブジェクトを返します。 既定では、このコマンドレットは出力を生成しません。

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

-Scope

変数のスコープを指定します。このパラメーターに使用できる値は次のとおりです。

  • Global
  • Local
  • Script
  • Private
  • 現在のスコープに対する相対的な数値 (0 からスコープの数、0 が現在のスコープ、1 がその親)。

Local が既定値です。

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

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

-Value

変数の値を指定します。

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

-Visibility

変数が作成されたセッションの外部で変数が表示されるかどうかを判断します。 このパラメーターは、他のユーザーに配信されるスクリプトとコマンドで使用するように設計されています。

有効な値は次のとおりです。

  • Public: 変数が表示されます。 (Public が既定値です)。
  • Private: 変数は表示されません。

変数がプライベートの場合、変数の一覧 (Get-Variableによって返される変数など) や、Variable: ドライブの表示には表示されません。 プライベート変数の値を読み取ったり変更したりするコマンドは、エラーを返します。 ただし、ユーザーは、変数が定義されたセッションでコマンドが書き込まれた場合に、プライベート変数を使用するコマンドを実行できます。

型:SessionStateEntryVisibility
指定可能な値:Public, Private
配置:Named
規定値:Public
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-WhatIf

コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。

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

入力

Object

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

出力

None

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

PSVariable

PassThru パラメーターを使用すると、このコマンドレットは、新しい変数または変更された変数を表す PSVariable オブジェクトを返します。

メモ

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

  • すべてのプラットフォーム:
    • set
    • sv