Клиентская библиотека администрирования Azure Purview для Python, версия 1.0.0b1

Статья
04/05/2023

Azure Purview — это полностью управляемая облачная служба.

Чтобы использовать эту библиотеку, в значительной степени полагайтесь на документацию службы .

Исходный код | Пакет (PyPI) | Справочная документация по| API Документация по продукту

Заявление об отказе

Поддержка пакетов Python пакета Azure SDK для Python 2.7 заканчивается 1 января 2022 г. Дополнительные сведения и вопросы см. на https://github.com/Azure/azure-sdk-for-python/issues/20691

Начало работы

Предварительные требования

Для использования этого пакета требуется Python 2.7 или 3.6 (или более поздней версии).
Для использования этого пакета вам потребуется подписка Azure и Purview .

Создание ресурса Purview

Следуйте этим инструкциям, чтобы создать ресурс Purview.

Установка пакета

Установите клиентую библиотеку учетной записи Azure Purview для Python с помощью pip:

pip install azure-purview-administration

Аутентификация клиента

Чтобы использовать учетные данные маркера Azure Active Directory (AAD), укажите экземпляр нужного типа учетных данных, полученных из библиотеки azure-identity .

Для проверки подлинности с помощью AAD необходимо сначала установить azure-identity и включить проверку подлинности AAD в ресурсе Purview.

После настройки можно выбрать тип учетных данных из azure.identity для использования. Например, для проверки подлинности клиента можно использовать DefaultAzureCredential :

Задайте значения идентификатора клиента, идентификатора клиента и секрета клиента приложения AAD в качестве переменных среды: 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)

Основные понятия

Клиент

Пакет содержит два типа клиента: PurviewAccountClient и PurviewMetadataPoliciesClient. Их можно использовать с одним пакетом в соответствии с вашими требованиями.

Примеры

В следующем разделе показано, как инициализировать и проверить подлинность клиента, а затем перечислить все ключи.

Получение ключей

Получение ключей

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)

В следующем разделе показано, как инициализировать и проверить подлинность клиента, а затем перечислить все роли.

List_Roles

Перечисление ролей

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 можно включить в клиенте ведение журнала на уровне отладки (DEBUG), на котором фиксируются сведения о телах запросов и ответов, а также заголовки без изменений:

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 образом можно включить подробное ведение журнала для одного вызова, даже если он не включен для клиента:

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

Дальнейшие действия

Дополнительные универсальные примеры см. в нашей клиентской документации.

Участие

На этом проекте приветствуются публикации и предложения. Для участия в большинстве процессов по разработке документации необходимо принять лицензионное соглашение участника (CLA), в котором указывается, что вы предоставляете нам права на использование ваших публикаций. Дополнительные сведения см. на странице cla.microsoft.com.

При отправке запроса на включение внесенных изменений CLA-бот автоматически определит необходимость предоставления соглашения CLA и соответствующего оформления запроса на включение внесенных изменений (например, добавление метки, комментария). Просто следуйте инструкциям бота. Будет достаточно выполнить их один раз для всех репозиториев, поддерживающих соглашение CLA.

В рамках этого проекта действуют правила поведения в отношении продуктов с открытым исходным кодом Майкрософт. Дополнительные сведения см. в разделе часто задаваемых вопросов о правилах поведения или обратитесь к opencode@microsoft.com с любыми дополнительными вопросами или комментариями.

Поделиться через