Add-ManagementRoleEntry
このコマンドレットは、オンプレミスの Exchange およびクラウド ベースのサービスで使用できます。 一部のパラメーターと設定は、1 つの環境または別の環境に限定される場合があります。
既存の管理役割に管理役割エントリを追加するには、Add-ManagementRoleEntry コマンドレットを使用します。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
Identity
Add-ManagementRoleEntry
[-Identity] <RoleEntryIdParameter>
[-Confirm]
[-DomainController <Fqdn>]
[-Force]
[-Overwrite]
[-Parameters <String[]>]
[-PSSnapinName <String>]
[-Type <ManagementRoleEntryType>]
[-UnScopedTopLevel]
[-WhatIf]
[<CommonParameters>]
ParentRoleEntry
Add-ManagementRoleEntry
[-ParentRoleEntry] <RoleEntryIdParameter>
-Role <RoleIdParameter>
[-Confirm]
[-DomainController <Fqdn>]
[-Force]
[-Overwrite]
[-WhatIf]
[<CommonParameters>]
説明
役割エントリに追加するコマンドレットとパラメーターは、親の役割に存在している必要があります。 組み込みの役割に役割エントリを追加することはできません。
役割エントリが役割の親役割にある場合にのみ、役割を管理役割に追加することができます。 たとえば、メール受信者ロールの子であるロールに Search-Mailbox ロール エントリを追加しようとすると、エラーが発生します。 このエラーは、Search-Mailbox 役割エントリが Mail Recipients 役割に存在しないために発生します。 Search-Mailbox 役割エントリを役割に追加するには、Search-Mailbox 役割エントリを含む、Mailbox Import Export 役割の子である役割を作成する必要があります。 次に、Add-ManagementRoleEntry コマンドレットを使用して、Search-Mailbox 役割エントリを新しい子の役割に追加できます。
管理ロールのエントリについて詳しくは、「 管理ロールについて」を参照してください。
このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 この記事にはこのコマンドレットのすべてのパラメーターが一覧表示されていますが、自分に割り当てられているアクセス許可に含まれていない一部のパラメーターにはアクセスできません。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。
例
例 1
Add-ManagementRoleEntry "Recipient Administrators\Get-Mailbox"
この例では、Get-Mailbox コマンドレットの新しい役割エントリを受信者管理者の管理役割に追加します。 Get-Mailbox コマンドレットの役割エントリは、受信者管理者の親の役割で構成されているとおりに追加されます。
例 2
Add-ManagementRoleEntry "Recipient Administrators\Get-Mailbox" -Parameters "Identity","Anr","Server","Filter"
この例では、Get-Mailbox コマンドレットに対応する新しい役割エントリを受信者管理者の役割に追加します。 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 では、この例では、Department パラメーターと Location パラメーターを含む MailboxAudit スクリプトを IT スクリプトに範囲指定されていない最上位ロールを追加します。 UnScopedTopLevel スイッチには、スコープを指定しないロール管理ロールが必要ですが、これは既定ではどの役割グループにも割り当てられていません。
パラメーター
-Confirm
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、オンプレミス用の組み込みセキュリティ アドオンメールボックス
Confirm スイッチは、確認プロンプトを表示するか非表示にするかを指定します。 このスイッチがコマンドレットに与える影響は、コマンドレットが続行する前に確認を必要とするかどうかによって異なります。
- データを破壊するコマンドレット (たとえば、Remove- コマンドレット) には、先に進む前にユーザーにそのコマンドの確認を強制する組み込みの一時停止があります。 これらのコマンドレットでは、正確な構文
-Confirm:$falseを使用して、確認プロンプトを省略できます。 - 他のほとんどのコマンドレット (たとえば、New-* や Set-* コマンドレット) には、組み込みの一時停止はありません。 これらのコマンドレットの場合、値を指定せずに Confirm スイッチを指定すると、一時停止が発生し、続行する前にコマンドの確認を強制されます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | Cf |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DomainController
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
DomainController パラメーターは、このコマンドレットで Active Directory からのデータの読み取りまたは Active Directory へのデータの書き込みに使用されるドメイン コントローラーを指定します。 ドメイン コントローラーは、完全修飾ドメイン名 (FQDN) で識別します。 たとえば、dc01.contoso.com です。
パラメーターのプロパティ
| 型: | Fqdn |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Force
適用対象: Exchange Online、オンプレミス メールボックス用の組み込みセキュリティ アドオン
このパラメーターは、クラウドベースのサービスでのみ使用できます。
[強制] スイッチは、警告または確認メッセージを非表示にします。 このスイッチで値を指定する必要はありません。
管理者の入力を求めることが不適切な場合に、このスイッチを使用してタスクをプログラムによって実行することができます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Identity
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、オンプレミス用の組み込みセキュリティ アドオンメールボックス
ID パラメーターには、追加するロール エントリを指定します。 このパラメーターでは、構文 Management role\role entry name を使用します (たとえば、 CustomRole\Set-Mailbox)。
管理ロールのエントリのしくみの詳細については、「 管理ロールについて」を参照してください。
追加する役割エントリは、親の役割に存在している必要があります。 役割エントリ名にスペースが含まれている場合、名前を二重引用符 (") で囲む必要があります。
パラメーターのプロパティ
| 型: | RoleEntryIdParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Identity
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Overwrite
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、オンプレミス用の組み込みセキュリティ アドオンメールボックス
[上書き] スイッチを使用すると、既存のロール エントリが、追加されるロール エントリによって上書きされます。 このスイッチで値を指定する必要はありません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Parameters
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、オンプレミス用の組み込みセキュリティ アドオンメールボックス
Parameters パラメーターには、追加される役割に含めるパラメーターを指定します。 指定するパラメーターは、役割エントリに関連付けられているコマンドレットに存在している必要があります。 複数のパラメーターをコンマで区切って指定できます。
パラメーターのプロパティ
| 型: | String[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Identity
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ParentRoleEntry
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、オンプレミス用の組み込みセキュリティ アドオンメールボックス
Role パラメーターで指定された役割を追加するために、ParentRoleEntry パラメーターには、親の役割にある役割エントリを指定します。 一般的に、このパラメーターは直接指定するものではありませんが、Get-ManagementRoleEntry コマンドレットからの役割エントリのパイプ処理を有効にするために使用されます。 ParentRoleEntry パラメーターを使用する場合、UnScopedTopLevel スイッチは使用できません。
パラメーターのプロパティ
| 型: | RoleEntryIdParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ParentRoleEntry
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-PSSnapinName
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
PSSnapinName パラメーターは、追加されるロールに関連付けられたコマンドレットを含む Windows PowerShell スナップインを指定します。 Get-PSSnapin コマンドレットを使用して、利用可能な Windows PowerShell スナップインの一覧を取得します。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Identity
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Role
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、オンプレミス用の組み込みセキュリティ アドオンメールボックス
Role パラメーターには、ParentRoleEntry パラメーターで指定した新しい役割エントリの追加先となる、役割を指定します。
パラメーターのプロパティ
| 型: | RoleIdParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ParentRoleEntry
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Type
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、オンプレミス用の組み込みセキュリティ アドオンメールボックス
Type パラメーターには、追加される役割の種類を指定します。 有効な値は、Cmdlet、Script、および ApplicationPermission です。
パラメーターのプロパティ
| 型: | ManagementRoleEntryType |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Identity
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-UnScopedTopLevel
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
既定では、このパラメーターは "スコープが指定されていないロール管理" ロールでのみ使用でき、そのロールはどのロール グループにも割り当てられていません。 このパラメーターを使用するには、範囲を指定しないロール管理ロールを役割グループに追加する必要があります (たとえば、組織管理役割グループ)。 詳細については、「役割グループへ役割を追加する」を参照してください。
UnScopedTopLevel スイッチは、範囲が設定されていない最上位管理ロールにロール エントリを追加することを指定します。 このスイッチで値を指定する必要はありません。
範囲が設定されていない最上位管理ロールには、カスタム スクリプトまたは Exchange 以外のコマンドレットのみを含めることができます。 詳細については、「 スコープなしロールの作成」を参照してください。
このスイッチを ParentRoleEntry パラメーターと一緒に使用することはできません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Identity
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、オンプレミス用の組み込みセキュリティ アドオンメールボックス
[WhatIf] スイッチは、何も変更を加えずにコマンドが実行する内容を表示します。 このスイッチで値を指定する必要はありません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | wi |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットは、共通パラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable をサポートします。 詳細については、「about_CommonParameters」を参照してください。
入力
Input types
このコマンドレットに使用できる入力の種類を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 コマンドレットで入力の種類のフィールドが空白の場合、そのコマンドレットには入力データを指定できません。
出力
Output types
このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。