Get-ManagementRole

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

使用 Get-ManagementRole cmdlet 可以查看组织内已创建的管理角色。

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

语法

Get-ManagementRole
   [-Identity] <RoleIdParameter>
   [-GetChildren]
   [-DomainController <Fqdn>]
   [-RoleType <RoleType>]
   [<CommonParameters>]
Get-ManagementRole
   [-Identity] <RoleIdParameter>
   [-Recurse]
   [-DomainController <Fqdn>]
   [-RoleType <RoleType>]
   [<CommonParameters>]
Get-ManagementRole
   [[-Identity] <RoleIdParameter>]
   [-Cmdlet <String>]
   [-CmdletParameters <String[]>]
   [-DomainController <Fqdn>]
   [-RoleType <RoleType>]
   [<CommonParameters>]
Get-ManagementRole
   [[-Identity] <RoleIdParameter>]
   [-Script <String>]
   [-ScriptParameters <String[]>]
   [-DomainController <Fqdn>]
   [-RoleType <RoleType>]
   [<CommonParameters>]

说明

您可以通过多种方式查看管理角色,包括列出组织中的所有角色、仅列出指定父角色的子角色等。 还可以查看特定角色的详细信息,方法是通过管道将 Get-ManagementRole cmdlet 的输出传递给 Format-List cmdlet。

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

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

示例

示例 1

Get-ManagementRole

本示例列出了在组织中创建的所有角色。

示例 2

Get-ManagementRole "Mail Recipients" -Recurse

本示例列出了“邮件收件人”管理角色的所有子角色。 此命令将对指定父角色的所有子角色执行递归查询。 此递归查询将查找每一个子角色,从父角色的直接子角色到层次结构中的最后一个子角色。 在递归列表中,还将返回父角色。

示例 3

Get-ManagementRole -CmdletParameters Identity, Database

本示例列出了同时包含 Identity 和 Database 参数的所有角色。 不返回仅包含其中一个参数的角色。

示例 4

Get-ManagementRole -RoleType UnScopedTopLevel

本示例列出了类型为 UnScopedTopLevel 的所有角色。 这些角色包含自定义脚本或非 Exchange cmdlet。

示例 5

Get-ManagementRole "Transport Rules" | Format-List Name, RoleType

本示例仅检索“传输规则”角色,并将 Get-ManagementRole cmdlet 的输出传递给 Format-List cmdlet。 随后,Format-List cmdlet 将只显示“传输规则”角色的 Name 和 RoleType 属性。 有关管道和 Format-List cmdlet 的详细信息,请参阅 关于管道使用命令输出

示例 6

Get-ManagementRole "Mail Recipients" -GetChildren

本示例列出了“邮件收件人”角色的直接子角色。 仅返回将“邮件收件人”角色作为其父角色的子角色。 不在列表中返回“邮件收件人”角色。

参数

-Cmdlet

Cmdlet 参数返回包含指定 cmdlet 的所有角色的列表。

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, Security & Compliance, Exchange Online Protection

-CmdletParameters

CmdletParameters 参数返回包括指定参数的所有角色列表。 可以用逗号分隔每个参数来指定多个参数。 如果指定多个参数,则仅返回包括所有指定参数的角色。

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, Security & Compliance, Exchange Online Protection

-DomainController

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

DomainController 参数指定此 cmdlet 从 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

-GetChildren

GetChildren 参数检索根据 Identity 参数中指定的父角色创建的所有角色列表。 不必为此开关指定值。

结果中仅包含父角色的直接子角色。

只能将此开关与 Identity 和 RoleType 参数一起使用。

Type:SwitchParameter
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, Security & Compliance, Exchange Online Protection

-Identity

Identity 参数指定要查看的角色。 如果要查看的角色中包含空格,则使用引号 (") 将该名称括起来。 可以使用通配符 (*) 和部分角色名称来匹配多个角色。

Type:RoleIdParameter
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, Security & Compliance, Exchange Online Protection

-Recurse

Recurse 参数检索根据 Identity 参数中指定的父角色创建的所有角色列表。 不必为此开关指定值。

返回在 Identity 参数中指定的角色、其子角色及子角色的子角色。

只能将此开关与 Identity 和 RoleType 参数一起使用。

Type:SwitchParameter
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, Security & Compliance, Exchange Online Protection

-RoleType

RoleType 参数返回与指定的角色类型匹配的角色列表。 有关有效角色类型的列表,请参阅 了解管理角色

Type:RoleType
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, Security & Compliance, Exchange Online Protection

-Script

Script 参数返回包含指定脚本的所有角色的列表。

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, Security & Compliance, Exchange Online Protection

-ScriptParameters

ScriptParameters 参数返回包括指定参数的所有角色列表。 可以用逗号分隔每个参数来指定多个参数。 如果指定多个参数,则仅返回包括所有指定参数的角色。

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, Security & Compliance, Exchange Online Protection

输入

Input types

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

输出

Output types

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