Customer feedback | az iot dps enrollment | explain `--device-information` and fix spelling in example

[dbradish-microsoft]

Describe the bug

Feedback category

Need more information /and/ Typo in example

Reference command

az iot dps enrollment create --device-information

Summary

From Learn Customer Feedback, a customer is requesting more information on the --device-information parameter. There is also a typo in the example (See screen print below).

Request

• Fix the typo in the current example
• And more information to the parameter short-summary
  • Where is this device information shown?
  • What is a good business purpose for this parameter use?

Doc link

https://learn.microsoft.com/en-us/cli/azure/iot/dps/enrollment

Customer feedback

" The document is ok but I have two attention points. --device-information seems to be the official name but the examples show --device-info. Please be consistent. And, what does this field do? Where is this device info shown? in the device twin??? I have no clue where this is kept. Please explain better. "

Screen print of typo in example

Related command

az iot dps enrollment create

Errors

n/a

Issue script & Debug output

n/a

Expected behavior

n/a

Environment Summary

Azure CLI 2.62.0

Additional context

No response

[yonzhan]

Thank you for opening this issue, we will look into it.

[microsoft-github-policy-service[bot]]

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @Azure/azure-iot-cli-triage.

[Elsie4ever]

Hi @dbradish-microsoft, thanks for the feedback, will investigate and update!

[vilit1]

Hi @dbradish-microsoft, I updated the help documentation in the extension to reflect the correct parameters. The documents will automatically update when the newest extension version is released. I will let you know when that will happen.

[dbradish-microsoft]

CCing @mikefrobbins