[IoT] Error handling of Hubs missing default storage endpoint #20595
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…t storage endpoint
vilit1
reviewed
Dec 2, 2021
vilit1
reviewed
Dec 2, 2021
src/azure-cli/azure/cli/command_modules/iot/tests/latest/test_iot_commands.py
Show resolved
Hide resolved
vilit1
reviewed
Dec 3, 2021
vilit1
approved these changes
Dec 8, 2021
digimaun
reviewed
Dec 9, 2021
digimaun
reviewed
Dec 9, 2021
src/azure-cli/azure/cli/command_modules/iot/tests/latest/test_iot_commands.py
Outdated
Show resolved
Hide resolved
digimaun
reviewed
Dec 9, 2021
digimaun
approved these changes
Dec 9, 2021
zhoxing-ms
reviewed
Dec 13, 2021
Comment on lines
589
to
591
| raise AzCLIError('This hub has no default storage endpoint for file upload.\n' | ||
| 'Please recreate your default storage endpoint by running ' | ||
| '`az iot hub update --name {hub_name} --fcs {storage_connection_string} --fc {storage_container_name}`') |
Contributor
There was a problem hiding this comment.
Could we use the UserFault instead of AzCLIError ?
Member
Author
There was a problem hiding this comment.
Sure - this one's a bit tough because I'm not sure what the correct error class would be - technically it is a user fault for trying to modify a storage endpoint that doesn't exist, but in the context of the command, the fault would be an RequiredArgumentMissingError.
For the time being we can classify it as an UnclassifiedUserFault since it's more complicated than just incorrect arguments or a misconfigured resource.
Member
Author
|
@zhoxing-ms Can we get this into the current milestone targeted for a January release? |
zhoxing-ms
approved these changes
Dec 27, 2021
Contributor
|
@c-ryan-k OK, this PR has been merged and will be released on 2022-01-04 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR fixes a bug where a hub without a default storage endpoint cannot be updated with
az iot hub update, and also shows an error if the user attempts to update file upload settings on a hub missing this required endpoint.Fixes #20004
Testing Guide
If your hub has no default storage endpoint (
properties.storageEndpoints[$default]), you should still be able to update other properties of the hub usingaz iot hub update [--param or --set], however if you attempt to update file-upload endpoint-specific settings (container name, connection string, sas_ttl, identity, etc), you will receive the following error:This hub has no default storage endpoint for file upload.Please recreate your default storage endpoint by running "az iot hub update --name {hub_name} --fcs {storage_connection_string} --fc {storage_container_name}"History Notes
[IoT] az iot hub update: Adds error handling for file-upload parameters and fixes empty $default storage endpoint errors
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.