Set-ManagementRoleEntry

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

使用 Set-ManagementRoleEntry cmdlet 可以更改现有角色条目中的可用参数。

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

语法

Default (默认值)

Set-ManagementRoleEntry
    [-Identity] <RoleEntryIdParameter>
    [-AddParameter]
    [-Confirm]
    [-DomainController <Fqdn>]
    [-Force]
    [-Parameters <String[]>]
    [-RemoveParameter]
    [-UnScopedTopLevel]
    [-WhatIf]
    [<CommonParameters>]

说明

Set-ManagementRoleEntry cmdlet 可更改现有角色条目中的可用参数。 如果要向角色条目中添加参数,则这些参数必须存在于父管理角色的角色条目中。 如果要从角色条目中删除参数,则子角色中不能存在从您要更改的角色条目继承这些参数的角色条目。 不能更改与内置角色相关联的角色条目。

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

您必须先获得权限,然后才能运行此 cmdlet。 尽管本文列出了 cmdlet 的所有参数,但如果某些参数未包含在分配给你的权限中,则可能无法访问这些参数。 若要查找在贵组织中运行任何 cmdlet 或参数所需的权限,请参阅 Find the permissions required to run any Exchange cmdlet

示例

示例 1

Set-ManagementRoleEntry "Help Desk Personnel\Get-Mailbox" -Parameters "Anr","Database" -RemoveParameter

本示例将从 Help Desk Personnel 角色上的 Get-Mailbox 角色条目中删除 Anr 参数和 Database 参数。

示例 2

Get-ManagementRoleEntry "Help Desk Personnel\*" | Set-ManagementRoleEntry -Parameters WhatIf -AddParameter

本示例将在 Help Desk Personnel 角色上检索角色条目列表,并使用 Set-ManagementRoleEntry cmdlet 将 WhatIf 开关添加到每个角色条目。

示例 3

Set-ManagementRoleEntry "Tier 1 Help Desk\Set-Mailbox" -Parameters "DisplayName","ForwardingAddress"

本示例将 DisplayName 参数和 ForwardingAddress 参数添加到 Tier 1 Help Desk 角色上的 Set-Mailbox 角色条目,并删除该角色条目中的所有其他参数。

示例 4

Set-ManagementRoleEntry "IT Scripts\MailboxAudit" -Parameters Location -AddParameter -UnScopedTopLevel

在本地 Exchange 中,此示例将 Location 参数添加到 IT 脚本无作用域顶级角色上的 MailboxAudit 自定义脚本。 UnScopedTopLevel 开关需要“未作用域角色管理”角色,默认情况下,该角色不会分配给任何角色组。

参数

-AddParameter

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

AddParameter 开关指定向指定角色条目添加参数。 不必为此开关指定值。

使用 Parameters 参数指定要添加的参数。

不能在同一命令中同时使用 AddParameter 开关和 RemoveParameter 开关。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-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
默认值:None
支持通配符:False
不显示:False
别名:cf

参数集

(All)
Position:Named
必需:False
来自管道的值: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
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Force

适用:Exchange Online、Exchange Online Protection

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

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

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

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值: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
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:1
必需:True
来自管道的值:True
来自管道的值(按属性名称):True
来自剩余参数的值:False

-Parameters

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

Parameters 参数指定要在角色条目中添加或删除的参数。

Parameters 参数具有下列模式:

  • 与 AddParameter 参数一起使用时,将向角色条目添加指定的参数。
  • 与 RemoveParameter 参数一起使用时,将从角色条目中删除指定的参数。
  • 如果既未使用 AddParameter 参数,也未使用 RemoveParameter 参数,则角色条目中只包含指定的参数。 如果指定了值 $Null,并且未使用 AddParameter 和 RemoveParameter 参数,则将删除角色条目中的所有参数。

可以指定多个参数,用逗号进行分隔。

参数属性

类型:

String[]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-RemoveParameter

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

RemoveParameter 开关指定删除指定角色条目的参数。 不必为此开关指定值。

使用 Parameters 参数指定要删除的参数。

不能在同一命令中同时使用 AddParameter 开关和 RemoveParameter 开关。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-UnScopedTopLevel

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

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

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

UnScopedTopLevel 开关指定要修改的角色条目位于未作用域的顶级角色上。 不必为此开关指定值。

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

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-WhatIf

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

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

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:无线

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters

输入

Input types

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

输出

Output types

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