Azure Purview Scanning-klientbibliotek för Python – version 1.0.0b2

Artikel
04/05/2023

Azure Purview Scanning är en fullständigt hanterad molntjänst vars användare kan genomsöka dina data till din dataegendom (även kallad din katalog). Genomsökning är en process där katalogen ansluter direkt till en datakälla enligt ett användarspecifikt schema.

Sök igenom dina data i katalogen
Granska dina data
Extrahera scheman från dina data

Förlita dig starkt på tjänstens dokumentation och våra klientdokument för att använda det här biblioteket

Källkod | Paket (PyPI) | API-referensdokumentation| Produktdokumentation

Friskrivning

Stöd för Azure SDK Python-paket för Python 2.7 upphör den 1 januari 2022. Mer information och frågor finns i https://github.com/Azure/azure-sdk-for-python/issues/20691

Komma igång

Förutsättningar

Python 2.7 eller 3.6 eller senare krävs för att använda det här paketet.
Du måste ha en Azure-prenumeration och en Purview för att kunna använda det här paketet.

Skapa en Purview-resurs

Följ de här anvisningarna för att skapa din Purview-resurs

Installera paketet

Installera Azure Purview Scanning-klientbiblioteket för Python med pip:

pip install azure-purview-scanning

Autentisera klienten

Om du vill använda en AAD-tokenautentisering (Azure Active Directory) anger du en instans av önskad typ av autentiseringsuppgifter som hämtats från azure-identity-biblioteket .

Om du vill autentisera med AAD måste du först installera azure-identity och aktivera AAD-autentisering på purview-resursen

Efter installationen kan du välja vilken typ av autentiseringsuppgifter från azure.identity som ska användas. Till exempel kan DefaultAzureCredential användas för att autentisera klienten:

Ange värdena för klient-ID, klient-ID och klienthemlighet för AAD-programmet som miljövariabler: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET

Använd den returnerade tokenautentiseringsuppgiften för att autentisera klienten:

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)

Viktiga begrepp

Client

Det här paketet erbjuder byggare av begäranden så att du kan skapa http-begäranden och skicka dessa begäranden till tjänsten med hjälp av send_request metoden . Mer information om hur du använder byggare av begäranden och våra klienter finns här.

Exempel

I följande avsnitt visas hur du initierar och autentiserar klienten och sedan visar en lista över alla dina datakällor.

Visa en lista över alla datakällor

Visa en lista över alla datakällor

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)

Felsökning

Allmänt

Purview Scanning-klienten genererar undantag som definierats i [Azure Core][azure_core] om du anropar .raise_for_status() dina svar.

Loggning

Det här biblioteket använder standardloggningsbiblioteket för loggning. Grundläggande information om HTTP-sessioner (URL:er, rubriker osv.) loggas på INFO-nivå.

Detaljerad loggning på FELSÖKNINGsnivå, inklusive begärande-/svarskroppar och oredigerade huvuden, kan aktiveras på en klient med nyckelordsargumentet 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 På samma sätt kan du aktivera detaljerad loggning för ett enda send_request anrop, även om det inte är aktiverat för klienten:

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

Nästa steg

Mer allmänna exempel finns i våra klientdokument.

Bidra

Det här projektet välkomnar bidrag och förslag. Merparten av bidragen kräver att du godkänner ett licensavtal för bidrag, där du deklarerar att du har behörighet att bevilja oss rättigheten att använda ditt bidrag, och att du dessutom uttryckligen gör så. Mer information finns i cla.microsoft.com.

När du skickar en pull-förfrågan avgör en CLA-robot automatiskt om du måste tillhandahålla ett licensavtal för bidrag med lämplig PR (t.ex. etikett eller kommentar). Följ bara robotens anvisningar. Du behöver bara göra detta en gång för alla repor som använder vårt licensavtal för bidrag.

Det här projektet använder sig av Microsofts uppförandekod för öppen källkod. Mer information finns i Vanliga frågor och svar om uppförandekod eller kontakt opencode@microsoft.com med ytterligare frågor eller kommentarer.

Share via