Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/identity

Package version

Index

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

BrowserLoginStyle

BrowserLoginStyle: "redirect" | "popup"

The "login style" to use in the authentication flow:

  • "redirect" redirects the user to the authentication page and then redirects them back to the page once authentication is completed.
  • "popup" opens a new browser window through with the redirect flow is initiated. The user's existing browser window does not leave the current page

DeviceCodePromptCallback

DeviceCodePromptCallback: function

Defines the signature of a callback which will be passed to DeviceCodeCredential for the purpose of displaying authentication details to the user.

Type declaration

Variables

Const AggregateAuthenticationErrorName

AggregateAuthenticationErrorName: "AggregateAuthenticationError" = "AggregateAuthenticationError"

The Error.name value of an AggregateAuthenticationError

Const AppServiceMsiApiVersion

AppServiceMsiApiVersion: "2017-09-01" = "2017-09-01"

Const AuthenticationErrorName

AuthenticationErrorName: "AuthenticationError" = "AuthenticationError"

The Error.name value of an AuthenticationError

Const ImdsApiVersion

ImdsApiVersion: "2018-02-01" = "2018-02-01"

Const ImdsEndpoint

ImdsEndpoint: "http://169.254.169.254/metadata/identity/oauth2/token" = "http://169.254.169.254/metadata/identity/oauth2/token"

Const logger

logger: AzureLogger = createClientLogger("identity")

The AzureLogger used for all clients within the identity package

Functions

_setDelayTestFunction

  • _setDelayTestFunction(func?: undefined | function): void
  • internal

    Parameters

    • Optional func: undefined | function

    Returns void

createSpan

  • createSpan(operationName: string, options?: GetTokenOptions): object

  • Creates a span using the global tracer.

    Parameters

    • operationName: string
    • Default value options: GetTokenOptions = {}

      The options for the underlying http request.

    Returns object

delay

  • delay(t: number): Promise<void>

  • A wrapper for setTimeout that resolves a promise after t milliseconds.

    internal

    Parameters

    • t: number

      The number of milliseconds to be delayed.

    Returns Promise<void>

    Resolved promise

getDefaultAzureCredential

  • getDefaultAzureCredential(): TokenCredential

Generated using TypeDoc