Set-Item (Microsoft.PowerShell.Management)

Set-Item

Модуль:

Microsoft.PowerShell.Management

Изменяет значение элемента на значение, указанное в команде.

Синтаксис

Set-Item
   [-Path] <String[]>
   [[-Value] <Object>]
   [-Force]
   [-PassThru]
   [-Filter <String>]
   [-Include <String[]>]
   [-Exclude <String[]>]
   [-Credential <PSCredential>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-Item
   -LiteralPath <String[]>
   [[-Value] <Object>]
   [-Force]
   [-PassThru]
   [-Filter <String>]
   [-Include <String[]>]
   [-Exclude <String[]>]
   [-Credential <PSCredential>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-Item
   [-Path] <string[]>
   [[-Value] <Object>]
   [-Force]
   [-PassThru]
   [-Filter <string>]
   [-Include <string[]>]
   [-Exclude <string[]>]
   [-Credential <pscredential>]
   [-WhatIf]
   [-Confirm]
   [-Options <ScopedItemOptions>]
   [<CommonParameters>]

Set-Item
   [[-Value] <Object>]
   -LiteralPath <string[]>
   [-Force]
   [-PassThru]
   [-Filter <string>]
   [-Include <string[]>]
   [-Exclude <string[]>]
   [-Credential <pscredential>]
   [-WhatIf]
   [-Confirm]
   [-Options <ScopedItemOptions>]
   [<CommonParameters>]

Set-Item
   [-Path] <string[]>
   [[-Value] <Object>]
   [-Force]
   [-PassThru]
   [-Filter <string>]
   [-Include <string[]>]
   [-Exclude <string[]>]
   [-Credential <pscredential>]
   [-WhatIf]
   [-Confirm]
   [-Type <RegistryValueKind>]
   [<CommonParameters>]

Set-Item
   [[-Value] <Object>]
   -LiteralPath <string[]>
   [-Force]
   [-PassThru]
   [-Filter <string>]
   [-Include <string[]>]
   [-Exclude <string[]>]
   [-Credential <pscredential>]
   [-WhatIf]
   [-Confirm]
   [-Type <RegistryValueKind>]
   [<CommonParameters>]

Описание

Командлет Set-Item изменяет значение элемента, например переменной или раздела реестра, на значение, указанное в команде.

Примеры

Пример 1. Создайте псевдоним

Эта команда создает псевдоним np для Блокнота.

Set-Item -Path alias:np -Value "c:\windows\notepad.exe"

Пример 2. Изменение значения переменной среды

Эта команда изменяет значение переменной среды UserRole на Администратор.

Set-Item -Path env:UserRole -Value "Administrator"

Пример 3. Измените функцию приглашения

Эта команда изменяет функцию приглашения, чтобы она отображала время перед путем.

Set-Item -Path function:prompt -Value {'PS '+ (Get-Date -Format t) + " " + (Get-Location) + '> '}

Пример 4. Установите параметры для функции подсказки

Эта команда устанавливает параметры AllScope и ReadOnly для функции приглашения. Эта команда использует динамический параметр Options Set-Item. Параметр Options доступен в Set-Item только при использовании его с поставщиком Alias или Function.

Set-Item -Path function:prompt -Options "AllScope,ReadOnly"

Параметры

-Confirm

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

Тип :

SwitchParameter

Псевдонимы:

cf

Позиция:

Именованный

Значение по умолчанию:

False

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

-Credential

Тип :

PSCredential

Позиция:

Именованный

Значение по умолчанию:

Текущий пользователь

Необходимый:

False

Примите ввод конвейера:

True

Принимайте подстановочные знаки:

False

-Exclude

Указывает в виде массива строк элемент или элементы, которые этот командлет исключает из операции. Значение этого параметра определяет параметр Path. Введите элемент пути или шаблон, например *.txt. Допускаются подстановочные знаки. Параметр Exclude действует только в том случае, если команда включает содержимое элемента, например C:\Windows\*, где подстановочный знак указывает содержимое C:\Windows.

Тип :

String[]

Позиция:

Именованный

Значение по умолчанию:

None

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

True

-Filter

Указывает фильтр для уточнения параметра Path. Поставщик FileSystem — единственный установленный поставщик PowerShell, поддерживающий использование фильтров. Синтаксис языка фильтров FileSystem можно найти в about_Wildcards. Фильтры более эффективны, чем другие параметры, поскольку поставщик применяет их, когда командлет получает объекты, а не заставляет PowerShell фильтровать объекты после их получения.

Тип :

String

Позиция:

Именованный

Значение по умолчанию:

None

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

True

-Force

Заставляет командлет устанавливать элементы, которые нельзя изменить другим способом, например псевдонимы или переменные, доступные только для чтения. Командлет не может изменять псевдонимы констант или переменные. Реализация варьируется от провайдера к провайдеру. Дополнительные сведения см. в разделе about_Providers. Даже при использовании параметра Force командлет не может переопределить ограничения безопасности.

Тип :

SwitchParameter

Позиция:

Именованный

Значение по умолчанию:

False

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

-Include

Указывает в виде массива строк элемент или элементы, которые этот командлет включает в операцию. Значение этого параметра определяет параметр Path. Введите элемент пути или шаблон, например "*.txt". Допускаются подстановочные знаки. Параметр Include действует только в том случае, если команда включает содержимое элемента, например C:\Windows\*, где подстановочный знак указывает содержимое C:\Windows.

Тип :

String[]

Позиция:

Именованный

Значение по умолчанию:

None

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

True

-LiteralPath

Указывает путь к одному или нескольким местоположениям. Значение LiteralPath используется точно так, как оно введено. Никакие символы не интерпретируются как подстановочные знаки. Если путь содержит escape-символы, заключите его в одинарные кавычки. Одинарные кавычки сообщают PowerShell не интерпретировать никакие символы как escape-последовательности.

Дополнительные сведения см. в разделе about_Quoting_Rules.

Тип :

String[]

Псевдонимы:

PSPath, LP

Позиция:

Именованный

Значение по умолчанию:

None

Необходимый:

True

Примите ввод конвейера:

True

Принимайте подстановочные знаки:

False

-Options

Это динамический параметр, доступный поставщикам Псевдоним и Функция. Дополнительные сведения см. в разделах about_Alias_Provider и about_Function_Provider.

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

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

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

Тип :

ScopedItemOptions

Позиция:

Именованный

Значение по умолчанию:

None

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

-PassThru

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

Тип :

SwitchParameter

Позиция:

Именованный

Значение по умолчанию:

False

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

-Path

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

Тип :

String[]

Позиция:

0

Значение по умолчанию:

None

Необходимый:

True

Примите ввод конвейера:

True

Принимайте подстановочные знаки:

True

-Type

Это динамический параметр, предоставляемый поставщиком Реестра. Поставщик Реестр и этот параметр доступны только в Windows.

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

• String: указывает строку, завершающуюся нулем. Используется для значений REG_SZ.
• ExpandString: указывает строку с нулевым завершением, содержащую нерасширенные ссылки на переменные среды, которые раскрываются при получении значения. Используется для значений REG_EXPAND_SZ.
• Двоичный: определяет двоичные данные в любой форме. Используется для значений REG_BINARY.
• DWord: указывает 32-битное двоичное число. Используется для значений REG_DWORD.
• MultiString: определяет массив строк с нулевым символом в конце, заканчивающихся двумя нулевыми символами. Используется для значений REG_MULTI_SZ.
• Qword: указывает 64-битное двоичное число. Используется для значений REG_QWORD.
• Неизвестно: указывает неподдерживаемый тип данных реестра, например значения REG_RESOURCE_LIST.

Тип :

РеестрValueKind

Позиция:

Именованный

Значение по умолчанию:

None

Необходимый:

False

Примите ввод конвейера:

True

Принимайте подстановочные знаки:

False

-Value

Указывает новое значение для элемента.

Тип :

Объект

Позиция:

1

Значение по умолчанию:

None

Необходимый:

False

Примите ввод конвейера:

True

Принимайте подстановочные знаки:

False

-WhatIf

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

Тип :

SwitchParameter

Псевдонимы:

wi

Позиция:

Именованный

Значение по умолчанию:

False

Необходимый:

False

Примите ввод конвейера:

False

Принимайте подстановочные знаки:

False

Входы

Объект

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

Выходы

Нет

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

Объект

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

Примечания

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

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

  si

• Set-Item не поддерживается поставщиком файловой системы PowerShell. Чтобы изменить значения элементов файловой системы, используйте командлет Set-Content.

• На дисках реестра HKLM: и HKCU: Set-Item изменяет данные в значении (по умолчанию) ключа реестра.

  • Чтобы создать и изменить имена разделов реестра, используйте командлеты New-Item и Rename-Item.
  • Чтобы изменить имена и данные в значениях реестра, используйте командлеты New-ItemProperty, Set-ItemProperty и Rename-ItemProperty.

• Set-Item предназначен для работы с данными, предоставляемыми любым поставщиком. Чтобы просмотреть список поставщиков, доступных в вашем сеансе, введите Get-PsProvider. Дополнительные сведения см. в разделе about_Providers.