Skip to content

{RDBMS} Use ServicePrincipalCredential with environment credential #22124

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 2 commits into from
Apr 21, 2022
Merged

{RDBMS} Use ServicePrincipalCredential with environment credential #22124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7b0479d
env-cred
jiasli Apr 20, 2022
3029dcd
azure.identity
jiasli Apr 20, 2022
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
27 changes: 27 additions & 0 deletions src/azure-cli-core/azure/cli/core/auth/identity.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,13 @@
AZURE_CLI_CLIENT_ID = '04b07795-8ddb-461a-bbee-02f9e1bf7b46'


# For environment credential
AZURE_AUTHORITY_HOST = "AZURE_AUTHORITY_HOST"
AZURE_TENANT_ID = "AZURE_TENANT_ID"
AZURE_CLIENT_ID = "AZURE_CLIENT_ID"
AZURE_CLIENT_SECRET = "AZURE_CLIENT_SECRET"


logger = get_logger(__name__)


Expand Down Expand Up @@ -346,3 +353,23 @@ def _try_remove(path):
os.remove(path)
except FileNotFoundError:
pass


def get_environment_credential():
# A temporary workaround used by rdbms module to use environment credential.
# TODO: Integrate with Identity and utilize MSAL HTTP and token cache to officially implement
# https://github.com/Azure/azure-cli/issues/10241
from os import getenv

sp_auth = ServicePrincipalAuth({
_TENANT: getenv(AZURE_TENANT_ID),
_CLIENT_ID: getenv(AZURE_CLIENT_ID),
_CLIENT_SECRET: getenv(AZURE_CLIENT_SECRET)
})

authority, _ = _get_authority_url(
# Override authority host if defined as env var
getenv(AZURE_AUTHORITY_HOST) or 'https://login.microsoftonline.com',
Copy link
Member Author

@jiasli jiasli Apr 21, 2022

Choose a reason for hiding this comment

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

See #17191 (comment)

getenv(AZURE_TENANT_ID))
credentials = ServicePrincipalCredential(sp_auth, authority=authority)
Copy link
Member Author

@jiasli jiasli May 26, 2025

Choose a reason for hiding this comment

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

This line is broken by the ServicePrincipalCredential's signature change in #29439.

return credentials
4 changes: 0 additions & 4 deletions src/azure-cli-core/azure/cli/core/tests/test_profile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
_transform_subscription_for_multiapi)
from azure.cli.core.auth.util import AccessToken
from azure.cli.core.mock import DummyCli
from azure.identity import AuthenticationRecord
from azure.mgmt.resource.subscriptions.models import \
(Subscription, SubscriptionPolicies, SpendingLimit, ManagedByTenant)

Expand Down Expand Up @@ -94,9 +93,6 @@ def setUpClass(cls):
cls.display_name1 = 'foo account'
cls.home_account_id = "00000003-0000-0000-0000-000000000000.00000003-0000-0000-0000-000000000000"
cls.client_id = "00000003-0000-0000-0000-000000000000"
cls.authentication_record = AuthenticationRecord(cls.tenant_id, cls.client_id,
"https://login.microsoftonline.com", cls.home_account_id,
cls.user1)
cls.state1 = 'Enabled'
cls.managed_by_tenants = [ManagedByTenantStub('00000003-0000-0000-0000-000000000000'),
ManagedByTenantStub('00000004-0000-0000-0000-000000000000')]
Expand Down
44 changes: 11 additions & 33 deletions src/azure-cli/azure/cli/command_modules/rdbms/_client_factory.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,12 @@

from azure.cli.core.commands.client_factory import get_mgmt_service_client
from azure.cli.core.profiles import ResourceType
from azure.cli.core.auth.identity import get_environment_credential, AZURE_CLIENT_ID

# pylint: disable=import-outside-toplevel

RM_URI_OVERRIDE = 'AZURE_CLI_RDBMS_RM_URI'
SUB_ID_OVERRIDE = 'AZURE_CLI_RDBMS_SUB_ID'
CLIENT_ID = 'AZURE_CLIENT_ID'
TENANT_ID = 'AZURE_TENANT_ID'
CLIENT_SECRET = 'AZURE_CLIENT_SECRET'


def get_mariadb_management_client(cli_ctx, **_):
Expand All @@ -24,13 +22,9 @@ def get_mariadb_management_client(cli_ctx, **_):
# variable.
rm_uri_override = getenv(RM_URI_OVERRIDE)
if rm_uri_override:
client_id = getenv(CLIENT_ID)
client_id = getenv(AZURE_CLIENT_ID)
if client_id:
from azure.identity import ClientSecretCredential
credentials = ClientSecretCredential(
client_id=client_id,
client_secret=getenv(CLIENT_SECRET),
tenant_id=getenv(TENANT_ID))
credentials = get_environment_credential()
else:
from msrest.authentication import Authentication # pylint: disable=import-error
credentials = Authentication()
Expand All @@ -52,13 +46,9 @@ def get_mysql_management_client(cli_ctx, **_):
# variable.
rm_uri_override = getenv(RM_URI_OVERRIDE)
if rm_uri_override:
client_id = getenv(CLIENT_ID)
client_id = getenv(AZURE_CLIENT_ID)
if client_id:
from azure.identity import ClientSecretCredential
credentials = ClientSecretCredential(
client_id=client_id,
client_secret=getenv(CLIENT_SECRET),
tenant_id=getenv(TENANT_ID))
credentials = get_environment_credential()
else:
from msrest.authentication import Authentication # pylint: disable=import-error
credentials = Authentication()
Expand All @@ -80,13 +70,9 @@ def get_mysql_flexible_management_client(cli_ctx, **_):
# variable.
rm_uri_override = getenv(RM_URI_OVERRIDE)
if rm_uri_override:
client_id = getenv(CLIENT_ID)
client_id = getenv(AZURE_CLIENT_ID)
if client_id:
from azure.identity import ClientSecretCredential
credentials = ClientSecretCredential(
client_id=client_id,
client_secret=getenv(CLIENT_SECRET),
tenant_id=getenv(TENANT_ID))
credentials = get_environment_credential()
else:
from msrest.authentication import Authentication # pylint: disable=import-error
credentials = Authentication()
Expand All @@ -108,13 +94,9 @@ def get_postgresql_management_client(cli_ctx, **_):
# variable.
rm_uri_override = getenv(RM_URI_OVERRIDE)
if rm_uri_override:
client_id = getenv(CLIENT_ID)
client_id = getenv(AZURE_CLIENT_ID)
if client_id:
from azure.identity import ClientSecretCredential
credentials = ClientSecretCredential(
client_id=client_id,
client_secret=getenv(CLIENT_SECRET),
tenant_id=getenv(TENANT_ID))
credentials = get_environment_credential()
else:
from msrest.authentication import Authentication # pylint: disable=import-error
credentials = Authentication()
Expand All @@ -135,13 +117,9 @@ def get_postgresql_flexible_management_client(cli_ctx, **_):
# variable.
rm_uri_override = getenv(RM_URI_OVERRIDE)
if rm_uri_override:
client_id = getenv(CLIENT_ID)
client_id = getenv(AZURE_CLIENT_ID)
if client_id:
from azure.identity import ClientSecretCredential
credentials = ClientSecretCredential(
client_id=client_id,
client_secret=getenv(CLIENT_SECRET),
tenant_id=getenv(TENANT_ID))
credentials = get_environment_credential()
else:
from msrest.authentication import Authentication # pylint: disable=import-error
credentials = Authentication()
Expand Down
1 change: 0 additions & 1 deletion src/azure-cli/requirements.py3.Darwin.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ azure-cosmos==3.2.0
azure-data-tables==12.2.0
azure-datalake-store==0.0.49
azure-graphrbac==0.60.0
azure-identity==1.6.1
azure-keyvault-administration==4.0.0b3
azure-keyvault-keys==4.5.0
azure-keyvault==1.1.0
Expand Down
1 change: 0 additions & 1 deletion src/azure-cli/requirements.py3.Linux.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ azure-cosmos==3.2.0
azure-data-tables==12.2.0
azure-datalake-store==0.0.49
azure-graphrbac==0.60.0
azure-identity==1.6.1
azure-keyvault-administration==4.0.0b3
azure-keyvault-keys==4.5.0
azure-keyvault==1.1.0
Expand Down
1 change: 0 additions & 1 deletion src/azure-cli/requirements.py3.windows.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ azure-cosmos==3.2.0
azure-data-tables==12.2.0
azure-datalake-store==0.0.49
azure-graphrbac==0.60.0
azure-identity==1.6.1
azure-keyvault-administration==4.0.0b3
azure-keyvault-keys==4.5.0
azure-keyvault==1.1.0
Expand Down
1 change: 0 additions & 1 deletion src/azure-cli/setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@
'azure-data-tables==12.2.0',
'azure-datalake-store~=0.0.49',
'azure-graphrbac~=0.60.0',
'azure-identity',
'azure-keyvault-administration==4.0.0b3',
'azure-keyvault-keys==4.5.0',
'azure-keyvault~=1.1.0',
Expand Down