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

Extend migration guide #21504

Closed
clausMeko opened this issue Sep 6, 2023 · 1 comment · Fixed by #21819
Closed

Extend migration guide #21504

clausMeko opened this issue Sep 6, 2023 · 1 comment · Fixed by #21819
Assignees
Labels
customer-reported Issues that are reported by GitHub users external to the Azure organization. Docs Event Hubs needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team

Comments

@clausMeko
Copy link

clausMeko commented Sep 6, 2023

Feature Request

Reading https://github.com/Azure/azure-sdk-for-go/blob/main/sdk/messaging/azeventhubs/migrationguide.md I had no clue how the authentication works now.

#20022 helped me solving the issue.

However explaining the Token setup now would be beneficial for many.

The current example for authentication where you initialize via:

defaultAzureCred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
  panic(err)
}

is simply not realistic because of nil and DefaultFunc.

Instead I had to use:
azidentity.NewClientSecretCredential(...)

which is probably closer to what most will need to do and therefore more instructive.

@github-actions github-actions bot added customer-reported Issues that are reported by GitHub users external to the Azure organization. needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. question The issue doesn't require a change to the product in order to be resolved. Most issues start as that labels Sep 6, 2023
@jhendrixMSFT jhendrixMSFT added Docs Event Hubs and removed question The issue doesn't require a change to the product in order to be resolved. Most issues start as that needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. labels Sep 6, 2023
@github-actions github-actions bot added the needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team label Sep 6, 2023
@richardpark-msft
Copy link
Member

@clausMeko, it's an interesting point. We do think that the DefaultAzureCredential is a good starting point, since it picks up so many common credential types. There's a specific bit in the documentation about it that mirrors what you're saying:

Note: DefaultAzureCredential is intended to simplify getting started with the SDK by handling common scenarios with reasonable default behaviors. Developers who want more control or whose scenario isn't served by the default settings should use other credential types.

With that said, I need to put some some comments in the examples that make it clear that this is not the only type and that there are many different types available. We tend to not over-duplicate docs, but I might have gone overboard there.

richardpark-msft added a commit that referenced this issue Oct 24, 2023
…zureCredential (#21819)

DefaultAzureCredential is great for getting started but, ultimately, users are expected to look at other more specific credentials. I've added in some text to the spots in our examples (and migration guide) that mention it, with a pointer to the docs so they can figure out what the right credential type is.

Fixes #21504
@github-actions github-actions bot locked and limited conversation to collaborators Jan 22, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
customer-reported Issues that are reported by GitHub users external to the Azure organization. Docs Event Hubs needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team
Projects
None yet
3 participants