Skip to content

Purview Unified SDK

Purview Unified SDK is a Python SDK for Microsoft Purview Unified Catalog.

It provides a simple and consistent Python interface for automating Microsoft Purview operations, including Business Domains, Data Products, Glossary Terms, Critical Data Elements (CDEs), Data Assets, Data Columns, Policies, Objectives and Key Results (OKRs), and resource relationships.

Whether you're building governance automation, migrating metadata, or integrating Microsoft Purview into your own applications, the SDK helps you work with the Unified Catalog through clean, reusable Python code.

Why Purview Unified SDK?

Building automation with the Microsoft Purview REST APIs often requires handling authentication, pagination, request formatting, resource relationships, and other API-specific details before you can focus on your actual governance tasks.

Purview Unified SDK abstracts these complexities behind a clean, consistent, and Pythonic interface, allowing you to spend less time writing infrastructure code and more time automating Microsoft Purview.

Key Features

  • ✅ Unified programming model across multiple Microsoft Purview resource types
  • ✅ Simple and intuitive Python APIs for common governance operations
  • ✅ Built-in authentication support
  • ✅ Automatic pagination for list operations
  • ✅ Consistent relationship management across supported resources
  • ✅ Strongly typed resource models
  • ✅ Comprehensive documentation and runnable examples
  • ✅ Designed for governance automation, reporting, and system migration workflows

Currently Supported

  • Business Domains
  • Data Products
  • Glossary Terms
  • Critical Data Elements (CDEs)
  • Data Assets
  • Data Columns
  • Objectives and Key Results (OKRs)
  • Policies
  • Resource Relationships
  • Data Map

Unlike scripts that target a single endpoint, Purview Unified SDK provides a unified programming model across multiple Microsoft Purview resource types, making it easier to build automation workflows that span the entire Unified Catalog.

Get started View the user guide Browse the API reference

Installation

Install the latest release from the Python Package Index:

pip install purview-unified-sdk

Import the SDK in Python:

from purview import PurviewClient, PurviewConfig

Quick Start

import os

from purview import PurviewClient, PurviewConfig

config = PurviewConfig(
    tenant_id=os.environ["PURVIEW_TENANT_ID"],
)

with PurviewClient(
    config,
    username=os.environ["PURVIEW_USERNAME"],
) as client:
    domains = client.domains.list_all()

for domain in domains:
    print(domain.name)

Read the full quick-start guide

Explore the Documentation

  • Getting Started

    Install the SDK, configure authentication, and run your first Microsoft Purview request.

    Get started

  • User Guide

    Learn how to work with Business Domains, Data Products, Glossary Terms, CDEs, Data Assets, Data Columns, OKRs, Policies, and Relationships.

    Open the user guide

  • Relationships

    Understand supported Microsoft Purview relationships, directionality, indirect associations, and validation status.

    Explore relationships

  • API Reference

    Review SDK clients, methods, parameters, return types, and model objects.

    Browse the API reference

  • Examples

    Explore runnable Python examples included in the repository.

    View examples on GitHub

Supported Resources

The SDK currently provides functionality for:

  • Business Domains
  • Data Products
  • Glossary Terms
  • Critical Data Elements
  • Data Assets
  • Data Columns
  • Objectives and Key Results
  • Policies
  • Resource relationships
  • Resource property retrieval

Package and Import Names

The PyPI distribution name is:

purview-unified-sdk

The Python import package is:

import purview

Therefore, install the package using:

pip install purview-unified-sdk

Then import its public classes using:

from purview import PurviewClient, PurviewConfig

Documentation Status

This documentation is being expanded alongside the SDK.

Validated behavior, supported relationships, known limitations, and complete examples will be documented throughout the User Guide and API Reference.

About

Purview Unified SDK is an open-source Python SDK for Microsoft Purview Unified Catalog, developed and maintained by Niki Zheng.

Contact

If you have questions, suggestions, or would like to report an issue, feel free to get in touch.

Contributions, feature requests, and bug reports are always welcome.

License

This project is released under the MIT License.