Remove-MailboxRestoreRequest
このコマンドレットは、オンプレミスの Exchange およびクラウド ベースのサービスで使用できます。 一部のパラメーターと設定は、1 つの環境または他の環境に限定される場合があります。
Remove-MailboxRestoreRequest コマンドレットを使用して、完全にまたは部分的に完了した復元要求を削除します。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
Identity
Remove-MailboxRestoreRequest
[-Identity] <MailboxRestoreRequestIdParameter>
[-Force]
[-Confirm]
[-DomainController <Fqdn>]
[-WhatIf]
[<CommonParameters>]
MigrationRequestQueue
Remove-MailboxRestoreRequest
-RequestGuid <Guid>
-RequestQueue <DatabaseIdParameter>
[-Confirm]
[-DomainController <Fqdn>]
[-WhatIf]
[<CommonParameters>]
説明
Identity パラメーターが必要なパラメーター セットでは、完全にまたは部分的に完了した復元要求を削除できます。
RequestGuid パラメーターと RequestQueue パラメーターを必要とするパラメーター セットは、Microsoft Exchange メールボックス レプリケーション サービス (MRS) のデバッグ目的でのみ使用されます。
このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 この記事ではコマンドレットのすべてのパラメーターを一覧表示しますが、割り当てられたアクセス許可にパラメーターが含まれていない場合は、一部のパラメーターにアクセスできない可能性があります。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。
例
例 1
Remove-MailboxRestoreRequest -Identity "Ayla\MailboxRestore1"
この例では、2 番目の復元要求 Ayla\MailboxRestore1 を削除します。
例 2
Get-MailboxRestoreRequest -Status Completed | Remove-MailboxRestoreRequest
この例では、Completed の状態の復元要求をすべて削除します。
例 3
Remove-MailboxRestoreRequest -RequestQueue MBXDB01 -RequestGuid 25e0eaf2-6cc2-4353-b83e-5cb7b72d441f
次の使用例は、MBXDB01に格納されている要求の RequestGuid パラメーターを使用して、復元要求を取り消します。 RequestGuid および RequestQueue パラメーターが必要なパラメーター セットは、MRS のデバッグのためにのみ使用します。 このパラメーター セットは、Microsoft カスタマー サービスおよびサポートから指示された場合のみ使用してください。
パラメーター
-Confirm
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、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 でのみ使用できます。
DomainController パラメーターは、このコマンドレットで Active Directory からのデータの読み取りまたは Active Directory へのデータの書き込みに使用されるドメイン コントローラーを指定します。 ドメイン コントローラーは、完全修飾ドメイン名 (FQDN) で識別します。 たとえば、dc01.contoso.com です。
パラメーターのプロパティ
| 型: | Fqdn |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Force
適用対象: Exchange Server 2016 年、Exchange Server 2019、Exchange Online
[強制] スイッチは、警告メッセージまたは確認メッセージを非表示にします。 このスイッチで値を指定する必要はありません。
管理者の入力を求めることが不適切な場合に、このスイッチを使用してタスクをプログラムによって実行することができます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Identity
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Identity
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Online
Identity パラメーターは、復元要求の ID を指定します。 Identity パラメーターは、復元するメールボックスのエイリアスと、復元要求の作成時に指定した名前で構成されます。 復元要求の ID は、次の構文を使用します: Alias\Name。
復元要求の作成時に名前を指定しなかった場合、Exchange によって既定の名前 MailboxRestore が自動的に生成されます。 Exchange では、MailboxRestore から始まり、MailboxRestoreX (X = 1- 9) から最大 10 個の名前が生成されます。
パラメーターのプロパティ
| 型: | MailboxRestoreRequestIdParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Identity
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-RequestGuid
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
RequestGuid パラメーターは、復元要求の一意の識別子を指定します。 GUID を検索するには、Get-MailboxRestoreRequest コマンドレットを使用します。 RequestGuid パラメーターを指定した場合は、RequestQueue パラメーターも指定する必要があります。
データベース名
パラメーターのプロパティ
| 型: | Guid |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
MigrationRequestQueue
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-RequestQueue
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
RequestQueue パラメーターは、要求のメールボックスまたはアーカイブが存在する復元先メールボックス データベースを指定します。 データベースを一意に識別する、任意の値を使用できます。 以下に例を示します。
- 名前
- 識別名 (DN)
- GUID
このパラメーターは RequestGuid パラメーターと共に使用する必要があります。 データベース名
パラメーターのプロパティ
| 型: | DatabaseIdParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
MigrationRequestQueue
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Online
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
このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。