Package version:

Function getBearerTokenProvider

  • getBearerTokenProvider(credential, scopes, options?): (() => Promise<string>)

  • Returns a callback that provides a bearer token. For example, the bearer token can be used to authenticate a request as follows:

    import { DefaultAzureCredential, getBearerTokenProvider } from "@azure/identity";
    import { createPipelineRequest } from "@azure/core-rest-pipeline";

    const credential = new DefaultAzureCredential();
    const scope = "https://cognitiveservices.azure.com/.default";
    const getAccessToken = getBearerTokenProvider(credential, scope);
    const token = await getAccessToken();

    // usage
    const request = createPipelineRequest({ url: "https://example.com" });
    request.headers.set("Authorization", `Bearer ${token}`);

    Parameters

    • credential: TokenCredential

      The credential used to authenticate the request.

    • scopes: string | {}

      The scopes required for the bearer token.

    • Optionaloptions: GetBearerTokenProviderOptions

      Options to configure the token provider.

    Returns (() => Promise<string>)

    a callback that provides a bearer token.

      • (): Promise<string>

      • Returns Promise<string>

Settings

Member Visibility