Udostępnij za pośrednictwem


Biblioteka klienta administracji usługi Azure Purview dla języka Python — wersja 1.0.0b1

Azure Purview to w pełni zarządzana usługa w chmurze.

W dużej mierze polegaj na dokumentacji usługi , aby korzystać z tej biblioteki

Kod | źródłowy Pakiet (PyPI) | Dokumentacja referencyjna interfejsu| API Dokumentacja produktu

Zrzeczenie odpowiedzialności

Obsługa pakietów języka Python zestawu Azure SDK dla języka Python 2.7 kończy się 01 stycznia 2022 r. Aby uzyskać więcej informacji i pytań, zapoznaj się z artykułem https://github.com/Azure/azure-sdk-for-python/issues/20691

Wprowadzenie

Wymagania wstępne

  • Do korzystania z tego pakietu wymagany jest język Python w wersji 2.7 lub 3.6 lub nowszej.
  • Aby korzystać z tego pakietu, musisz mieć subskrypcję platformy Azure i usługę Purview .

Tworzenie zasobu usługi Purview

Postępuj zgodnie z tymi instrukcjami, aby utworzyć zasób usługi Purview

Instalowanie pakietu

Zainstaluj bibliotekę klienta konta usługi Azure Purview dla języka Python przy użyciu narzędzia pip:

pip install azure-purview-administration

Uwierzytelnianie klienta

Aby użyć poświadczeń tokenu usługi Azure Active Directory (AAD), podaj wystąpienie żądanego typu poświadczeń uzyskanego z biblioteki azure-identity .

Aby uwierzytelnić się za pomocą usługi AAD, musisz najpierw zainstalowaćazure-identity i włączyć uwierzytelnianie usługi AAD w zasobie usługi Purview

Po skonfigurowaniu można wybrać typ poświadczeń z witryny azure.identity do użycia. Na przykład wartość DefaultAzureCredential może służyć do uwierzytelniania klienta:

Ustaw wartości identyfikatora klienta, identyfikatora dzierżawy i wpisu tajnego klienta aplikacji usługi AAD jako zmienne środowiskowe: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET

Użyj zwróconego poświadczenia tokenu, aby uwierzytelnić klienta:

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)

Kluczowe pojęcia

Klient

Pakiet zawiera dwa rodzaje klienta: PurviewAccountClient i PurviewMetadataPoliciesClient. Można ich używać z jednym pakietem zgodnie z wymaganiami.

Przykłady

W poniższej sekcji pokazano, jak zainicjować i uwierzytelnić klienta, a następnie wyświetlić listę wszystkich kluczy.

Pobieranie kluczy

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)

W poniższej sekcji pokazano, jak zainicjować i uwierzytelnić klienta, a następnie wyświetlić listę wszystkich ról.

Wyświetlanie listy ról

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)

Rozwiązywanie problemów

Ogólne

Klient usługi Purview zgłosi wyjątki, jeśli kod stanu odpowiedzi nie jest zdefiniowany.

Rejestrowanie

Ta biblioteka używa standardowej biblioteki rejestrowania do rejestrowania. Podstawowe informacje o sesjach HTTP (adresach URL, nagłówkach itp.) są rejestrowane na poziomie INFORMACJI.

Szczegółowe rejestrowanie na poziomie DEBUG, w tym treści żądań/odpowiedzi i nieredagowanych nagłówków, można włączyć na kliencie z argumentem logging_enable kluczowym:

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)

Podobnie może logging_enable włączyć szczegółowe rejestrowanie dla pojedynczego wywołania, nawet jeśli nie jest włączone dla klienta:

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

Następne kroki

Aby uzyskać więcej ogólnych przykładów, zobacz dokumentację klienta.

Współtworzenie

W tym projekcie zachęcamy do współtworzenia i zgłaszania sugestii. Współtworzenie w większości przypadków wymaga zgody na umowę licencyjną dotyczącą współautorów (CLA, Contributor License Agreement), zgodnie z którą współautor ma prawo udzielić i faktycznie udziela nam praw do używania wytworzonej przez siebie zawartości. Aby uzyskać szczegółowe informacje, odwiedź stronę cla.microsoft.com.

Po przesłaniu żądania ściągnięcia robot CLA automatycznie określi, czy musisz przekazać umowę CLA, i doda odpowiednie informacje do tego żądania (na przykład etykietę czy komentarz). Po prostu postępuj zgodnie z instrukcjami robota. Wystarczy zrobić to raz dla wszystkich repozytoriów, w przypadku których jest używana nasza umowa CLA.

W tym projekcie przyjęto Kodeks postępowania oprogramowania Open Source firmy Microsoft. Aby uzyskać więcej informacji, zobacz Często zadawane pytania dotyczące kodeksu postępowania lub skontaktuj się z opencode@microsoft.com dodatkowymi pytaniami lub komentarzami.