Skip to content

{Core} az login: Capture managed_by_tenants error #15550

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

Merged
jiasli merged 7 commits into from
Nov 4, 2020
Merged

{Core} az login: Capture managed_by_tenants error #15550

Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ed808cf
wrap managed_by_tenants error
jiasli Oct 16, 2020
e1a4145
add example
jiasli Oct 16, 2020
4952a9a
Update src/azure-cli-core/azure/cli/core/_profile.py
jiasli Oct 23, 2020
b729ef5
Update src/azure-cli-core/azure/cli/core/_profile.py
jiasli Oct 23, 2020
3145198
Use CLIError
jiasli Oct 23, 2020
e0dbfe3
Merge branch 'dev' into login-stack
jiasli Nov 4, 2020
a15831f
Update link
jiasli Nov 4, 2020
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
10 changes: 10 additions & 0 deletions src/azure-cli-core/azure/cli/core/_profile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,16 @@ def _normalize_properties(self, user, subscriptions, is_service_principal, cert_
if hasattr(s, 'home_tenant_id'):
subscription_dict[_HOME_TENANT_ID] = s.home_tenant_id
if hasattr(s, 'managed_by_tenants'):
if s.managed_by_tenants is None:
# managedByTenants is missing from the response. This is a known service issue:
# https://github.com/Azure/azure-rest-api-specs/issues/9567
# pylint: disable=line-too-long
from azure.cli.core.azclierror import UserFault
raise UserFault("Invalid profile is used for cloud '{cloud_name}'. "
Copy link
Contributor

@houk-ms houk-ms Oct 16, 2020

Choose a reason for hiding this comment

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

Can we define an error sub-class may be InvalidProfileError(UserFault) and raise the specific error? UserFault is designed as an abstract class and is not recommended to be raised directly.

Copy link
Member Author

@jiasli jiasli Oct 16, 2020

Choose a reason for hiding this comment

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

This is only a temporary mitigation to the service bug, it should actually be an Unsupported API version error.

Copy link
Contributor

@arrownj arrownj Oct 23, 2020

Choose a reason for hiding this comment

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

@houk-ms , you can use ABC and abstractmethod (from abc import ABC, abstractmethod) to define your class and make the parent class can't be instantiated.

Copy link
Contributor

@houk-ms houk-ms Oct 23, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

@arrownj sure, we can do that. Maybe in next CLI release

Copy link
Contributor

@houk-ms houk-ms Oct 23, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

@jiasli In this case, cosider using from azure.cli.core.azclierror import UnknownError to replace UserFault if you don't define a new error type

Copy link
Member Author

@jiasli jiasli Oct 23, 2020

Choose a reason for hiding this comment

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

Let's use CLIError for now until the error can be classified as UnsupportedAPIError after the service is fixed.

"To configure the cloud profile, run `az cloud set --name {cloud_name} --profile <profile>(e.g. 2019-03-01-hybrid)`. "
"For more information about using Azure CLI with Azure Stack, see "
"https://docs.microsoft.com/en-us/azure/azure-stack/user/azure-stack-version-profiles-azurecli2#connect-to-azure-stack"
.format(cloud_name=self.cli_ctx.cloud.name))
subscription_dict[_MANAGED_BY_TENANTS] = [{_TENANT_ID: t.tenant_id} for t in s.managed_by_tenants]

consolidated.append(subscription_dict)
Expand Down