CredentialPersistenceOptions

Shared configuration options for credentials that support persistent token caching.

Hierarchy

CredentialPersistenceOptions

Index

Properties

tokenCachePersistenceOptions

Properties

Optional tokenCachePersistenceOptions

tokenCachePersistenceOptions: TokenCachePersistenceOptions

Options to provide to the persistence layer (if one is available) when storing credentials.

You must first register a persistence provider as an extension. See the @azure/identity-cache-persistence package on NPM.

Example:

import persistence from "@azure/identity-cache-persistence";
import { useIdentityExtension, DeviceCodeCredential } from "@azure/identity";

useIdentityExtension(persistence);

async function main() {
  const credential = new DeviceCodeCredential({
    tokenCachePersistenceOptions: {
      name: "mycustomcachename"
    }
  });
}

main().catch((error) => {
  console.error("An error occured:", error);
  process.exit(1);
});