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

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]
      [<CommonParameters>]
Rename-ItemProperty
      -LiteralPath <String>
      [-Name] <String>
      [-NewName] <String>
      [-PassThru]
      [-Force]
      [-Filter <String>]
      [-Include <String[]>]
      [-Exclude <String[]>]
      [-Credential <PSCredential>]
      [-WhatIf]
      [-Confirm]
      [<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

Заметка

Этот параметр не поддерживается поставщиками, установленными с помощью PowerShell. Чтобы олицетворить другого пользователя или повысить свои учетные данные при выполнении этого командлета, используйте Invoke-Command.

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

-Exclude

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

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

-Filter

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

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

-Force

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

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

-Include

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

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

-LiteralPath

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

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

Тип:String
Aliases:PSPath, LP
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

-WhatIf

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

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

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

String

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

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

None

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

PSCustomObject

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

Примечания

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

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

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