Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ManagedIdentityCredential

Package version

Attempts authentication using a managed identity that has been assigned to the deployment environment. This authentication type works in Azure VMs, App Service and Azure Functions applications, and inside of Azure Cloud Shell.

More information about configuring managed identities can be found here:

https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview

Hierarchy

  • ManagedIdentityCredential

Implements

  • TokenCredential
  • TokenCredential

Index

Methods

Methods

getToken

  • getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken | null>
  • Authenticates with Azure Active Directory and returns an access token if successful. If authentication cannot be performed at this time, this method may return null. If an error occurs during authentication, an AuthenticationError containing failure details will be thrown.

    Parameters

    • scopes: string | string[]

      The list of scopes for which the token will have access.

    • Optional options: GetTokenOptions

      The options used to configure any requests this TokenCredential implementation might make.

    Returns Promise<AccessToken | null>

Generated using TypeDoc