Azure / Azure/azure-cli-extensions

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

Open
#8,091 5 comments 0 reactions 0 assignees View on GitHub
Auto-Assign bug IoT/CLI Service Attention
Dominant language
Python
Stars
454
Forks
1.7k
Avg merge
2d 19h
Merged PRs (30d)
64

Description

### 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
![image](https://github.com/user-attachments/assets/b5a53bf8-bcdb-4db8-ab66-3e5b0d14a176)

### 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_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.