Test-OAuthConnectivity

リファレンス

モジュール:: ExchangePowerShell

適用対象:: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

このコマンドレットは、オンプレミスの Exchange およびクラウドベースのサービスで使用できます。一部のパラメーターおよび設定は、いずれかの環境専用となっている場合があります。

ユーザーに対するパートナーアプリケーションの OAuth 認証をテストするには、Test-OAuthConnectivity コマンドレットを使用します。

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

構文

Test-OAuthConnectivity
    -Service <ModServiceType>
    -TargetUri <Uri>
    [-AppOnly]
    [-Confirm]
    [-Mailbox <MailboxIdParameter>]
    [-ReloadConfig]
    [-UseCachedToken]
    [-WhatIf]
    [<CommonParameters>]

説明

SharePoint、Lync、Skype for Business パートナーアプリケーションは、オンプレミスの Exchange 展開で自動的に作成されます。 Test-OAuthConnectivity コマンドレットがオンプレミス展開の他のパートナーアプリケーションに対して成功するには、まず、%ExchangeInstallPath%Scripts フォルダー (PowerShell の$env:ExchangeInstallPath\Scripts) で使用できるConfigure-EnterprisePartnerApplication.ps1 スクリプトを使用してパートナーアプリケーションを作成する必要があります。

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

例

例 1

Test-OAuthConnectivity -Service EWS -TargetUri https://cas.contoso.com/ews/ -Mailbox "Gurinder Singh"

この例では、Exchange for Gurinder Singh との OAuth 接続をテストします。

パラメーター

-AppOnly

AppOnly スイッチは、コマンドレットが指定されたサービスをユーザーコンテキストを使わずに Exchange として認証するように指定します。このスイッチで値を指定する必要はありません。

Type:	SwitchParameter
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, Exchange Online

-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 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-Mailbox

Mailbox パラメーターは、指定したパートナーアプリケーションへの OAuth 接続をテストするメールボックスを指定します。メールボックスを一意に識別する任意の値を使用できます。次に例を示します。

名前
Alias
識別名 (DN)
正規 DN
Domain\Username
電子メールアドレス
GUID
LegacyExchangeDN
SamAccountName
ユーザー ID またはユーザープリンシパル名 (UPN)

Type:	MailboxIdParameter
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, Exchange Online

-ReloadConfig

ReloadConfig スイッチは、すべての構成設定を Exchange 構成オブジェクトから再読み込みします。このスイッチで値を指定する必要はありません。

このスイッチを使用しない場合は、キャッシュされた構成設定が使用されます。

Type:	SwitchParameter
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, Exchange Online

-Service

Service パラメーターは、パートナーアプリケーションを指定します。 PasswordQuality パラメーターは、デバイスパスワードに必要なパスワードの最小品質レベルを指定します。パスワードの品質は、パスワードのセキュリティと複雑さを示す数値の尺度です。品質の値が大きいほど、より安全なパスワードであることを示します。

EWS
AutoD
Generic

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

-TargetUri

TargetUri パラメーターは、OAuth 接続をテストするサービスの URL を指定します。

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

-UseCachedToken

UseCachedToken スイッチは、OAuth が既存のキャッシュされた認証トークンの使用を試みるように指定します。このスイッチで値を指定する必要はありません。

Type:	SwitchParameter
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, Exchange Online

-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 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

入力

Input types

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

出力

Output types

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