SQLAlchemy ORM を使って、Python でAzure Active Directory データに連携する方法

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

Pythonエコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for AzureAD は、pandas、Matplotlib モジュール、SQLAlchemy ツールキットから使用することで Azure Active Directory にデータ連携するPython アプリケーションを構築し、Azure Active Directory データを可視化できます。 本記事では、SQLAlchemy でAzure Active Directory に連携して、データを取得、、更新、挿入、削除 する方法を説明します。

CData Python Connectors の特徴

CData Python Connectors は、以下のような特徴を持った製品です。

1. Azure Active Directory をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
2. Python をはじめとする多様なデータ分析・BI ツールにAzure Active Directory データを連携
3. ノーコードでの手軽な接続設定

CData Python Connectors では、1.データソースとしてAzure Active Directory の接続を設定、2.Python からPython Connectors との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

必要なモジュールのインストール

pip でSQLAlchemy ツールキットをインストールします：

pip install sqlalchemy

モジュールのインポートを忘れずに行います：

import sqlalchemy

Python でAzure Active Directory データをモデル化

次は、接続文字列で接続を確立します。create_engine 関数を使って、Azure Active Directory データに連携するEngne を作成します。

engine = create_engine("azuread///?OAuthClientId=MyApplicationId&OAuthClientSecret=MySecretKey&CallbackURL=http://localhost:33333&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

Azure Active Directory はOAuth 認証を使用します。OAuth で認証するには、OAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティを取得するアプリを作成する必要があります。認証手順は、ヘルプドキュメントのOAuth セクションを参照してください。

Azure Active Directory データのマッピングクラスの宣言

接続を確立したら、OR マッパーでモデル化するテーブルのマッピングクラスを宣言します。本記事では、Domains テーブルを使います。sqlalchemy.ext.declarative.declarative_base 関数を使って、新しいクラスにフィールド（カラム）を定義します。

base = declarative_base()
class Domains(base):
	__tablename__ = "Domains"
	id = Column(String,primary_key=True)
	availabilityStatus = Column(String)
	...

Azure Active Directory データをクエリ

マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションにEngine をバインドして、セッションのquery メソッドにマッピングクラスを提供します。

query メソッドを使う

engine = create_engine("azuread///?OAuthClientId=MyApplicationId&OAuthClientSecret=MySecretKey&CallbackURL=http://localhost:33333&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Domains).filter_by(isVerified="TRUE"):
	print("id: ", instance.id)
	print("availabilityStatus: ", instance.availabilityStatus)
	print("---------")

ほかの方法としては、execute メソッドを適切なテーブルオブジェクトに使うことが可能です。以下のコードはアクティブなsession に対して有効です。

execute メソッドを使う

Domains_table = Domains.metadata.tables["Domains"]
for instance in session.execute(Domains_table.select().where(Domains_table.c.isVerified == "TRUE")):
	print("id: ", instance.id)
	print("availabilityStatus: ", instance.availabilityStatus)
	print("---------")

より複雑なクエリとして、JOIN、集計、Limit などが利用可能です。詳細はヘルプドキュメントをご覧ください。

Azure Active Directory データの挿入（INSERT）

Azure Active Directory データへの挿入には、マップされたクラスのインスタンスを定義し、アクティブな session に追加します。commit 関数を呼び出して、Azure Active Directory にすべての追加インスタンスを送ります。

new_rec = Domains(id="placeholder", isVerified="TRUE")
session.add(new_rec)
session.commit()

Azure Active Directory データを更新（UPDATE）

Azure Active Directory データの更新には、更新するレコードをフィルタクエリとともにフェッチします。そして、フィールドの値を変更し、セッションでcommit 関数を呼んで、Azure Active Directory にレコードを追加します。

updated_rec = session.query(Domains).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.isVerified = "TRUE"
session.commit()

Azure Active Directory データを削除（DELETE）

Azure Active Directory データの削除には、フィルタクエリと一緒に対象となるレコードをフェッチします。そして、アクティブsession でレコードを削除し、セッションでcommit 関数を呼び出して、該当するレコードの削除を実行します。

deleted_rec = session.query(Domains).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
session.delete(deleted_rec)
session.commit()

Azure Active Directory からPython へのデータ連携には、ぜひCData Python Connector をご利用ください

このようにCData Python Connector と併用することで、270を超えるSaaS、NoSQL データをPython からコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

日本のユーザー向けにCData Python Connector は、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。