Python 用 Azure Purview スキャン クライアント ライブラリ - バージョン 1.0.0b2

Azure Purview Scanning は、ユーザーがデータ資産 ( カタログとも呼ばれます) にデータをスキャンできるフル マネージド クラウド サービスです。 スキャンは、ユーザー指定のスケジュールに従ってカタログが直接データ ソースに接続するプロセスです。

• データをカタログにスキャンする
• データを調べる
• データからスキーマを抽出する

このライブラリを使用するには、 サービスのドキュメント と クライアント ドキュメント に大きく依存してください

ソースコード | パッケージ (PyPI) | API リファレンス ドキュメント| 製品ドキュメント

免責事項

Python 2.7 に対する Azure SDK Python パッケージのサポートは、2022 年 1 月 1 日に終了します。 詳細と質問については、https://github.com/Azure/azure-sdk-for-python/issues/20691 を参照してください

作業の開始

前提条件

• このパッケージを使用するには、Python 2.7 または3.6 以降が必要です。
• このパッケージを使用するには、 Azure サブスクリプション と Purview が必要です。

Purview リソースを作成する

次の手順に従って Purview リソースを作成します

パッケージをインストールする

pip を使用して Python 用 Azure Purview Scanning クライアント ライブラリをインストールします。

pip install azure-purview-scanning

クライアントを認証する

Azure Active Directory (AAD) トークン資格情報を使用するには、azure-identity ライブラリから取得した目的の資格情報の種類のインスタンスを指定します。

AAD で認証するには、まず Purview リソースで AAD 認証をインストールazure-identityして有効にする必要があります

セットアップ後、使用する azure.identity から 資格情報 の種類を選択できます。 たとえば、 DefaultAzureCredential を使用してクライアントを認証できます。

AAD アプリケーションのクライアント ID、テナント ID、クライアント シークレットの値を環境変数として設定します(AZURE_CLIENT_ID、AZURE_TENANT_ID、AZURE_CLIENT_SECRET

返されたトークン資格情報を使用してクライアントを認証します。

from azure.purview.scanning import PurviewScanningClient
from azure.identity import DefaultAzureCredential

credential = DefaultAzureCredential()
client = PurviewScanningClient(endpoint="https://<my-account-name>.scan.purview.azure.com", credential=credential)

主要な概念

Client

このパッケージは、http 要求をビルドし、 メソッドを使用してこれらの要求をサービスに送信できるように、要求ビルダーを send_request 提供します。 要求ビルダーとクライアントの使用方法の詳細については、 こちらを参照してください。

例

次のセクションでは、クライアントを初期化して認証し、すべてのデータ ソースを一覧表示する方法について説明します。

• すべてのデータ ソースを一覧表示する

すべてのデータ ソースを一覧表示する

from azure.purview.scanning import PurviewScanningClient
from azure.identity import DefaultAzureCredential
from azure.core.exceptions import HttpResponseError

credential = DefaultAzureCredential()
client = PurviewScanningClient(endpoint="https://<my-account-name>.scan.purview.azure.com", credential=credential)
try:
    response = client.data_sources.list_all()
    result = [item for item in response]
    print(result)
except HttpResponseError as e:
    print(e)

トラブルシューティング

全般

応答で を呼び出 .raise_for_status() すと、[Azure Core][azure_core] で定義されている例外が Purview Scanning クライアントによって発生します。

ログの記録

このライブラリでは、標準の ログ記録 ライブラリを使用してログを記録します。 HTTP セッション (URL、ヘッダーなど) に関する基本情報は INFO レベルでログに記録されます。

要求/応答本文と編集されていないヘッダーを含む詳細なデバッグ レベルのログ記録は、次のように logging_enable キーワード引数を使用してクライアントで有効にすることができます。

import sys
import logging
from azure.identity import DefaultAzureCredential
from azure.purview.scanning import PurviewScanningClient

# Create a logger for the 'azure' SDK
logger = logging.getLogger('azure')
logger.setLevel(logging.DEBUG)

# Configure a console output
handler = logging.StreamHandler(stream=sys.stdout)
logger.addHandler(handler)

endpoint = "https://<my-account-name>.scan.purview.azure.com"
credential = DefaultAzureCredential()

# This client will log detailed information about its HTTP sessions, at DEBUG level
client = PurviewScanningClient(endpoint=endpoint, credential=credential, logging_enable=True)

同様に、 logging_enable クライアントで有効になっていない場合でも、1 回 send_request の呼び出しに対して詳細なログ記録を有効にすることができます。

result = client.data_sources.list_all(logging_enable=True)

次のステップ

一般的なサンプルについては、 クライアント ドキュメントを参照してください。

共同作成

このプロジェクトでは、共同作成と提案を歓迎しています。 ほとんどの共同作成では、共同作成者使用許諾契約書 (CLA) にご同意いただき、ご自身の共同作成内容を使用する権利を Microsoft に供与する権利をお持ちであり、かつ実際に供与することを宣言していただく必要があります。 詳細については、「 cla.microsoft.com」を参照してください。

pull request を送信すると、CLA を提供して PR (ラベル、コメントなど) を適宜装飾する必要があるかどうかを CLA ボットが自動的に決定します。 ボットによって提供される手順にそのまま従ってください。 この操作は、Microsoft の CLA を使用するすべてのリポジトリについて、1 回だけ行う必要があります。

このプロジェクトでは、Microsoft オープン ソースの倫理規定を採用しています。 詳しくは、「Code of Conduct FAQ (倫理規定についてよくある質問)」を参照するか、opencode@microsoft.com 宛てに質問またはコメントをお送りください。