Freigeben über

New-Variable

  • Referenz
Modul:
Microsoft.PowerShell.Utility

Erstellt eine neue Variable.

Syntax

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

Beschreibung

Das Cmdlet New-Variable erstellt eine neue Variable in Windows PowerShell. Sie können der Variablen beim Erstellen einen Wert zuweisen oder den Wert zuweisen bzw. ändern, nachdem die Variable erstellt wurde.

Sie können die Parameter von New-Variable verwenden, um die Eigenschaften der Variablen festzulegen, den Bereich einer Variablen festzulegen und zu bestimmen, ob Variablen öffentlich oder privat sind.

In der Regel erstellen Sie eine neue Variable, indem Sie den Variablennamen und ihren Wert eingeben, z. B $Var = 3. , aber Sie können das Cmdlet New-Variable verwenden, um die zugehörigen Parameter zu verwenden.

Beispiele

Beispiel 1: Create einer Variablen

PS C:\> New-Variable days

Mit diesem Befehl wird eine neue Variable mit dem Namen days erstellt. Sie müssen den Parameter Name nicht eingeben.

Beispiel 2: Create einer Variablen und Zuweisen eines Werts

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

Dieser Befehl erstellt eine Variable namens zipcode und weist ihr den Wert 98033 zu.

Beispiel 3: Create einer Variablen mit der Option ReadOnly

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

In diesem Beispiel wird gezeigt, wie Sie die ReadOnly-Option von New-Variable verwenden, um eine Variable vor überschrieben zu schützen.

Der erste Befehl erstellt eine neue Variable mit dem Namen Max und legt ihren Wert auf 256 fest. Er verwendet den Option-Parameter mit dem Wert ReadOnly.

Der zweite Befehl versucht, eine zweite Variable mit demselben Namen zu erstellen. Dieser Befehl gibt einen Fehler zurück, da für diese Variable die Option „schreibgeschützt“ festgelegt ist.

Der dritte Befehl verwendet den Force-Parameter , um den schreibgeschützten Schutz für die Variable außer Kraft zu setzen. In diesem Fall ist der Befehl zum Erstellen einer neuen Variable mit dem gleichen Namen erfolgreich.

Beispiel 4: Create einer privaten Variablen

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
...

Mit diesem Befehl wird das Verhalten einer privaten Variable in einem Modul veranschaulicht. Das Modul enthält das Cmdlet Get-Counter, das über eine private Variable namens Counter verfügt. Der Befehl verwendet den Visibility-Parameter mit dem Wert Private, um die Variable zu erstellen.

Die Beispielausgabe zeigt das Verhalten einer privaten Variable. Der Benutzer, der das Modul geladen hat, kann den Wert der Counter-Variable nicht anzeigen oder ändern, die Counter-Variable kann jedoch durch die Befehle im Modul gelesen und geändert werden.

Beispiel 5: Create einer Variablen mit einem Leerzeichen

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

Dieser Befehl veranschaulicht, dass Variablen mit Leerzeichen erstellt werden können. Auf die Variablen kann mithilfe des Cmdlets Get-Variable oder direkt durch Trennzeichen einer Variablen mit Klammern zugegriffen werden.

Parameter

-Confirm

Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Gibt eine Beschreibung der Variablen an.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Gibt an, dass das Cmdlet eine Variable mit demselben Namen wie eine vorhandene schreibgeschützte Variable erstellt.

Standardmäßig können Sie eine Variable überschreiben, es sei denn, die Variable weist den Optionswert „ReadOnly“ oder „Constant“ auf. Weitere Informationen finden Sie im Parameter Option .

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Gibt einen Namen für die neue Variable an.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Option

Gibt den Wert der Options-Eigenschaft der Variablen an. Zulässige Werte für diesen Parameter:

  • Keine. Legt keine Optionen fest. (Keine ist der Standardwert.)
  • Readonly. Kann gelöscht werden. Kann nicht geändert werden, außer mithilfe des Force-Parameters .
  • Privat. Die Variable ist nur im aktuellen Bereich verfügbar.
  • AllScope. Die Variable wird in neu erstellte Bereiche kopiert.
  • Konstante. Kann nicht gelöscht oder geändert werden. Die Konstante ist nur gültig, wenn Sie eine Variable erstellen. Sie können die Optionen einer vorhandenen Variablen nicht in Konstant ändern.

Geben Sie ein, um die Options-Eigenschaft aller Variablen in der Sitzung Get-Variable | Format-Table -Property name, options -autosizeanzuzeigen.

Type:ScopedItemOptions
Accepted values:None, ReadOnly, Constant, Private, AllScope, Unspecified
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

Gibt ein Objekt zurück, das das Element darstellt, mit dem Sie arbeiten. Standardmäßig wird von diesem Cmdlet keine Ausgabe generiert.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Scope

Gibt den Bereich der neuen Variablen an. Zulässige Werte für diesen Parameter:

  • Global. Variablen, die im globalen Bereich erstellt wurden, sind in einem PowerShell-Prozess überall zugänglich.
  • Lokal. Der lokale Bereich bezieht sich auf den aktuellen Bereich. Dies kann je nach Kontext ein beliebiger Bereich sein.
  • Skript. Auf variablen, die im Skriptbereich erstellt wurden, kann nur innerhalb der Skriptdatei oder des Moduls zugegriffen werden, in der sie erstellt werden.
  • Privat. Auf variablen, die im privaten Bereich erstellt wurden, kann nicht außerhalb des Bereichs zugegriffen werden, in dem sie vorhanden sind. Sie können den privaten Bereich verwenden, um eine private Version eines Elements mit demselben Namen in einem anderen Bereich zu erstellen.
  • Eine Zahl relativ zum aktuellen Bereich (0 durch die Anzahl der Bereiche, wobei 0 der aktuelle Bereich ist, 1 sein übergeordneter Bereich, 2 das übergeordnete Element des übergeordneten Bereichs usw.). Negative Zahlen können nicht verwendet werden.

Local ist der Standardbereich, wenn der Bereichsparameter nicht angegeben wird.

Weitere Informationen finden Sie unter „about_Scopes“.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Value

Gibt den Anfangswert der Variablen an.

Type:Object
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Visibility

Bestimmt, ob die Variable außerhalb der Sitzung, in der sie erstellt wurde, sichtbar ist. Dieser Parameter ist für die Verwendung in Skripts und Befehlen konzipiert, die an andere Benutzer übermittelt werden. Zulässige Werte für diesen Parameter:

  • Öffentlich. Die Variable wird angezeigt. (Öffentlich ist der Standardwert.)
  • Privat. Die Variable wird nicht angezeigt.

Wenn eine Variable privat ist, wird sie nicht in den Listen mit Variablen angezeigt, z. B. jene, die von Get-Variable zurückgegeben werden, oder in den Anzeigen des Variable:-Laufwerks. Befehle zum Lesen oder Ändern des Werts einer privaten Variablen geben einen Fehler zurück. Der Benutzer kann jedoch Befehle ausführen, die eine private Variable verwenden, wenn die Befehle in der Sitzung geschrieben wurden, in der die Variable definiert wurde.

Type:SessionStateEntryVisibility
Accepted values:Public, Private
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Zeigt, was geschieht, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Eingaben

Object

Sie können einen Wert an New-Variable übergeben.

Ausgaben

None or System.Management.Automation.PSVariable

Wenn Sie den PassThru-Parameter verwenden, generiert New-Variable ein System.Management.Automation.PSVariable-Objekt , das die neue Variable darstellt. Andernfalls wird von diesem Cmdlet keine Ausgabe generiert.