Set-Variable

Синтаксис

Default (по умолчанию)

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

Описание

Примеры

Пример 1. Установка переменной и получение его значения

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 *

Пример 3. Общие сведения об общедоступных и частных переменных

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.

Параметры

-Confirm

Запрашивает подтверждение перед запуском cmdlet.

Свойства параметра

Наборы параметров

-Description

Задает описание переменной.

Свойства параметра

Наборы параметров

-Exclude

Указывает массив элементов, которые этот командлет исключает из операции. Значение этого параметра квалифифициирует параметр Path. Введите элемент пути или шаблон, например *.txt. Подстановочные символы разрешены.

Свойства параметра

Наборы параметров

-Force

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

По умолчанию можно перезаписать переменную, если переменная не имеет значения параметра ReadOnly или Constant. Дополнительные сведения см. в параметре параметра .

Свойства параметра

Наборы параметров

-Include

Указывает массив элементов, которые этот командлет включает в операцию. Значение этого параметра квалифифициирует параметр Name. Введите имя или шаблон имени, например c*. Подстановочные символы разрешены.

Свойства параметра

Наборы параметров

-Name

Определяет имя переменной.

Свойства параметра

Наборы параметров

-Option

Задает значение свойства Options переменной.

Допустимые значения:

• None: не задает параметры. (None используется по умолчанию.)
• ReadOnly: можно удалить. Невозможно изменить, за исключением использования параметра Force.
• Constant: невозможно удалить или изменить. Constant допустимо только при создании переменной. Нельзя изменить параметры существующей переменной на Constant.
• Private: переменная доступна только в текущей области.
• AllScope: переменная копируется в новые области, созданные.

Эти значения определяются как перечисление, основанное на флагах. Можно объединить несколько значений, чтобы задать несколько флагов с помощью этого параметра. Значения можно передать параметру Option в виде массива значений или в виде строки, разделенной запятыми этих значений. Командлет объединяет значения с помощью операции binary-OR. Передача значений в виде массива является самым простым вариантом, а также позволяет использовать дополнение при нажатии Tab для значений.

Свойства параметра

Наборы параметров

-PassThru

Возвращает объект, представляющий новую переменную. По умолчанию этот командлет не создает выходные данные.

Свойства параметра

Наборы параметров

-Scope

Указывает область переменной. Допустимые значения для этого параметра:

• Global
• Local
• Script
• Private
• Число относительно текущей области (от 0 до числа областей, где 0 является текущей областью, а 1 — родительским).

Local — это значение по умолчанию.

Для получения дополнительной информации см. about_Scopes.

Свойства параметра

Наборы параметров

-Value

Указывает значение переменной.

Свойства параметра

Наборы параметров

-Visibility

Определяет, отображается ли переменная вне сеанса, в котором она была создана. Этот параметр предназначен для использования в скриптах и командах, которые будут доставлены другим пользователям.

Допустимые значения:

• Public: переменная видна. (Public используется по умолчанию.)
• Private: переменная не отображается.

Если переменная является частной, она не отображается в списках переменных, таких как те, которые возвращаются Get-Variable, или в дисплеях переменной : диске. Команды для чтения или изменения значения частной переменной возвращают ошибку. Однако пользователь может выполнять команды, использующие частную переменную, если команды были записаны в сеансе, в котором была определена переменная.

Свойства параметра

Наборы параметров

-WhatIf

Показывает, что произойдет, если командлет будет запущен. Командлет не запускается.

Свойства параметра

Наборы параметров

CommonParameters

Входные данные

Object

Выходные данные

None

PSVariable

Примечания

Связанные ссылки

• Очистить переменную
• Get-Variable
• новая переменная
• УдалитьПеременную