Get-MailboxImportRequest
このコマンドレットは、オンプレミスの Exchange およびクラウド ベースのサービスで使用できます。 一部のパラメーターと設定は、1 つの環境または別の環境に限定される場合があります。
Get-MailboxImportRequest コマンドレットを使用して、New-MailboxImportRequest コマンドレットによって開始されたインポート要求に関する詳細な進行状態を表示します。
このコマンドレットは、Mailbox Import Export 役割でのみ使用でき、既定では、この役割はどの役割グループにも割り当てられていません。 このコマンドレットを使用するには、Mailbox Import Export 役割を役割グループ (たとえば、Organization Management 役割グループ) に追加する必要があります。 詳細については、「役割グループへ役割を追加する」を参照してください。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
Identity
Get-MailboxImportRequest
[[-Identity] <MailboxImportRequestIdParameter>]
[-DomainController <Fqdn>]
[-ResultSize <Unlimited>]
[<CommonParameters>]
Filtering
Get-MailboxImportRequest
[-Mailbox <MailboxLocationIdParameter>]
[-BatchName <String>]
[-Database <DatabaseIdParameter>]
[-DomainController <Fqdn>]
[-HighPriority <Boolean>]
[-Name <String>]
[-ResultSize <Unlimited>]
[-Status <RequestStatus>]
[-Suspend <Boolean>]
[-RequestQueue <DatabaseIdParameter>]
[<CommonParameters>]
説明
Get-MailboxImportRequest コマンドレットの検索条件はブール型の And ステートメントです。 複数のパラメーターを使用すると、検索が絞り込まれて、検索結果の数が少なくなります。
このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 この記事にはこのコマンドレットのすべてのパラメーターが一覧表示されていますが、自分に割り当てられているアクセス許可に含まれていない一部のパラメーターにはアクセスできません。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。
例
例 1
Get-MailboxImportRequest -Identity "tony\Recovered"
この例では、tony\Recovered という ID が設定されている進行中のインポート要求の状態に関する既定の情報を返します。 既定で返される情報の種類には、名、メールボックス、および状態が含まれています。
例 2
Get-MailboxImportRequest -Status InProgress -Database DB01
Exchange Server 2010 では、この例により、データベース DB01 上にあるメールボックスまたはアーカイブについて、処理中のインポート要求の状態が返されます。
例 3
Get-MailboxImportRequest -BatchName "ImportingDB1PSTs" -Status Completed
この例では、完了した ImportingDB1PSTs というバッチ内のインポート要求の状態を返します。
例 4
Get-MailboxImportRequest -Name "Recovered" -Suspend $true
この例では、インポートが一時停止されているところで Recovered という名前を持つすべてのインポート要求が返されます。
パラメーター
-BatchName
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online
BatchName パラメーターは、バッチのインポート要求に付けられた名前を指定します。
データベース名
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
MailboxFiltering
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
MailboxLocationFiltering
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Database
適用対象: 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
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
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
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
HighPriority パラメーターは、要求の作成時に割り当てられた Priority 値に基づいて結果をフィルター処理します。 このパラメーターの有効な入力値は、$true または $false です。 これらの値によって結果がフィルター処理される方法を次に示します:
- $true 優先度の値が高、高、最高、または緊急で作成された要求を返します。
- $false 優先度の値が 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、Exchange Online
Identity パラメーターは、インポート要求の ID を指定します。 既定では、インポート要求の名前は <alias>\MailboxImportX です (X = 0-9)。 インポート要求の名前を指定する場合は、次の構文を使用します。 Alias\Name。 Microsoft Exchange は、自動的にメールボックスのエイリアスを使用して要求の前に行います。
このパラメーターは、次のパラメーターと併用できません。
- BatchName
- Mailbox
- 名前
- 状態
- Suspend
- HighPriority
注意: Identityパラメータの値$nullまたは存在しない値は、IdentityパラメータなしでGet-コマンドを実行したかのように、 すべての オブジェクトを返します。 Identity パラメーターの値のリストが正確であり、存在しない$null値が含まれていないことを確認します。
パラメーターのプロパティ
| 型: | MailboxImportRequestIdParameter |
| 規定値: | 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、Exchange Online
このパラメーターは、オンプレミスの Exchange でのみ使用可能で正常に機能します。
Mailbox パラメーターは、コンテンツのインポート先メールボックスで結果をフィルター処理します。
Exchange 2016 CU7 以降では、パラメーターの種類は MailboxLocationIdParameter です。 エイリアス値は、メールボックスを識別する最も簡単な方法です。
データベース名
ヒント: Exchange 2016 CU6 以前では、パラメーターの種類は MailboxOrMailUserIdParameter でした。 メールボックス (エイリアスを含む) を一意に識別する任意の値を使用できます。
パラメーターのプロパティ
| 型: | MailboxLocationIdParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
MailboxLocationFiltering
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Name
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019、Exchange Server SE、Exchange Online
Name パラメーターは指定の名前のインポート要求が返されることを指定します。
インポート要求を作成したときに指定した名前で検索するには、このパラメーターを使用します。 要求の作成時に名前を指定しなかった場合、既定の名前は MailboxImportX (ここで 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
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
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、Exchange Online
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、Exchange Online
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、Exchange Online
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
このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。