Suspend-MailboxExportRequest

  • リファレンス
モジュール:
ExchangePowerShell
適用対象:
Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

このコマンドレットは、オンプレミスの Exchange でのみ使用可能です。

Suspend-MailboxExportRequest コマンドレットを使用すると、エクスポート要求が作成されてから Completed の状態に達するまでの間に、いつでもエクスポート要求を中断できます。 要求を再開するには、Resume-MailboxExportRequest コマンドレットを使用します。

このコマンドレットはメールボックスインポートエクスポートロールでのみ使用でき、既定ではロールはどの役割グループにも割り当てられません。 このコマンドレットを使用するには、役割グループ (組織の管理役割グループなど) にメールボックスインポートエクスポートロールを追加する必要があります。 詳細については、「役割グループへ役割を追加する」を参照してください。

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

構文

Suspend-MailboxExportRequest
       [-Identity] <MailboxExportRequestIdParameter>
       [-Confirm]
       [-DomainController <Fqdn>]
       [-SuspendComment <String>]
       [-WhatIf]
       [<CommonParameters>]

説明

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

例

例 1

Suspend-MailboxExportRequest -Identity "Ayla\MailboxExport1"

この例では、Ayla\MailboxExport1 という ID を持つ Ayla のメールボックスの 2 回目のエクスポート要求を中断します。

例 2

Get-MailboxExportRequest -Status InProgress | Suspend-MailboxExportRequest -SuspendComment "Resume after 22:00 (10 P.M.)"

この例では、Get-MailboxExportRequest コマンドレットを使用して状態が InProgress であるエクスポート要求をすべて取得し、その出力に "22 時 (午後 10 時) 以降に再開" という中断コメントを付けて Suspend-MailboxExportRequest コマンドレットにパイプライン処理します。

パラメーター

-Confirm

Confirm スイッチは、確認プロンプトを表示するか非表示にするかを指定します。 このスイッチがコマンドレットにどのような影響を与えるかは、先に進む前にコマンドレットで確認が必要となるかどうかで決まります。

  • 破壊的なコマンドレット (Remove-* コマンドレットなど) には、続行する前にコマンドの確認を強制する組み込みの一時停止があります。 これらのコマンドレットでは、正確な構文-Confirm:$falseを使用して、確認プロンプトを省略できます。
  • 他のほとんどのコマンドレット (New-* コマンドレットや Set-* コマンドレットなど) には、一時停止が組み込まれています。 これらのコマンドレットの場合、値なしで Confirm スイッチを指定すると、先に進む前に、一時停止してコマンドを確認する必要があります。
Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-DomainController

DomainController パラメーターは、このコマンドレットで Active Directory からのデータの読み取りまたは Active Directory へのデータの書き込みに使用されるドメイン コントローラーを指定します。 ドメイン コントローラーは、完全修飾ドメイン名 (FQDN) で識別します。 たとえば、dc01.contoso.com です。

Type:Fqdn
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-Identity

Identity パラメーターは、エクスポート要求の ID を指定します。 既定では、エクスポート要求の名前 <alias>\MailboxExportX は (X = 0 から 9) です。 次の構文を使用します。 Alias\Name

Type:MailboxExportRequestIdParameter
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-SuspendComment

SuspendComment パラメーターは、要求が中断された理由の説明を指定します。 このパラメーターは、Suspend パラメーターを指定する場合にのみ使用できます。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-WhatIf

WhatIf スイッチは、コマンドの操作をシミュレートします。 このスイッチを使用すると、実際にその変更内容を適用せずに、発生する変更を確認できます。 このスイッチで値を指定する必要はありません。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

入力

Input types

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

出力

Output types

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