[New API] Tables Sovereign Cloud Support #45246

jairmyree · 2025-05-07T17:02:19Z

This pull request introduces the TableAudience class to define and manage audiences for Azure Table services, allowing for more flexible authentication and endpoint configuration. It also updates the TableClientBuilder and TableServiceClientBuilder to support this new functionality. Below is a summary of the most important changes:

New Feature: `TableAudience` Class

Added the TableAudience class to define audiences for Azure Table services, including predefined audiences for Azure Storage and Cosmos services in public cloud, China, and US government environments. It also provides a method to generate default scopes for authentication. (sdk/tables/azure-data-tables/src/main/java/com/azure/data/tables/models/TableAudience.java)

Builder Enhancements

Updated TableClientBuilder and TableServiceClientBuilder to include an audience property, allowing users to specify the audience during client configuration. Added a new audience(TableAudience audience) method to set this property. (sdk/tables/azure-data-tables/src/main/java/com/azure/data/tables/TableClientBuilder.java, sdk/tables/azure-data-tables/src/main/java/com/azure/data/tables/TableServiceClientBuilder.java) [1] [2] [3] [4]

Pipeline Updates

Modified the buildPipeline method in BuilderHelper to accept a TableAudience parameter and determine the appropriate default scope based on the audience. (sdk/tables/azure-data-tables/src/main/java/com/azure/data/tables/BuilderHelper.java) [1] [2]

Constants Simplification

Replaced specific scope constants (COSMOS_SCOPE, STORAGE_SCOPE) with a generic DEFAULT_SCOPE in TablesConstants. (sdk/tables/azure-data-tables/src/main/java/com/azure/data/tables/implementation/TablesConstants.java, sdk/tables/azure-data-tables/src/main/java/com/azure/data/tables/implementation/StorageConstants.java) [1] [2]

Testing

Added TableAudienceTests to validate the behavior of the TableAudience class, including predefined audiences and custom audience handling. (sdk/tables/azure-data-tables/src/test/java/com/azure/data/tables/TableAudienceTests.java)

azure-sdk · 2025-05-07T17:15:07Z

API Change Check

APIView identified API level changes in this PR and created the following API reviews

com.azure:azure-data-tables

azure-sdk · 2025-05-07T17:24:17Z

API change check

APIView has identified API level changes in this PR and created following API reviews.

com.azure:azure-data-tables

vcolin7 · 2025-05-07T18:50:35Z

sdk/tables/azure-data-tables/src/main/java/com/azure/data/tables/TableClientBuilder.java

@@ -744,4 +750,17 @@ public TableClientBuilder enableTenantDiscovery() {

        return this;
    }
+
+    /**
+     * Sets the {@link TableAudience} to use when authenticating with the Table Service.


nit;

Suggested change

* Sets the {@link TableAudience} to use when authenticating with the Table Service.

* Sets the {@link TableAudience} to use when authenticating with the Azure Tables service.

vcolin7 · 2025-05-07T18:51:19Z

sdk/tables/azure-data-tables/src/main/java/com/azure/data/tables/TableServiceClientBuilder.java

+     * Sets the {@link TableAudience audience} for the Azure Table service.
+     *
+     * @param audience The {@link TableAudience audience} for the Azure Table service.


nit;

Suggested change

* Sets the {@link TableAudience audience} for the Azure Table service.

*

* @param audience The {@link TableAudience audience} for the Azure Table service.

* Sets the {@link TableAudience audience} for the Azure Tables service.

*

* @param audience The {@link TableAudience audience} for the Azure Tables service.

vcolin7 · 2025-05-07T18:52:48Z

sdk/tables/azure-data-tables/src/main/java/com/azure/data/tables/models/TableAudience.java

+import java.net.URISyntaxException;
+
+/**
+ * Defines the audience for the Azure Table service.


nit;

Suggested change

* Defines the audience for the Azure Table service.

* Defines the audience for the Azure Tables service.

vcolin7 · 2025-05-07T18:53:14Z

sdk/tables/azure-data-tables/src/main/java/com/azure/data/tables/models/TableAudience.java

+ * The audience can be one of the following:
+ * <ul>
+ *     <li>AZURE_STORAGE_PUBLIC_CLOUD</li>
+ *     <li>AZURE_STORAGE_CHINAD</li>


nit; Typo

Suggested change

* <li>AZURE_STORAGE_CHINAD</li>

* <li>AZURE_STORAGE_CHINA</li>

vcolin7 · 2025-05-07T18:53:52Z

sdk/tables/azure-data-tables/src/main/java/com/azure/data/tables/models/TableAudience.java

+     */
+    public static final TableAudience AZURE_COSMOS_CHINA = fromString("https://cosmos.azure.cn");
+    /**
+     * The audience for the Azure Cosmos service in the US government.


Suggested change

* The audience for the Azure Cosmos service in the US government.

* The audience for the Azure Cosmos service in the US government cloud.

vcolin7 · 2025-05-07T18:54:00Z

sdk/tables/azure-data-tables/src/main/java/com/azure/data/tables/models/TableAudience.java

+    public static final TableAudience AZURE_STORAGE_CHINA = fromString("https://storage.azure.cn");
+
+    /**
+     * The audience for the Azure Storage service in the US government.


Suggested change

* The audience for the Azure Storage service in the US government.

* The audience for the Azure Storage service in the US government cloud.

vcolin7 · 2025-05-07T18:55:09Z

sdk/tables/azure-data-tables/src/main/java/com/azure/data/tables/models/TableAudience.java

+    /**
+     * @deprecated The audience is for the public.
+     */
+    @Deprecated
+    public TableAudience() {
+        // This constructor is deprecated and should not be used.
+    }


Do we need a public constructor when using an ExpandableStringEnum? Can we make it private or package-private instead? It just feels weird adding a new API and have it become deprecated at the same time.

vcolin7 · 2025-05-07T18:56:46Z

sdk/tables/azure-data-tables/src/main/java/com/azure/data/tables/BuilderHelper.java

+            perRetryAdditionalPolicies, configuration, logger, enableTenantDiscovery, null);
+    }
+
+    static HttpPipeline buildPipeline(AzureNamedKeyCredential azureNamedKeyCredential,


Do we need to add a new overload for the method above? Since it's package-private, we can add the new parameter to it.

alzimmermsft · 2025-05-08T16:22:09Z

sdk/tables/azure-data-tables/src/main/java/com/azure/data/tables/BuilderHelper.java

+        audience = (audience != null)
+            ? audience
+            : (TableUtils.isCosmosEndpoint(endpoint)
+                ? TableAudience.AZURE_COSMOS_PUBLIC_CLOUD
+                : TableAudience.AZURE_STORAGE_PUBLIC_CLOUD);


For easier readability, let's not use ternary in ternary operators.

alzimmermsft · 2025-05-08T16:23:04Z

sdk/tables/azure-data-tables/src/main/java/com/azure/data/tables/TableClientBuilder.java

@@ -218,6 +220,10 @@ public TableClientBuilder() {
    public TableClient buildClient() {
        TableServiceVersion serviceVersion = version != null ? version : TableServiceVersion.getLatest();

+        if (audience == null) {
+            audience = TableAudience.AZURE_STORAGE_PUBLIC_CLOUD;


This is modifying the builder itself, which isn't what we want when creating the client.

Also, is defaulting to Storage public cloud scope the correct choice here? If it is, please add comments explaining why this is the right choice. As the other client builder doesn't add in a default audience.

alzimmermsft · 2025-05-08T16:28:51Z

sdk/tables/azure-data-tables/src/test/java/com/azure/data/tables/TableAudienceTests.java

+    }
+
+    @Test
+    public void testCustomAudience() {


Please make these parameterized tests where the arguments as the input string for fromString and the expected value.

Testing like this can be painful if a change breaks a few cases as you'll need to run and fail multiple times to find all cases that broke. A parameterized test will tell you every case that breaks.

alzimmermsft · 2025-05-08T16:30:05Z

sdk/tables/azure-data-tables/src/main/java/com/azure/data/tables/models/TableAudience.java

+     */
+    public static final TableAudience AZURE_COSMOS_US_GOVERNMENT = fromString("https://cosmos.azure.us");
+
+    private final ClientLogger logger = new ClientLogger(TableAudience.class);


Make this a constant, otherwise a new ClientLogger will be instantiated every time a new instance is created.

jairmyree added 2 commits May 2, 2025 12:08

Introducing TableAudience

cbdb56e

Adding tests and updating TableAudience api

b1e976f

jairmyree requested review from christothes, pvaneck and alzimmermsft May 7, 2025 17:02

jairmyree requested a review from vcolin7 as a code owner May 7, 2025 17:02

jairmyree added 2 commits May 7, 2025 10:04

Update spacing

94970f9

Add Javadoc for getDefaultScope

40dbcae

github-actions bot added the Tables label May 7, 2025

jairmyree added 2 commits May 7, 2025 10:12

Fixing checkstyle violations

d3fcf6c

Adding license header

7d81298

Removing necessary comment

d5d00ab

vcolin7 reviewed May 7, 2025

View reviewed changes

alzimmermsft reviewed May 8, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[New API] Tables Sovereign Cloud Support #45246

[New API] Tables Sovereign Cloud Support #45246

jairmyree commented May 7, 2025

azure-sdk commented May 7, 2025 •

edited by github-actions bot

Loading

azure-sdk commented May 7, 2025

vcolin7 May 7, 2025

vcolin7 May 7, 2025

vcolin7 May 7, 2025

vcolin7 May 7, 2025

vcolin7 May 7, 2025

vcolin7 May 7, 2025

vcolin7 May 7, 2025

vcolin7 May 7, 2025

alzimmermsft May 8, 2025

alzimmermsft May 8, 2025

alzimmermsft May 8, 2025 •

edited

Loading

alzimmermsft May 8, 2025

alzimmermsft May 8, 2025

	* Sets the {@link TableAudience} to use when authenticating with the Table Service.
	* Sets the {@link TableAudience} to use when authenticating with the Azure Tables service.

	* Defines the audience for the Azure Table service.
	* Defines the audience for the Azure Tables service.

	* <li>AZURE_STORAGE_CHINAD</li>
	* <li>AZURE_STORAGE_CHINA</li>

	* The audience for the Azure Cosmos service in the US government.
	* The audience for the Azure Cosmos service in the US government cloud.

	* The audience for the Azure Storage service in the US government.
	* The audience for the Azure Storage service in the US government cloud.

[New API] Tables Sovereign Cloud Support #45246

Are you sure you want to change the base?

[New API] Tables Sovereign Cloud Support #45246

Conversation

jairmyree commented May 7, 2025

New Feature: TableAudience Class

Builder Enhancements

Pipeline Updates

Constants Simplification

Testing

azure-sdk commented May 7, 2025 • edited by github-actions bot Loading

API Change Check

azure-sdk commented May 7, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alzimmermsft May 8, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

New Feature: `TableAudience` Class

azure-sdk commented May 7, 2025 •

edited by github-actions bot

Loading

alzimmermsft May 8, 2025 •

edited

Loading