[Identity] Clearer message on the getToken methods (#11487)

Azure · Sep 29, 2020 · cc8c8fc · cc8c8fc
1 parent 931539a
commit cc8c8fc
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/sdk/core/core-auth/src/tokenCredential.ts b/sdk/core/core-auth/src/tokenCredential.ts
@@ -11,6 +11,9 @@ export interface TokenCredential {
   /**
    * Gets the token provided by this credential.
    *
+   * This method is called automatically by Azure SDK client libraries. You may call this method
+   * directly, but you must also handle token caching and token refreshing.
+   *
    * @param scopes The list of scopes for which the token will have access.
    * @param options The options used to configure any requests this
    *                TokenCredential implementation might make.

diff --git a/sdk/identity/identity/src/credentials/chainedTokenCredential.ts b/sdk/identity/identity/src/credentials/chainedTokenCredential.ts
@@ -43,6 +43,9 @@ export class ChainedTokenCredential implements TokenCredential {
    * `TokenCredential` implementations.  Throws an {@link AggregateAuthenticationError}
    * when one or more credentials throws an {@link AuthenticationError} and
    * no credentials have returned an access token.
+   * 
+   * This method is called automatically by Azure SDK client libraries. You may call this method
+   * directly, but you must also handle token caching and token refreshing.
    *
    * @param scopes The list of scopes for which the token will have access.
    * @param options The options used to configure any requests this