Fix identity doc issues (Azure#41324)

Author: xiangyan99

sdk/identity/azure-identity/azure/identity/_auth_record.py

@@ -34,6 +34,7 @@ def __init__(self, tenant_id: str, client_id: str, authority: str, home_account_
     def authority(self) -> str:
         """The authority host used to authenticate the account.
 
+        :return: The authority host used to authenticate the account.
         :rtype: str
         """
         return self._authority
@@ -42,6 +43,7 @@ def authority(self) -> str:
     def client_id(self) -> str:
         """The client ID of the application which performed the original authentication.
 
+        :return: The client ID of the application which performed the original authentication.
         :rtype: str
         """
         return self._client_id
@@ -50,6 +52,7 @@ def client_id(self) -> str:
     def home_account_id(self) -> str:
         """A unique identifier of the account.
 
+        :return: A unique identifier of the account.
         :rtype: str
         """
         return self._home_account_id
@@ -58,6 +61,7 @@ def home_account_id(self) -> str:
     def tenant_id(self) -> str:
         """The tenant the account should authenticate in.
 
+        :return: The tenant the account should authenticate in.
         :rtype: str
         """
         return self._tenant_id
@@ -66,6 +70,7 @@ def tenant_id(self) -> str:
     def username(self) -> str:
         """The user principal or service principal name of the account.
 
+        :return: The user principal or service principal name of the account.
         :rtype: str
         """
         return self._username

sdk/identity/azure-identity/azure/identity/_constants.py

@@ -27,6 +27,10 @@ def __getattr__(cls, name):
 
 
 class AzureAuthorityHosts(metaclass=AzureAuthorityHostsMeta):
+    """Constants for Microsoft Entra ID authority hosts.
+    These are used to construct authority URLs for various Azure environments.
+    """
+
     AZURE_CHINA = "login.chinacloudapi.cn"
     AZURE_GOVERNMENT = "login.microsoftonline.us"
     AZURE_PUBLIC_CLOUD = "login.microsoftonline.com"

sdk/identity/azure-identity/azure/identity/_credentials/client_assertion.py

@@ -66,6 +66,7 @@ def __exit__(self, *args: Any) -> None:
         self._client.__exit__(*args)
 
     def close(self) -> None:
+        """Close the credential's underlying HTTP client and release resources."""
         self.__exit__()
 
     def _acquire_token_silently(self, *scopes: str, **kwargs: Any) -> Optional[AccessTokenInfo]:

sdk/identity/azure-identity/azure/identity/_exceptions.py

@@ -37,6 +37,7 @@ def __init__(
     def scopes(self) -> Iterable[str]:
         """Scopes requested during the failed authentication.
 
+        :return: Scopes requested during the failed authentication.
         :rtype: ~typing.Iterable[str]
         """
         return self._scopes
@@ -45,6 +46,7 @@ def scopes(self) -> Iterable[str]:
     def claims(self) -> Optional[str]:
         """Additional claims required in the next authentication.
 
+        :return: Additional claims required in the next authentication, or None if no additional claims are required.
         :rtype: str or None
         """
         return self._claims

sdk/identity/azure-identity/azure/identity/_internal/get_token_mixin.py

@@ -104,7 +104,7 @@ def get_token_info(self, *scopes: str, options: Optional[TokenRequestOptions] =
         :keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
         :paramtype options: ~azure.core.credentials.TokenRequestOptions
 
-        :rtype: AccessTokenInfo
+        :rtype: ~azure.core.credentials.AccessTokenInfo
         :return: An AccessTokenInfo instance containing information about the token.
         :raises CredentialUnavailableError: the credential is unable to attempt authentication because it lacks
             required data, state, or platform support

sdk/identity/azure-identity/azure/identity/_internal/interactive.py

@@ -253,6 +253,7 @@ def authenticate(
           for these scopes.
         :keyword str claims: additional claims required in the token, such as those provided by
           :func:`AuthenticationRequiredError.claims`
+        :return: An AuthenticationRecord containing the authenticated user's information.
         :rtype: ~azure.identity.AuthenticationRecord
         :raises ~azure.core.exceptions.ClientAuthenticationError: authentication failed. The error's ``message``
           attribute gives a reason.

sdk/identity/azure-identity/azure/identity/_internal/msal_credentials.py

@@ -68,6 +68,7 @@ def __exit__(self, *args: Any) -> None:
         self._client.__exit__(*args)
 
     def close(self) -> None:
+        """Close the credential's underlying HTTP client and release resources."""
         self.__exit__()
 
     def _initialize_cache(self, is_cae: bool = False) -> msal.TokenCache:

sdk/identity/azure-identity/azure/identity/aio/_credentials/chained.py

@@ -25,7 +25,7 @@ class ChainedTokenCredential(AsyncContextManager):
     https://aka.ms/azsdk/python/identity/credential-chains#chainedtokencredential-overview.
 
     :param credentials: credential instances to form the chain
-    :type credentials: ~azure.core.credentials.AsyncTokenCredential
+    :type credentials: ~azure.core.credentials_async.AsyncTokenCredential
 
     .. admonition:: Example:
 

sdk/identity/azure-identity/azure/identity/aio/_credentials/on_behalf_of.py

@@ -109,6 +109,7 @@ async def __aenter__(self) -> "OnBehalfOfCredential":
         return self
 
     async def close(self) -> None:
+        """Close the credential's underlying HTTP client."""
         await self._client.close()
 
     async def _acquire_token_silently(self, *scopes: str, **kwargs: Any) -> Optional[AccessTokenInfo]:

sdk/identity/azure-identity/azure/identity/aio/_internal/get_token_mixin.py

@@ -104,7 +104,7 @@ async def get_token_info(self, *scopes: str, options: Optional[TokenRequestOptio
         :keyword options: A dictionary of options for the token request. Unknown options will be ignored. Optional.
         :paramtype options: ~azure.core.credentials.TokenRequestOptions
 
-        :rtype: AccessTokenInfo
+        :rtype: ~azure.core.credentials.AccessTokenInfo
         :return: An AccessTokenInfo instance containing information about the token.
         :raises CredentialUnavailableError: the credential is unable to attempt authentication because it lacks
             required data, state, or platform support