Skip to main content

Microsoft Azure Azure Purview Catalog Client Library for Python

Project description

Azure Purview Catalog client library for Python

Azure Purview Catalog is a fully managed cloud service whose users can discover the data sources they need and understand the data sources they find. At the same time, Data Catalog helps organizations get more value from their existing investments.

  • Search for data using technical or business terms
  • Browse associated technical, business, semantic, and operational metadata
  • Identify the sensitivity level of data.

Please rely heavily on the service's documentation and our client docs to use this library

Source code | Package (PyPI) | API reference documentation| Product documentation


Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to

Getting started


  • Python 3.6 or later is required to use this package.
  • You must have an Azure subscription and a Purview to use this package.

Create a Purview Resource

Follow these instructions to create your Purview resource

Install the package

Install the Azure Purview Catalog client library for Python with pip:

pip install azure-purview-catalog

Authenticate the client

To use an Azure Active Directory (AAD) token credential, provide an instance of the desired credential type obtained from the azure-identity library.

To authenticate with AAD, you must first pip install azure-identity and enable AAD authentication on your Purview resource

After setup, you can choose which type of credential from azure.identity to use. As an example, DefaultAzureCredential can be used to authenticate the client:

Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET

Use the returned token credential to authenticate the client:

from azure.purview.catalog import PurviewCatalogClient
from azure.identity import DefaultAzureCredential

credential = DefaultAzureCredential()
client = PurviewCatalogClient(endpoint="https://<my-account-name>", credential=credential)

Key concepts


This package offers request builders so you can build http requests and send these requests to the service using the send_request method. For more information on how to use request builders and our clients, see here.


The following section shows you how to initialize and authenticate your client, then get all of your type-defs.

Get All Type Definitions

from azure.purview.catalog import PurviewCatalogClient
from azure.identity import DefaultAzureCredential
from azure.core.exceptions import HttpResponseError

credential = DefaultAzureCredential()
client = PurviewCatalogClient(endpoint="https://<my-account-name>", credential=credential)
    response = client.types.get_all_type_definitions()
    # print out all of your entity definitions

except HttpResponseError as e:



The Purview Catalog client will raise exceptions defined in Azure Core if you call .raise_for_status() on your responses.


This library uses the standard logging library for logging. Basic information about HTTP sessions (URLs, headers, etc.) is logged at INFO level.

Detailed DEBUG level logging, including request/response bodies and unredacted headers, can be enabled on a client with the logging_enable keyword argument:

import sys
import logging
from azure.identity import DefaultAzureCredential
from azure.purview.catalog import PurviewCatalogClient

# Create a logger for the 'azure' SDK
logger = logging.getLogger('azure')

# Configure a console output
handler = logging.StreamHandler(stream=sys.stdout)

endpoint = "https://<my-account-name>"
credential = DefaultAzureCredential()

# This client will log detailed information about its HTTP sessions, at DEBUG level
client = PurviewCatalogClient(endpoint=endpoint, credential=credential, logging_enable=True)

Similarly, logging_enable can enable detailed logging for a single send_request call, even when it isn't enabled for the client:

result = client.types.get_all_type_definitions(logging_enable=True)

Next steps

For more generic samples, see our client docs.


This project welcomes contributions and suggestions. 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. For details, visit

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact with any additional questions or comments.

Release History

1.0.0b4 (2022-06-13)


  • Support Atlas 2.2 APIs

Bugs Fixed

  • Add missing query parameter includeTermHierarchy for update term API
  • Add missing query parameter excludeRelationshipTypes for get term API

1.0.0b3 (2022-03-15)

Bugs Fixed

  • Fix delete_by_guids to get rid of bad request error #22487

1.0.0b2 (2021-09-29)


  • Add convenience operations to client

Breaking changes

  • Remove rest layer and request builders(detailed description is in
  • The HttpRequest parameter to send_request has changed from http_request to request
  • Ordering of endpoint and credential params have changed

1.0.0b1 (2021-05-11)

  • This is the initial release of the Azure Purview Catalog library.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution (168.5 kB view hashes)

Uploaded Source

Built Distribution

azure_purview_catalog-1.0.0b4-py3-none-any.whl (154.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page