Get-MailboxExportRequest
このコマンドレットは、オンプレミスの Exchange でのみ使用可能です。
Get-MailboxExportRequest コマンドレットは、New-MailboxExportRequest コマンドレットを使用して開始されたエクスポート要求に関する詳細な進行状態を表示します。
このコマンドレットはメールボックスインポートエクスポートロールでのみ使用でき、既定ではロールはどの役割グループにも割り当てられません。 このコマンドレットを使用するには、役割グループ (組織の管理役割グループなど) にメールボックスインポートエクスポートロールを追加する必要があります。 詳細については、「役割グループへ役割を追加する」を参照してください。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
Identity
Get-MailboxExportRequest
[[-Identity] <MailboxExportRequestIdParameter>]
[-DomainController <Fqdn>]
[-ResultSize <Unlimited>]
[<CommonParameters>]
MailboxFiltering
Get-MailboxExportRequest
[-Mailbox <MailboxOrMailUserIdParameter>]
[-BatchName <String>]
[-Database <DatabaseIdParameter>]
[-DomainController <Fqdn>]
[-HighPriority <Boolean>]
[-Name <String>]
[-ResultSize <Unlimited>]
[-Status <RequestStatus>]
[-Suspend <Boolean>]
[-RequestQueue <DatabaseIdParameter>]
[<CommonParameters>]
MailboxLocationFiltering
Get-MailboxExportRequest
[-Mailbox <MailboxLocationIdParameter>]
[-BatchName <String>]
[-Database <DatabaseIdParameter>]
[-DomainController <Fqdn>]
[-HighPriority <Boolean>]
[-Name <String>]
[-ResultSize <Unlimited>]
[-Status <RequestStatus>]
[-Suspend <Boolean>]
[-RequestQueue <DatabaseIdParameter>]
[<CommonParameters>]
説明
Get-MailboxExportRequest コマンドレットの検索条件はブール型の And ステートメントです。 複数のパラメーターを使用すると、検索が絞り込まれて、検索結果の数が少なくなります。
このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 この記事ではコマンドレットのすべてのパラメーターを一覧表示しますが、割り当てられたアクセス許可にパラメーターが含まれていない場合は、一部のパラメーターにアクセスできない可能性があります。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。
例
例 1
Get-MailboxExportRequest -Identity "tony\DB01toPST"
この例では、tony\DB01toPST という ID を持つエクスポート要求の進行状態を返します。
例 2
Get-MailboxExportRequest -Status InProgress -Database DB01
Exchange Server 2010 では、この例では、データベース DB01 に存在するメールボックスまたはアーカイブの進行中のエクスポート要求の状態を返します。
例 3
Get-MailboxExportRequest -BatchName "Attachment_CompanyReport" -Status Completed
この例では、完了したバッチ Attachment_CompanyReport 内のエクスポート要求の状態を返します。
例 4
Get-MailboxExportRequest -Name "DB01toPST" -Suspend $true
次の使用例は、エクスポートが中断されている DB01toPST という名前のエクスポート要求をすべて返します。
パラメーター
-BatchName
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
BatchName パラメーターは、バッチのエクスポート要求に付けられた名前を指定します。
データベース名
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
MailboxFiltering
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
MailboxLocationFiltering
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Database
適用対象: Exchange Server 2010
このパラメーターは Exchange Server 2010 でのみ使用できます。
Database パラメーターは、ユーザーのメールボックスまたはアーカイブが存在するデータベースを指定します。 データベースを一意に識別する、任意の値を使用できます。 以下に例を示します。
- 名前
- 識別名 (DN)
- GUID
データベース名
パラメーターのプロパティ
| 型: | DatabaseIdParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
MailboxFiltering
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
MailboxLocationFiltering
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DomainController
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
DomainController パラメーターは、このコマンドレットで Active Directory からのデータの読み取りまたは Active Directory へのデータの書き込みに使用されるドメイン コントローラーを指定します。 ドメイン コントローラーは、完全修飾ドメイン名 (FQDN) で識別します。 たとえば、dc01.contoso.com です。
パラメーターのプロパティ
| 型: | Fqdn |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-HighPriority
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
HighPriority パラメーターは、要求の作成時に割り当てられた Priority 値に基づいて結果をフィルター処理します。 このパラメーターの有効な入力値は、$true または $false です。 これらの値によって結果がフィルター処理される方法を次に示します。
- $true 優先度の値が [高]、[高]、[最高]、または [緊急] で作成された要求を返します。
- $false Priority 値 Normal、Low、Lower、Lowest で作成された要求を返します。
データベース名
パラメーターのプロパティ
| 型: | Boolean |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
MailboxFiltering
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
MailboxLocationFiltering
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Identity
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
Identity パラメーターは、エクスポート要求の ID を指定します。 既定では、エクスポート要求には <alias>\MailboxExportX という名前が付けられます (X = 0 から 9)。 New-MailboxExportRequest コマンドレットを使用して要求が作成されたときにエクスポート要求の名前を指定した場合は、次の構文を使用します: Alias\Name。 Exchange は、メールボックスのエイリアスを使用して要求の前に自動的に先行します。
このパラメーターを次のパラメーターと併用することはできません。
- BatchName
- Mailbox
- Name
- 状態
- 停止する
- HighPriority
注意: Identity パラメーターの値$null値または存在しない値は、Identity パラメーターなしで Get- コマンドを実行したかのように 、すべての オブジェクトを返します。 Identity パラメーターの値の一覧が正確であり、存在しない$null値が含まれていないことを確認します。
パラメーターのプロパティ
| 型: | MailboxExportRequestIdParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Identity
| 配置: | 1 |
| 必須: | False |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Mailbox
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
Mailbox パラメーターは、コンテンツのエクスポート元のソース メールボックスによって結果をフィルター処理します。
Exchange 2016 CU7 以降では、このパラメーターは MailboxLocationIdParameter 型であるため、メールボックスを識別するために使用できる最も簡単な値は Alias 値です。
Exchange 2016 CU6 以前では、このパラメーターは MailboxOrMailUserIdParameter 型であるため、メールボックスを一意に識別する任意の値を使用できます。 例:
- Name
- Alias
- 識別名 (DN)
- 正規 DN
- ドメイン\ユーザー名
- 電子メール アドレス
- GUID
- LegacyExchangeDN
- SamAccountName
- ユーザー ID またはユーザー プリンシパル名 (UPN)
データベース名
パラメーターのプロパティ
| 型: | MailboxOrMailUserIdParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
MailboxFiltering
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
MailboxLocationFiltering
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Name
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
Name パラメーターは、指定の名前のエクスポート要求が返されることを指定します。
エクスポート要求を作成したときに指定した名前で検索するには、このパラメーターを使用します。
要求の作成時に名前を指定しなかった場合、既定の名前は MailboxExportX (ここで X = 0-9) になります。
データベース名
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
MailboxFiltering
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
MailboxLocationFiltering
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-RequestQueue
適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
RequestQueue パラメーターは、要求が実行されているメールボックス データベースに基づいて要求を識別します。 データベースを一意に識別する、任意の値を使用できます。 以下に例を示します。
- 名前
- 識別名 (DN)
- GUID
データベース名
パラメーターのプロパティ
| 型: | DatabaseIdParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
MailboxFiltering
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
MailboxLocationFiltering
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ResultSize
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
ResultSize パラメーターは、返される結果の最大数を指定します。 クエリに一致するすべてのリクエストを返す場合は、このパラメーターの値に unlimited を使用します。 既定値は 1,000 です。
パラメーターのプロパティ
| 型: | Unlimited |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Status
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
Status パラメーターは、状態に基づいて結果をフィルター処理します。 次の値を使用できます。
- AutoSuspended
- 完了
- CompletedWithWarning
- CompletionInProgress
- 失敗
- InProgress
- キューに登録済み
- 再試行
- 中断
- 同期済み
データベース名
CompletionInProgress と AutoSuspended は、エクスポート要求には適用されません。また、情報は返されません。
パラメーターのプロパティ
| 型: | RequestStatus |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
MailboxFiltering
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
MailboxLocationFiltering
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Suspend
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE
Suspend パラメーターは、中断された要求を返すかどうかを指定します。 このパラメーターの有効な入力値は、$true または $false です。
データベース名
パラメーターのプロパティ
| 型: | Boolean |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
MailboxFiltering
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
MailboxLocationFiltering
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、「about_CommonParameters」を参照してください。
入力
Input types
このコマンドレットに使用できる入力の種類を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 コマンドレットで入力の種類のフィールドが空白の場合、そのコマンドレットには入力データを指定できません。
出力
Output types
このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。