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

doc: mention iot hub query in iot hub device-twin list help #700

Merged
merged 2 commits into from
Dec 16, 2024

Conversation

Delapouite
Copy link
Contributor

Hi

While trying to query devices from the IoTHub registry my first attempt was to look for a az iot hub device-twin query command which does not exist.

Then, I stumbled upon az iot hub device-twin list which does a select * from devices by default. But looking at the auto-completion of this command I was a bit misled : it does indeed offer a --query flag, but it has nothing to do with the fact of querying devices. As discovered later in the --help output, it's a global flag also used by a lot of commands to filter the JSON output with JMESPath.

In the end, the command I was looking for is az iot hub query which was not very obvious as there's no mention of "devices" in its name.

So my hope with this PR is that it will avoid other users to waste time and more easily find the command they are looking for.

Thanks.


This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Thank you for contributing to the IoT extension!

This checklist is used to make sure that common guidelines for a pull request are followed.

General Guidelines

Intent for Production

  • It is expected that pull requests made to default or core branches such as dev or main are of production grade. Corollary to this, any merged contributions to these branches may be deployed in a public release at any given time. By checking this box, you agree and commit to the expected production quality of code.

Basic expectations

  • If introducing new functionality or modified behavior, are they backed by unit and/or integration tests?
  • In the same context as above are command names and their parameter definitions accurate? Do help docs have sufficient content?
  • Have all the relevant unit and integration tests pass? i.e. pytest <project root> -vv. Please provide evidence in the form of a screenshot showing a successful run of tests locally OR a link to a test pipeline that has been run against the change-set.
  • Have linter checks passed using the .pylintrc and .flake8 rules? Look at the CI scripts for example usage.
  • Have extraneous print or debug statements, commented out code-blocks or code-statements (if any) been removed from the surface area of changes?
  • Have you made an entry in HISTORY.rst which concisely explains your user-facing feature or change?

Azure IoT CLI maintainers reserve the right to enforce any of the outlined expectations.

A PR is considered ready for review when all basic expectations have been met (or do not apply).

@Delapouite Delapouite requested a review from digimaun as a code owner May 20, 2024 07:47
@digimaun digimaun merged commit a0ab1b8 into Azure:dev Dec 16, 2024
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants