DefaultAzureCredential class

パッケージ:

@azure/identity

Azure SDK クライアント ライブラリを使用するほとんどのアプリケーションで動作する既定の ChainedTokenCredential 構成を提供します。 詳細については、「DefaultAzureCredential の概要 を参照してください。

次の資格情報の種類が順番に試行されます。

• EnvironmentCredential
• WorkloadIdentityCredential
• ManagedIdentityCredential
• AzureCliCredential の
• AzurePowerShellCredential の
• AzureDeveloperCliCredential

認証の試行方法の詳細については、これらの資格情報の種類のドキュメントを参照してください。

Extends

ChainedTokenCredential

コンストラクター

DefaultAzureCredential(DefaultAzureCredentialClientIdOptions)	DefaultAzureCredentialClientIdOptions DefaultAzureCredential クラスのインスタンスを作成します。
DefaultAzureCredential(DefaultAzureCredentialOptions)	DefaultAzureCredentialOptions DefaultAzureCredential クラスのインスタンスを作成します。
DefaultAzureCredential(DefaultAzureCredentialResourceIdOptions)	DefaultAzureCredentialResourceIdOptions DefaultAzureCredential クラスのインスタンスを作成します。

継承されたメソッド

getToken(string | string[], GetTokenOptions)

チェーンされた TokenCredential 実装の 1 つによって返される最初のアクセス トークンを返します。 1 つ以上の資格情報が AuthenticationError をスローし、資格情報がアクセス トークンを返していない場合に、AggregateAuthenticationError をスローします。 このメソッドは、Azure SDK クライアント ライブラリによって自動的に呼び出されます。 このメソッドは直接呼び出すことができますが、トークンのキャッシュとトークンの更新も処理する必要があります。

コンストラクターの詳細

DefaultAzureCredential(DefaultAzureCredentialClientIdOptions)

DefaultAzureCredentialClientIdOptions DefaultAzureCredential クラスのインスタンスを作成します。

new DefaultAzureCredential(options?: DefaultAzureCredentialClientIdOptions)

パラメーター

options

DefaultAzureCredentialClientIdOptions

省略可能なパラメーター。 DefaultAzureCredentialClientIdOptions 参照してください。

DefaultAzureCredential(DefaultAzureCredentialOptions)

DefaultAzureCredentialOptions DefaultAzureCredential クラスのインスタンスを作成します。

new DefaultAzureCredential(options?: DefaultAzureCredentialOptions)

パラメーター

options

DefaultAzureCredentialOptions

省略可能なパラメーター。 DefaultAzureCredentialOptions 参照してください。

DefaultAzureCredential(DefaultAzureCredentialResourceIdOptions)

DefaultAzureCredentialResourceIdOptions DefaultAzureCredential クラスのインスタンスを作成します。

new DefaultAzureCredential(options?: DefaultAzureCredentialResourceIdOptions)

パラメーター

options

DefaultAzureCredentialResourceIdOptions

省略可能なパラメーター。 DefaultAzureCredentialResourceIdOptions 参照してください。

継承済みメソッドの詳細

getToken(string | string[], GetTokenOptions)

チェーンされた TokenCredential 実装の 1 つによって返される最初のアクセス トークンを返します。 1 つ以上の資格情報が AuthenticationError をスローし、資格情報がアクセス トークンを返していない場合に、AggregateAuthenticationError をスローします。

このメソッドは、Azure SDK クライアント ライブラリによって自動的に呼び出されます。 このメソッドは直接呼び出すことができますが、トークンのキャッシュとトークンの更新も処理する必要があります。

function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>

パラメーター

scopes

string | string[]

トークンがアクセスできるスコープの一覧。

options

GetTokenOptions

この TokenCredential 実装が行う可能性のある要求を構成するために使用されるオプション。

戻り値

Promise<AccessToken>

ChainedTokenCredential.getToken から継承された