chore(benchmark): wire excludedRegionsList into Cosmos*RequestOptions (#49313)

jeet1995 · Copilot · web-flow · commit eb81eb287e6c · 2026-05-29T16:01:56.000Z
Adds an excludedRegionsList field on TenantDefaultConfig (mirroring preferredRegionsList) and threads getExcludedRegionsList() into every Cosmos*RequestOptions constructed by the vanilla async/sync benchmark workloads (read, write, query, readMany, bulk).

Co-authored-by: Copilot &lt;223556219+Copilot@users.noreply.github.com&gt;
diff --git a/sdk/cosmos/azure-cosmos-benchmark/src/main/java/com/azure/cosmos/benchmark/AsyncBenchmark.java b/sdk/cosmos/azure-cosmos-benchmark/src/main/java/com/azure/cosmos/benchmark/AsyncBenchmark.java
@@ -210,6 +210,7 @@ abstract class AsyncBenchmark<T> implements Benchmark {
                 });
 
             CosmosBulkExecutionOptions bulkExecutionOptions = new CosmosBulkExecutionOptions();
+            bulkExecutionOptions.setExcludedRegions(cfg.getExcludedRegionsList());
             List<CosmosBulkOperationResponse<Object>> failedResponses = Collections.synchronizedList(new ArrayList<>());
             cosmosAsyncContainer
                 .executeBulkOperations(bulkOperationFlux, bulkExecutionOptions)
diff --git a/sdk/cosmos/azure-cosmos-benchmark/src/main/java/com/azure/cosmos/benchmark/AsyncQueryBenchmark.java b/sdk/cosmos/azure-cosmos-benchmark/src/main/java/com/azure/cosmos/benchmark/AsyncQueryBenchmark.java
@@ -40,6 +40,7 @@ protected Mono<FeedResponse<PojoizedJson>> performWorkload(long i) {
         Flux<FeedResponse<PojoizedJson>> obs;
         Random r = new Random();
         CosmosQueryRequestOptions options = new CosmosQueryRequestOptions();
+        options.setExcludedRegions(workloadConfig.getExcludedRegionsList());
 
         if (workloadConfig.getOperationType() == Operation.QueryCross) {
 
diff --git a/sdk/cosmos/azure-cosmos-benchmark/src/main/java/com/azure/cosmos/benchmark/AsyncQuerySinglePartitionMultiple.java b/sdk/cosmos/azure-cosmos-benchmark/src/main/java/com/azure/cosmos/benchmark/AsyncQuerySinglePartitionMultiple.java
@@ -19,6 +19,7 @@ class AsyncQuerySinglePartitionMultiple extends AsyncBenchmark<FeedResponse<Pojo
         super(cfg);
         options = new CosmosQueryRequestOptions();
         options.setPartitionKey(new PartitionKey("pk"));
+        options.setExcludedRegions(cfg.getExcludedRegionsList());
     }
 
     @Override
diff --git a/sdk/cosmos/azure-cosmos-benchmark/src/main/java/com/azure/cosmos/benchmark/AsyncReadBenchmark.java b/sdk/cosmos/azure-cosmos-benchmark/src/main/java/com/azure/cosmos/benchmark/AsyncReadBenchmark.java
@@ -3,6 +3,7 @@
 
 package com.azure.cosmos.benchmark;
 
+import com.azure.cosmos.models.CosmosItemRequestOptions;
 import com.azure.cosmos.models.CosmosItemResponse;
 import com.azure.cosmos.models.PartitionKey;
 
@@ -18,8 +19,10 @@ class AsyncReadBenchmark extends AsyncBenchmark<PojoizedJson> {
     protected Mono<PojoizedJson> performWorkload(long i) {
         int index = (int) (i % docsToRead.size());
         PojoizedJson doc = docsToRead.get(index);
+        CosmosItemRequestOptions options = new CosmosItemRequestOptions();
+        options.setExcludedRegions(workloadConfig.getExcludedRegionsList());
         return cosmosAsyncContainer.readItem(doc.getId(),
-            new PartitionKey(doc.getId()), PojoizedJson.class)
+            new PartitionKey(doc.getId()), options, PojoizedJson.class)
             .map(CosmosItemResponse::getItem);
     }
 }
diff --git a/sdk/cosmos/azure-cosmos-benchmark/src/main/java/com/azure/cosmos/benchmark/AsyncReadManyBenchmark.java b/sdk/cosmos/azure-cosmos-benchmark/src/main/java/com/azure/cosmos/benchmark/AsyncReadManyBenchmark.java
@@ -4,6 +4,7 @@
 package com.azure.cosmos.benchmark;
 
 import com.azure.cosmos.models.CosmosItemIdentity;
+import com.azure.cosmos.models.CosmosReadManyRequestOptions;
 import com.azure.cosmos.models.FeedResponse;
 import com.azure.cosmos.models.PartitionKey;
 
@@ -37,6 +38,8 @@ protected Mono<FeedResponse<PojoizedJson>> performWorkload(long i) {
             cosmosItemIdentities.add(new CosmosItemIdentity(partitionKey, doc.getId()));
         }
 
-        return cosmosAsyncContainer.readMany(cosmosItemIdentities, PojoizedJson.class);
+        CosmosReadManyRequestOptions options = new CosmosReadManyRequestOptions();
+        options.setExcludedRegions(workloadConfig.getExcludedRegionsList());
+        return cosmosAsyncContainer.readMany(cosmosItemIdentities, options, PojoizedJson.class);
     }
 }
diff --git a/sdk/cosmos/azure-cosmos-benchmark/src/main/java/com/azure/cosmos/benchmark/AsyncWriteBenchmark.java b/sdk/cosmos/azure-cosmos-benchmark/src/main/java/com/azure/cosmos/benchmark/AsyncWriteBenchmark.java
@@ -3,6 +3,7 @@
 
 package com.azure.cosmos.benchmark;
 
+import com.azure.cosmos.models.CosmosItemRequestOptions;
 import com.azure.cosmos.models.CosmosItemResponse;
 import com.azure.cosmos.models.PartitionKey;
 
@@ -28,18 +29,21 @@ class AsyncWriteBenchmark extends AsyncBenchmark<CosmosItemResponse> {
     protected Mono<CosmosItemResponse> performWorkload(long i) {
         String id = uuid + i;
         Mono<? extends CosmosItemResponse<?>> result;
+        CosmosItemRequestOptions options = new CosmosItemRequestOptions();
+        options.setExcludedRegions(workloadConfig.getExcludedRegionsList());
         if (workloadConfig.isDisablePassingPartitionKeyAsOptionOnWrite()) {
             result = cosmosAsyncContainer.createItem(BenchmarkHelper.generateDocument(id,
                 dataFieldValue,
                 partitionKey,
-                workloadConfig.getDocumentDataFieldCount()));
+                workloadConfig.getDocumentDataFieldCount()),
+                options);
         } else {
             result = cosmosAsyncContainer.createItem(BenchmarkHelper.generateDocument(id,
                 dataFieldValue,
                 partitionKey,
                 workloadConfig.getDocumentDataFieldCount()),
                 new PartitionKey(id),
-                null);
+                options);
         }
         // Raw type cast is required because CosmosItemResponse uses wildcard generics
         // that cannot be expressed in the class type parameter without propagating
diff --git a/sdk/cosmos/azure-cosmos-benchmark/src/main/java/com/azure/cosmos/benchmark/SyncBenchmark.java b/sdk/cosmos/azure-cosmos-benchmark/src/main/java/com/azure/cosmos/benchmark/SyncBenchmark.java
@@ -186,6 +186,7 @@ private static ImplementationBridgeHelpers.CosmosClientHelper.CosmosClientAccess
                     });
 
                 CosmosBulkExecutionOptions bulkExecutionOptions = new CosmosBulkExecutionOptions();
+                bulkExecutionOptions.setExcludedRegions(workloadCfg.getExcludedRegionsList());
                 List<CosmosBulkOperationResponse<Object>> failedResponses = Collections.synchronizedList(new ArrayList<>());
                 asyncContainer
                     .executeBulkOperations(bulkOperationFlux, bulkExecutionOptions)
diff --git a/sdk/cosmos/azure-cosmos-benchmark/src/main/java/com/azure/cosmos/benchmark/SyncReadBenchmark.java b/sdk/cosmos/azure-cosmos-benchmark/src/main/java/com/azure/cosmos/benchmark/SyncReadBenchmark.java
@@ -21,7 +21,9 @@ protected CosmosItemResponse performWorkload(long i) throws Exception {
         PojoizedJson doc = docsToRead.get(index);
 
         String partitionKeyValue = doc.getId();
+        CosmosItemRequestOptions options = new CosmosItemRequestOptions();
+        options.setExcludedRegions(workloadConfig.getExcludedRegionsList());
         return cosmosContainer.readItem(doc.getId(), new PartitionKey(partitionKeyValue),
-                                        new CosmosItemRequestOptions(), InternalObjectNode.class);
+                                        options, InternalObjectNode.class);
     }
 }
diff --git a/sdk/cosmos/azure-cosmos-benchmark/src/main/java/com/azure/cosmos/benchmark/SyncWriteBenchmark.java b/sdk/cosmos/azure-cosmos-benchmark/src/main/java/com/azure/cosmos/benchmark/SyncWriteBenchmark.java
@@ -3,6 +3,7 @@
 
 package com.azure.cosmos.benchmark;
 
+import com.azure.cosmos.models.CosmosItemRequestOptions;
 import com.azure.cosmos.models.CosmosItemResponse;
 import com.azure.cosmos.models.PartitionKey;
 import org.apache.commons.lang3.RandomStringUtils;
@@ -26,13 +27,15 @@ class SyncWriteBenchmark extends SyncBenchmark<CosmosItemResponse> {
     @Override
     protected CosmosItemResponse performWorkload(long i) throws Exception {
         String id = uuid + i;
-        CosmosItemResponse<PojoizedJson> response;
+        CosmosItemRequestOptions options = new CosmosItemRequestOptions();
+        options.setExcludedRegions(workloadConfig.getExcludedRegionsList());
         if (workloadConfig.isDisablePassingPartitionKeyAsOptionOnWrite()) {
             // require parsing partition key from the doc
             return cosmosContainer.createItem(BenchmarkHelper.generateDocument(id,
                 dataFieldValue,
                 partitionKey,
-                workloadConfig.getDocumentDataFieldCount()));
+                workloadConfig.getDocumentDataFieldCount()),
+                options);
         }
 
         // more optimized for write as partition key is already passed as config
@@ -41,6 +44,6 @@ protected CosmosItemResponse performWorkload(long i) throws Exception {
             partitionKey,
             workloadConfig.getDocumentDataFieldCount()),
             new PartitionKey(id),
-            null);
+            options);
     }
 }
diff --git a/sdk/cosmos/azure-cosmos-benchmark/src/main/java/com/azure/cosmos/benchmark/TenantDefaultConfig.java b/sdk/cosmos/azure-cosmos-benchmark/src/main/java/com/azure/cosmos/benchmark/TenantDefaultConfig.java
@@ -140,6 +140,9 @@ class TenantDefaultConfig {
     @JsonProperty("preferredRegionsList")
     protected String preferredRegionsList;
 
+    @JsonProperty("excludedRegionsList")
+    protected String excludedRegionsList;
+
     @JsonProperty("manageDatabase")
     protected Boolean manageDatabase;
 
@@ -233,6 +236,13 @@ public List<String> getPreferredRegionsList() {
         return regions;
     }
 
+    public List<String> getExcludedRegionsList() {
+        if (excludedRegionsList == null || excludedRegionsList.isEmpty()) return null;
+        List<String> regions = new ArrayList<>();
+        for (String r : excludedRegionsList.split(",")) { regions.add(r.trim()); }
+        return regions;
+    }
+
     public boolean shouldManageDatabase() { return manageDatabase != null ? manageDatabase : false; }
     public String getApplicationName() { return applicationName != null ? applicationName : ""; }
     public boolean isManagedIdentityRequired() { return isManagedIdentityRequired != null && isManagedIdentityRequired; }
@@ -278,6 +288,7 @@ void applyTo(TenantWorkloadConfig tenant) {
         if (http2Enabled != null && tenant.http2Enabled == null) tenant.http2Enabled = http2Enabled;
         if (http2MaxConcurrentStreams != null && tenant.http2MaxConcurrentStreams == null) tenant.http2MaxConcurrentStreams = http2MaxConcurrentStreams;
         if (preferredRegionsList != null && tenant.preferredRegionsList == null) tenant.preferredRegionsList = preferredRegionsList;
+        if (excludedRegionsList != null && tenant.excludedRegionsList == null) tenant.excludedRegionsList = excludedRegionsList;
         if (manageDatabase != null && tenant.manageDatabase == null) tenant.manageDatabase = manageDatabase;
         if (isManagedIdentityRequired != null && tenant.isManagedIdentityRequired == null) tenant.isManagedIdentityRequired = isManagedIdentityRequired;
         if (applicationName != null && tenant.applicationName == null) tenant.applicationName = applicationName;

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@ class AsyncQuerySinglePartitionMultiple extends AsyncBenchmark<FeedResponse<Pojo`
`19`	`19`	`super(cfg);`
`20`	`20`	`options = new CosmosQueryRequestOptions();`
`21`	`21`	`options.setPartitionKey(new PartitionKey("pk"));`
	`22`	`+ options.setExcludedRegions(cfg.getExcludedRegionsList());`
`22`	`23`	`}`
`23`	`24`
`24`	`25`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`	`package com.azure.cosmos.benchmark;`
`5`	`5`
`6`	`6`	`import com.azure.cosmos.models.CosmosItemIdentity;`
	`7`	`+import com.azure.cosmos.models.CosmosReadManyRequestOptions;`
`7`	`8`	`import com.azure.cosmos.models.FeedResponse;`
`8`	`9`	`import com.azure.cosmos.models.PartitionKey;`
`9`	`10`
`@@ -37,6 +38,8 @@ protected Mono<FeedResponse<PojoizedJson>> performWorkload(long i) {`
`37`	`38`	`cosmosItemIdentities.add(new CosmosItemIdentity(partitionKey, doc.getId()));`
`38`	`39`	`}`
`39`	`40`
`40`		`- return cosmosAsyncContainer.readMany(cosmosItemIdentities, PojoizedJson.class);`
	`41`	`+ CosmosReadManyRequestOptions options = new CosmosReadManyRequestOptions();`
	`42`	`+ options.setExcludedRegions(workloadConfig.getExcludedRegionsList());`
	`43`	`+ return cosmosAsyncContainer.readMany(cosmosItemIdentities, options, PojoizedJson.class);`
`41`	`44`	`}`
`42`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,9 @@ protected CosmosItemResponse performWorkload(long i) throws Exception {`
`21`	`21`	`PojoizedJson doc = docsToRead.get(index);`
`22`	`22`
`23`	`23`	`String partitionKeyValue = doc.getId();`
	`24`	`+ CosmosItemRequestOptions options = new CosmosItemRequestOptions();`
	`25`	`+ options.setExcludedRegions(workloadConfig.getExcludedRegionsList());`
`24`	`26`	`return cosmosContainer.readItem(doc.getId(), new PartitionKey(partitionKeyValue),`
`25`		`- new CosmosItemRequestOptions(), InternalObjectNode.class);`
	`27`	`+ options, InternalObjectNode.class);`
`26`	`28`	`}`
`27`	`29`	`}`