Add-ManagementRoleEntry

此 cmdlet 可在本地 Exchange 和基于云的服务中使用。 一些参数和设置可能只适用于某个特定的环境。

使用 Add-ManagementRoleEntry cmdlet 将管理角色条目添加到现有管理角色。

有关以下语法部分的参数设置的详细信息,请参阅 Exchange cmdlet 语法

语法

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>]

说明

添加到角色条目的 cmdlet 及其参数必须存在于父角色中。 无法向内置角色添加角色条目。

如果角色的父角色中存在角色条目,则只能向管理角色添加角色条目。 例如,如果尝试将 Search-Mailbox 角色条目添加到邮件收件人角色的子角色,将收到错误。 发生此错误的原因是邮件收件人角色中不存在 Search-Mailbox 角色条目。 若要将 Search-Mailbox 角色条目添加到角色,需要创建一个角色,该角色是邮箱导入导出角色的子角色,其中包含 Search-Mailbox 角色条目。 然后,可以使用 Add-ManagementRoleEntry cmdlet 将 Search-Mailbox 角色条目添加到新的子角色。

有关管理角色条目的详细信息,请参阅 了解管理角色

您必须先获得权限,然后才能运行此 cmdlet。 虽然本主题中列出了此 cmdlet 的所有参数,但如果这些参数并未包含在分配给您的权限中,那么您将无法使用这些参数。 若要查找在贵组织中运行任何 cmdlet 或参数所需的权限,请参阅 Find the permissions required to run any Exchange cmdlet

示例

示例 1

Add-ManagementRoleEntry "Recipient Administrators\Get-Mailbox"

本示例将 Get-Mailbox cmdlet 的新角色条目添加到“收件人管理员”管理角色。 Get-Mailbox cmdlet 的角色条目与在“收件人管理员”父角色中的配置完全相同。

示例 2

Add-ManagementRoleEntry "Recipient Administrators\Get-Mailbox" -Parameters "Identity","Anr","Server","Filter"

本示例将 Get-Mailbox cmdlet 的新角色条目添加到“收件人管理员”角色。 只有 Identity、Anr、Server 和 Filter 参数才会添加到新角色条目。

示例 3

Get-ManagementRoleEntry "Mail Recipients\*Mailbox*" | Add-ManagementRoleEntry -Role "Mailbox Administrators"

此示例使用 Get-ManagementRoleEntry cmdlet 检索邮件收件人管理角色上存在的所有角色条目的列表,这些角色条目在 cmdlet 名称中包含字符串“Mailbox”,然后使用 Add-ManagementRoleEntry cmdlet 将它们添加到邮箱管理员角色。 角色条目将完全按照在父角色上配置的方式添加到子角色。

示例 4

Add-ManagementRoleEntry "IT Scripts\MailboxAudit" -Parameters "Department","Location" -UnScopedTopLevel

在本地 Exchange 中,本示例将具有 Department 和 Location 参数的 MailboxAudit 脚本添加到 IT 脚本非作用域顶级角色。 请注意,UnScopedTopLevel 开关需要“未作用域角色管理”角色,默认情况下,该角色不会分配给任何角色组。

参数

-Confirm

适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Online、Exchange Online Protection

Confirm 开关指定是否显示确认提示。 此开关对 cmdlet 造成的影响取决于在你继续操作之前 cmdlet 是否需要确认。

  • 破坏性 cmdlet(例如 Remove-* cmdlets)内置有暂停,可强制要求先确认命令,然后再继续操作。 对于这些 cmdlet,您可以使用此确切语法跳过确认提示:-Confirm:$false
  • 其他大多数 cmdlet(例如 New-* 和 Set-* cmdlet)都没有内置暂停。 对于这些 cmdlet,指定不含值的 Confirm 开关会引入暂停,从而强制要求你先确认命令,然后再继续操作。
类型:SwitchParameter
别名:cf
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-DomainController

适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019

此参数只在本地 Exchange 中可用。

DomainController 参数指定此 cmdlet 从 Active Directory 读取数据或向其写入数据时使用的域控制器。 可以使用完全限定的域名 (FQDN) 来标识域控制器。 例如,dc01.contoso.com。

类型:Fqdn
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Force

适用:Exchange Online、Exchange Online Protection

此参数仅在基于云的服务中可用。

强制开关隐藏警告或确认消息。 不必为此开关指定值。

您可以在以编程方式运行任务时使用此开关,因为此时并不适合提示用户提供管理输入。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Identity

适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Online、Exchange Online Protection

Identity 参数指定要添加的角色条目。 此参数使用语法: Management role\role entry name (例如 CustomRole\Set-Mailbox ,) 。

有关管理角色条目工作原理的详细信息,请参阅 了解管理角色

要添加的角色条目必须存在于父角色中。 如果角色条目名称包含空格,则必须将名称括在引号 (“) 中。

类型:RoleEntryIdParameter
Position:1
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-Overwrite

适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Online、Exchange Online Protection

“覆盖”开关会导致添加的角色条目覆盖现有角色条目。 不必为此开关指定值。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Parameters

适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Online、Exchange Online Protection

Parameters 参数指定要包含在要添加的角色中的参数。 指定的参数必须存在于与角色条目关联的 cmdlet 上。 可以指定多个参数,用逗号进行分隔。

类型:String[]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ParentRoleEntry

适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Online、Exchange Online Protection

ParentRoleEntry 参数指定要添加到使用 Role 参数指定的角色的父角色中的角色条目。 此参数通常不直接使用,但存在用于启用 Get-ManagementRoleEntry cmdlet 中的角色条目的管道。 如果使用 ParentRoleEntry 参数,则无法使用 UnScopedTopLevel 开关。

类型:RoleEntryIdParameter
Position:1
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-PSSnapinName

适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019

此参数只在本地 Exchange 中可用。

PSSnapinName 参数指定Windows PowerShell管理单元,其中包含与要添加的角色关联的 cmdlet。 使用 Get-PSSnapin cmdlet 检索可用Windows PowerShell管理单元的列表。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Role

适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Online、Exchange Online Protection

Role 参数指定由 ParentRoleEntry 参数指定的新角色条目添加到的角色。

类型:RoleIdParameter
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-Type

适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Online、Exchange Online Protection

Type 参数指定要添加的角色条目的类型。 有效值为 Cmdlet、Script 和 ApplicationPermission。

类型:ManagementRoleEntryType
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-UnScopedTopLevel

适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019

此参数只在本地 Exchange 中可用。

默认情况下,此参数仅在“无作用域角色管理”角色中可用,并且该角色不分配给任何角色组。 若要使用此参数,需要将“未作用域角色管理”角色添加到角色组 (例如,将“组织管理”角色组) 。 有关详细信息,请参阅向角色组添加角色

UnScopedTopLevel 开关指定将角色条目添加到未作用域的顶级管理角色。 不必为此开关指定值。

无作用域的顶级管理角色只能包含自定义脚本或非 Exchange cmdlet。 有关详细信息,请参阅 创建无作用域角色

不能将此开关与 ParentRoleEntry 参数一起使用。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-WhatIf

适用:Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Online、Exchange Online Protection

WhatIf 开关模拟命令操作。 可以使用此开关在不实际应用将会发生的更改的情况下预览这些更改。 不必为此开关指定值。

类型:SwitchParameter
别名:wi
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

输入

Input types

若要了解此 cmdlet 接受的输入类型,请参阅 cmdlet 的输入和输出类型。 如果 cmdlet 的"输入类型"字段为空,则表明此 cmdlet 不接受输入数据。

输出

Output types

若要了解此 cmdlet 接受的返回类型(亦称为"输出类型"),请参阅 cmdlet 的输入和输出类型。 如果"输出类型"字段为空,则表明此 cmdlet 不返回任何数据。