rename method ExchangeTeamsToken to ExchangeTeamsUserAadToken (#24846)

* rename method ExchangeTeamsToken to ExchangeTeamsUserAadToken * updated documentation * regenerated api * rename parameters and tests * regenerated test recordings * regenerate api
Azure · Oct 21, 2021 · 5a108ba · 5a108ba
1 parent f6cc06f
commit 5a108ba
Show file tree

Hide file tree

Showing 66 changed files with 658 additions and 1,730 deletions.
diff --git a/sdk/communication/Azure.Communication.Identity/README.md b/sdk/communication/Azure.Communication.Identity/README.md
@@ -117,7 +117,7 @@ Response deleteResponse = client.DeleteUser(user);
 ### Exchanging AAD access token of a Teams User for a Communication Identity access token
 
 ```C# Snippet:ExchangeTeamsTokenAsync
-Response<AccessToken> tokenResponse = await client.ExchangeTeamsTokenAsync(teamsToken);
+Response<AccessToken> tokenResponse = await client.ExchangeTeamsUserAadTokenAsync(teamsToken);
 string token = tokenResponse.Value.Token;
 Console.WriteLine($"Token: {token}");
 ```

diff --git a/...unication/Azure.Communication.Identity/api/Azure.Communication.Identity.netstandard2.0.cs b/...unication/Azure.Communication.Identity/api/Azure.Communication.Identity.netstandard2.0.cs
@@ -13,8 +13,8 @@ public CommunicationIdentityClient(System.Uri endpoint, Azure.Core.TokenCredenti
         public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Communication.CommunicationUserIdentifier>> CreateUserAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public virtual Azure.Response DeleteUser(Azure.Communication.CommunicationUserIdentifier communicationUser, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public virtual System.Threading.Tasks.Task<Azure.Response> DeleteUserAsync(Azure.Communication.CommunicationUserIdentifier communicationUser, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        public virtual Azure.Response<Azure.Core.AccessToken> ExchangeTeamsToken(string teamsToken, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Core.AccessToken>> ExchangeTeamsTokenAsync(string teamsToken, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual Azure.Response<Azure.Core.AccessToken> ExchangeTeamsUserAadToken(string teamsUserAadToken, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
+        public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Core.AccessToken>> ExchangeTeamsUserAadTokenAsync(string teamsUserAadToken, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public virtual Azure.Response<Azure.Core.AccessToken> GetToken(Azure.Communication.CommunicationUserIdentifier communicationUser, System.Collections.Generic.IEnumerable<Azure.Communication.Identity.CommunicationTokenScope> scopes, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Core.AccessToken>> GetTokenAsync(Azure.Communication.CommunicationUserIdentifier communicationUser, System.Collections.Generic.IEnumerable<Azure.Communication.Identity.CommunicationTokenScope> scopes, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
         public virtual Azure.Response RevokeTokens(Azure.Communication.CommunicationUserIdentifier communicationUser, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }

diff --git a/...ion/Azure.Communication.Identity/samples/Sample1_CommunicationIdentityClient.md b/...ion/Azure.Communication.Identity/samples/Sample1_CommunicationIdentityClient.md
@@ -68,7 +68,7 @@ Console.WriteLine($"Expires On: {expiresOn}");
 The `CommunicationIdentityClient` can be used to exchange an AAD access token of a Teams user for a new Communication Identity access token with a matching expiration time.
 
 ```C# Snippet:ExchangeTeamsToken
-Response<AccessToken> tokenResponse = client.ExchangeTeamsToken(teamsToken);
+Response<AccessToken> tokenResponse = client.ExchangeTeamsUserAadToken(teamsToken);
 string token = tokenResponse.Value.Token;
 Console.WriteLine($"Token: {token}");
 ```

diff --git a/...zure.Communication.Identity/samples/Sample1_CommunicationIdentityClientAsync.md b/...zure.Communication.Identity/samples/Sample1_CommunicationIdentityClientAsync.md
@@ -70,7 +70,7 @@ Console.WriteLine($"Expires On: {expiresOn}");
 The `CommunicationIdentityClient` can be used to exchange an AAD access token of a Teams user for a new Communication Identity access token with a matching expiration time.
 
 ```C# Snippet:ExchangeTeamsTokenAsync
-Response<AccessToken> tokenResponse = await client.ExchangeTeamsTokenAsync(teamsToken);
+Response<AccessToken> tokenResponse = await client.ExchangeTeamsUserAadTokenAsync(teamsToken);
 string token = tokenResponse.Value.Token;
 Console.WriteLine($"Token: {token}");
 ```

diff --git a/sdk/communication/Azure.Communication.Identity/src/CommunicationIdentityClient.cs b/sdk/communication/Azure.Communication.Identity/src/CommunicationIdentityClient.cs
@@ -282,16 +282,16 @@ public virtual async Task<Response> RevokeTokensAsync(CommunicationUserIdentifie
         }
 
         /// <summary>Exchange an AAD access token of a Teams User for a Communication Identity access token.</summary>
-        /// <param name="teamsToken">AAD access token of a Teams User to acquire a new Communication Identity access token.</param>
+        /// <param name="teamsUserAadToken">AAD access token of a Teams User to acquire a new Communication Identity access token.</param>
         /// <param name="cancellationToken">The cancellation token to use.</param>
         /// <exception cref="RequestFailedException">The server returned an error.</exception>
-        public virtual Response<AccessToken> ExchangeTeamsToken(string teamsToken, CancellationToken cancellationToken = default)
+        public virtual Response<AccessToken> ExchangeTeamsUserAadToken(string teamsUserAadToken, CancellationToken cancellationToken = default)
         {
-            using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(CommunicationIdentityClient)}.{nameof(ExchangeTeamsToken)}");
+            using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(CommunicationIdentityClient)}.{nameof(ExchangeTeamsUserAadToken)}");
             scope.Start();
             try
             {
-                Response<CommunicationIdentityAccessToken> response = RestClient.ExchangeTeamsUserAccessToken(teamsToken, cancellationToken);
+                Response<CommunicationIdentityAccessToken> response = RestClient.ExchangeTeamsUserAccessToken(teamsUserAadToken, cancellationToken);
                 return Response.FromValue(new AccessToken(response.Value.Token, response.Value.ExpiresOn), response.GetRawResponse());
             }
             catch (Exception ex)
@@ -302,15 +302,15 @@ public virtual Response<AccessToken> ExchangeTeamsToken(string teamsToken, Cance
         }
 
         /// <summary>Asynchronously exchange an AAD access token of a Teams User for a Communication Identity access token.</summary>
-        /// <param name="teamsToken">AAD access token of a Teams User to acquire a new Communication Identity access token.</param>
+        /// <param name="teamsUserAadToken">AAD access token of a Teams User to acquire a new Communication Identity access token.</param>
         /// <param name="cancellationToken">The cancellation token to use.</param>
-        public virtual async Task<Response<AccessToken>> ExchangeTeamsTokenAsync(String teamsToken, CancellationToken cancellationToken = default)
+        public virtual async Task<Response<AccessToken>> ExchangeTeamsUserAadTokenAsync(String teamsUserAadToken, CancellationToken cancellationToken = default)
         {
-            using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(CommunicationIdentityClient)}.{nameof(ExchangeTeamsToken)}");
+            using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(CommunicationIdentityClient)}.{nameof(ExchangeTeamsUserAadToken)}");
             scope.Start();
             try
             {
-                Response<CommunicationIdentityAccessToken> response = await RestClient.ExchangeTeamsUserAccessTokenAsync(teamsToken, cancellationToken).ConfigureAwait(false);
+                Response<CommunicationIdentityAccessToken> response = await RestClient.ExchangeTeamsUserAccessTokenAsync(teamsUserAadToken, cancellationToken).ConfigureAwait(false);
                 return Response.FromValue(new AccessToken(response.Value.Token, response.Value.ExpiresOn), response.GetRawResponse());
             }
             catch (Exception ex)

diff --git a/...cation.Identity/tests/CommunicationIdentityClient/CommunicationIdentityClientLiveTests.cs b/...cation.Identity/tests/CommunicationIdentityClient/CommunicationIdentityClientLiveTests.cs
@@ -131,7 +131,7 @@ public async Task RevokeTokenWithNullUserShouldThrow()
         }
 
         [Test]
-        public async Task ExchangeTeamsTokenWithValidToken()
+        public async Task ExchangeTeamsUserAadTokenWithValidToken()
         {
             if (TestEnvironment.ShouldIgnoreIdentityExchangeTokenTest) {
                 Assert.Ignore("Ignore exchange teams token test if flag is enabled.");
@@ -140,18 +140,18 @@ public async Task ExchangeTeamsTokenWithValidToken()
             string token = await generateTeamsToken();
 
             CommunicationIdentityClient client = CreateClientWithConnectionString();
-            Response<AccessToken> tokenResponse = await client.ExchangeTeamsTokenAsync(token);
+            Response<AccessToken> tokenResponse = await client.ExchangeTeamsUserAadTokenAsync(token);
             Assert.IsNotNull(tokenResponse.Value);
             Assert.IsFalse(string.IsNullOrWhiteSpace(tokenResponse.Value.Token));
         }
 
         [Test]
-        public async Task ExchangeTeamsTokenWithEmptyTokenShouldThrow()
+        public async Task ExchangeTeamsUserAadTokenWithEmptyTokenShouldThrow()
         {
             try
             {
                 CommunicationIdentityClient client = CreateClientWithConnectionString();
-                Response<AccessToken> tokenResponse = await client.ExchangeTeamsTokenAsync("");
+                Response<AccessToken> tokenResponse = await client.ExchangeTeamsUserAadTokenAsync("");
             }
             catch (RequestFailedException ex)
             {
@@ -164,12 +164,12 @@ public async Task ExchangeTeamsTokenWithEmptyTokenShouldThrow()
         }
 
         [Test]
-        public async Task ExchangeTeamsTokenWithNullTokenShouldThrow()
+        public async Task ExchangeTeamsUserAadTokenWithNullTokenShouldThrow()
         {
             try
             {
                 CommunicationIdentityClient client = CreateClientWithConnectionString();
-                Response<AccessToken> tokenResponse = await client.ExchangeTeamsTokenAsync(null);
+                Response<AccessToken> tokenResponse = await client.ExchangeTeamsUserAadTokenAsync(null);
             }
             catch (ArgumentNullException ex)
             {
@@ -180,12 +180,12 @@ public async Task ExchangeTeamsTokenWithNullTokenShouldThrow()
         }
 
         [Test]
-        public async Task ExchangeTeamsTokenWithInvalidTokenShouldThrow()
+        public async Task ExchangeTeamsUserAadTokenWithInvalidTokenShouldThrow()
         {
             try
             {
                 CommunicationIdentityClient client = CreateClientWithConnectionString();
-                Response<AccessToken> tokenResponse = await client.ExchangeTeamsTokenAsync("invalid");
+                Response<AccessToken> tokenResponse = await client.ExchangeTeamsUserAadTokenAsync("invalid");
             }
             catch (RequestFailedException ex)
             {
@@ -198,12 +198,12 @@ public async Task ExchangeTeamsTokenWithInvalidTokenShouldThrow()
         }
 
         [Test]
-        public async Task ExchangeTeamsTokenWithExpiredTokenShouldThrow()
+        public async Task ExchangeTeamsUserAadTokenWithExpiredTokenShouldThrow()
         {
             try
             {
                 CommunicationIdentityClient client = CreateClientWithConnectionString();
-                Response<AccessToken> tokenResponse = await client.ExchangeTeamsTokenAsync(TestEnvironment.CommunicationExpiredTeamsToken);
+                Response<AccessToken> tokenResponse = await client.ExchangeTeamsUserAadTokenAsync(TestEnvironment.CommunicationExpiredTeamsToken);
             }
             catch (RequestFailedException ex)
             {

diff --git a/...ords/CommunicationIdentityClientLiveTests/CreateUserAndTokenWithNullScopeShouldThrow.json b/...ords/CommunicationIdentityClientLiveTests/CreateUserAndTokenWithNullScopeShouldThrow.json
diff --git a/...CommunicationIdentityClientLiveTests/CreateUserAndTokenWithNullScopeShouldThrowAsync.json b/...CommunicationIdentityClientLiveTests/CreateUserAndTokenWithNullScopeShouldThrowAsync.json
diff --git a/...essionRecords/CommunicationIdentityClientLiveTests/DeleteUserWithNullUserShouldThrow.json b/...essionRecords/CommunicationIdentityClientLiveTests/DeleteUserWithNullUserShouldThrow.json
diff --git a/...nRecords/CommunicationIdentityClientLiveTests/DeleteUserWithNullUserShouldThrowAsync.json b/...nRecords/CommunicationIdentityClientLiveTests/DeleteUserWithNullUserShouldThrowAsync.json
diff --git a/...s/CommunicationIdentityClientLiveTests/ExchangeTeamsTokenWithExpiredTokenShouldThrow.json b/...s/CommunicationIdentityClientLiveTests/ExchangeTeamsTokenWithExpiredTokenShouldThrow.json
diff --git a/...municationIdentityClientLiveTests/ExchangeTeamsTokenWithInvalidTokenShouldThrowAsync.json b/...municationIdentityClientLiveTests/ExchangeTeamsTokenWithInvalidTokenShouldThrowAsync.json
diff --git a/...okenWithExpiredTokenShouldThrowAsync.json → ...serAadTokenWithEmptyTokenShouldThrow.json b/...okenWithExpiredTokenShouldThrowAsync.json → ...serAadTokenWithEmptyTokenShouldThrow.json