[Metrics Advisor] Api Key rotation (Azure#13490)

Co-authored-by: Jeremy Meng <yumeng@microsoft.com>

Author: KarishmaGhiya

sdk/metricsadvisor/ai-metrics-advisor/review/ai-metrics-advisor.api.md

@@ -1041,10 +1041,10 @@ export interface MetricsAdvisorClientOptions extends PipelineOptions {
 // @public
 export class MetricsAdvisorKeyCredential {
     constructor(subscriptionKey: string, apiKey: string);
-    // (undocumented)
-    readonly apiKey: string;
-    // (undocumented)
-    readonly subscriptionKey: string;
+    get apiKey(): string;
+    get subscriptionKey(): string;
+    updateApiKey(apiKey: string): void;
+    updateSubscriptionKey(subscriptionKey: string): void;
 }
 
 // @public

sdk/metricsadvisor/ai-metrics-advisor/src/metricsAdvisorKeyCredentialPolicy.ts

@@ -18,13 +18,73 @@ const X_API_KEY_HEADER_NAME = "x-api-key";
  * Credential used to authenticate and authorize with Metrics Advisor service
  */
 export class MetricsAdvisorKeyCredential {
+  /**
+   * Subscription access key from the Azure portal
+   */
+  private _subscriptionKey: string;
+
+  /**
+   * API key from the Metrics Advisor web portal
+   */
+  private _apiKey: string;
+
   /**
    * Creates an instance of MetricsAdvisorKeyCredential
    *
    * @param subscriptionKey - Subscription access key from the Azure portal
    * @param apiKey - API key from the Metrics Advisor web portal
    */
-  constructor(readonly subscriptionKey: string, readonly apiKey: string) {}
+  constructor(subscriptionKey: string, apiKey: string) {
+    if (!subscriptionKey || !apiKey) {
+      throw new RangeError("Subscription Key or Api Key doesn't have a valid value");
+    }
+    this._subscriptionKey = subscriptionKey;
+    this._apiKey = apiKey;
+  }
+
+  /**
+   * Get Api Key
+   */
+  public get apiKey(): string {
+    return this._apiKey;
+  }
+
+  /**
+   * Get Subscription key
+   */
+  public get subscriptionKey(): string {
+    return this._subscriptionKey;
+  }
+
+  /**
+   * Change the value of the subscription key.
+   *
+   * Updates will take effect upon the next request after
+   * updating the key value.
+   *
+   * @param subscriptionKey - The new subscription key value to be used
+   */
+  public updateSubscriptionKey(subscriptionKey: string): void {
+    if (!subscriptionKey) {
+      throw new RangeError("subscriptionKey must be a non-empty string");
+    }
+    this._subscriptionKey = subscriptionKey;
+  }
+
+  /**
+   * Change the value of the api key.
+   *
+   * Updates will take effect upon the next request after
+   * updating the key value.
+   *
+   * @param apiKey - The new api key value to be used
+   */
+  public updateApiKey(apiKey: string): void {
+    if (!apiKey) {
+      throw new RangeError("apiKey must be a non-empty string");
+    }
+    this._apiKey = apiKey;
+  }
 }
 
 /**
@@ -46,26 +106,21 @@ export function createMetricsAdvisorKeyCredentialPolicy(
  * using the appropriate header
  */
 class MetricsAdvisorKeyCredentialPolicy extends BaseRequestPolicy {
-  private subscriptionKey: string;
-  private apiKey: string;
-
   constructor(
     nextPolicy: RequestPolicy,
     options: RequestPolicyOptionsLike,
-    credential: MetricsAdvisorKeyCredential
+    private _credential: MetricsAdvisorKeyCredential
   ) {
     super(nextPolicy, options);
-    this.subscriptionKey = credential.subscriptionKey;
-    this.apiKey = credential.apiKey;
   }
 
   public async sendRequest(webResource: WebResourceLike): Promise<HttpOperationResponse> {
     if (!webResource) {
       throw new Error("webResource cannot be null or undefined");
     }
 
-    webResource.headers.set(API_KEY_HEADER_NAME, this.subscriptionKey);
-    webResource.headers.set(X_API_KEY_HEADER_NAME, this.apiKey);
+    webResource.headers.set(API_KEY_HEADER_NAME, this._credential.subscriptionKey);
+    webResource.headers.set(X_API_KEY_HEADER_NAME, this._credential.apiKey);
     return this._nextPolicy.sendRequest(webResource);
   }
 }

sdk/metricsadvisor/ai-metrics-advisor/test/public/keyRotation.spec.ts

@@ -0,0 +1,30 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { assert } from "chai";
+
+import { MetricsAdvisorKeyCredential } from "../../src";
+import { testEnv } from "./util/recordedClients";
+
+describe("MetricsAdvisorKeyCredential", () => {
+  let credential: MetricsAdvisorKeyCredential;
+
+  beforeEach(function() {
+    credential = new MetricsAdvisorKeyCredential(
+      testEnv.METRICS_ADVISOR_SUBSCRIPTION_KEY,
+      testEnv.METRICS_ADVISOR_API_KEY
+    );
+  });
+
+  it("update subscriptionKey", async function() {
+    const newSubscriptionKey = "Abc";
+    credential.updateSubscriptionKey(newSubscriptionKey);
+    assert.equal(credential.subscriptionKey, newSubscriptionKey);
+  });
+
+  it("update apiKey", async function() {
+    const newApiKey = "Abcdef";
+    credential.updateApiKey(newApiKey);
+    assert.equal(credential.apiKey, newApiKey);
+  });
+});