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

Azure Remote Rendering Readme and Samples Issue #18386

Closed
v-jiaodi opened this issue Oct 27, 2021 · 7 comments
Closed

Azure Remote Rendering Readme and Samples Issue #18386

v-jiaodi opened this issue Oct 27, 2021 · 7 comments
Assignees
Labels
Client This issue points to a problem in the data-plane of the library. Docs needs-team-triage Workflow: This issue needs the team to triage. Remote Rendering test-manual-pass

Comments

@v-jiaodi
Copy link
Member

v-jiaodi commented Oct 27, 2021

Section link1,link2:

image

Reason:
The parameter format of DeviceCodeCredential should be object.

Suggestion:
Update to

let credential = new DeviceCodeCredential({tenantId, clientId, userPromptCallback:deviceCodeCallback, 
    authorityHost: "https://login.microsoftonline.com/" + tenantId
  });

@ramya-rao-a and @MalcolmTyrrell for notification.

@ghost ghost added the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Oct 27, 2021
@v-xuto v-xuto added Client This issue points to a problem in the data-plane of the library. Docs needs-team-triage Workflow: This issue needs the team to triage. Remote Rendering test-manual-pass and removed needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. labels Oct 27, 2021
@ramya-rao-a
Copy link
Contributor

@MalcolmTyrrell Ideally, we don't list the examples showing the different credentials from @azure/identity in the readme or in the individual samples. The preference is that we show the simplest example and then point customers to the readme of @azure/identity for more details on the credential being used as well as examples of other credentials.

Any reason why we chose to list examples of all the credentials for the mixed-reality-remote-rendering package?

@v-xuto
Copy link
Member

v-xuto commented Dec 17, 2021

@MalcolmTyrrell Any ideas?

@v-xuto
Copy link
Member

v-xuto commented Jan 7, 2022

@MalcolmTyrrell Any ideas on this issue?

@MichaelZp0
Copy link
Member

I think this issue was fixed with this pull request here #18648.

@MalcolmTyrrell
Copy link
Member

@ramya-rao-a @v-xuto : Apologies for not seeing this earlier. My team switched away from this product.

The client contacts the Mixed Reality STS service via this SDK, to get authenticated for using the remote rendering service. This introduces a little subtlety into the different ways the client is constructed. In particular, if you provide an AccessToken the behavior is special (it bypasses the STS service). Is it true that we don't need to provide examples for every other credential type. I think I did that because I saw that another SDK did it :)

@ramya-rao-a
Copy link
Contributor

Thanks for the clarification @MalcolmTyrrell!

The catch with providing examples for the different credential types is that we will always have newer credentials for newer scenarios and expecting each Azure SDK package to enumerate all would not be right.

So, in terms of credential usage, we would still recommend sticking to DefaultAzureCredential and then pointing to the @azure/identity readme for examples on other auth scenarios. We can keep the "Authenticating with a static access token" section as it does not use any credential types from @azure/identity

@v-xuto
Copy link
Member

v-xuto commented Jan 21, 2022

Close this issue, due to PR #18648 merged.

@v-xuto v-xuto closed this as completed Jan 21, 2022
openapi-sdkautomation bot pushed a commit to AzureSDKAutomation/azure-sdk-for-js that referenced this issue Mar 24, 2022
openapi-sdkautomation bot pushed a commit to AzureSDKAutomation/azure-sdk-for-js that referenced this issue Mar 24, 2022
@github-actions github-actions bot locked and limited conversation to collaborators Apr 11, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Client This issue points to a problem in the data-plane of the library. Docs needs-team-triage Workflow: This issue needs the team to triage. Remote Rendering test-manual-pass
Projects
None yet
Development

No branches or pull requests

6 participants