[Identity] Add more detail to VSCodeCred class doc (Azure#27013)

Add more details to the VisualStudioCodeCredential class docstring to let users know about its current shortcomings. Signed-off-by: Paul Van Eck <paulvaneck@microsoft.com>
danigm · Oct 26, 2022 · ada565c · ada565c
1 parent 47dfd59
commit ada565c
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/sdk/identity/azure-identity/azure/identity/_credentials/vscode.py b/sdk/identity/azure-identity/azure/identity/_credentials/vscode.py
@@ -112,7 +112,12 @@ def _initialize(self, vscode_user_settings, **kwargs):
 
 
 class VisualStudioCodeCredential(_VSCodeCredentialBase, GetTokenMixin):
-    """Authenticates as the Azure user signed in to Visual Studio Code.
+    """Authenticates as the Azure user signed in to Visual Studio Code via the 'Azure Account' extension.
+
+    It's a `known issue <https://github.com/Azure/azure-sdk-for-python/issues/23249>`_ that this credential doesn't
+    work with `Azure Account extension <https://marketplace.visualstudio.com/items?itemName=ms-vscode.azure-account>`_
+    versions newer than **0.9.11**. A long-term fix to this problem is in progress. In the meantime, consider
+    authenticating with :class:`AzureCliCredential`.
 
     :keyword str authority: Authority of an Azure Active Directory endpoint, for example "login.microsoftonline.com".
         This argument is required for a custom cloud and usually unnecessary otherwise. Defaults to the authority

diff --git a/sdk/identity/azure-identity/azure/identity/aio/_credentials/vscode.py b/sdk/identity/azure-identity/azure/identity/aio/_credentials/vscode.py
@@ -18,7 +18,12 @@
 
 
 class VisualStudioCodeCredential(_VSCodeCredentialBase, AsyncContextManager, GetTokenMixin):
-    """Authenticates as the Azure user signed in to Visual Studio Code.
+    """Authenticates as the Azure user signed in to Visual Studio Code via the 'Azure Account' extension.
+
+    It's a `known issue <https://github.com/Azure/azure-sdk-for-python/issues/23249>`_ that this credential doesn't
+    work with `Azure Account extension <https://marketplace.visualstudio.com/items?itemName=ms-vscode.azure-account>`_
+    versions newer than **0.9.11**. A long-term fix to this problem is in progress. In the meantime, consider
+    authenticating with :class:`AzureCliCredential`.
 
     :keyword str authority: Authority of an Azure Active Directory endpoint, for example "login.microsoftonline.com".
         This argument is required for a custom cloud and usually unnecessary otherwise. Defaults to the authority