Remove-ManagementRole

モジュール:
Exchange PowerShell

このコマンドレットは、オンプレミスの Exchange およびクラウド ベースのサービスで使用できます。 一部のパラメーターと設定は、1 つの環境または他の環境に限定される場合があります。

不要になったカスタム管理役割を削除するには、Remove-ManagementRole コマンドレットを使用します。

以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。

構文

Default (既定) 

Remove-ManagementRole
    [-Identity] <RoleIdParameter>
    [-Confirm]
    [-DomainController <Fqdn>]
    [-Force]
    [-Recurse]
    [-UnScopedTopLevel]
    [-WhatIf]
    [<CommonParameters>]

説明

役割を削除する前に、すべての管理役割の割り当てを削除する必要があります。 役割が子役割を持つ親である場合、親役割を削除する前に子役割を削除するか、親役割を削除するときに Recurse パラメーターを使用する必要があります。 削除できるのは、カスタム役割だけです。 Mail Recipients 役割などの組み込みの役割は削除できません。 カスタム ロールを削除する方法の詳細については、「ロールの 削除」を参照してください。

このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 この記事にはこのコマンドレットのすべてのパラメーターが一覧表示されていますが、自分に割り当てられているアクセス許可に含まれていない一部のパラメーターにはアクセスできません。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。

例

例 1

Remove-ManagementRole ExampleRole1

この例では、ExampleRole1 という 1 つの役割を削除します。

例 2

Remove-ManagementRole ExampleRole2 -Recurse -WhatIf

この例では、Remove-ManagementRole コマンドレットを WhatIf スイッチとともに実行します。 WhatIf スイッチにより、コマンドは指定した処理を実行するかのように動作しますが、実際には何の変更も行われません。 代わりに、コマンドを実行した場合にどのような結果になるかが表示されるので、その処理が正しいかどうかを確認することができます。

結果が期待どおりの場合は、WhatIf スイッチを削除し、コマンドをもう一度実行して ExampleRole2 親ロールとそのすべての子ロールを削除します。

例 3

Get-ManagementRole *Example* | Remove-ManagementRole -WhatIf

この例では、Get-ManagementRole コマンドレットを使用して、役割名に "Example" という文字列が含まれる役割の一覧を取得し、次に、この一覧を Remove-ManagementRole コマンドレットにパイプ処理します。 WhatIf スイッチが指定されているので、Remove-ManagementRole コマンドレットにより、削除される役割が表示されますが、実際には何の変更も行われません。 結果が予測どおりの場合は、WhatIf スイッチなしでコマンドを実行して、役割を削除できます。

例 4

Remove-ManagementRole "In-house scripts" -UnScopedTopLevel

オンプレミスの Exchange では、この例では、スコープ外の社内スクリプトの最上位管理ロールを削除します。 これは対象範囲外の最上位の役割であるため、UnScopedTopLevel スイッチを使用する必要があります。 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-* コマンドレット) には、組み込みの一時停止はありません。 これらのコマンドレットでは、値を指定せずに [確認] スイッチを指定すると、続行する前にコマンドの確認を強制する一時停止が発生します。

パラメーターのプロパティ

型: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、オンプレミス用の組み込みセキュリティ アドオンメールボックス

Identity パラメーターには、削除するカスタム役割を指定します。 役割の名前にスペースが含まれている場合、名前を二重引用符 (") で囲んでください。

パラメーターのプロパティ

型:RoleIdParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:1
必須:True
パイプラインからの値:True
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-Recurse

適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online、オンプレミス用の組み込みセキュリティ アドオンメールボックス

Recurse スイッチは、指定したロールと、指定したロールのすべての子ロールを削除します。 このスイッチで値を指定する必要はありません。

結果が正しいことを確認するには、WhatIf スイッチを使用してコマンドをテストすることをお勧めします。

パラメーターのプロパティ

型: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 Server SE

このパラメーターは、オンプレミスの 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 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

このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。