Implement SAS-based authentication

sdk/maps/azure-maps-geolocation/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release History
 
+## 1.0.0-beta.3 (Unreleased)
+
+### Features added
+
+- Integrated support for SAS-based authentication
+
 ## 1.0.0-beta.2 (2024-11-08)
 
 ### Other Changes

sdk/maps/azure-maps-geolocation/src/main/java/com/azure/maps/geolocation/GeolocationClientBuilder.java

@@ -10,7 +10,9 @@
 import com.azure.core.client.traits.EndpointTrait;
 import com.azure.core.client.traits.HttpTrait;
 import com.azure.core.client.traits.TokenCredentialTrait;
+import com.azure.core.client.traits.AzureSasCredentialTrait;
 import com.azure.core.credential.AzureKeyCredential;
+import com.azure.core.credential.AzureSasCredential;
 import com.azure.core.credential.TokenCredential;
 import com.azure.core.http.HttpClient;
 import com.azure.core.http.HttpHeaderName;
@@ -28,6 +30,7 @@
 import com.azure.core.http.policy.RetryOptions;
 import com.azure.core.http.policy.RetryPolicy;
 import com.azure.core.http.policy.UserAgentPolicy;
+import com.azure.core.http.policy.AzureSasCredentialPolicy;
 import com.azure.core.util.ClientOptions;
 import com.azure.core.util.Configuration;
 import com.azure.core.util.CoreUtils;
@@ -58,7 +61,8 @@
  * <!-- end com.azure.maps.geolocation.sync.builder.ad.instantiation -->
  */
 @ServiceClientBuilder(serviceClients = { GeolocationClient.class, GeolocationAsyncClient.class })
-public final class GeolocationClientBuilder implements AzureKeyCredentialTrait<GeolocationClientBuilder>,
+public final class GeolocationClientBuilder
+    implements AzureKeyCredentialTrait<GeolocationClientBuilder>, AzureSasCredentialTrait<GeolocationClientBuilder>,
     TokenCredentialTrait<GeolocationClientBuilder>, HttpTrait<GeolocationClientBuilder>,
     ConfigurationTrait<GeolocationClientBuilder>, EndpointTrait<GeolocationClientBuilder> {
 
@@ -98,6 +102,7 @@ public final class GeolocationClientBuilder implements AzureKeyCredentialTrait<G
     // credentials
     private AzureKeyCredential keyCredential;
     private TokenCredential tokenCredential;
+    private AzureSasCredential sasCredential;
 
     /**
      * Default constructor for the builder class.
@@ -262,6 +267,19 @@ public GeolocationClientBuilder credential(AzureKeyCredential keyCredential) {
         return this;
     }
 
+    /**
+     * Sets the {@link AzureSasCredential} used to authenticate HTTP requests.
+     *
+     * @param sasCredential The {@link AzureSasCredential} used to authenticate HTTP requests.
+     * @return The updated {@link GeolocationClientBuilder} object.
+     * @throws NullPointerException If {@code sasCredential} is null.
+     */
+    @Override
+    public GeolocationClientBuilder credential(AzureSasCredential sasCredential) {
+        this.sasCredential = Objects.requireNonNull(sasCredential, "'keyCredential' cannot be null.");
+        return this;
+    }
+
     /**
      * Sets retry options
      *
@@ -339,6 +357,8 @@ private HttpPipeline createHttpPipeline() {
             policies.add(new BearerTokenAuthenticationPolicy(tokenCredential, DEFAULT_SCOPES));
         } else if (keyCredential != null) {
             policies.add(new AzureKeyCredentialPolicy(GEOLOCATION_SUBSCRIPTION_KEY, keyCredential));
+        } else if (sasCredential != null) {
+            policies.add(new AzureSasCredentialPolicy(sasCredential));
         } else {
             // Throw exception that credential and tokenCredential cannot be null
             throw LOGGER.logExceptionAsError(

sdk/maps/azure-maps-render/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release History
 
+## 2.0.0-beta.2 (Unreleased)
+
+### Features added
+
+- Integrated support for SAS-based authentication
+
 ## 2.0.0-beta.1 (2024-11-08)
 
 ### Features Added

sdk/maps/azure-maps-render/src/main/java/com/azure/maps/render/MapsRenderClientBuilder.java

@@ -10,7 +10,9 @@
 import com.azure.core.client.traits.EndpointTrait;
 import com.azure.core.client.traits.HttpTrait;
 import com.azure.core.client.traits.TokenCredentialTrait;
+import com.azure.core.client.traits.AzureSasCredentialTrait;
 import com.azure.core.credential.AzureKeyCredential;
+import com.azure.core.credential.AzureSasCredential;
 import com.azure.core.credential.TokenCredential;
 import com.azure.core.http.HttpClient;
 import com.azure.core.http.HttpHeaderName;
@@ -28,6 +30,7 @@
 import com.azure.core.http.policy.RetryOptions;
 import com.azure.core.http.policy.RetryPolicy;
 import com.azure.core.http.policy.UserAgentPolicy;
+import com.azure.core.http.policy.AzureSasCredentialPolicy;
 import com.azure.core.util.ClientOptions;
 import com.azure.core.util.Configuration;
 import com.azure.core.util.CoreUtils;
@@ -78,7 +81,8 @@
  * <!-- end com.azure.maps.render.sync.builder.ad.instantiation -->
  */
 @ServiceClientBuilder(serviceClients = { MapsRenderClient.class, MapsRenderAsyncClient.class })
-public final class MapsRenderClientBuilder implements AzureKeyCredentialTrait<MapsRenderClientBuilder>,
+public final class MapsRenderClientBuilder
+    implements AzureKeyCredentialTrait<MapsRenderClientBuilder>, AzureSasCredentialTrait<MapsRenderClientBuilder>,
     TokenCredentialTrait<MapsRenderClientBuilder>, HttpTrait<MapsRenderClientBuilder>,
     ConfigurationTrait<MapsRenderClientBuilder>, EndpointTrait<MapsRenderClientBuilder> {
 
@@ -142,6 +146,7 @@ public MapsRenderClientBuilder() {
     // credentials
     private AzureKeyCredential keyCredential;
     private TokenCredential tokenCredential;
+    private AzureSasCredential sasCredential;
 
     /**
      * Sets the Azure Maps client id for use with Azure AD Authentication. This client id
@@ -297,6 +302,19 @@ public MapsRenderClientBuilder credential(AzureKeyCredential keyCredential) {
         return this;
     }
 
+    /**
+     * Sets the {@link AzureSasCredential} used to authenticate HTTP requests.
+     *
+     * @param sasCredential The {@link AzureSasCredential} used to authenticate HTTP requests.
+     * @return The updated {@link MapsRenderClientBuilder} object.
+     * @throws NullPointerException If {@code sasCredential} is null.
+     */
+    @Override
+    public MapsRenderClientBuilder credential(AzureSasCredential sasCredential) {
+        this.sasCredential = Objects.requireNonNull(sasCredential, "'sasCredential' cannot be null.");
+        return this;
+    }
+
     /**
      * Builds an instance of RenderClientImpl with the provided parameters.
      *
@@ -361,6 +379,8 @@ private HttpPipeline createHttpPipeline() {
             policies.add(new BearerTokenAuthenticationPolicy(tokenCredential, DEFAULT_SCOPES));
         } else if (keyCredential != null) {
             policies.add(new AzureKeyCredentialPolicy(RENDER_SUBSCRIPTION_KEY, keyCredential));
+        } else if (sasCredential != null) {
+            policies.add(new AzureSasCredentialPolicy(sasCredential));
         } else {
             // Throw exception that credential and tokenCredential cannot be null
             throw LOGGER.logExceptionAsError(

sdk/maps/azure-maps-route/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release History
 
+## 1.0.0-beta.3 (Unreleased)
+
+### Features added
+
+- Integrated support for SAS-based authentication
+
 ## 1.0.0-beta.2 (2024-11-08)
 
 ### Other Changes

sdk/maps/azure-maps-route/src/main/java/com/azure/maps/route/MapsRouteClientBuilder.java

@@ -9,7 +9,9 @@
 import com.azure.core.client.traits.EndpointTrait;
 import com.azure.core.client.traits.HttpTrait;
 import com.azure.core.client.traits.TokenCredentialTrait;
+import com.azure.core.client.traits.AzureSasCredentialTrait;
 import com.azure.core.credential.AzureKeyCredential;
+import com.azure.core.credential.AzureSasCredential;
 import com.azure.core.credential.TokenCredential;
 import com.azure.core.http.HttpClient;
 import com.azure.core.http.HttpHeaderName;
@@ -27,6 +29,7 @@
 import com.azure.core.http.policy.RetryOptions;
 import com.azure.core.http.policy.RetryPolicy;
 import com.azure.core.http.policy.UserAgentPolicy;
+import com.azure.core.http.policy.AzureSasCredentialPolicy;
 import com.azure.core.util.ClientOptions;
 import com.azure.core.util.Configuration;
 import com.azure.core.util.CoreUtils;
@@ -76,7 +79,8 @@
  * <!-- end com.azure.maps.route.sync.builder.ad.instantiation -->
  */
 @ServiceClientBuilder(serviceClients = { MapsRouteClient.class, MapsRouteAsyncClient.class })
-public final class MapsRouteClientBuilder implements AzureKeyCredentialTrait<MapsRouteClientBuilder>,
+public final class MapsRouteClientBuilder
+    implements AzureKeyCredentialTrait<MapsRouteClientBuilder>, AzureSasCredentialTrait<MapsRouteClientBuilder>,
     TokenCredentialTrait<MapsRouteClientBuilder>, HttpTrait<MapsRouteClientBuilder>,
     ConfigurationTrait<MapsRouteClientBuilder>, EndpointTrait<MapsRouteClientBuilder> {
 
@@ -109,6 +113,7 @@ public final class MapsRouteClientBuilder implements AzureKeyCredentialTrait<Map
     // credentials
     private AzureKeyCredential keyCredential;
     private TokenCredential tokenCredential;
+    private AzureSasCredential sasCredential;
 
     /**
      * Default constructor for the builder class.
@@ -276,6 +281,19 @@ public MapsRouteClientBuilder credential(AzureKeyCredential keyCredential) {
         return this;
     }
 
+    /**
+     * Sets the {@link AzureSasCredential} used to authenticate HTTP requests.
+     *
+     * @param sasCredential The {@link AzureSasCredential} used to authenticate HTTP requests.
+     * @return The updated {@link MapsRouteClientBuilder} object.
+     * @throws NullPointerException If {@code sasCredential} is null.
+     */
+    @Override
+    public MapsRouteClientBuilder credential(AzureSasCredential sasCredential) {
+        this.sasCredential = Objects.requireNonNull(sasCredential, "'sasCredential' cannot be null.");
+        return this;
+    }
+
     /**
      * Sets retry options
      *
@@ -353,6 +371,8 @@ private HttpPipeline createHttpPipeline() {
             policies.add(new BearerTokenAuthenticationPolicy(tokenCredential, DEFAULT_SCOPES));
         } else if (keyCredential != null) {
             policies.add(new AzureKeyCredentialPolicy(MAPS_SUBSCRIPTION_KEY, keyCredential));
+        } else if (sasCredential != null) {
+            policies.add(new AzureSasCredentialPolicy(sasCredential));
         } else {
             // Throw exception that credential and tokenCredential cannot be null
             throw LOGGER.logExceptionAsError(

sdk/maps/azure-maps-search/CHANGELOG.md

@@ -1,6 +1,12 @@
 # Release History
 
-## 2.0.0-beta.1 (2024-12-19)
+## 2.0.0-beta.2 (Unreleased)
+
+### Features added
+
+- Integrated support for SAS-based authentication
+
+## 2.0.0-beta.1 (2024-12-17)
 
 ### Features Added
 

sdk/maps/azure-maps-search/src/main/java/com/azure/maps/search/MapsSearchClientBuilder.java

@@ -9,7 +9,9 @@
 import com.azure.core.client.traits.EndpointTrait;
 import com.azure.core.client.traits.HttpTrait;
 import com.azure.core.client.traits.TokenCredentialTrait;
+import com.azure.core.client.traits.AzureSasCredentialTrait;
 import com.azure.core.credential.AzureKeyCredential;
+import com.azure.core.credential.AzureSasCredential;
 import com.azure.core.credential.TokenCredential;
 import com.azure.core.http.HttpClient;
 import com.azure.core.http.HttpHeaderName;
@@ -27,6 +29,7 @@
 import com.azure.core.http.policy.RetryOptions;
 import com.azure.core.http.policy.RetryPolicy;
 import com.azure.core.http.policy.UserAgentPolicy;
+import com.azure.core.http.policy.AzureSasCredentialPolicy;
 import com.azure.core.util.ClientOptions;
 import com.azure.core.util.Configuration;
 import com.azure.core.util.CoreUtils;
@@ -60,7 +63,8 @@
  * <!-- end com.azure.maps.search.sync.builder.ad.instantiation -->
  */
 @ServiceClientBuilder(serviceClients = { MapsSearchClient.class, MapsSearchAsyncClient.class })
-public final class MapsSearchClientBuilder implements AzureKeyCredentialTrait<MapsSearchClientBuilder>,
+public final class MapsSearchClientBuilder
+    implements AzureKeyCredentialTrait<MapsSearchClientBuilder>, AzureSasCredentialTrait<MapsSearchClientBuilder>,
     TokenCredentialTrait<MapsSearchClientBuilder>, HttpTrait<MapsSearchClientBuilder>,
     ConfigurationTrait<MapsSearchClientBuilder>, EndpointTrait<MapsSearchClientBuilder> {
 
@@ -94,6 +98,7 @@ public final class MapsSearchClientBuilder implements AzureKeyCredentialTrait<Ma
     // credentials
     private AzureKeyCredential keyCredential;
     private TokenCredential tokenCredential;
+    private AzureSasCredential sasCredential;
 
     /**
      * Default constructor for the builder class.
@@ -262,6 +267,19 @@ public MapsSearchClientBuilder credential(AzureKeyCredential keyCredential) {
         return this;
     }
 
+    /**
+     * Sets the {@link AzureSasCredential} used to authenticate HTTP requests.
+     *
+     * @param sasCredential The {@link AzureSasCredential} used to authenticate HTTP requests.
+     * @return The updated {@link MapsSearchClientBuilder} object.
+     * @throws NullPointerException If {@code sasCredential} is null.
+     */
+    @Override
+    public MapsSearchClientBuilder credential(AzureSasCredential sasCredential) {
+        this.sasCredential = Objects.requireNonNull(sasCredential, "'sasCredential' cannot be null.");
+        return this;
+    }
+
     /**
      * Sets retry options
      * @param retryOptions the retry options for the client
@@ -338,6 +356,8 @@ private HttpPipeline createHttpPipeline() {
             policies.add(new BearerTokenAuthenticationPolicy(tokenCredential, DEFAULT_SCOPES));
         } else if (keyCredential != null) {
             policies.add(new AzureKeyCredentialPolicy(MAPS_SUBSCRIPTION_KEY, keyCredential));
+        } else if (sasCredential != null) {
+            policies.add(new AzureSasCredentialPolicy(sasCredential));
         } else {
             // Throw exception that credential and tokenCredential cannot be null
             throw LOGGER.logExceptionAsError(

sdk/maps/azure-maps-timezone/CHANGELOG.md

@@ -4,6 +4,8 @@
 
 ### Features Added
 
+- Integrated support for SAS-based authentication
+
 ### Breaking Changes
 
 ### Bugs Fixed

sdk/maps/azure-maps-timezone/src/main/java/com/azure/maps/timezone/TimeZoneClientBuilder.java

@@ -10,7 +10,9 @@
 import com.azure.core.client.traits.EndpointTrait;
 import com.azure.core.client.traits.HttpTrait;
 import com.azure.core.client.traits.TokenCredentialTrait;
+import com.azure.core.client.traits.AzureSasCredentialTrait;
 import com.azure.core.credential.AzureKeyCredential;
+import com.azure.core.credential.AzureSasCredential;
 import com.azure.core.credential.TokenCredential;
 import com.azure.core.http.HttpClient;
 import com.azure.core.http.HttpHeaderName;
@@ -28,6 +30,7 @@
 import com.azure.core.http.policy.RetryOptions;
 import com.azure.core.http.policy.RetryPolicy;
 import com.azure.core.http.policy.UserAgentPolicy;
+import com.azure.core.http.policy.AzureSasCredentialPolicy;
 import com.azure.core.util.ClientOptions;
 import com.azure.core.util.Configuration;
 import com.azure.core.util.CoreUtils;
@@ -51,16 +54,16 @@
  * AzureKeyCredential keyCredential = new AzureKeyCredential(System.getenv("SUBSCRIPTION_KEY"));
  *
  * // Creates a client
- * TimeZoneClient client = new TimeZoneClientBuilder() 
+ * TimeZoneClient client = new TimeZoneClientBuilder()
  *     .credential(keyCredential)
  *     .timezoneClientId(System.getenv("MAPS_CLIENT_ID"))
  *     .buildClient();
  * </pre>
  * <!-- end com.azure.maps.timezone.sync.builder.ad.instantiation -->
  */
 @ServiceClientBuilder(serviceClients = { TimeZoneClient.class, TimeZoneAsyncClient.class })
-public final class TimeZoneClientBuilder
-    implements AzureKeyCredentialTrait<TimeZoneClientBuilder>, TokenCredentialTrait<TimeZoneClientBuilder>,
+public final class TimeZoneClientBuilder implements AzureKeyCredentialTrait<TimeZoneClientBuilder>,
+    AzureSasCredentialTrait<TimeZoneClientBuilder>, TokenCredentialTrait<TimeZoneClientBuilder>,
     HttpTrait<TimeZoneClientBuilder>, ConfigurationTrait<TimeZoneClientBuilder>, EndpointTrait<TimeZoneClientBuilder> {
 
     // constants
@@ -105,6 +108,7 @@ public final class TimeZoneClientBuilder
     // credentials
     private AzureKeyCredential keyCredential;
     private TokenCredential tokenCredential;
+    private AzureSasCredential sasCredential;
 
     /** Default constructor for the builder class; Create an instance of the TimeZoneClientBuilder. */
     public TimeZoneClientBuilder() {
@@ -269,6 +273,19 @@ public TimeZoneClientBuilder credential(AzureKeyCredential keyCredential) {
         return this;
     }
 
+    /**
+     * Sets the {@link AzureSasCredential} used to authenticate HTTP requests.
+     *
+     * @param sasCredential The {@link AzureSasCredential} used to authenticate HTTP requests.
+     * @return The updated {@link TimeZoneClientBuilder} object.
+     * @throws NullPointerException If {@code sasCredential} is null.
+     */
+    @Override
+    public TimeZoneClientBuilder credential(AzureSasCredential sasCredential) {
+        this.sasCredential = Objects.requireNonNull(sasCredential, "'sasCredential' cannot be null.");
+        return this;
+    }
+
     /**
      * Sets retry options
      * @param retryOptions the retry options for the client
@@ -345,6 +362,8 @@ private HttpPipeline createHttpPipeline() {
             policies.add(new BearerTokenAuthenticationPolicy(tokenCredential, DEFAULT_SCOPES));
         } else if (keyCredential != null) {
             policies.add(new AzureKeyCredentialPolicy(MAPS_SUBSCRIPTION_KEY, keyCredential));
+        } else if (sasCredential != null) {
+            policies.add(new AzureSasCredentialPolicy(sasCredential));
         } else {
             // Throw exception that credential and tokenCredential cannot be null
             throw LOGGER.logExceptionAsError(