Set-ManagementRoleEntry
このコマンドレットは、オンプレミスの Exchange およびクラウド ベースのサービスで使用できます。 一部のパラメーターと設定は、1 つの環境または他の環境に限定される場合があります。
既存の管理役割エントリで使用可能なパラメーターを変更するには、Set-ManagementRoleEntry コマンドレットを使用します。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
Default (既定)
Set-ManagementRoleEntry
[-Identity] <RoleEntryIdParameter>
[-AddParameter]
[-Confirm]
[-DomainController <Fqdn>]
[-Force]
[-Parameters <String[]>]
[-RemoveParameter]
[-UnScopedTopLevel]
[-WhatIf]
[<CommonParameters>]
説明
Set-ManagementRoleEntry コマンドレットは、既存の役割エントリで使用可能なパラメーターを変更します。 役割エントリにパラメーターを追加する場合、パラメーターは親管理役割内の役割エントリに置く必要があります。 役割エントリからパラメーターを削除する場合、変更する役割エントリのパラメーターを継承する役割エントリが子役割内に存在することはできません。 組み込みの役割に関連付けられている役割エントリは変更できません。
管理ロール エントリの詳細については、「 管理ロールについて」を参照してください。
このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 この記事ではコマンドレットのすべてのパラメーターを一覧表示しますが、割り当てられたアクセス許可にパラメーターが含まれていない場合は、一部のパラメーターにアクセスできない可能性があります。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。
例
例 1
Set-ManagementRoleEntry "Help Desk Personnel\Get-Mailbox" -Parameters "Anr","Database" -RemoveParameter
この例では、Anr パラメーターと Database パラメーターを、Help Desk Personnel 役割にある Get-Mailbox 役割エントリから削除します。
例 2
Get-ManagementRoleEntry "Help Desk Personnel\*" | Set-ManagementRoleEntry -Parameters WhatIf -AddParameter
この例では、Help Desk Personnel 役割の役割エントリの一覧を取得し、Set-ManagementRoleEntry コマンドレットを使用して、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 では、次の使用例は、スコープなし最上位レベルの役割である IT スクリプトの MailboxAudit カスタム スクリプトに Location パラメーターを追加します。 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 |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Confirm
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Online、Exchange Online Protection
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 でのみ使用できます。
DomainController パラメーターは、このコマンドレットで Active Directory からのデータの読み取りまたは Active Directory へのデータの書き込みに使用されるドメイン コントローラーを指定します。 ドメイン コントローラーは、完全修飾ドメイン名 (FQDN) で識別します。 たとえば、dc01.contoso.com です。
パラメーターのプロパティ
| 型: | Fqdn |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Force
適用対象: Exchange Online、Exchange Online Protection
このパラメーターは、クラウドベースのサービスでのみ使用できます。
[強制] スイッチは、警告メッセージまたは確認メッセージを非表示にします。 このスイッチで値を指定する必要はありません。
管理者の入力を求めることが不適切な場合に、このスイッチを使用してタスクをプログラムによって実行することができます。
パラメーターのプロパティ
| 型: | 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 Online、Exchange Online Protection
Identity パラメーターは、変更するロール エントリを指定します。 このパラメーターでは、 <management role>\<role entry name> ( CustomRole\Set-Mailbox など) という構文を使用します。
管理ロールエントリのしくみの詳細については、「 管理ロールについて」を参照してください。
役割エントリ名にスペースが含まれている場合、名前を二重引用符 (") で囲んでください。
パラメーターのプロパティ
| 型: | RoleEntryIdParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 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 |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 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 |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-UnScopedTopLevel
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
既定では、このパラメーターは UnScoped ロール管理ロールでのみ使用でき、そのロールはどのロール グループにも割り当てられません。 このパラメーターを使用するには、スコープ外の役割管理ロールを役割グループ (組織の管理役割グループなど) に追加する必要があります。 詳細については、「役割グループへ役割を追加する」を参照してください。
UnScopedTopLevel スイッチは、変更するロール エントリがスコープ外の最上位ロール上にあることを指定します。 このスイッチで値を指定する必要はありません。
スコープなし最上位レベルの管理ロールには、カスタム スクリプトまたは Exchange 以外のコマンドレットのみを含めることができます。 詳細については、「 スコープなしロールを作成する」を参照してください。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 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 |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(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
このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。