MicrosoftDocs / azure-docs

Open source documentation of Microsoft Azure
https://docs.microsoft.com/azure
Creative Commons Attribution 4.0 International
10.27k stars 21.45k forks source link

Consider IoT PnP module support for IoTHub Time Series ID #78470

Closed sandervandevelde closed 3 years ago

sandervandevelde commented 3 years ago

In this Azure IoT Plug and Play documentation regarding TSI it is recommended to add this 'composite key that consists of iothub-connection-device-id and dt-subject'.

This is due to 'your Time Series ID is immutable, Microsoft recommends enabling this option in case you need it in the future.'.

I came across this by accident.

Is even useful for customers without PnP implementation yet so they are prepared for future implementations?

If, so, the text needs to be updated so the composite key is proposed.


Document Details

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

SatishBoddu-MSFT commented 3 years ago

Hello @sandervandevelde Thanks for the feedback!.

I have assigned the issue to the content author for further review.

tedvilutis commented 3 years ago

@sandervandevelde, this is just an example of the best practice to have a unique TSID within the same fleet. I couldn't find any reference to PnP in the doc. Can you provide us more details? Thank you.

sandervandevelde commented 3 years ago

Hello @tedvilutis,

This page is about best practices regarding the Time Series ID.

It does not include the Azure PnP related best practice:

As an IoT Plug and Play user, for your Time Series ID, specify a composite key that consists of *iothub-connection-device-id* and *dt-subject*

Please show the same best practices on both page.

tedvilutis commented 3 years ago

It is implied in "You can also select up to three key properties as your Time Series ID. Their combination will be a composite key that represents the Time Series ID." The best practice page is linked with the tutorial page. But thank you for your contribution to the Azure Time Series Insights documentation. We have created a work item based on your feedback. We will prioritize it and make any necessary changes. #please-close

sandervandevelde commented 3 years ago

Thanks for your reply.

I would like to have these two TSI-related pages being on par.

At this moment, I see this helpful note:

image

I propose to add a second note:

"If you have plans to use IoT Plug and Play device models or are using IoT Plug and Play device models without currently using components, you should include dt-subject as part of a composite key so that you can use components in the future"

This way, both 'landing pages' for users who start with Azure IoT (and PnP in the near future) as good to go already.

tedvilutis commented 3 years ago

Done.