add api version validation

Author: linglingye001

src/appConfigurationClient.ts

@@ -10,12 +10,15 @@ import {
     FeatureFlagClientOptions,
     GetConfigurationSettingOptions,
     GetSnapshotOptions,
+    KnownAppConfigurationApiVersion,
     ListConfigurationSettingsForSnapshotOptions,
     ListConfigurationSettingsOptions,
     ListFeatureFlagsOptions
 } from "@azure/app-configuration";
 import { TokenCredential } from "@azure/identity";
 import { instanceOfTokenCredential } from "./common/utils.js";
+import { ArgumentError } from "./common/errors.js";
+import { ErrorMessages } from "./common/errorMessages.js";
 import { RequestTracingOptions, applyRequestTracing } from "./requestTracing/utils.js";
 
 /**
@@ -78,6 +81,10 @@ export function getFeatureFlagClientOptions(options?: ConfigurationClientOptions
     if (options === undefined) {
         return undefined;
     }
+    if (options.apiVersion !== undefined &&
+        options.apiVersion !== KnownAppConfigurationApiVersion.V20260501Preview) {
+        throw new ArgumentError(ErrorMessages.API_VERSION_NOT_SUPPORTED);
+    }
 
     return {
         ...options,

src/common/errorMessages.ts

@@ -20,6 +20,7 @@ export const enum ErrorMessages {
     INVALID_KEY_FILTER = "Key filter cannot be null or empty.",
     INVALID_LABEL_FILTER = "The characters '*' and ',' are not supported in label filters.",
     INVALID_TAG_FILTER = "Tag filter must follow the format 'tagName=tagValue'",
+    API_VERSION_NOT_SUPPORTED = "The App Configuration provider requires API version '2026-05-01-preview'.",
     CONNECTION_STRING_OR_ENDPOINT_MISSED = "A connection string or an endpoint with credential must be specified to create a client.",
     REPLICA_DISCOVERY_NOT_SUPPORTED = "Replica discovery is not supported when loading from Azure Front Door. For guidance on how to take advantage of geo-replication when Azure Front Door is used, visit https://aka.ms/appconfig/geo-replication-with-afd",
     LOAD_BALANCING_NOT_SUPPORTED = "Load balancing is not supported when loading from Azure Front Door. For guidance on how to take advantage of geo-replication when Azure Front Door is used, visit https://aka.ms/appconfig/geo-replication-with-afd",

test/clientOptions.test.ts

@@ -7,9 +7,11 @@ import chaiAsPromised from "chai-as-promised";
 chai.use(chaiAsPromised);
 const expect = chai.expect;
 import { load } from "../src/index.js";
-import { createMockedConnectionString } from "./utils/testHelper.js";
-import { getClientOptions } from "../src/appConfigurationClientManager.js";
+import { createMockedConnectionString, createMockedTokenCredential } from "./utils/testHelper.js";
+import { AppConfigurationClientManager, getClientOptions } from "../src/appConfigurationClientManager.js";
 import { getFeatureFlagClientOptions } from "../src/appConfigurationClient.js";
+import { KnownAppConfigurationApiVersion } from "@azure/app-configuration";
+import { ErrorMessages } from "../src/common/errorMessages.js";
 import nock from "nock";
 
 class HttpRequestCountPolicy {
@@ -41,6 +43,16 @@ describe("custom client options", function () {
         nock.restore();
     });
 
+    it("should reject an unsupported API version", () => {
+        const createClientManager = () => new AppConfigurationClientManager(createMockedConnectionString(fakeEndpoint), {
+            clientOptions: {
+                apiVersion: KnownAppConfigurationApiVersion.V20260401
+            }
+        });
+
+        expect(createClientManager).throws(ErrorMessages.API_VERSION_NOT_SUPPORTED);
+    });
+
     it("should use equivalent options for configuration and feature flag clients", () => {
         const countPolicy = new HttpRequestCountPolicy();
         const configurationClientOptions = getClientOptions({