search

Azure / azure-cli

Azure Command-Line Interface
MIT License
3.93k stars 2.9k forks source link

AZ CLI should show error details or provide documentation on how to find error details #17973

Open adesca opened 3 years ago

adesca commented 3 years ago

When a Synapse workspace command fails, instead of providing the detailed error, there's an error message that says to refer to error details for more information.

Sample error: image

To reproduce:

  1. Run az synapse workspace key update --key-identifier xxx --is-active true --workspace-name xxx --resource-group xxx --name xxx with a synapse workspace that's had encryption activated, and recently been given access to the Key.
  2. Attempt to activate the workspace through this command
  3. Run into an error saying to check error details that aren't visible.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

ghost commented 3 years ago

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @aim-for-better, @idear1203.

Issue Details
When a Synapse workspace command fails, instead of providing the detailed error, there's an error message that says to refer to error details for more information. Sample error: ![image](https://user-images.githubusercontent.com/15189666/117209632-3768bd00-adbc-11eb-97fa-c487d8c1714a.png) To reproduce: 1. Run `az synapse workspace key update --key-identifier xxx --is-active true --workspace-name xxx --resource-group xxx --name xxx` with a synapse workspace that's had encryption activated, and recently been given access to the Key. 2. Attempt to activate the workspace through this command 3. Run into an error saying to check error details that aren't visible. --- #### Document Details ⚠ *Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.* * ID: fa3bcbf2-292f-d579-5f93-2204f273dc09 * Version Independent ID: 78529488-9766-9230-bb35-494ad6032022 * Content: [az synapse workspace key](https://docs.microsoft.com/en-us/cli/azure/synapse/workspace/key?view=azure-cli-latest#az_synapse_workspace_key_update) * Content Source: [latest/docs-ref-autogen/synapse/workspace/key.yml](https://github.com/MicrosoftDocs/azure-docs-cli/blob/master/latest/docs-ref-autogen/synapse/workspace/key.yml) * GitHub Login: @rloutlaw * Microsoft Alias: **routlaw**
Author: adesca
Assignees: -
Labels: `Service Attention`, `Synapse`
Milestone: -
yonzhan commented 3 years ago

route to service team

idear1203 commented 3 years ago

@yonzhan we don't have customization on error handling. We just call SDK method here. Is this something that should be done in the CLI fundamental layer or could you please share me with some good examples how other services handles such case. Thanks in advance!

CC @zesluo

yonzhan commented 3 years ago

Add error handling expert @houk-ms to help with.