-
Notifications
You must be signed in to change notification settings - Fork 47
Add an Azure Resources API (v4) authentication layer #1284
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?
Conversation
|
|
||
| const v4: string = '4.0.0'; | ||
|
|
||
| export type AuthApiFactoryDependencies = { |
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.
Added this type in preparation to leverage dependency injection during tests. It probably belongs in the follow-up test PR, but I'm hoping to not have to extract and re-add it again 😅
|
We need to write some documentation on how this new layer works. I'd like to help out writing the docs if you want my help, can you post the diagram you made @MicroFish91? |
Yup! I actually already have some docs and diagrams added in this other PR. Let me know if you think anything else should be added / changed to either the main README or the auth one |
Overview
This PR adds a secure auth layer that clients should interface with to obtain the Azure Resources core APIs (used for registering branch data resources). For full details on the new auth handshake, please see the auth readme included with this PR. We will continue to publicly provide the core APIs while we let clients onboard. Afterwards we will remove these APIs from the public exports and only expose them through the dedicated auth layer.
Setup
Here are the steps if you would like to try out the changes:
npm install&npm run compilein Azure Resources rootnpm install&npm packin Azure Resources API rootnpm installand add the Azure Resources API package built from step 3onDidReceiveAzureResourcesApiscallback to verify we are getting matching Azure Resources APIsClient Extension Samples
Container Apps example (V2): microsoft/vscode-azurecontainerapps#992
Functions example (internal + V2): microsoft/vscode-azurefunctions#4777
Todos
To add in follow-up PRs.
UPDATE (11/20/2025):
I split up the PRs a bit better, now the client tooling lives in this PR. Therefore if you want to test the functionality described under
Setupabove, you'll now need to test off of that branch instead.The order of the PRs to review should be: