Add auth-related azd env variable checks and improve docs #2386
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.
PR Overview
This pull request improves the authentication and access control documentation and introduces environment variable checks for auth-related configuration. The changes include reformatting of the login and access control instructions, grouping related CLI commands into clearly marked steps, and updating the command descriptions for better clarity and consistency.
Reviewed Changes
| File | Description |
|---|---|
| docs/login_and_acl.md | Reorganized and reformatted authentication and ACL setup instructions for improved readability and consistency. |
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| 1. Run `azd env set AZURE_AUTH_TENANT_ID <YOUR-TENANT-ID>` to set the tenant ID associated with authentication. | ||
| 1. If your auth tenant ID is different from your currently logged in tenant ID, run `azd auth login --tenant-id <YOUR-TENANT-ID>` to login to the authentication tenant simultaneously. | ||
| 1. Run `azd up` to deploy the app. | ||
| 1. **Enable authentication for the app** |
There was a problem hiding this comment.
Thanks - this looks a lot clearer
| $AZURE_ENFORCE_ACCESS_CONTROL = (azd env get-value AZURE_ENFORCE_ACCESS_CONTROL) | ||
| $USE_CHAT_HISTORY_COSMOS = (azd env get-value USE_CHAT_HISTORY_COSMOS) | ||
|
|
||
| if ($AZURE_ENABLE_GLOBAL_DOCUMENT_ACCESS -eq "true") { |
There was a problem hiding this comment.
This seems like the right scenario to check
mattgotteiner
approved these changes
Feb 26, 2025
hasithb
pushed a commit
to hasithb/azure-search-openai-demo
that referenced
this pull request
Oct 19, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Purpose
Fixes #2325 and related issues.
At least a few developers have gotten themselves into situations where they've set some auth-related parameters but not others, so I've added checks to the auth_init scripts.
Now developers will see errors like these two:
I also improved the docs, based on o3-mini suggested formatting.
Does this introduce a breaking change?
When developers merge from main and run the server, azd up, or azd deploy, will this produce an error?
If you're not sure, try it out on an old environment.
Does this require changes to learn.microsoft.com docs?
This repository is referenced by this tutorial
which includes deployment, settings and usage instructions. If text or screenshot need to change in the tutorial,
check the box below and notify the tutorial author. A Microsoft employee can do this for you if you're an external contributor.
Type of change
Code quality checklist
See CONTRIBUTING.md for more details.
N/A, we don't have Bicep tests