[IoT] BREAKING CHANGE: Migrate az iot hub devicestream command group to CLI extension#31913
Conversation
️✔️AzureCLI-FullTest
|
❌AzureCLI-BreakingChangeTest
Please submit your Breaking Change Pre-announcement ASAP if you haven't already. Please note:
|
|
Thank you for your contribution! We will review the pull request and get back to you soon. |
|
The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR. Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions). pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>
|
There was a problem hiding this comment.
Pull Request Overview
This PR removes the az iot hub devicestream command group from the Azure CLI codebase, migrating its functionality to the azure-iot extension to maintain a single version of the IoT Hub API in the main repository.
- Removes the
iot_hub_devicestream_showfunction and associated command registration - Removes test coverage for the devicestream show command
- Cleans up help documentation and API version references
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
test_iot_commands.py |
Removes test case for devicestream show command |
custom.py |
Removes the iot_hub_devicestream_show function implementation |
commands.py |
Removes command group registration for devicestream commands |
_help.py |
Removes help documentation for devicestream commands |
_shared.py |
Removes ad hoc API version reference for devicestream functionality |
Comments suppressed due to low confidence (1)
|
Because this PR may cause a breaking change, it is recommended to release it in the breaking change window |
@zhoxing-ms If this is a breaking change, I can adjust this pr (or create a new pr) to deprecate rather than fully remove and do a follow up removal pr the next month. |
|
@zhoxing-ms this command was classified as preview, was using a legacy API and has minimal usage - do these conditions warrant a breaking change? |
Yes, exactly |
May I ask do you have Telemetry to evaluate how much usage it has? |
zhoxing-ms
changed the title
az iot hub devicestreamaz iot hub devicestream
|
Here is the data for July: |
zhoxing-ms
changed the title
az iot hub devicestreamaz iot hub devicestream command group to CLI extension
Related command
az iot hub devicestream
Description
Removes the
az iot hub devicestreamcommand group from this code base. The commands are moved to the azure-iot extension with the same functionality (Azure/azure-iot-cli-extension#748)This way we can keep one version of the IoT Hub API in this repository.
Testing Guide
Removed the command from test_iot_hub, ran the recorded tests, and ran the tests live. The recorded tests did not change.
History Notes
[IoT] Remove
az iot hub devicestream. To use this command, please install the latest version of the extension azure-iot.This checklist is used to make sure that common guidelines for a pull request are followed.
The PR title and description has followed the guideline in Submitting Pull Requests.
I adhere to the Command Guidelines.
I adhere to the Error Handling Guidelines.