SecurityTokenProvider.GetTokenAsync(TimeSpan) メソッド

public:
 System::Threading::Tasks::Task<System::IdentityModel::Tokens::SecurityToken ^> ^ GetTokenAsync(TimeSpan timeout);

public System.Threading.Tasks.Task<System.IdentityModel.Tokens.SecurityToken> GetTokenAsync(TimeSpan timeout);

member this.GetTokenAsync : TimeSpan -> System.Threading.Tasks.Task<System.IdentityModel.Tokens.SecurityToken>

Public Function GetTokenAsync (timeout As TimeSpan) As Task(Of SecurityToken)

パラメーター

返品

非同期読み取り操作を表し、取得するセキュリティ トークンを表すSecurityTokenをラップするTask。

注釈

GetTokenAsync メソッドは、クライアントが SOAP メッセージを送信し、セキュリティ トークンが必要な場合に、ClientCredentials クラスによって呼び出されます。

GetTokenAsync メソッドは、GetTokenCoreAsync メソッドを呼び出します。

ほとんどの場合、timeout パラメーターは、SecurityTokenProviderなどのUserNameSecurityTokenProviderの派生クラスでは使用されません。 ただし、セキュリティ トークンを取得するには、分散メッセージングが必要な場合があります。 たとえば、フェデレーション サービスで使用 IssuedSecurityTokenProvider 。 このような場合、 timeout パラメーターは、ネットワーク障害、メッセージ損失、およびその他のエラー状態によって発生する例外を回避するために使用されます。

このメソッドは、メソッドの同期的な例外がスローできるすべての非使用例外を返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機しているときにスローされます。 ArgumentException などの使用に関する例外は、引き続き同期的にスローされます。 格納されている例外については、 GetToken(TimeSpan)によってスローされる例外を参照してください。