Compartir a través de

Biblioteca cliente de administración de Azure Purview para Python: versión 1.0.0b1

  • Artículo

Azure Purview es un servicio en la nube totalmente administrado.

Confíe en gran medida en la documentación del servicio para usar esta biblioteca.

Código | fuente Paquete (PyPI) | Documentación | de referencia de APIDocumentación del producto

Declinación de responsabilidades

La compatibilidad con paquetes de Python del SDK de Azure para Python 2.7 finaliza el 1 de enero de 2022. Para más información y preguntas, consulte https://github.com/Azure/azure-sdk-for-python/issues/20691.

Introducción

Requisitos previos

Creación de un recurso de Purview

Siga estas instrucciones para crear el recurso de Purview.

Instalar el paquete

Instale la biblioteca cliente de la cuenta de Azure Purview para Python con pip:

pip install azure-purview-administration

Autenticar el cliente

Para usar una credencial de token de Azure Active Directory (AAD), proporcione una instancia del tipo de credencial deseado obtenido de la biblioteca azure-identity .

Para autenticarse con AAD, primero debe instalarazure-identity pip y habilitar la autenticación de AAD en el recurso de Purview.

Después de la instalación, puede elegir el tipo de credencial de azure.identity que se va a usar. Por ejemplo, Se puede usar DefaultAzureCredential para autenticar al cliente:

Establezca los valores del identificador de cliente, el identificador de inquilino y el secreto de cliente de la aplicación de AAD como variables de entorno: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET

Use la credencial de token devuelta para autenticar al cliente:

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)

Conceptos clave

Remoto

El paquete contiene dos tipos de cliente: PurviewAccountClient y PurviewMetadataPoliciesClient. Puede usarlos con un paquete según sus requisitos.

Ejemplos

En la sección siguiente se muestra cómo inicializar y autenticar el cliente y, a continuación, enumerar todas las claves.

Obtención de claves

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)

En la sección siguiente se muestra cómo inicializar y autenticar el cliente y, a continuación, enumerar todos los roles.

Enumerar 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)

Solución de problemas

General

El cliente de Purview generará excepciones si no se define el código de estado de las respuestas.

Registro

Esta biblioteca usa la biblioteca de registro estándar para el registro. La información básica sobre las sesiones HTTP (direcciones URL, encabezados, etc.) se registra en el nivel INFO.

El registro detallado del nivel de depuración, incluidos los cuerpos de solicitud y respuesta, y los encabezados no redactados, se puede habilitar en un cliente con el argumento de palabra clave 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)

Del mismo modo, logging_enable puede habilitar el registro detallado para una sola llamada, incluso cuando no está habilitado para el cliente:

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

Pasos siguientes

Para obtener ejemplos más genéricos, consulte nuestros documentos de cliente.

Contribuciones

Este proyecto agradece las contribuciones y sugerencias. La mayoría de las contribuciones requieren que acepte un Contrato de licencia para el colaborador (CLA) que declara que tiene el derecho a concedernos y nos concede los derechos para usar su contribución. Para obtener más información, visite cla.microsoft.com.

Cuando se envía una solicitud de incorporación de cambios, un bot de CLA determinará de forma automática si tiene que aportar un CLA y completar la PR adecuadamente (por ejemplo, la etiqueta, el comentario). Solo siga las instrucciones que le dará el bot. Solo será necesario que lo haga una vez en todos los repositorios con nuestro CLA.

Este proyecto ha adoptado el Código de conducta de Microsoft Open Source. Para más información, consulte las preguntas más frecuentes del código de conducta o póngase en contacto con opencode@microsoft.com si tiene cualquier otra pregunta o comentario.