New-Variable

  • Odwołanie
Moduł:
Microsoft.PowerShell.Utility

Tworzy nową zmienną.

Składnia

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

Opis

Polecenie New-Variable cmdlet tworzy nową zmienną w programie PowerShell. Wartość można przypisać do zmiennej podczas jej tworzenia lub przypisywać lub zmieniać wartość po jej utworzeniu.

Możesz użyć parametrów New-Variable , aby ustawić właściwości zmiennej, ustawić zakres zmiennej i określić, czy zmienne są publiczne, czy prywatne.

Zazwyczaj tworzysz nową zmienną, wpisując nazwę zmiennej i jej wartość, na przykład $Var = 3, ale możesz użyć polecenia cmdlet , aby użyć New-Variable jego parametrów.

Przykłady

Przykład 1. Tworzenie zmiennej

New-Variable days

To polecenie tworzy nową zmienną o nazwie days. Nie musisz wpisywać parametru Nazwa .

Przykład 2. Tworzenie zmiennej i przypisywanie jej wartości

New-Variable -Name "zipcode" -Value 98033

To polecenie tworzy zmienną o nazwie zipcode i przypisuje mu wartość 98033.

Przykład 3. Tworzenie zmiennej z opcją 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

W tym przykładzie pokazano, jak używać ReadOnly opcji New-Variable ochrony zmiennej przed zastąpieniem.

Pierwsze polecenie tworzy nową zmienną o nazwie Max i ustawia jej wartość na 256. Używa parametru Option z wartością ReadOnly.

Drugie polecenie próbuje utworzyć drugą zmienną o tej samej nazwie. To polecenie zwraca błąd, ponieważ dla zmiennej jest ustawiona opcja tylko do odczytu.

Trzecie polecenie używa parametru Force , aby zastąpić ochronę tylko do odczytu w zmiennej. W takim przypadku polecenie utworzenia nowej zmiennej o tej samej nazwie powiedzie się.

Przykład 4. Przypisywanie wielu opcji do zmiennej

New-Variable -Name 'TestVariable' -Value 'Test Value' -Option AllScope,Constant

W tym przykładzie zostanie utworzona zmienna i zostanie przypisana AllScope opcja i Constant , aby zmienna będzie dostępna w bieżącym zakresie i nie można zmienić ani usunąć żadnych nowych zakresów.

Przykład 5. Tworzenie zmiennej prywatnej

To polecenie demonstruje zachowanie zmiennej prywatnej w module. Moduł zawiera Get-Counter polecenie cmdlet, które ma zmienną prywatną o nazwie Counter. Polecenie używa parametru Widoczność z wartością Private, aby utworzyć zmienną.

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

Przykładowe dane wyjściowe pokazują zachowanie zmiennej prywatnej. Użytkownik, który załadował moduł, nie może wyświetlić ani zmienić wartości zmiennej Counter, ale zmienna Counter może być odczytywana i zmieniana przez polecenia w module.

Przykład 6. Tworzenie zmiennej z spacją

W tym przykładzie pokazano, że można tworzyć zmienne z spacjami. Dostęp do zmiennych można uzyskać za pomocą Get-Variable polecenia cmdlet lub bezpośrednio, rozdzielając zmienną z nawiasami klamrowymi.

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

Parametry

-Confirm

Monituje o potwierdzenie przed uruchomieniem polecenia cmdlet.

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

-Description

Określa opis zmiennej.

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

-Force

Wskazuje, że polecenie cmdlet tworzy zmienną o tej samej nazwie co istniejąca zmienna tylko do odczytu.

Domyślnie można zastąpić zmienną, chyba że zmienna ma wartość ReadOnly opcji lub Constant. Aby uzyskać więcej informacji, zobacz Parametr opcji .

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

-Name

Określa nazwę nowej zmiennej.

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

-Option

Określa wartość właściwości Options zmiennej. Dopuszczalne wartości tego parametru to:

  • None - Ustawia brak opcji. Wartość domyślna to None.
  • ReadOnly - Można usunąć. Nie można zmienić, z wyjątkiem użycia parametru Force .
  • Private — Zmienna jest dostępna tylko w bieżącym zakresie.
  • AllScope — Zmienna jest kopiowana do wszystkich nowych utworzonych zakresów.
  • Constant - Nie można usunąć ani zmienić. Constant jest prawidłowy tylko podczas tworzenia zmiennej. Nie można zmienić opcji istniejącej zmiennej na Constant.

Te wartości są definiowane jako wyliczenie oparte na flagach. Możesz połączyć wiele wartości ze sobą, aby ustawić wiele flag przy użyciu tego parametru. Wartości można przekazać do parametru Option jako tablicę wartości lub jako ciąg rozdzielany przecinkami tych wartości. Polecenie cmdlet połączy wartości przy użyciu operacji binary-OR. Przekazywanie wartości jako tablicy jest najprostszą opcją, a także umożliwia użycie uzupełniania tabulatorów na wartościach.

Aby wyświetlić właściwość Options wszystkich zmiennych w sesji, wpisz Get-Variable | Format-Table -Property name, options -AutoSize.

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

Zwraca obiekt reprezentujący element, z którym pracujesz. Domyślnie to polecenie cmdlet nie generuje żadnych danych wyjściowych.

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

-Scope

Określa zakres nowej zmiennej. Dopuszczalne wartości tego parametru to:

  • Global — Zmienne utworzone w zakresie globalnym są dostępne wszędzie w procesie programu PowerShell.
  • Local — Zakres lokalny odnosi się do bieżącego zakresu, może to być dowolny zakres w zależności od kontekstu. Local jest zakresem domyślnym, gdy parametr zakresu nie jest określony.
  • Script — Zmienne utworzone w zakresie skryptu są dostępne tylko w pliku skryptu lub module, w których są tworzone.
  • Liczba względem bieżącego zakresu (od 0 do liczby zakresów, gdzie 0 jest bieżącym zakresem, 1 jest jego elementem nadrzędnym, 2 elementem nadrzędnym zakresu nadrzędnego itd.). Nie można użyć liczb ujemnych.

Uwaga

Parametr akceptuje również wartość Private. Private nie jest w rzeczywistości zakresem, ale opcjonalnym ustawieniem dla zmiennej. Jednak użycie Private wartości z tym poleceniem cmdlet nie zmienia widoczności zmiennej. Aby uzyskać więcej informacji, zobacz about_Scopes.

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

-Value

Określa początkową wartość zmiennej.

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

-Visibility

Określa, czy zmienna jest widoczna poza sesją, w której została utworzona. Ten parametr jest przeznaczony do użycia w skryptach i poleceniach, które zostaną dostarczone do innych użytkowników. Dopuszczalne wartości tego parametru to:

  • Public - Zmienna jest widoczna. Wartość domyślna to Public.
  • Private - Zmienna nie jest widoczna.

Gdy zmienna jest prywatna, nie jest wyświetlana na listach zmiennych, takich jak te zwracane przez Get-Variable, lub w wyświetlaniu Variable: dysku. Polecenia odczytu lub zmiany wartości zmiennej prywatnej zwracają błąd. Użytkownik może jednak uruchamiać polecenia używające zmiennej prywatnej, jeśli polecenia zostały zapisane w sesji, w której zdefiniowano zmienną.

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

-WhatIf

Pokazuje, co się stanie po uruchomieniu polecenia cmdlet. Polecenie cmdlet nie zostało uruchomione.

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

Dane wejściowe

Object

Dowolny obiekt można przekazać potokowi do New-Variableobiektu .

Dane wyjściowe

None

Domyślnie to polecenie cmdlet nie zwraca żadnych danych wyjściowych.

PSVariable

Jeśli używasz parametru PassThru , to polecenie cmdlet zwraca obiekt PSVariable reprezentujący nową zmienną.

Uwagi

Program PowerShell zawiera następujące aliasy dla programu New-Variable:

  • Wszystkie platformy:
    • nv