Skip to content

{Cloud} az cloud register: Compatible with more response formats from ARM endpoint API #31566

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.

Sign up for GitHub

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

Draft
evelyn-ys wants to merge 6 commits into
base: dev
Choose a base branch
from
Draft

{Cloud} az cloud register: Compatible with more response formats from ARM endpoint API #31566

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
95fdcac
az cloud register: Compatible with more response formats from ARM end…
evelyn-ys May 28, 2025
90d9044
Check response metadata empty
evelyn-ys May 28, 2025
2c34934
Update src/azure-cli/azure/cli/command_modules/cloud/custom.py
evelyn-ys May 29, 2025
858eff8
Update src/azure-cli/azure/cli/command_modules/cloud/custom.py
evelyn-ys May 29, 2025
27962e5
fallback for arm_dict['suffixes']
evelyn-ys Jun 10, 2025
6707a76
Merge branch 'fix_cloud_endpoint_discovery' of https://github.com/eve…
evelyn-ys Jun 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/azure-cli-core/azure/cli/core/cloud.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ def _add_starting_dot(suffix):
def _get_arm_endpoint(arm_dict, is_suffix=False):
def _get_processed_arm_endpoint(name, add_dot=False, fallback_value=None):
if is_suffix:
return (_add_starting_dot(arm_dict['suffixes'][name]) if add_dot else arm_dict['suffixes'][name]) if name in arm_dict['suffixes'] else fallback_value
return (_add_starting_dot(arm_dict['suffixes'][name]) if add_dot else arm_dict['suffixes'][name]) if 'suffixes' in arm_dict and name in arm_dict['suffixes'] else fallback_value
Copy link
Member

@jiasli jiasli Jun 10, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If arm_dict does contain suffixes but arm_dict['suffixes'] is None, name in arm_dict['suffixes'] will fail:

arm_dict = {'suffixes': None}
name = 'test'
print('suffixes' in arm_dict and name in arm_dict['suffixes'])

Output:

Traceback (most recent call last):
  File "D:\cli\testproj\main.py", line 3, in <module>
    print('suffixes' in arm_dict and name in arm_dict['suffixes'])
                                     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
TypeError: argument of type 'NoneType' is not iterable

It is hard to enumerate all possibilities for an undocumented API.

Copy link
Member Author

@evelyn-ys evelyn-ys Jun 10, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch! Updated to use if name in arm_dict.get('suffixes', {}) now

return arm_dict[name] if name in arm_dict else fallback_value
return _get_processed_arm_endpoint

Expand Down
7 changes: 6 additions & 1 deletion src/azure-cli/azure/cli/command_modules/cloud/custom.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,12 @@ def _populate_from_metadata_endpoint(arm_endpoint, session=None):
response = session.get(metadata_endpoint)
if response.status_code == 200:
metadata = response.json()
return _arm_to_cli_mapper(metadata)
if isinstance(metadata, dict) and metadata:
return _arm_to_cli_mapper(metadata)
elif isinstance(metadata, list) and metadata:
return _arm_to_cli_mapper(metadata[0])
msg = 'Response body does not contain valid json. Response content: {}'.format(str(metadata))
raise CLIError(error_msg_fmt.format(msg))
msg = 'Server returned status code {} for {}'.format(response.status_code, metadata_endpoint)
raise CLIError(error_msg_fmt.format(msg))
except (requests.exceptions.ConnectionError, requests.exceptions.HTTPError) as err:
Expand Down
Loading