Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve Doc phrasing for DefaultAzureCredential.GetToken #15369

Closed
joshfree opened this issue Sep 18, 2020 · 0 comments
Closed

Improve Doc phrasing for DefaultAzureCredential.GetToken #15369

joshfree opened this issue Sep 18, 2020 · 0 comments
Assignees
@jianghaolu
Labels
Azure.Identity blocking-release Blocks release Client This issue points to a problem in the data-plane of the library.
Milestone
[2020] October

Comments

@joshfree
Copy link
Member

Tracking Work Item

This method is called by Azure SDK clients. It isn't intended for use in application code.

The statement from the XML docs mentioned above, was meant to discourage people from calling GetTokenAsync directly in the most common case that they are using a client from Azure SDK which supports authenticating using a TokenCredential. Let's clarify the message as at least 2 users have been confused by the phrasing above.

Related Azure/azure-sdk-for-net#13531 and Azure/azure-sdk-for-python#13875
@joshfree joshfree added Client This issue points to a problem in the data-plane of the library. Azure.Identity blocking-release Blocks release labels Sep 18, 2020
@joshfree joshfree added this to the [2020] October milestone Sep 18, 2020
@joshfree joshfree changed the title Docs for DefaultAzureCredential.GetToken Improve Doc phrasing for DefaultAzureCredential.GetToken Sep 18, 2020
@joshfree joshfree mentioned this issue Sep 18, 2020
Closed
@g2vinay g2vinay closed this as completed Oct 5, 2020
@github-actions github-actions bot locked and limited conversation to collaborators Apr 12, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@jianghaolu jianghaolu

Labels
Azure.Identity blocking-release Blocks release Client This issue points to a problem in the data-plane of the library.
Projects
None yet
Milestone
[2020] October
Development

No branches or pull requests
3 participants
@joshfree @jianghaolu @g2vinay