Skip to content

Commit 0b6fd42

Browse files
authored
Update DefaultAzureCredential API docs (#44001)
* Update DefaultAzureCredential API docs * React to feedback * Add broker docstring
1 parent 75fe949 commit 0b6fd42

File tree

2 files changed

+13
-9
lines changed

2 files changed

+13
-9
lines changed

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

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -73,10 +73,11 @@ class DefaultAzureCredential(ChainedTokenCredential):
7373
4. On Windows only: a user who has signed in with a Microsoft application, such as Visual Studio. If multiple
7474
identities are in the cache, then the value of the environment variable ``AZURE_USERNAME`` is used to select
7575
which identity to use. See :class:`~azure.identity.SharedTokenCacheCredential` for more details.
76-
5. The identity currently logged in to the Azure CLI.
77-
6. The identity currently logged in to Azure PowerShell.
78-
7. The identity currently logged in to the Azure Developer CLI.
79-
8. Brokered authentication. On Windows and WSL only, this uses the default account logged in via
76+
5. The identity logged in to Visual Studio Code with the Azure Resources extension.
77+
6. The identity currently logged in to the Azure CLI.
78+
7. The identity currently logged in to Azure PowerShell.
79+
8. The identity currently logged in to the Azure Developer CLI.
80+
9. Brokered authentication. On Windows and WSL only, this uses the default account logged in via
8081
Web Account Manager (WAM) if the `azure-identity-broker` package is installed.
8182
8283
This default behavior is configurable with keyword arguments.
@@ -95,7 +96,7 @@ class DefaultAzureCredential(ChainedTokenCredential):
9596
Defaults to **False**.
9697
:keyword bool exclude_powershell_credential: Whether to exclude Azure PowerShell. Defaults to **False**.
9798
:keyword bool exclude_visual_studio_code_credential: Whether to exclude stored credential from VS Code.
98-
Defaults to **True**.
99+
Defaults to **False**.
99100
:keyword bool exclude_shared_token_cache_credential: Whether to exclude the shared token cache. Defaults to
100101
**False**.
101102
:keyword bool exclude_interactive_browser_credential: Whether to exclude interactive browser authentication (see

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

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,12 @@ class DefaultAzureCredential(ChainedTokenCredential):
6868
4. On Windows only: a user who has signed in with a Microsoft application, such as Visual Studio. If multiple
6969
identities are in the cache, then the value of the environment variable ``AZURE_USERNAME`` is used to select
7070
which identity to use. See :class:`~azure.identity.aio.SharedTokenCacheCredential` for more details.
71-
5. The identity currently logged in to the Azure CLI.
72-
6. The identity currently logged in to Azure PowerShell.
73-
7. The identity currently logged in to the Azure Developer CLI.
71+
5. The identity logged in to Visual Studio Code with the Azure Resources extension.
72+
6. The identity currently logged in to the Azure CLI.
73+
7. The identity currently logged in to Azure PowerShell.
74+
8. The identity currently logged in to the Azure Developer CLI.
75+
9. Brokered authentication. On Windows and WSL only, this uses the default account logged in via
76+
Web Account Manager (WAM) if the `azure-identity-broker` package is installed.
7477
7578
This default behavior is configurable with keyword arguments.
7679
@@ -86,7 +89,7 @@ class DefaultAzureCredential(ChainedTokenCredential):
8689
variables from the credential. Defaults to **False**.
8790
:keyword bool exclude_powershell_credential: Whether to exclude Azure PowerShell. Defaults to **False**.
8891
:keyword bool exclude_visual_studio_code_credential: Whether to exclude stored credential from VS Code.
89-
Defaults to **True**.
92+
Defaults to **False**.
9093
:keyword bool exclude_managed_identity_credential: Whether to exclude managed identity from the credential.
9194
Defaults to **False**.
9295
:keyword bool exclude_shared_token_cache_credential: Whether to exclude the shared token cache. Defaults to

0 commit comments

Comments
 (0)