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.

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

Add Thread Safety and Additional Concepts README sections to Identity #18549

Closed
kinelski opened this issue Feb 8, 2021 · 1 comment · Fixed by #23771
Closed

Add Thread Safety and Additional Concepts README sections to Identity #18549

kinelski opened this issue Feb 8, 2021 · 1 comment · Fixed by #23771
Labels
Azure.Identity Client This issue points to a problem in the data-plane of the library. Docs
Milestone

Comments

@kinelski
Copy link
Member

kinelski commented Feb 8, 2021

The READMEs in our libraries usually contain the following sections:

### Thread safety
We guarantee that all client instance methods are thread-safe and independent of each other ([guideline](https://azure.github.io/azure-sdk/dotnet_introduction.html#dotnet-service-methods-thread-safety)). This ensures that the recommendation of reusing client instances is always safe, even across threads.

### Additional concepts
<!-- CLIENT COMMON BAR -->
[Client options](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/README.md#configuring-service-clients-using-clientoptions) |
[Accessing the response](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/README.md#accessing-http-response-details-using-responset) |
[Long-running operations](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/README.md#consuming-long-running-operations-using-operationt) |
[Handling failures](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/README.md#reporting-errors-requestfailedexception) |
[Diagnostics](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/samples/Diagnostics.md) |
[Mocking](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/README.md#mocking) |
[Client lifetime](https://devblogs.microsoft.com/azure-sdk/lifetime-management-and-thread-safety-guarantees-of-azure-sdk-net-clients/)
<!-- CLIENT COMMON BAR -->

Given that Azure.Identity is a unique library and not all these concepts apply, or don't apply in the same way as other client libraries, these sections have not been added to Identity's README (discussion here).

Goal: include these sections in the README of the Identity library with the content that's applicable to it.

@kinelski kinelski added Client This issue points to a problem in the data-plane of the library. Azure.Identity Docs labels Feb 8, 2021
@kinelski kinelski added this to the Backlog milestone Feb 8, 2021
@ghost ghost added the no-recent-activity There has been no recent activity on this issue. label Mar 12, 2021
@ghost
Copy link

ghost commented Mar 12, 2021

Hi @kinelski. There hasn't been recent engagement on this pull request. If this is still an active work stream, please let us know by removing the no-recent-activity label. Otherwise, we'll close this out in 7 days.

@kinelski kinelski removed the no-recent-activity There has been no recent activity on this issue. label Mar 12, 2021
@github-actions github-actions bot locked and limited conversation to collaborators Mar 28, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Azure.Identity Client This issue points to a problem in the data-plane of the library. Docs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant