[Text Translation] Change scopes to audiences (#35732)

MikeyMCZ · Michal Materna · annatisch · web-flow · commit ec92c6381df2 · 2024-05-22T13:17:55.000+12:00
* [Text Translation] Change scopes to audiences

* Fixing PR comments

* Fix review feedback

* Fix PR comment

* Update sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_patch.py

Co-authored-by: Anna Tisch &lt;antisch@microsoft.com&gt;

* Fixing PR comments

---------

Co-authored-by: Michal Materna &lt;mimat@microsoft.com&gt;
Co-authored-by: Anna Tisch &lt;antisch@microsoft.com&gt;
diff --git a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_patch.py b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_patch.py
@@ -12,7 +12,8 @@
 from ._client import TextTranslationClient as ServiceClientGenerated
 
 DEFAULT_TOKEN_SCOPE = "https://api.microsofttranslator.com/"
-DEFAULT_ENTRA_ID_SCOPE = "https://cognitiveservices.azure.com/.default"
+DEFAULT_ENTRA_ID_SCOPE = "https://cognitiveservices.azure.com"
+DEFAULT_SCOPE = "/.default"
 
 
 def patch_sdk():
@@ -47,10 +48,20 @@ class TranslatorEntraIdAuthenticationPolicy(BearerTokenCredentialPolicy):
 
     :param credential: Translator Entra Id Credentials used to access Translator Resource for global endpoint.
     :type credential: ~azure.core.credentials.TokenCredential
+    :keyword str region: Used for National Clouds.
+    :keyword str resource_id: Used with both a TokenCredential combined with a region.
+    :keyword str audience: Scopes of the credentials.
     """
 
-    def __init__(self, credential: TokenCredential, resource_id: str, region: str, scopes: str, **kwargs: Any) -> None:
-        super(TranslatorEntraIdAuthenticationPolicy, self).__init__(credential, scopes, **kwargs)
+    def __init__(
+            self,
+            credential: TokenCredential,
+            resource_id: str,
+            region: str,
+            audience: str,
+            **kwargs: Any
+        ) -> None:
+        super(TranslatorEntraIdAuthenticationPolicy, self).__init__(credential, audience, **kwargs)
         self.resource_id = resource_id
         self.region = region
         self.translator_credential = credential
@@ -86,19 +97,21 @@ def set_authentication_policy(credential, kwargs):
     elif hasattr(credential, "get_token"):
         if not kwargs.get("authentication_policy"):
             if kwargs.get("region") and kwargs.get("resource_id"):
+                scope = kwargs.pop("audience", DEFAULT_ENTRA_ID_SCOPE).rstrip("/") + DEFAULT_SCOPE
                 kwargs["authentication_policy"] = TranslatorEntraIdAuthenticationPolicy(
                     credential,
                     kwargs["resource_id"],
                     kwargs["region"],
-                    kwargs.pop("scopes", DEFAULT_ENTRA_ID_SCOPE),
+                    scope,
                 )
             else:
                 if kwargs.get("resource_id") or kwargs.get("region"):
                     raise ValueError(
-                        "Both 'resource_id' and 'region' must be provided with a TokenCredential for authentication."
+                        """Both 'resource_id' and 'region' must be provided with a TokenCredential for
+                         regional resource authentication."""
                     )
                 kwargs["authentication_policy"] = BearerTokenCredentialPolicy(
-                    credential, *kwargs.pop("scopes", [DEFAULT_TOKEN_SCOPE]), kwargs
+                    credential, *[kwargs.pop("audience", DEFAULT_TOKEN_SCOPE)], kwargs
                 )
 
 
@@ -134,15 +147,16 @@ class TextTranslationClient(ServiceClientGenerated):
     None + AzureKeyCredential - used for global translator endpoint with global Translator resource
     None + TokenCredential - general translator endpoint with token authentication
     None + TokenCredential + Region - general translator endpoint with regional Translator resource
+
     :keyword str endpoint: Supported Text Translation endpoints (protocol and hostname, for example:
-    https://api.cognitive.microsofttranslator.com). If not provided, global translator endpoint will be used.
+     https://api.cognitive.microsofttranslator.com). If not provided, global translator endpoint will be used.
     :keyword credential: Credential used to authenticate with the Translator service
     :paramtype credential: Union[AzureKeyCredential, TokenCredential]
     :keyword str region: Used for National Clouds.
     :keyword str resource_id: Used with both a TokenCredential combined with a region.
-    :keyword str scopes: Scopes of the credentials.
+    :keyword str audience: Scopes of the credentials.
     :keyword  str api_version: Default value is "3.0". Note that overriding this default value may
-    result in unsupported behavior.
+     result in unsupported behavior.
     """
 
     @overload
@@ -153,8 +167,8 @@ def __init__(
         region: Optional[str] = None,
         endpoint: Optional[str] = None,
         resource_id: Optional[str] = None,
-        scopes: Optional[str] = None,
-        api_version="3.0",
+        audience: Optional[str] = None,
+        api_version: str = "3.0",
         **kwargs
     ): ...
 
@@ -165,7 +179,7 @@ def __init__(
         credential: AzureKeyCredential,
         region: Optional[str] = None,
         endpoint: Optional[str] = None,
-        api_version="3.0",
+        api_version: str = "3.0",
         **kwargs
     ): ...
 
@@ -174,7 +188,7 @@ def __init__(
         self,
         *,
         endpoint: str,
-        api_version="3.0",
+        api_version: str ="3.0",
         **kwargs
     ): ...
 
diff --git a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/aio/_patch.py b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/aio/_patch.py
@@ -16,6 +16,7 @@
 from .._patch import (
     DEFAULT_TOKEN_SCOPE,
     DEFAULT_ENTRA_ID_SCOPE,
+    DEFAULT_SCOPE,
     get_translation_endpoint,
     TranslatorAuthenticationPolicy,
 )
@@ -40,12 +41,15 @@ class AsyncTranslatorEntraIdAuthenticationPolicy(AsyncBearerTokenCredentialPolic
 
     :param credential: Translator Entra Id Credentials used to access Translator Resource for global endpoint.
     :type credential: ~azure.core.credentials_async.AsyncTokenCredential
+    :keyword str region: Used for National Clouds.
+    :keyword str resource_id: Used with both a TokenCredential combined with a region.
+    :keyword str audience: Scopes of the credentials.
     """
 
     def __init__(
-        self, credential: AsyncTokenCredential, resource_id: str, region: str, scopes: str, **kwargs: Any
+        self, credential: AsyncTokenCredential, resource_id: str, region: str, audience: str, **kwargs: Any
     ) -> None:
-        super(AsyncTranslatorEntraIdAuthenticationPolicy, self).__init__(credential, scopes, **kwargs)
+        super(AsyncTranslatorEntraIdAuthenticationPolicy, self).__init__(credential, audience, **kwargs)
         self.resource_id = resource_id
         self.region = region
         self.translator_credential = credential
@@ -68,19 +72,21 @@ def set_authentication_policy(credential, kwargs):
     elif hasattr(credential, "get_token"):
         if not kwargs.get("authentication_policy"):
             if kwargs.get("region") and kwargs.get("resource_id"):
+                scope = kwargs.pop("audience", DEFAULT_ENTRA_ID_SCOPE).rstrip("/") + DEFAULT_SCOPE
                 kwargs["authentication_policy"] = AsyncTranslatorEntraIdAuthenticationPolicy(
                     credential,
                     kwargs["resource_id"],
                     kwargs["region"],
-                    kwargs.pop("scopes", DEFAULT_ENTRA_ID_SCOPE),
+                    scope,
                 )
             else:
                 if kwargs.get("resource_id") or kwargs.get("region"):
                     raise ValueError(
-                        "Both 'resource_id' and 'region' must be provided with a TokenCredential for authentication."
+                        """Both 'resource_id' and 'region' must be provided with a TokenCredential
+                         for regional resource authentication."""
                     )
                 kwargs["authentication_policy"] = AsyncBearerTokenCredentialPolicy(
-                    credential, *kwargs.pop("scopes", [DEFAULT_TOKEN_SCOPE]), kwargs
+                    credential, *[kwargs.pop("audience", DEFAULT_TOKEN_SCOPE)], kwargs
                 )
 
 
@@ -116,15 +122,16 @@ class TextTranslationClient(ServiceClientGenerated):
     None + AzureKeyCredential - used for global translator endpoint with global Translator resource
     None + AsyncTokenCredential - general translator endpoint with token authentication
     None + AsyncTokenCredential + Region - general translator endpoint with regional Translator resource
+
     :keyword str endpoint: Supported Text Translation endpoints (protocol and hostname, for example:
-    https://api.cognitive.microsofttranslator.com). If not provided, global translator endpoint will be used.
+     https://api.cognitive.microsofttranslator.com). If not provided, global translator endpoint will be used.
     :keyword credential: Credential used to authenticate with the Translator service
     :paramtype credential: Union[AzureKeyCredential, AsyncTokenCredential]
     :keyword str region: Used for National Clouds.
     :keyword str resource_id: Used with both a TokenCredential combined with a region.
-    :keyword str scopes: Scopes of the credentials.
+    :keyword str audience: Scopes of the credentials.
     :keyword  str api_version: Default value is "3.0". Note that overriding this default value may
-    result in unsupported behavior.
+     result in unsupported behavior.
     """
 
     @overload
@@ -135,8 +142,8 @@ def __init__(
         region: Optional[str] = None,
         endpoint: Optional[str] = None,
         resource_id: Optional[str] = None,
-        scopes: Optional[str] = None,
-        api_version="3.0",
+        audience: Optional[str] = None,
+        api_version: str = "3.0",
         **kwargs
     ): ...
 
@@ -147,7 +154,7 @@ def __init__(
         credential: AzureKeyCredential,
         region: Optional[str] = None,
         endpoint: Optional[str] = None,
-        api_version="3.0",
+        api_version: str = "3.0",
         **kwargs
     ): ...
 
@@ -156,7 +163,7 @@ def __init__(
         self,
         *,
         endpoint: str,
-        api_version="3.0",
+        api_version: str = "3.0",
         **kwargs
     ): ...
 
diff --git a/sdk/translation/azure-ai-translation-text/tests/static_access_token_credential.py b/sdk/translation/azure-ai-translation-text/tests/static_access_token_credential.py
@@ -16,7 +16,7 @@ def __init__(self, apikey, region):
             region, apikey
         )
 
-    def get_token(self, *scopes, **kwargs):
+    def get_token(self, *audience, **kwargs):
         response = requests.post(self.request_url)
         access_token = response.content.decode("UTF-8")
         expires_on = datetime.datetime.now() + datetime.timedelta(days=1)

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ def __init__(self, apikey, region):`
`16`	`16`	`region, apikey`
`17`	`17`	`)`
`18`	`18`
`19`		`- def get_token(self, scopes, *kwargs):`
	`19`	`+ def get_token(self, audience, *kwargs):`
`20`	`20`	`response = requests.post(self.request_url)`
`21`	`21`	`access_token = response.content.decode("UTF-8")`
`22`	`22`	`expires_on = datetime.datetime.now() + datetime.timedelta(days=1)`