New-Variable

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

Командлет New-Variable создает новую переменную в PowerShell. Можно назначить значение переменной во время его создания или назначить или изменить значение после его создания.

Параметры New-Variable можно использовать для задания свойств переменной, задания области переменной и определения того, являются ли переменные общедоступными или частными.

Как правило, вы создаете новую переменную, введя имя переменной и его значение, например $Var = 3, но для использования параметров можно использовать командлет New-Variable.

New-Variable days

Эта команда создает новую переменную с именами дней. Не требуется вводить параметр Name.

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

В этом примере показано, как использовать параметр ReadOnlyNew-Variable для защиты переменной от перезаписи.

Первая команда создает новую переменную с именем Max и задает для нее значение 256. В нем используется параметр параметра со значением ReadOnly.

Вторая команда пытается создать вторую переменную с тем же именем. Эта команда возвращает ошибку, так как параметр только для чтения установлен в переменной.

Третья команда использует параметр Force для переопределения защиты только для чтения в переменной. В этом случае команда для создания новой переменной с тем же именем завершается успешно.

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

В этом примере создается переменная и назначается параметры AllScope и Constant, поэтому переменная будет доступна в текущей области и любые новые области, созданные и не могут быть изменены или удалены.

Эта команда демонстрирует поведение частной переменной в модуле. Модуль содержит командлет Get-Counter, имеющий частную переменную с именем Counter. Команда использует параметр видимости со значением Private для создания переменной.

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

В примере выходных данных показано поведение частной переменной. Пользователь, загрузивший модуль, не может просматривать или изменять значение переменной Счетчика, но переменная Счетчика может быть считываема и изменена командами в модуле.

В этом примере показано, что можно создать переменные с пробелами. К переменным можно обращаться с помощью командлета Get-Variable или непосредственно с разделителями переменной с фигурными скобками.

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

Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.

Можно передать любой объект в New-Variable.

По умолчанию этот командлет не возвращает выходные данные.

При использовании параметра PassThru этот командлет возвращает объект PSVariable, представляющий новую переменную.

PowerShell включает следующие псевдонимы для New-Variable:

• Все платформы:
  • nv