Add-ManagementRoleEntry
Этот командлет доступен в локальной среде Exchange и в облачной службе. Некоторые параметры и настройки могут отличаться в зависимости от среды.
Используйте командлет Add-ManagementRoleEntry для добавления записей роли управления к существующей роли управления.
Сведения о наборах параметров в разделе Синтаксис ниже см. В разделе Синтаксис командлета Exchange.
Синтаксис
Add-ManagementRoleEntry
[-Identity] <RoleEntryIdParameter>
[-Confirm]
[-DomainController <Fqdn>]
[-Force]
[-Overwrite]
[-Parameters <String[]>]
[-PSSnapinName <String>]
[-Type <ManagementRoleEntryType>]
[-UnScopedTopLevel]
[-WhatIf]
[<CommonParameters>] Add-ManagementRoleEntry
[-ParentRoleEntry] <RoleEntryIdParameter>
-Role <RoleIdParameter>
[-Confirm]
[-DomainController <Fqdn>]
[-Force]
[-Overwrite]
[-WhatIf]
[<CommonParameters>] Описание
Командлет и его параметры, добавляемые к записи роли, должны существовать в родительской роли. Добавление записей роли во встроенные роли невозможно.
Запись роли можно добавить в роль управления только в случае, если запись роли существует в родительской роли этой роли управления. Например, при попытке добавить запись роли Search-Mailbox в дочернюю роль роли получателей почты, возникнет ошибка. Ошибка возникает из-за того, что запись роли Search-Mailbox не существует в роли получателей почты. Чтобы добавить запись роли Search-Mailbox в роль, следует создать роль, дочернюю по отношению к роли импорта и экспорта почтовых ящиков, которая содержит запись роли Search-Mailbox. Затем можно будет использовать командлет Add-ManagementRoleEntry для добавления записи роли Search-Mailbox в новую дочернюю роль.
Дополнительные сведения о записях ролей управления см. в разделе Общие сведения о ролях управления.
Для его запуска необходимо получить соответствующие разрешения. В этой статье перечислены все параметры командлета. Но некоторые из них могут быть вам не доступны, если они не включены в назначенные разрешения. Сведения о необходимых разрешениях для запуска командлетов и использования параметров в организации см. в статье Find the permissions required to run any Exchange cmdlet.
Примеры
Пример 1
Add-ManagementRoleEntry "Recipient Administrators\Get-Mailbox"В этом примере новая запись роли для командлета Get-Mailbox добавляется к роли "Recipient Administrators". Запись роли для командлета Get-Mailbox добавляется в точном соответствии с ее конфигурацией в родительской роли "Recipient Administrators".
Пример 2
Add-ManagementRoleEntry "Recipient Administrators\Get-Mailbox" -Parameters "Identity","Anr","Server","Filter"В этом примере новая запись роли для командлета Get-Mailbox добавляется к роли управления "Recipient Administrators". В новую запись роли добавляются только параметры Identity, Anr, Server и Filter.
Пример 3
Get-ManagementRoleEntry "Mail Recipients\*Mailbox*" | Add-ManagementRoleEntry -Role "Mailbox Administrators"В этом примере командлет Get-ManagementRoleEntry используется для получения списка всех записей ролей, существующих в роли управления "Получатели почты", содержащей строку "Mailbox" в имени командлета, а затем добавляет их в роль "Администраторы почтовых ящиков" с помощью командлета Add-ManagementRoleEntry. Записи роли добавляются в дочернюю роль точно так же, как они настроены для родительской роли.
Пример 4
Add-ManagementRoleEntry "IT Scripts\MailboxAudit" -Parameters "Department","Location" -UnScopedTopLevelВ локальной среде Exchange в этом примере скрипт MailboxAudit с параметрами Department и Location добавляется в роль верхнего уровня "ИТ-скрипты без параметров". Обратите внимание, что для параметра UnScopedTopLevel требуется роль UnScoped Role Management, которая по умолчанию не назначается ни одной группе ролей.
Параметры
-Confirm
Переключатель подтверждения указывает, показывать или скрывать запрос подтверждения. Влияние этого параметра на командлет зависит от того, требуется ли командлету подтверждение перед выполнением.
- Деструктивные командлеты (например, командлеты Remove-*) имеют встроенную паузу, которая заставляет вас подтвердить команду перед продолжением. Можно пропускать запросы на подтверждение этих командлетов, используя следующий синтаксис:
-Confirm:$false. - Большинство других командлетов (например, командлеты New-* и Set-*) не имеют встроенной приостановки. Для этих командлетов указание переключателя Confirm без значения вводит паузу, которая заставляет вас подтвердить команду перед продолжением.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-DomainController
Этот параметр доступен только в локальной среде Exchange.
Параметр DomainController указывает контроллер домена, который используется этим командлетом для чтения или записи данных в Active Directory. Вы определяете контроллер домена по его полному доменному имени (FQDN). Например, dc01.contoso.com.
| Type: | Fqdn |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-Force
Этот параметр доступен только в облачной службе.
Переключатель "Принудительно" скрывает сообщения с предупреждениями или подтверждениями. Указывать значение для этого параметра необязательно.
Этот параметр можно применять для программного выполнения задач, не требующего вмешательства администратора.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online, Exchange Online Protection |
-Identity
Параметр Identity указывает запись роли, которую требуется добавить. В этом параметре используется синтаксис : Management role\role entry name (например, CustomRole\Set-Mailbox).
Дополнительные сведения о работе записей ролей управления см. в разделе Общие сведения о ролях управления.
Добавляемая запись роли должна существовать в родительской роли. Если имя записи роли содержит пробелы, его необходимо заключить в кавычки (").
| Type: | RoleEntryIdParameter |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-Overwrite
Параметр Перезаписать приводит к тому, что существующие записи роли будут перезаписаны добавляемыми записями ролей. Для этого переключателя не требуется указывать значение.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-Parameters
Параметр Parameters указывает параметры, включенные в добавляемую роль. Указанные параметры должны существовать в командлете, связанном с записью роли. Можно указать несколько параметров, разделенных запятыми.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-ParentRoleEntry
Параметр ParentRoleEntry указывает запись в родительской роли, которая добавляется в роль, указанную в параметре Role. Обычно это параметр не используется напрямую, но позволяет осуществить передачу записей роли из командлета Get-ManagementRoleEntry. При использовании параметра ParentRoleEntry использование параметра UnScopedTopLevel невозможно.
| Type: | RoleEntryIdParameter |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-PSSnapinName
Этот параметр доступен только в локальной среде Exchange.
Параметр PSSnapinName указывает оснастку Windows PowerShell, содержащую командлет, связанный с добавляемой ролью. Используйте командлет Get-PSSnapin для получения списка доступных оснастки Windows PowerShell.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-Role
Параметр Role указывает роль, в которую добавляется новая запись роли, указанная в параметре ParentRoleEntry.
| Type: | RoleIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-Type
Параметр Type указывает тип добавляемой записи роли. Допустимые значения: Командлет, Скрипт и ApplicationPermission.
| Type: | ManagementRoleEntryType |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-UnScopedTopLevel
Этот параметр доступен только в локальной среде Exchange.
По умолчанию этот параметр доступен только в роли "Управление ролями UnScoped", и эта роль не назначается ни одной группе ролей. Чтобы использовать этот параметр, необходимо добавить роль UnScoped Role Management в группу ролей (например, в группу ролей Управление организацией). Подробнее см. в разделе Добавление роли в группу ролей.
Параметр UnScopedTopLevel указывает, что вы добавляете запись роли в неуправляемую роль управления верхнего уровня. Указывать значение для этого параметра необязательно.
Неуправляемые роли управления верхнего уровня могут содержать только пользовательские скрипты или командлеты, отличные от Exchange. Дополнительные сведения см. в разделе Создание роли без параметров.
Этот параметр нельзя использовать с параметром ParentRoleEntry.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-WhatIf
Переключатель WhatIf имитирует действия команды. Вы можете использовать его для просмотра результатов изменений без фактического внесения этих изменений. С этим параметром не нужно указывать значение.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
Входные данные
Input types
Сведения о типах входных данных, которые принимает этот командлет, см. в разделе Типы входных и выходных данных командлетов. Если поле Тип ввода для командлета пустое, командлет не принимает входные данные.
Выходные данные
Output types
Сведения о типах возвращаемых данных, которые также называются типами выходных данных, которые принимает этот командлет, см. в разделе Типы входных и выходных данных командлетов. Если поле Тип вывода пусто, командлет не возвращает данные.