New-Variable

New-Variable コマンドレットは、Windows PowerShell で新しい変数を作成します。 変数の作成時に値を割り当てたり、作成後に値を割り当てたり変更したりすることができます。

New-Variable のパラメーターを使用して、変数のプロパティを設定し、変数のスコープを設定し、変数がパブリックかプライベートかを判断できます。

通常は、変数名とその値 ($Var = 3など) を入力して新しい変数を作成しますが、New-Variable コマンドレットを使用してパラメーターを使用できます。

PS C:\> New-Variable days

このコマンドは、days という名前の新しい変数を作成します。 Name パラメーターを入力する必要はありません。

PS C:\> New-Variable -Name "zipcode" -Value 98033

このコマンドは、zipcode という名前の変数を作成し、値 98033 を割り当てます。

PS C:\> New-Variable -Name Max -Value 256 -Option ReadOnly
PS C:\> New-Variable -Name max -Value 1024

New-Variable : A variable with name 'max' already exists.
At line:1 char:1
+ New-Variable -Name max -Value 1024
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : ResourceExists: (max:String) [New-Variable], SessionStateException
    + FullyQualifiedErrorId : VariableAlreadyExists,Microsoft.PowerShell.Commands.NewVariableCommand

PS C:\> New-Variable -Name max -Value 1024 -Force

この例では、New-Variable の ReadOnly オプション 使用して、変数が上書きされないように保護する方法を示します。

最初のコマンドは、Max という名前の新しい変数を作成し、その値を 256 に設定します。 値が ReadOnly の Option パラメーターを使用します。

2 番目のコマンドは、同じ名前の 2 つ目の変数を作成しようとします。 このコマンドは、変数に読み取り専用オプションが設定されているため、エラーを返します。

3 番目のコマンドでは、Force パラメーターを使用して、変数の読み取り専用保護をオーバーライドします。 この場合、同じ名前の新しい変数を作成するコマンドは成功します。

PS C:\> New-Variable -Name counter -Visibility Private

#Effect of private variable in a module.

PS C:\> Get-Variable c*

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

PS C:\> $counter
"Cannot access the variable '$counter' because it is a private variable"
At line:1 char:1
+ $counter
+ ~~~~~~~~
    + CategoryInfo          : PermissionDenied: (counter:String) [], SessionStateException
    + FullyQualifiedErrorId : VariableIsPrivate

PS C:\> Get-Counter
Name         Value
----         -----
Counter1     3.1415
...

このコマンドは、モジュール内のプライベート変数の動作を示します。 モジュールには、Counter という名前のプライベート変数を持つ Get-Counter コマンドレットが含まれています。 このコマンドでは、値が Private の Visibility パラメーターを使用して変数を作成します。

サンプル出力は、プライベート変数の動作を示しています。 モジュールを読み込んだユーザーは Counter 変数の値を表示または変更できませんが、Counter 変数はモジュール内のコマンドで読み取りおよび変更できます。

PS C:\> New-Variable -Name 'with space' -Value 'abc123xyz'

PS C:\> Get-Variable -Name 'with space'

Name                           Value
----                           -----
with space                     abc123xyz

PS C:\> ${with space}
abc123xyz

このコマンドは、スペースを含む変数を作成できることを示しています。 変数には、Get-Variable コマンドレットを使用するか、変数を中かっこで区切って直接アクセスできます。

Object

値をパイプ処理して、New-Variableを できます。

None or System.Management.Automation.PSVariable

PassThru パラメーターを使用すると、New-Variable 新しい変数を表す System.Management.Automation.PSVariable オブジェクトが生成されます。 それ以外の場合、このコマンドレットは出力を生成しません。