Python 用 Azure Purview 管理クライアント ライブラリ - バージョン 1.0.0b1
Azure Purview はフル マネージド クラウド サービスです。
このライブラリを使用するには、 サービスのドキュメント に大きく依存してください
ソースコード | パッケージ (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 アカウント クライアント ライブラリをインストールします。
pip install azure-purview-administration
クライアントを認証する
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.administration.account import PurviewAccountClient
from azure.purview.administration.metadatapolicies import PurviewMetadataPoliciesClient
from azure.identity import DefaultAzureCredential
credential = DefaultAzureCredential()
endpoint = "https://<my-account-name>.purview.azure.com"
account_client = PurviewAccountClient(endpoint=endpoint, credential=credential)
metadatapolicy_client = PurviewMetadataPoliciesClient(endpoint=endpoint, credential=credential)
主要な概念
Client
パッケージには、 と PurviewMetadataPoliciesClientの 2 種類のクライアントPurviewAccountClientが含まれています。 要件に応じて、1 つのパッケージで使用できます。
例
次のセクションでは、クライアントを初期化して認証し、すべてのキーを一覧表示する方法を示します。
キーの取得
from azure.purview.administration.account import PurviewAccountClient
from azure.identity import DefaultAzureCredential
credential = DefaultAzureCredential()
client = PurviewAccountClient(endpoint="https://<my-account-name>.purview.azure.com", credential=credential)
response = client.accounts.get_access_keys()
print(response)
次のセクションでは、クライアントを初期化して認証し、すべてのロールを一覧表示する方法を示します。
ロールの一覧表示
from azure.purview.administration.metadatapolicies import PurviewMetadataPoliciesClient
from azure.identity import DefaultAzureCredential
credential = DefaultAzureCredential()
client = PurviewMetadataPoliciesClient(endpoint="https://<my-account-name>.purview.azure.com", credential=credential)
response = client.metadata_roles.list()
result = [item for item in response]
print(result)
トラブルシューティング
全般
応答の状態コードが定義されていない場合、Purview クライアントは例外を発生させます。
ログの記録
このライブラリでは、ログ記録に標準 のログ ライブラリが使用されます。 HTTP セッションに関する基本情報 (URL、ヘッダーなど) は INFO レベルでログに記録されます。
要求/応答本文と編集されていないヘッダーを含む詳細なデバッグ レベルのログ記録は、次のように logging_enable キーワード引数を使用してクライアントで有効にすることができます。
import sys
import logging
from azure.identity import DefaultAzureCredential
from azure.purview.administration.account import PurviewAccountClient
# 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>.purview.azure.com"
credential = DefaultAzureCredential()
# This client will log detailed information about its HTTP sessions, at DEBUG level
client = PurviewAccountClient(endpoint=endpoint, credential=credential, logging_enable=True)
同様に、 logging_enable クライアントで有効になっていない場合でも、1 回の呼び出しに対して詳細なログ記録を有効にすることができます。
result = client.accounts.get_access_keys(logging_enable=True)
次のステップ
その他の一般的なサンプルについては、 クライアント ドキュメントを参照してください。
共同作成
このプロジェクトでは、共同作成と提案を歓迎しています。 ほとんどの共同作成では、共同作成者使用許諾契約書 (CLA) にご同意いただき、ご自身の共同作成内容を使用する権利を Microsoft に供与する権利をお持ちであり、かつ実際に供与することを宣言していただく必要があります。 詳細については、「 cla.microsoft.com」を参照してください。
pull request を送信すると、CLA を提供して PR (ラベル、コメントなど) を適宜装飾する必要があるかどうかを CLA ボットが自動的に決定します。 ボットによって提供される手順にそのまま従ってください。 この操作は、Microsoft の CLA を使用するすべてのリポジトリについて、1 回だけ行う必要があります。
このプロジェクトでは、Microsoft オープン ソースの倫理規定を採用しています。 詳しくは、「Code of Conduct FAQ (倫理規定についてよくある質問)」を参照するか、opencode@microsoft.com 宛てに質問またはコメントをお送りください。
Azure SDK for Python