Test-SiteMailbox
このコマンドレットは、オンプレミスの Exchange でのみ使用可能です。
Test-SiteMailbox コマンドレットを使用して、Microsoft SharePoint 接続へのサイト メールボックスをテストし、ユーザーがサイト メールボックスを使用するための適切なアクセス許可を持っているかどうかをテストします。 このコマンドレットは、トラブルシューティングおよび診断を目的に使用する必要があります。
サイト メールボックスは、2017 年に Exchange Online および SharePoint Online で非推奨になりました。 詳細については、「 サイト メールボックスの廃止」を参照してください。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
Default (既定)
Test-SiteMailbox
[[-Identity] <RecipientIdParameter>]
[-BypassOwnerCheck]
[-Confirm]
[-RequestorIdentity <RecipientIdParameter>]
[-SharePointUrl <Uri>]
[-UseAppTokenOnly]
[-WhatIf]
[<CommonParameters>]
説明
RequestorIdentity パラメーターを指定しない場合、コマンドは、このコマンドを実行するユーザーの ID を使用します。
このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 この記事ではコマンドレットのすべてのパラメーターを一覧表示しますが、割り当てられたアクセス許可にパラメーターが含まれていない場合は、一部のパラメーターにアクセスできない可能性があります。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。
例
例 1
Test-SiteMailbox -BypassOwnerCheck -SharePointUrl "https://myserver/teams/edu"
この例では、SharePoint サイトの接続のみをテストします。 このコマンドは、サイト メールボックスの作成前、またはサイト メールボックスの作成で問題が発生した場合に使用できます。
例 2
Test-SiteMailbox -BypassOwnerCheck -Identity mysitemailbox@contoso.com -UseAppTokenOnly
次の使用例は、Identity パラメーターと UseAppTokenOnly パラメーターを使用して、既存のサイト メールボックスとの Exchange サーバー接続をテストします。 Identity パラメーターはサイト メールボックスを指定し、UseAppTokenOnly パラメーターは Exchange サーバーの ID でテストすることを指定します。 ドキュメントの同期の問題をトラブルシューティングする場合に、このコマンドを実行します。
例 3
Test-SiteMailbox -BypassOwnerCheck -RequestorIdentity "kweku@contoso.com" -SharePointUrl "https://myserver/teams/edu"
この例では、RequestorIdentity パラメーターを使用して SharePoint サイトにアクセスする特定のユーザーの機能をテストします。
パラメーター
-BypassOwnerCheck
適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
BypassOwnerCheck パラメーターは、コマンドを実行しているアカウントがサイト メールボックスのメンバーまたは所有者でない場合に使用されます。 このスイッチで値を指定する必要はありません。
このスイッチを使用せず、サイト メールボックスのメンバーまたは所有者でない場合、コマンドは失敗します。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Confirm
適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
Confirm スイッチは、確認プロンプトを表示するか非表示にするかを指定します。 このスイッチがコマンドレットにどのような影響を与えるかは、先に進む前にコマンドレットで確認が必要となるかどうかで決まります。
- データを破壊するコマンドレット (たとえば、Remove- コマンドレット) には、先に進む前にユーザーにそのコマンドの確認を強制する組み込みの一時停止があります。 これらのコマンドレットでは、正確な構文
-Confirm:$falseを使用して、確認プロンプトを省略できます。 - 他のほとんどのコマンドレット (たとえば、New-* や Set-* コマンドレット) には、組み込みの一時停止はありません。 これらのコマンドレットの場合、値なしで Confirm スイッチを指定すると、先に進む前に、一時停止してコマンドを確認する必要があります。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | cf |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Identity
適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
Identity パラメーターは、テストするサイト メールボックスを指定します。 サイト メールボックスを一意に識別する任意の値を使用できます。 例:
- 名前
- Alias
- 識別名 (DN)
- 正規 DN
- 電子メール アドレス
- GUID
このパラメーターは SharePointUrl パラメーターと併用できません。
パラメーターのプロパティ
| 型: | RecipientIdParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 1 |
| 必須: | False |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-RequestorIdentity
適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
RequestorIdentity パラメーターは、SharePoint サイト メールボックスに対する正しいアクセス許可をテストするユーザーを指定します。 ユーザーを一意に識別する任意の値を使用できます。 以下に例を示します。
- 名前
- Alias
- 識別名 (DN)
- 正規 DN
- 電子メール アドレス
- GUID
このパラメーターは UseAppTokenOnly パラメーターと併用できません。
このパラメーターを指定しない場合、コマンドは、このコマンドを実行するユーザーの ID を使用します。
パラメーターのプロパティ
| 型: | RecipientIdParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-SharePointUrl
適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
SharePointUrl パラメーターは、サイト メールボックスがホストされる SharePoint URL を指定します (例: "https://myserver/teams/edu")。
データベース名
パラメーターのプロパティ
| 型: | Uri |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-UseAppTokenOnly
適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
UseAppTokenOnly スイッチは、Exchange サーバーの ID を使用してサイト メールボックスをテストすることを指定します。 このスイッチで値を指定する必要はありません。
RequestorIdentity パラメーターでは、このスイッチを使用できません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
適用対象: Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
WhatIf スイッチは、コマンドの操作をシミュレートします。 このスイッチを使用すると、実際にその変更内容を適用せずに、発生する変更を確認できます。 このスイッチで値を指定する必要はありません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(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
このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。