Get-ManagementRole
このコマンドレットは、オンプレミスの Exchange およびクラウド ベースのサービスで使用できます。 一部のパラメーターおよび設定は、いずれかの環境専用となっている場合があります。
組織内で作成された管理役割を表示するには、Get-ManagementRole コマンドレットを使用します。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
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 コマンドレットの出力を Format-List コマンドレットにパイプ処理することで、特定の役割の詳細を表示することもできます。
管理役割の詳細については、「管理の役割について」を参照してください。
このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 このトピックにはこのコマンドレットのすべてのパラメーターが一覧表示されていますが、自分に割り当てられているアクセス許可に含まれていない一部のパラメーターにはアクセスできません。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 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 以外のコマンドレットが含まれています。
例 5
Get-ManagementRole "Transport Rules" | Format-List Name, RoleTypeこの例では、トランスポート ルールの役割のみが取得され、Get-ManagementRole コマンドレットの出力が Format-List コマンドレットに渡されます。 Format-List コマンドレットにより、トランスポート ルールの役割の Name プロパティと RoleType プロパティのみが表示されます。 パイプライン処理とFormat-List コマンドレットの詳細については、「 パイプライン について」と「 コマンド出力の操作」を参照してください。
例 6
Get-ManagementRole "Mail Recipients" -GetChildrenこの例では、メール受信者の役割の直下の子を一覧表示します。 メール受信者の役割を親役割として保持している子役割のみが返されます。 メール受信者の役割はリストに返されません。
パラメーター
-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 パラメーターは、このコマンドレットで Active Directory からのデータの読み取りまたは 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
このコマンドレットに使用できる入力の種類を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 コマンドレットで入力の種類のフィールドが空白の場合、そのコマンドレットには入力データを指定できません。
出力
Output types
このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。