blob: 9b395f8edddee5923e0d8341fd99508f4262e674 [file] [log] [blame]
:mod:`airflow.providers.microsoft.azure.hooks.base_azure`
=========================================================
.. py:module:: airflow.providers.microsoft.azure.hooks.base_azure
Module Contents
---------------
.. py:class:: AzureBaseHook(sdk_client: Any, conn_id: str = 'azure_default')
Bases: :class:`airflow.hooks.base.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.
:type sdk_client: Optional[str]
:param conn_id: The :ref:`Azure connection id<howto/connection:azure>`
which refers to the information to connect to the service.
:type: str
.. attribute:: conn_name_attr
:annotation: = azure_conn_id
.. attribute:: default_conn_name
:annotation: = azure_default
.. attribute:: conn_type
:annotation: = azure
.. attribute:: hook_name
:annotation: = Azure
.. staticmethod:: get_connection_form_widgets()
Returns connection widgets to add to connection form
.. staticmethod:: get_ui_field_behaviour()
Returns custom field behaviour
.. method:: get_conn(self)
Authenticates the resource using the connection id passed during init.
:return: the authenticated client.