Stop-MigrationBatch

モジュール:
Exchange PowerShell

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

進行中の移行バッチの処理を停止するには、Stop-MigrationBatch コマンドレットを使用します。

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

構文

Default (既定) 

Stop-MigrationBatch
    [[-Identity] <MigrationBatchIdParameter>]
    [-Confirm]
    [-DomainController <Fqdn>]
    [-Partition <MailboxIdParameter>]
    [-WhatIf]
    [<CommonParameters>]

説明

Stop-MigrationBatch コマンドレットは、オンプレミスの Exchange organizationまたは Microsoft 365 で実行されているクラウドベースの移行サービスによって処理されている移行バッチを停止します。 移行バッチのうち停止できるのは、メールボックスがまだ移行の過程にあるもの、または移行待ちのものだけです。 移行を停止しても、既に移行されているメールボックスには影響しません。 アクティブに移行されているメールボックスの移行が直ちに停止されます。 移行バッチ内のすべての移行要求が完了または失敗した場合、このコマンドレットは実行されません。

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

例

例 1

Stop-MigrationBatch

この例を実行すると、現在移行サービスによる処理を受けている移行バッチが停止します。

例 2

Stop-MigrationBatch -Identity MigrationBatch1

この例では、移行バッチ MigrationBatch1 が停止します。

パラメーター

-Confirm

適用対象: 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 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

-Identity

適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online

Identity パラメーターは、現在の移行バッチの名前を識別します。 このパラメーターの値は、New-MigrationBatch コマンドレットの Name パラメーターで指定されます。

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

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

パラメーター セット

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

-Partition

適用対象: Exchange Online

このパラメーターは、クラウドベースのサービスでのみ使用できます。

このパラメーターは、Microsoft の内部使用のために予約されています。

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

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

パラメーター セット

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

-WhatIf

適用対象: 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

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