-
Notifications
You must be signed in to change notification settings - Fork 6k
Update visual studio code auth content and diagrams #48182
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
base: main
Are you sure you want to change the base?
Update visual studio code auth content and diagrams #48182
Conversation
@scottaddie I went ahead and replaced the remaining legacy diagrams with standardized/editable mermaid diagrams - just let me know if you want any changes or if you'd prefer not to replace some of them. |
docs/azure/sdk/authentication/local-development-dev-accounts.md
Outdated
Show resolved
Hide resolved
docs/azure/sdk/media/mermaidjs/local-developer-authentication.md
Outdated
Show resolved
Hide resolved
docs/azure/sdk/media/mermaidjs/local-service-principal-authentication.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Scott Addie <10702007+scottaddie@users.noreply.github.com>
LocalDev --> AppSP["**Service principal**"] | ||
LocalDev --> DevAccount["**Developer account**"] | ||
LocalDev --> Broker["**Broker**"] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we are mixing concepts here - Broker would be a developer account also. Should we use only Service principal
and User principal
? We could probably get rid of Broker.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The idea behind this diagram is the authentication approach or technique that the user would implement, so even though the underlying account is the same its acquired using a different approach.
%% npm i -g @mermaid-js/mermaid-cli@10.9.1 | ||
%% 2. Run command: mmdc -i local-broker-authentication.md -o ../../media/mermaidjs/local-broker-authentication.svg | ||
|
||
flowchart LR |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What are we trying to communicate with this diagram? I think we should either use a component diagram that illustrates how the broker interacts with the application or remove it.
VS --> DevAccount | ||
VSC --> DevAccount | ||
AZD --> DevAccount | ||
AZCLI --> DevAccount |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The CLI and perhaps others can authenticate service principles in addition to developer accounts. I'm not sure if this diagram adds any new information other than these tools can interact with developer credentials.
VSC --> DevAccount | ||
AZD --> DevAccount | ||
AZCLI --> DevAccount | ||
AZPS --> DevAccount |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The Broker is also part of the Dev credentials; it's another way to get access to the Developer account credentials
AS["Azure services"] | ||
|
||
APP --> BK | ||
BK --> AS |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It might be helpful to add another layer to this diagram to emphasize that the Broker is part of Windows (WAM), Intune in Linux and MacOS and that these OS component and tools are the one interacting with the .NET App to get the User's credentials.
Summary
Replace diagrams with standardized, editable mermaid diagrams.
Update Visual Studio Code credentials.
Fixes #Issue_Number (if available)
Internal previews