Share via

Azure Purview-Verwaltungsclientbibliothek für Python– Version 1.0.0b1

  • Artikel

Azure Purview ist ein vollständig verwalteter Clouddienst.

Verlassen Sie sich bei der Verwendung dieser Bibliothek stark auf die Dokumentation des Diensts .

Quellcode | Paket (PyPI) | API-Referenzdokumentation| Produktdokumentation

Haftungsausschluss

Die Unterstützung von Azure SDK-Python-Paketen für Python 2.7 endet am 1. Januar 2022. Weitere Informationen und Antworten finden Sie unter https://github.com/Azure/azure-sdk-for-python/issues/20691.

Erste Schritte

Voraussetzungen

  • Für die Verwendung dieses Pakets ist Python 2.7 bzw. 3.6 oder höher erforderlich.
  • Sie müssen über ein Azure-Abonnement und eine Purview verfügen, um dieses Paket verwenden zu können.

Erstellen einer Purview-Ressource

Befolgen Sie diese Anweisungen, um Ihre Purview-Ressource zu erstellen.

Installieren des Pakets

Installieren Sie die Clientbibliothek des Azure Purview-Kontos für Python mit pip:

pip install azure-purview-administration

Authentifizieren des Clients

Um Anmeldeinformationen für Azure Active Directory-Token (AAD) zu verwenden, geben Sie eine Instanz des gewünschten Anmeldeinformationstyps an, der aus der azure-identity-Bibliothek abgerufen wird.

Um sich bei AAD zu authentifizieren, müssen Sie zuerst pip installieren azure-identity und die AAD-Authentifizierung für Ihre Purview-Ressource aktivieren.

Nach dem Setup können Sie auswählen, welche Art von Anmeldeinformationen aus azure.identity verwendet werden soll. Beispielsweise kann DefaultAzureCredential verwendet werden, um den Client zu authentifizieren:

Legen Sie die Werte der Client-ID, mandanten-ID und des geheimen Clientschlüssels der AAD-Anwendung als Umgebungsvariablen fest: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET

Verwenden Sie die zurückgegebenen Tokenanmeldeinformationen, um den Client zu authentifizieren:

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)

Wichtige Begriffe

Client

Das Paket enthält zwei Arten von Client: PurviewAccountClient und PurviewMetadataPoliciesClient. Sie können sie gemäß Ihren Anforderungen mit einem Paket verwenden.

Beispiele

Im folgenden Abschnitt wird gezeigt, wie Sie Ihren Client initialisieren und authentifizieren und dann alle Schlüssel auflisten.

Abrufen von Schlüsseln

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)

Im folgenden Abschnitt wird gezeigt, wie Sie Ihren Client initialisieren und authentifizieren und dann alle Rollen auflisten.

Auflisten von Rollen

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)

Problembehandlung

Allgemein

Der Purview-Client löst Ausnahmen aus, wenn der Statuscode Ihrer Antworten nicht definiert ist.

Protokollierung

Diese Bibliothek verwendet die Standardprotokollbibliothek für die Protokollierung. Grundlegende Informationen zu HTTP-Sitzungen (URLs, Header usw.) werden auf INFO-Ebene protokolliert.

Eine ausführliche Protokollierung auf der Ebene DEBUG, einschließlich Anforderungs-/Antworttexten und vollständiger Header, kann auf einem Client mit dem Schlüsselwortargument logging_enable aktiviert werden:

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 Auf ähnliche Weise kann die detaillierte Protokollierung für einen einzelnen Aufruf aktiviert werden, auch wenn sie für den Client nicht aktiviert ist:

result = client.accounts.get_access_keys(logging_enable=True)

Nächste Schritte

Weitere generische Beispiele finden Sie in unserer Clientdokumentation.

Mitwirken

Beiträge und Vorschläge für dieses Projekt sind willkommen. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. Weitere Informationen finden Sie unter cla.microsoft.com.

Wenn Sie einen Pull Request (PR) übermitteln, überprüft ein CLA-Bot automatisch, ob Sie eine Lizenzvereinbarung bereitstellen und den PR entsprechend ergänzen müssen (z.B. mit einer Bezeichnung oder einem Kommentar). Führen Sie einfach die Anweisungen des Bots aus. Sie müssen dies nur einmal für alle Repositorys ausführen, die unsere CLA verwenden.

Für dieses Projekt gelten die Microsoft-Verhaltensregeln für Open Source (Microsoft Open Source Code of Conduct). Weitere Informationen finden Sie in den häufig gestellten Fragen zum Verhaltenskodex. Sie können sich auch an opencode@microsoft.com wenden, wenn Sie weitere Fragen oder Anmerkungen haben.