Поделиться через

Rename-ItemProperty

  • Ссылка
Модуль:
Microsoft.PowerShell.Management

Переименовывает свойство элемента.

Синтаксис

Rename-ItemProperty
      [-Path] <String>
      [-Name] <String>
      [-NewName] <String>
      [-PassThru]
      [-Force]
      [-Filter <String>]
      [-Include <String[]>]
      [-Exclude <String[]>]
      [-Credential <PSCredential>]
      [-WhatIf]
      [-Confirm]
      [-UseTransaction]
      [<CommonParameters>]
Rename-ItemProperty
      -LiteralPath <String>
      [-Name] <String>
      [-NewName] <String>
      [-PassThru]
      [-Force]
      [-Filter <String>]
      [-Include <String[]>]
      [-Exclude <String[]>]
      [-Credential <PSCredential>]
      [-WhatIf]
      [-Confirm]
      [-UseTransaction]
      [<CommonParameters>]

Описание

Командлет Rename-ItemProperty изменяет имя указанного свойства элемента. Значение свойства не изменяется. Например, можно использовать Rename-ItemProperty для изменения имени записи реестра.

Примеры

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

Эта команда переименовывает запись реестра конфигурации, содержащуюся в разделе "HKEY_LOCAL_MACHINE\Software\SmpApplication" в "oldconfig".

Rename-ItemProperty -Path HKLM:\Software\SmpApplication -Name config -NewName oldconfig

Параметры

-Confirm

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

Тип:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Credential

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

Введите имя пользователя, например User01 или Domain01\User01, или введите объект PSCredential, например объект, созданный командлетом Get-Credential. Если ввести имя пользователя, вам будет предложено ввести пароль.

Предупреждение

Этот параметр не поддерживается поставщиками, установленными в Windows PowerShell.

Тип:PSCredential
Position:Named
Default value:Current user
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-Exclude

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

Тип:String[]
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:True

-Filter

Задает фильтр в формате или языке поставщика. Значение этого параметра квалифифициирует параметр Path.

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

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:True

-Force

Принудительно переименовывает командлет для переименования свойства объекта, к которому в противном случае не удается получить доступ пользователю. Реализация зависит от поставщика к поставщику. Дополнительные сведения см. в разделе about_Providers.

Тип:SwitchParameter
Position:Named
Default value:False
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Include

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

Тип:String[]
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:True

-LiteralPath

Указывает путь к свойству элемента. В отличие от параметра пути значение ЛитерPath используется точно так же, как и типизированный. Символы не интерпретируются как подстановочные знаки. Если путь содержит escape-символы, заключите его в одинарные кавычки. Одинарные кавычки говорят PowerShell не интерпретировать какие-либо символы как escape-последовательности.

Тип:String
Aliases:PSPath
Position:Named
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-Name

Указывает текущее имя свойства для переименования.

Тип:String
Aliases:PSProperty
Position:1
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-NewName

Задает новое имя свойства.

Тип:String
Position:2
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-PassThru

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

Тип:SwitchParameter
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Path

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

Тип:String
Position:0
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:True

-UseTransaction

Включает команду в активную транзакцию. Этот параметр действителен только в том случае, если выполняется транзакция. Дополнительные сведения см. в about_Transactions.

Тип:SwitchParameter
Aliases:usetx
Position:Named
Default value:False
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-WhatIf

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

Тип:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

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

String

Можно передать строку, содержащую путь, но не литеральный путь к этому командлету.

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

None, System.Management.Automation.PSCustomObject

Этот командлет создает PSCustomObject, представляющий переименованное свойство элемента, если указать параметр PassThru. В противном случае этот командлет не создает выходные данные.

Примечания

Remove-ItemProperty предназначен для работы с данными, предоставляемыми любым поставщиком. Чтобы вывести список поставщиков, доступных в сеансе, введите Get-PSProvider. Дополнительные сведения см. в разделе about_Providers.