Skip to content

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

Open

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

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

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

Metadata

Assignees

No one assigned

    Labels

    Auto-AssignAuto assign by botIoT/CLIService AttentionThis issue is responsible by Azure service team.bugThis issue requires a change to an existing behavior in the product in order to be resolved.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions