Source code for

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.
from __future__ import annotations

import warnings
from typing import Any

from azure.common.client_factory import get_client_from_auth_file, get_client_from_json_dict
from azure.common.credentials import ServicePrincipalCredentials

from airflow.exceptions import AirflowException, AirflowProviderDeprecationWarning
from airflow.hooks.base import BaseHook
from import (

[docs]class AzureBaseHook(BaseHook): """ This hook acts as a base hook for azure services. It offers several authentication mechanisms to authenticate the client library used for upstream azure hooks. :param sdk_client: The SDKClient to use. :param conn_id: The :ref:`Azure connection id<howto/connection:azure>` which refers to the information to connect to the service. """
[docs] conn_name_attr = "azure_conn_id"
[docs] default_conn_name = "azure_default"
[docs] conn_type = "azure"
[docs] hook_name = "Azure"
@classmethod @add_managed_identity_connection_widgets
[docs] def get_connection_form_widgets(cls) -> dict[str, Any]: """Return connection widgets to add to connection form.""" from flask_appbuilder.fieldwidgets import BS3TextFieldWidget from flask_babel import lazy_gettext from wtforms import StringField return { "tenantId": StringField(lazy_gettext("Azure Tenant ID"), widget=BS3TextFieldWidget()), "subscriptionId": StringField(lazy_gettext("Azure Subscription ID"), widget=BS3TextFieldWidget()), }
[docs] def get_ui_field_behaviour(cls) -> dict[str, Any]: """Return custom field behaviour.""" import json return { "hidden_fields": ["schema", "port", "host"], "relabeling": { "login": "Azure Client ID", "password": "Azure Secret", }, "placeholders": { "extra": json.dumps( { "key_path": "path to json file for auth", "key_json": "specifies json dict for auth", }, indent=1, ), "login": "client_id (token credentials auth)", "password": "secret (token credentials auth)", "tenantId": "tenantId (token credentials auth)", "subscriptionId": "subscriptionId (token credentials auth)", }, }
def __init__(self, sdk_client: Any, conn_id: str = "azure_default"): self.sdk_client = sdk_client self.conn_id = conn_id super().__init__()
[docs] def get_conn(self) -> Any: """ Authenticate the resource using the connection id passed during init. :return: the authenticated client. """ conn = self.get_connection(self.conn_id) tenant = conn.extra_dejson.get("tenantId") if not tenant and conn.extra_dejson.get("extra__azure__tenantId"): warnings.warn( "`extra__azure__tenantId` is deprecated in azure connection extra, " "please use `tenantId` instead", AirflowProviderDeprecationWarning, stacklevel=2, ) tenant = conn.extra_dejson.get("extra__azure__tenantId") subscription_id = conn.extra_dejson.get("subscriptionId") if not subscription_id and conn.extra_dejson.get("extra__azure__subscriptionId"): warnings.warn( "`extra__azure__subscriptionId` is deprecated in azure connection extra, " "please use `subscriptionId` instead", AirflowProviderDeprecationWarning, stacklevel=2, ) subscription_id = conn.extra_dejson.get("extra__azure__subscriptionId") key_path = conn.extra_dejson.get("key_path") if key_path: if not key_path.endswith(".json"): raise AirflowException("Unrecognised extension for key file.")"Getting connection using a JSON key file.") return get_client_from_auth_file(client_class=self.sdk_client, auth_path=key_path) key_json = conn.extra_dejson.get("key_json") if key_json:"Getting connection using a JSON config.") return get_client_from_json_dict(client_class=self.sdk_client, config_dict=key_json) credentials: ServicePrincipalCredentials | AzureIdentityCredentialAdapter if all([conn.login, conn.password, tenant]):"Getting connection using specific credentials and subscription_id.") credentials = ServicePrincipalCredentials( client_id=conn.login, secret=conn.password, tenant=tenant ) else:"Using DefaultAzureCredential as credential") managed_identity_client_id = conn.extra_dejson.get("managed_identity_client_id") workload_identity_tenant_id = conn.extra_dejson.get("workload_identity_tenant_id") credentials = AzureIdentityCredentialAdapter( managed_identity_client_id=managed_identity_client_id, workload_identity_tenant_id=workload_identity_tenant_id, ) return self.sdk_client( credentials=credentials, subscription_id=subscription_id, )

Was this entry helpful?