DOC: Updating readme file #155
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This pull request simplifies the README documentation for Entra ID authentication by removing detailed authentication method notes and replacing them with a reference link to more comprehensive documentation.
- Removes specific implementation notes for access token, device code, and default authentication methods
- Adds a link to the Microsoft Entra ID support document in the project wiki
| - **Access Token**: the connection string **must not** contain `UID`, `PWD`, `Authentication`, or `Trusted_Connection` keywords. | ||
| - **Device Code**: make sure to specify a `Connect Timeout` that provides enough time to go through the device code flow authentication process. | ||
| - **Default**: Ensure you're authenticated via az login, or running within a managed identity-enabled environment. | ||
| > For more information on Entra ID please refer this [document](https://github.com/microsoft/mssql-python/wiki/Microsoft-Entra-ID-support) |
There was a problem hiding this comment.
The phrase 'please refer this document' is grammatically incorrect. It should be 'please refer to this document' or 'please see this document'.
Suggested change
| > For more information on Entra ID please refer this [document](https://github.com/microsoft/mssql-python/wiki/Microsoft-Entra-ID-support) | |
| > For more information on Entra ID please refer to this [document](https://github.com/microsoft/mssql-python/wiki/Microsoft-Entra-ID-support) |
Copilot uses AI. Check for mistakes.
sumitmsft
approved these changes
Jul 25, 2025
bewithgaurav
approved these changes
Jul 28, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Work Item / Issue Reference
Summary
This pull request updates the
README.mdfile to enhance documentation related to Entra ID authentication. It removes specific notes about authentication methods and replaces them with a link to a detailed document for further information.Documentation updates:
README.md: Removed detailed notes about access token, device code, and default authentication methods, and added a reference link to the Microsoft Entra ID support document for more comprehensive guidance.