Skip to content

Getting Started

Welcome to the Purview Unified SDK.

This guide walks you through everything required to start working with Microsoft Purview Unified Catalog using Python.

Whether you are using the SDK for the first time or integrating it into an existing application, the following guides will help you get started quickly.

Before You Begin

Before using the SDK, ensure that you have:

  • Python 3.10 or later
  • Access to Microsoft Purview Unified Catalog
  • A Microsoft Entra ID account
  • Appropriate permissions to access Microsoft Purview APIs

Learning Path

We recommend reading the documentation in the following order.

1. Installation

Install the SDK from the Python Package Index (PyPI) and verify that your Python environment is correctly configured.

2. Authentication

Learn how the SDK authenticates with Microsoft Entra ID and how to configure your Microsoft account.

3. Configuration

Create a PurviewConfig object and configure your application.

4. Quick Start

Run your first SDK program and retrieve data from Microsoft Purview Unified Catalog.

Next Steps

After completing the Getting Started guide, continue with the User Guide to learn how to work with:

  • Business Domains
  • Data Products
  • Glossary Terms
  • Critical Data Elements
  • Data Map Resources
  • Relationships

➡️ Next: Installation