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

Endpoint reference #65354

Closed
taylor-anderson821 opened this issue Nov 1, 2020 · 4 comments
Closed

Endpoint reference #65354

taylor-anderson821 opened this issue Nov 1, 2020 · 4 comments

Comments

@taylor-anderson821
Copy link
Contributor

As someone who is new to ADT, endpoints, routes, topics, and subscriptions, I found this line in this page confusing:

"Next, create an Azure Digital Twins endpoint pointing to your event grid topic. Use the command below, filling in the placeholder fields as necessary:"

The CLI reference for: az dt endpoint create eventgrid found here
https://docs.microsoft.com/en-us/cli/azure/ext/azure-iot/dt/endpoint/create?view=azure-cli-latest

Says that CLI command 'az dt endpoint create eventgrid' "adds an EventGrid Topic endpoint to a Digital Twins instance. Requires pre-created resource"

So I think it would be more clear for the ADT doc to say that it is adding an Event Grid topic endpoint to the instance rather than an adding an ADT endpoint.

T


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

@ChaitanyaNaykodi-MSFT
Copy link
Contributor

Hello @jjadta, Thank you for your feedback! We will review and update as appropriate.

@baanders
Copy link
Contributor

baanders commented Nov 3, 2020

Thanks @jjadta for the comment! This makes sense.

The intent was to clarify that while Event Grid, Service Bus, etc... are other Azure services that you set up separately, the endpoint is part of the ADT instance. However, I see how this could be confusing, especially when the wording is different from the CLI documentation.

Here's a suggested rewrite for the sentence:
"Next, create an Event Grid endpoint in Azure Digital Twins, which will connect your instance to your event grid topic."

Do you think this adds the needed clarification?

@taylor-anderson821
Copy link
Contributor Author

taylor-anderson821 commented Nov 3, 2020 via email

@baanders
Copy link
Contributor

baanders commented Nov 3, 2020

@jjadta Great, thanks for the confirmation!

I am making this edit in PR #136417, and will have Git close this issue when the fix is merged.
(You can still feel free to comment back on this thread with additional comments or questions if needed.)

Thanks again for the feedback!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants