Get-MailboxImportRequest
このコマンドレットは、オンプレミスの Exchange およびクラウド ベースのサービスで使用できます。 一部のパラメーターおよび設定は、いずれかの環境専用となっている場合があります。
Get-MailboxImportRequest コマンドレットを使用して、New-MailboxImportRequest コマンドレットによって開始されたインポート要求に関する詳細な進行状態を表示します。
このコマンドレットはメールボックスインポートエクスポートロールでのみ使用でき、既定ではロールはどの役割グループにも割り当てられません。 このコマンドレットを使用するには、役割グループ (組織の管理役割グループなど) にメールボックスインポートエクスポートロールを追加する必要があります。 詳細については、「役割グループへ役割を追加する」を参照してください。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
Get-MailboxImportRequest
[[-Identity] <MailboxImportRequestIdParameter>]
[-DomainController <Fqdn>]
[-ResultSize <Unlimited>]
[<CommonParameters>]
Get-MailboxImportRequest
[-BatchName <String>]
[-Database <DatabaseIdParameter>]
[-DomainController <Fqdn>]
[-HighPriority <Boolean>]
[-Mailbox <MailboxOrMailUserIdParameter>]
[-Name <String>]
[-ResultSize <Unlimited>]
[-Status <RequestStatus>]
[-Suspend <Boolean>]
[-RequestQueue <DatabaseIdParameter>]
[<CommonParameters>]
Get-MailboxImportRequest
[-BatchName <String>]
[-Database <DatabaseIdParameter>]
[-DomainController <Fqdn>]
[-HighPriority <Boolean>]
[-Mailbox <MailboxLocationIdParameter>]
[-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
BatchName パラメーターは、バッチのインポート要求に付けられた名前を指定します。
データベース名
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, Exchange Online |
-Database
このパラメーターは Exchange Server 2010 でのみ使用できます。
Database パラメーターは、ユーザーのメールボックスまたはアーカイブが存在するデータベースを指定します。 データベースを一意に識別する、任意の値を使用できます。 以下に例を示します。
- 名前
- 識別名 (DN)
- GUID
データベース名
Type: | DatabaseIdParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010 |
-DomainController
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
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 |
-HighPriority
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
HighPriority パラメーターは、要求の作成時に割り当てられた Priority 値に基づいて結果をフィルター処理します。 このパラメーターの有効な入力値は、$true または $false です。 これらの値によって結果がフィルター処理される方法を次に示します。
- $true 優先度の値が [高]、[高]、[最高]、または [緊急] で作成された要求を返します。
- $false Priority 値 Normal、Low、Lower、Lowest を使用して作成された要求を返します。
データベース名
Type: | Boolean |
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>\MailboxImportX
は (X = 0 から 9) です。 インポート要求の名前を指定する場合は、次の構文を使用します。 Alias\Name
Microsoft Exchange は、メールボックスのエイリアスで要求の前に自動的に置き換えられます。
このパラメーターは、次のパラメーターと併用できません。
- Batchname
- Mailbox
- 名前
- 状態
- 中断
- HighPriority
Type: | MailboxImportRequestIdParameter |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Mailbox
このパラメーターは、オンプレミスの Exchange でのみ使用可能で正常に機能します。
Mailbox パラメーターは、コンテンツのインポート先のメールボックスによって結果をフィルター処理します。
Exchange 2016 CU7 以降では、このパラメーターは MailboxLocationIdParameter 型であるため、メールボックスを識別するために使用できる最も簡単な値は Alias 値です。
Exchange 2016 CU6 以前では、このパラメーターは MailboxOrMailUserIdParameter 型であるため、メールボックスを一意に識別する任意の値を使用できます。 例:
- 名前
- Alias
- 識別名 (DN)
- 正規 DN
- Domain\Username
- 電子メール アドレス
- GUID
- LegacyExchangeDN
- SamAccountName
- ユーザー ID またはユーザー プリンシパル名 (UPN)
データベース名
Type: | MailboxOrMailUserIdParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013 |
-Name
Name パラメーターは指定の名前のインポート要求が返されることを指定します。
インポート要求を作成したときに指定した名前で検索するには、このパラメーターを使用します。 要求の作成時に名前を指定しなかった場合、既定の名前は MailboxImportX (ここで X = 0-9) になります。
データベース名
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, Exchange Online |
-RequestQueue
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
RequestQueue パラメーターは、要求が実行されているメールボックス データベースに基づいて要求を識別します。 データベースを一意に識別する、任意の値を使用できます。 以下に例を示します。
- 名前
- 識別名 (DN)
- GUID
データベース名
Type: | DatabaseIdParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-ResultSize
ResultSize パラメーターは、返される結果の最大数を指定します。 クエリに一致するすべてのリクエストを返す場合は、このパラメーターの値に unlimited を使用します。 既定値は 1,000 です。
Type: | Unlimited |
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, Exchange Online |
-Status
Status パラメーターは、状態に基づいて結果をフィルター処理します。 次の値を使用できます。
- AutoSuspended
- 完了
- CompletedWithWarning
- CompletionInProgress
- 失敗
- InProgress
- キューに登録済み
- 再試行
- 中断
- 同期済み
データベース名
CompletionInProgress および AutoSuspended はインポート要求には適用されないため、情報は返されません。
Type: | RequestStatus |
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, Exchange Online |
-Suspend
Suspend パラメーターは、中断された要求を返すかどうかを指定します。 このパラメーターの有効な入力値は、$true または $false です。
データベース名
Type: | Boolean |
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, Exchange Online |
入力
Input types
このコマンドレットに使用できる入力の種類を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 コマンドレットで入力の種類のフィールドが空白の場合、そのコマンドレットには入力データを指定できません。
出力
Output types
このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。