@azure/identity 4.5.0-beta.3 → 4.5.0

package/types/identity.d.ts

@@ -540,7 +540,14 @@ export declare class ChainedTokenCredential implements TokenCredential {
      * @param sources - `TokenCredential` implementations to be tried in order.
      *
      * Example usage:
-     * ```javascript
+     * ```ts snippet:chained_token_credential_example
+     * import { ClientSecretCredential, ChainedTokenCredential } from "@azure/identity";
+     *
+     * const tenantId = "<tenant-id>";
+     * const clientId = "<client-id>";
+     * const clientSecret = "<client-secret>";
+     * const anotherClientId = "<another-client-id>";
+     * const anotherSecret = "<another-client-secret>";
      * const firstCredential = new ClientSecretCredential(tenantId, clientId, clientSecret);
      * const secondCredential = new ClientSecretCredential(tenantId, anotherClientId, anotherSecret);
      * const credentialChain = new ChainedTokenCredential(firstCredential, secondCredential);
@@ -758,23 +765,14 @@ export declare interface CredentialPersistenceOptions {
      *
      * Example:
      *
-     * ```javascript
-     * import { cachePersistencePlugin } from "@azure/identity-cache-persistence";
+     * ```ts snippet:credential_persistence_options_example
      * import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";
      *
      * useIdentityPlugin(cachePersistencePlugin);
-     *
-     * async function main() {
-     *   const credential = new DeviceCodeCredential({
-     *     tokenCachePersistenceOptions: {
-     *       enabled: true
-     *     }
-     *   });
-     * }
-     *
-     * main().catch((error) => {
-     *   console.error("An error occurred:", error);
-     *   process.exit(1);
+     * const credential = new DeviceCodeCredential({
+     *   tokenCachePersistenceOptions: {
+     *     enabled: true,
+     *   },
      * });
      * ```
      */
@@ -955,13 +953,15 @@ export declare class DeviceCodeCredential implements TokenCredential {
      *
      * Developers can configure how this message is shown by passing a custom `userPromptCallback`:
      *
-     * ```js
+     * ```ts snippet:device_code_credential_example
+     * import { DeviceCodeCredential } from "@azure/identity";
+     *
      * const credential = new DeviceCodeCredential({
-     *   tenantId: env.AZURE_TENANT_ID,
-     *   clientId: env.AZURE_CLIENT_ID,
+     *   tenantId: process.env.AZURE_TENANT_ID,
+     *   clientId: process.env.AZURE_CLIENT_ID,
      *   userPromptCallback: (info) => {
      *     console.log("CUSTOMIZED PROMPT CALLBACK", info.message);
-     *   }
+     *   },
      * });
      * ```
      *
@@ -1133,14 +1133,14 @@ export declare interface ErrorResponse {
 /**
  * Returns a callback that provides a bearer token.
  * For example, the bearer token can be used to authenticate a request as follows:
- * ```js
- * import { DefaultAzureCredential } from "@azure/identity";
+ * ```ts snippet:token_provider_example
+ * 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}`);
@@ -1441,15 +1441,17 @@ export declare class OnBehalfOfCredential implements TokenCredential {
      *
      * Example using the `KeyClient` from [\@azure/keyvault-keys](https://www.npmjs.com/package/\@azure/keyvault-keys):
      *
-     * ```ts
+     * ```ts snippet:on_behalf_of_credential_pem_example
+     * import { OnBehalfOfCredential } from "@azure/identity";
+     * import { KeyClient } from "@azure/keyvault-keys";
+     *
      * const tokenCredential = new OnBehalfOfCredential({
-     *   tenantId,
-     *   clientId,
+     *   tenantId: "tenant-id",
+     *   clientId: "client-id",
      *   certificatePath: "/path/to/certificate.pem",
-     *   userAssertionToken: "access-token"
+     *   userAssertionToken: "access-token",
      * });
      * const client = new KeyClient("vault-url", tokenCredential);
-     *
      * await client.getKey("key-name");
      * ```
      *
@@ -1463,15 +1465,17 @@ export declare class OnBehalfOfCredential implements TokenCredential {
      *
      * Example using the `KeyClient` from [\@azure/keyvault-keys](https://www.npmjs.com/package/\@azure/keyvault-keys):
      *
-     * ```ts
+     * ```ts snippet:on_behalf_of_credential_secret_example
+     * import { OnBehalfOfCredential } from "@azure/identity";
+     * import { KeyClient } from "@azure/keyvault-keys";
+     *
      * const tokenCredential = new OnBehalfOfCredential({
-     *   tenantId,
-     *   clientId,
-     *   clientSecret,
-     *   userAssertionToken: "access-token"
+     *   tenantId: "tenant-id",
+     *   clientId: "client-id",
+     *   clientSecret: "client-secret",
+     *   userAssertionToken: "access-token",
      * });
      * const client = new KeyClient("vault-url", tokenCredential);
-     *
      * await client.getKey("key-name");
      * ```
      *
@@ -1485,15 +1489,19 @@ export declare class OnBehalfOfCredential implements TokenCredential {
      *
      * Example using the `KeyClient` from [\@azure/keyvault-keys](https://www.npmjs.com/package/\@azure/keyvault-keys):
      *
-     * ```ts
+     * ```ts snippet:on_behalf_of_credential_assertion_example
+     * import { OnBehalfOfCredential } from "@azure/identity";
+     * import { KeyClient } from "@azure/keyvault-keys";
+     *
      * const tokenCredential = new OnBehalfOfCredential({
-     *   tenantId,
-     *   clientId,
-     *   getAssertion: () => { return Promise.resolve("my-jwt")},
-     *   userAssertionToken: "access-token"
+     *   tenantId: "tenant-id",
+     *   clientId: "client-id",
+     *   getAssertion: () => {
+     *     return Promise.resolve("my-jwt");
+     *   },
+     *   userAssertionToken: "access-token",
      * });
      * const client = new KeyClient("vault-url", tokenCredential);
-     *
      * await client.getKey("key-name");
      * ```
      *
@@ -1666,18 +1674,16 @@ export declare interface TokenCredentialOptions extends CommonClientOptions {
  *
  * Example:
  *
- * ```javascript
- * import { cachePersistencePlugin } from "@azure/identity-cache-persistence";
+ * ```ts snippet:consumer_example
+ * import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";
  *
- * import { useIdentityPlugin, DefaultAzureCredential } from "@azure/identity";
  * useIdentityPlugin(cachePersistencePlugin);
- *
- * // The plugin has the capability to extend `DefaultAzureCredential` and to
+ * // The plugin has the capability to extend `DeviceCodeCredential` and to
  * // add middleware to the underlying credentials, such as persistence.
- * const credential = new DefaultAzureCredential({
+ * const credential = new DeviceCodeCredential({
  *   tokenCachePersistenceOptions: {
- *     enabled: true
- *   }
+ *     enabled: true,
+ *   },
  * });
  * ```
  *