Enable AAD access for Question Answering Service (Azure#29665)

* Enable AAD access for QuestionAnswering

* Enable AAD access for QuestionAnsweringProjectsClient

* Update Tests

* Add Audience property to support multiple clouds

* Update AAD tests

* Fix for AAD QuestionAnsweringClient

* Fix for AAD QuestionAnsweringClient

* Update Live Test Session Records

* Ignore AAD support tests

Not supported in the PPE environment. Need to switch over to the same static test resources for CLU. See Azure#29958

* Update changelog

Co-authored-by: Heath Stewart <[email protected]>

Author: rokulka

sdk/cognitivelanguage/Azure.AI.Language.QuestionAnswering/CHANGELOG.md

@@ -1,14 +1,10 @@
 # Release History
 
-## 1.1.0-beta.2 (Unreleased)
+## 1.1.0-beta.2 (2022-07-19)
 
 ### Features Added
 
-### Breaking Changes
-
-### Bugs Fixed
-
-### Other Changes
+- Added support for Azure Active Directory (AAD) authentication.
 
 ## 1.1.0-beta.1 (2022-02-08)
 

sdk/cognitivelanguage/Azure.AI.Language.QuestionAnswering/src/QuestionAnsweringAudience.cs

@@ -0,0 +1,59 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System;
+using System.ComponentModel;
+using Azure.Core;
+
+namespace Azure.AI.Language.QuestionAnswering
+{
+    /// <summary> Cloud audiences available for QuestionAnswering. </summary>
+    public readonly partial struct QuestionAnsweringAudience : IEquatable<QuestionAnsweringAudience>
+    {
+        private readonly string _value;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="QuestionAnsweringAudience"/> object.
+        /// </summary>
+        /// <param name="value">The Azure Active Directory audience to use when forming authorization scopes.For the Language service, this value corresponds to a URL that identifies the Azure cloud where the resource is located. For more information: <see href="https://docs.microsoft.com/azure/azure-government/documentation-government-cognitiveservices" />.</param>
+        /// <exception cref="ArgumentNullException"> <paramref name="value"/> is null. </exception>
+        /// <remarks>Please use one of the constant members over creating a custom value unless you have special needs for doing so.</remarks>
+        public QuestionAnsweringAudience(string value)
+        {
+            Argument.AssertNotNullOrEmpty(value, nameof(value));
+            _value = value;
+        }
+
+        private const string AzureChinaValue = "https://cognitiveservices.azure.cn";
+        private const string AzureGovernmentValue = "https://cognitiveservices.azure.us";
+        private const string AzurePublicCloudValue = "https://cognitiveservices.azure.com";
+
+        /// <summary> Azure China. </summary>
+        public static QuestionAnsweringAudience AzureChina { get; } = new QuestionAnsweringAudience(AzureChinaValue);
+
+        /// <summary> Azure Government. </summary>
+        public static QuestionAnsweringAudience AzureGovernment { get; } = new QuestionAnsweringAudience(AzureGovernmentValue);
+
+        /// <summary> Azure Public Cloud. </summary>
+        public static QuestionAnsweringAudience AzurePublicCloud { get; } = new QuestionAnsweringAudience(AzurePublicCloudValue);
+
+        /// <summary> Determines if two <see cref="QuestionAnsweringAudience"/> values are the same. </summary>
+        public static bool operator ==(QuestionAnsweringAudience left, QuestionAnsweringAudience right) => left.Equals(right);
+        /// <summary> Determines if two <see cref="QuestionAnsweringAudience"/> values are not the same. </summary>
+        public static bool operator !=(QuestionAnsweringAudience left, QuestionAnsweringAudience right) => !left.Equals(right);
+        /// <summary> Converts a string to a <see cref="QuestionAnsweringAudience"/>. </summary>
+        public static implicit operator QuestionAnsweringAudience(string value) => new QuestionAnsweringAudience(value);
+
+        /// <inheritdoc />
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public override bool Equals(object obj) => obj is QuestionAnsweringAudience other && Equals(other);
+        /// <inheritdoc />
+        public bool Equals(QuestionAnsweringAudience other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase);
+
+        /// <inheritdoc />
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public override int GetHashCode() => _value?.GetHashCode() ?? 0;
+        /// <inheritdoc />
+        public override string ToString() => _value;
+    }
+}

sdk/cognitivelanguage/Azure.AI.Language.QuestionAnswering/src/QuestionAnsweringClient.cs

@@ -52,6 +52,34 @@ public QuestionAnsweringClient(Uri endpoint, AzureKeyCredential credential, Ques
             _restClient = new(Diagnostics, Pipeline, Endpoint, Options.Version);
         }
 
+        /// <summary> Initializes a new instance of QuestionAnsweringClient. </summary>
+        /// <param name="endpoint"> Supported Cognitive Services endpoint (e.g., https://&lt;resource-name&gt;.cognitiveservices.azure.com). </param>
+        /// <param name="credential"> A credential used to authenticate to an Azure Service. </param>
+        /// <exception cref="ArgumentNullException"> <paramref name="endpoint"/> or <paramref name="credential"/> is null. </exception>
+        public QuestionAnsweringClient(Uri endpoint, TokenCredential credential) : this(endpoint, credential, new QuestionAnsweringClientOptions())
+        {
+        }
+
+        /// <summary> Initializes a new instance of QuestionAnsweringClient. </summary>
+        /// <param name="endpoint"> Supported Cognitive Services endpoint (e.g., https://&lt;resource-name&gt;.cognitiveservices.azure.com). </param>
+        /// <param name="credential"> A credential used to authenticate to an Azure Service. </param>
+        /// <param name="options"> The options for configuring the client. </param>
+        /// <exception cref="ArgumentNullException"> <paramref name="endpoint"/> or <paramref name="credential"/> is null. </exception>
+        public QuestionAnsweringClient(Uri endpoint, TokenCredential credential, QuestionAnsweringClientOptions options)
+        {
+            Argument.AssertNotNull(endpoint, nameof(endpoint));
+            Argument.AssertNotNull(credential, nameof(credential));
+            Options = options ?? new QuestionAnsweringClientOptions();
+
+            var authorizationScope = $"{(string.IsNullOrEmpty(Options.Audience?.ToString()) ? QuestionAnsweringAudience.AzurePublicCloud : Options.Audience)}/.default";
+
+            Diagnostics = new ClientDiagnostics(Options, true);
+            Pipeline = HttpPipelineBuilder.Build(Options, new HttpPipelinePolicy[] { new BearerTokenAuthenticationPolicy(credential, authorizationScope) }, Array.Empty<HttpPipelinePolicy>(), new ResponseClassifier());
+            Endpoint = endpoint;
+
+            _restClient = new(Diagnostics, Pipeline, Endpoint, Options.Version);
+        }
+
         /// <summary>
         /// Protected constructor to allow mocking.
         /// </summary>

sdk/cognitivelanguage/Azure.AI.Language.QuestionAnswering/src/QuestionAnsweringClientOptions.cs

@@ -43,6 +43,12 @@ public enum ServiceVersion
 
         internal string Version { get; }
 
+        /// <summary>
+        /// Gets or sets the Audience to use for authentication with Azure Active Directory (AAD). The audience is not considered when using a shared key.
+        /// </summary>
+        /// <value>If <c>null</c>, <see cref="QuestionAnsweringAudience.AzurePublicCloud" /> will be assumed.</value>
+        public QuestionAnsweringAudience? Audience { get; set; }
+
         /// <summary>
         /// Initializes new instance of QuestionAnsweringClientOptions.
         /// </summary>

sdk/cognitivelanguage/Azure.AI.Language.QuestionAnswering/src/QuestionAnsweringProjectsClient.cs

@@ -5,12 +5,39 @@
 using System.Collections.Generic;
 using System.Text;
 using Azure.Core;
+using Azure.Core.Pipeline;
 
 namespace Azure.AI.Language.QuestionAnswering.Projects
 {
     /// <summary> The QuestionAnsweringProjects service client. </summary>
     [CodeGenType("QuestionAnsweringProjectsClient")]
     public partial class QuestionAnsweringProjectsClient
     {
+        /// <summary> Initializes a new instance of QuestionAnsweringProjectsClient. </summary>
+        /// <param name="endpoint"> Supported Cognitive Services endpoint (e.g., https://&lt;resource-name&gt;.cognitiveservices.azure.com). </param>
+        /// <param name="credential"> A credential used to authenticate to an Azure Service. </param>
+        /// <exception cref="ArgumentNullException"> <paramref name="endpoint"/> or <paramref name="credential"/> is null. </exception>
+        public QuestionAnsweringProjectsClient(Uri endpoint, TokenCredential credential) : this(endpoint, credential, new QuestionAnsweringClientOptions())
+        {
+        }
+
+        /// <summary> Initializes a new instance of QuestionAnsweringProjectsClient. </summary>
+        /// <param name="endpoint"> Supported Cognitive Services endpoint (e.g., https://&lt;resource-name&gt;.cognitiveservices.azure.com). </param>
+        /// <param name="credential"> A credential used to authenticate to an Azure Service. </param>
+        /// <param name="options"> The options for configuring the client. </param>
+        /// <exception cref="ArgumentNullException"> <paramref name="endpoint"/> or <paramref name="credential"/> is null. </exception>
+        public QuestionAnsweringProjectsClient(Uri endpoint, TokenCredential credential, QuestionAnsweringClientOptions options)
+        {
+            Argument.AssertNotNull(endpoint, nameof(endpoint));
+            Argument.AssertNotNull(credential, nameof(credential));
+            options ??= new QuestionAnsweringClientOptions();
+
+            var authorizationScope = $"{(string.IsNullOrEmpty(options.Audience?.ToString()) ? QuestionAnsweringAudience.AzurePublicCloud : options.Audience)}/.default";
+
+            ClientDiagnostics = new ClientDiagnostics(options, true);
+            _pipeline = HttpPipelineBuilder.Build(options, new HttpPipelinePolicy[] { new BearerTokenAuthenticationPolicy(credential, authorizationScope) }, Array.Empty<HttpPipelinePolicy>(), new ResponseClassifier());
+            _endpoint = endpoint;
+            _apiVersion = options.Version;
+        }
     }
 }

sdk/cognitivelanguage/Azure.AI.Language.QuestionAnswering/tests/QuestionAnsweringClientLiveTests.cs

@@ -16,6 +16,38 @@ public QuestionAnsweringClientLiveTests(bool isAsync, QuestionAnsweringClientOpt
         {
         }
 
+        [RecordedTest]
+        [Ignore("https://github.com/Azure/azure-sdk-for-net/issues/29958")]
+        public async Task SupportsAadAuthentication()
+        {
+            QuestionAnsweringClientOptions clientOptions = new QuestionAnsweringClientOptions()
+            {
+                DefaultLanguage = "en",
+            };
+
+            QuestionAnsweringClient client = CreateClient<QuestionAnsweringClient>(
+                TestEnvironment.Endpoint,
+                TestEnvironment.Credential,
+                InstrumentClientOptions(clientOptions));
+
+            Response<AnswersFromTextResult> response = await client.GetAnswersFromTextAsync(
+                "How long it takes to charge surface?",
+                new[]
+                {
+                    "Power and charging. It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. " +
+                    "It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.",
+
+                    "You can use the USB port on your Surface Pro 4 power supply to charge other devices, like a phone, while your Surface charges. " +
+                    "The USB port on the power supply is only for charging, not for data transfer. If you want to use a USB device, plug it into the USB port on your Surface.",
+                });
+
+            Assert.That(response.Value.Answers.Count, Is.EqualTo(3));
+
+            IList<TextAnswer> answers = response.Value.Answers.Where(answer => answer.Confidence > 0.9).ToList();
+            Assert.That(answers, Has.Count.AtLeast(2));
+            Assert.That(answers, Has.All.Matches<TextAnswer>(answer => answer.Id == "1" && answer.ShortAnswer.Text?.Trim() == "two to four hours"));
+        }
+
         [RecordedTest]
         public async Task AnswersKnowledgeBaseQuestion()
         {

sdk/cognitivelanguage/Azure.AI.Language.QuestionAnswering/tests/QuestionAnsweringClientTests.cs

@@ -2,6 +2,7 @@
 // Licensed under the MIT License.
 
 using System;
+using Azure.Core;
 using NUnit.Framework;
 
 namespace Azure.AI.Language.QuestionAnswering.Tests
@@ -16,7 +17,7 @@ public class QuestionAnsweringClientTests
         public void QuestionAnswerClientEndpointNull()
         {
             ArgumentException ex = Assert.Throws<ArgumentNullException>(
-                () => new QuestionAnsweringClient(null, null));
+                () => new QuestionAnsweringClient(null, (AzureKeyCredential)null));
             Assert.AreEqual("endpoint", ex.ParamName);
         }
 
@@ -26,7 +27,25 @@ public void QuestionAnsweringClientCredentialNull()
             Uri endpoint = new Uri("https://test.api.cognitive.microsoft.com", UriKind.Absolute);
 
             ArgumentException ex = Assert.Throws<ArgumentNullException>(
-                () => new QuestionAnsweringClient(endpoint, null));
+                () => new QuestionAnsweringClient(endpoint, (AzureKeyCredential)null));
+            Assert.AreEqual("credential", ex.ParamName);
+        }
+
+        [Test]
+        public void QuestionAnsweringClientEndpointNullUsingTokenCredential()
+        {
+            ArgumentNullException ex = Assert.Throws<ArgumentNullException>(
+                () => new QuestionAnsweringClient(null, (TokenCredential)null));
+            Assert.AreEqual("endpoint", ex.ParamName);
+        }
+
+        [Test]
+        public void QuestionAnsweringClientCredentialNullUsingTokenCredential()
+        {
+            Uri endpoint = new("https://test.cognitive.microsoft.com", UriKind.Absolute);
+
+            ArgumentNullException ex = Assert.Throws<ArgumentNullException>(
+                () => new QuestionAnsweringClient(endpoint, (TokenCredential)null));
             Assert.AreEqual("credential", ex.ParamName);
         }
 

sdk/cognitivelanguage/Azure.AI.Language.QuestionAnswering/tests/QuestionAnsweringProjectsClientLiveTests.cs

@@ -21,6 +21,40 @@ public QuestionAnsweringProjectsClientLiveTests(bool isAsync, QuestionAnsweringC
         {
         }
 
+        [RecordedTest]
+        [Ignore("https://github.com/Azure/azure-sdk-for-net/issues/29958")]
+        public async Task SupportsAadAuthentication()
+        {
+            QuestionAnsweringProjectsClient client = CreateClient<QuestionAnsweringProjectsClient>(
+               TestEnvironment.Endpoint,
+               TestEnvironment.Credential,
+               InstrumentClientOptions(
+                    new QuestionAnsweringClientOptions()));
+
+            string testProjectName = CreateTestProjectName();
+
+            RequestContent creationRequestContent = RequestContent.Create(
+                new
+                {
+                    description = "This is the description for a test project",
+                    language = "en",
+                    multilingualResource = false,
+                    settings = new
+                    {
+                        defaultAnswer = "No answer found for your question."
+                    }
+                }
+                );
+
+            Response createProjectResponse = await client.CreateProjectAsync(testProjectName, creationRequestContent);
+            Response projectDetailsResponse = await client.GetProjectDetailsAsync(testProjectName);
+
+            Assert.AreEqual(201, createProjectResponse.Status);
+            Assert.AreEqual(200, projectDetailsResponse.Status);
+
+            await client.DeleteProjectAsync(WaitUntil.Completed, testProjectName);
+        }
+
         [RecordedTest]
         public async Task CreateProject()
         {

sdk/cognitivelanguage/Azure.AI.Language.QuestionAnswering/tests/QuestionAnsweringProjectsClientTests.cs

@@ -5,6 +5,7 @@
 using NUnit.Framework;
 using Azure.AI.Language.QuestionAnswering.Projects;
 using Azure.Core.TestFramework;
+using Azure.Core;
 
 namespace Azure.AI.Language.QuestionAnswering.Tests
 {
@@ -22,7 +23,7 @@ public class QuestionAnsweringProjectsClientTests
         public void QuestionAnswerProjectsClientEndpointNull()
         {
             ArgumentException ex = Assert.Throws<ArgumentNullException>(
-                () => new QuestionAnsweringProjectsClient(null, null));
+                () => new QuestionAnsweringProjectsClient(null, (AzureKeyCredential)null));
             Assert.AreEqual("endpoint", ex.ParamName);
         }
 
@@ -32,7 +33,25 @@ public void QuestionAnsweringProjectsClientCredentialNull()
             Uri endpoint = new Uri("https://test.api.cognitive.microsoft.com", UriKind.Absolute);
 
             ArgumentException ex = Assert.Throws<ArgumentNullException>(
-                () => new QuestionAnsweringProjectsClient(endpoint, null));
+                () => new QuestionAnsweringProjectsClient(endpoint, (AzureKeyCredential)null));
+            Assert.AreEqual("credential", ex.ParamName);
+        }
+
+        [Test]
+        public void QuestionAnsweringProjectsClientEndpointNullUsingTokenCredential()
+        {
+            ArgumentNullException ex = Assert.Throws<ArgumentNullException>(
+                () => new QuestionAnsweringClient(null, (TokenCredential)null));
+            Assert.AreEqual("endpoint", ex.ParamName);
+        }
+
+        [Test]
+        public void QuestionAnsweringProjectsClientCredentialNullUsingTokenCredential()
+        {
+            Uri endpoint = new("https://test.cognitive.microsoft.com", UriKind.Absolute);
+
+            ArgumentNullException ex = Assert.Throws<ArgumentNullException>(
+                () => new QuestionAnsweringClient(endpoint, (TokenCredential)null));
             Assert.AreEqual("credential", ex.ParamName);
         }