TokenCredential インターフェイス

  • リファレンス
パッケージ:
com.azure.core.credential
Maven 成果物:
com.azure:azure-core:1.46.0

public interface TokenCredential

トークン資格情報インターフェイスは、Azure サービスへの要求を行うときに Azure Active Directory (Azure AD) 認証に必要なアクセス トークンを管理および提供するための基本的なコンポーネントとして機能します。

TokenCredentialインターフェイス、オファーgetToken(TokenRequestContext request)、メソッドgetTokenSync(TokenRequestContext request)。 これらのメソッドは、Azure サービスへの要求を認証するために使用できるアクセス トークンを取得する役割を担います。 の TokenRequestContext 一部として指定された scopes パラメーターは、トークンに必要なリソースまたはアクセス許可を表します。

トークン資格情報インターフェイスは、 Azure Id ライブラリのさまざまな資格情報クラスによって実装されます。 これらの資格情報クラスは認証プロセスを処理し、指定されたスコープと追加の構成に基づいて必要なアクセス トークンを提供します。

トークン資格情報インターフェイスを使用すると、アプリケーション コードから認証ロジックを抽象化できます。 これにより、認証メカニズムを柔軟に選択でき、トークンのキャッシュや更新など、アクセス トークンの管理が簡素化されます。 これは、さまざまな Azure サービスとライブラリ間で要求を認証するための一貫したアプローチを提供します。

トークン資格情報インターフェイスを実装する資格情報クラスの例をいくつか次に示します。

  • DefaultAzureCredential: 要求を自動的に認証するために一連の認証方法を試行する資格情報を表します。 環境変数、マネージド ID、開発者ツールの資格情報など、環境に基づいて適切な認証メカニズムを自動的に選択することで、プロセスを簡略化します。
  • ClientSecretCredential: クライアント ID、クライアント シークレット、テナント ID を使用して認証する資格情報を表します。 クライアント シークレットを使用して Azure サービスで認証する必要があるクライアント アプリケーションがあるシナリオに適しています。
  • ClientCertificateCredential: 認証にクライアント ID、クライアント証明書、テナント ID を使用する資格情報を表します。 この資格情報は、クライアント アプリケーションに認証に使用できるクライアント証明書がある場合に便利です。
  • InteractiveBrowserCredential: ブラウザーでユーザーと対話認証フローを実行する資格情報を表します。 これは、ユーザーが同意を提供する必要があるシナリオや、多要素認証が必要なシナリオに役立ちます。

インターフェイスを実装するその他の TokenCredential 資格情報クラスについては、 Azure Identity ライブラリを参照してください。

これらの資格情報クラスは、さまざまな Azure クライアント ライブラリと組み合わせて使用して要求を認証し、アクセス トークンを手動で管理しなくても Azure サービスにアクセスできます。 トークン資格情報インターフェイスは、さまざまな Azure サービスと SDK で Azure Active Directory (AAD) 認証を安全かつ効率的に処理するための一貫した方法を提供します。

メソッドの概要

修飾子と型 メソッドと説明
abstract Mono<AccessToken> getToken(TokenRequestContext request)

特定のリソース/対象ユーザーのトークンを非同期に取得します。
default AccessToken getTokenSync(TokenRequestContext request)

特定のリソース/対象ユーザーのトークンを同期的に取得します。

メソッドの詳細

getToken

public abstract Mono getToken(TokenRequestContext request)

特定のリソース/対象ユーザーのトークンを非同期に取得します。 このメソッドは、Azure SDK クライアント ライブラリによって自動的に呼び出されます。 このメソッドは直接呼び出すことができますが、トークンのキャッシュとトークンの更新も処理する必要があります。

Parameters:

request - トークン要求の詳細

Returns:

1 つのアクセス トークンを出力するパブリッシャー

getTokenSync

public default AccessToken getTokenSync(TokenRequestContext request)

特定のリソース/対象ユーザーのトークンを同期的に取得します。 このメソッドは、Azure SDK クライアント ライブラリによって自動的に呼び出されます。 このメソッドは直接呼び出すことができますが、トークンのキャッシュとトークンの更新も処理する必要があります。

Parameters:

request - トークン要求の詳細

Returns:

アクセス トークン

適用対象