Edit

Python SDKs for Microsoft Discovery

Microsoft Discovery provides Python SDKs for data-plane and control-plane operations. Both packages are publicly available from the Python Package Index (PyPI) and can be integrated into Python applications.

SDK Package Use
Data plane azure-ai-discovery Interact with Microsoft Discovery resources and perform runtime operations, such as working with workspaces, investigations, tasks, tools, bookshelves, and knowledge bases.
Control plane azure-mgmt-discovery Provision, configure, and manage Microsoft Discovery resources through Azure Resource Manager (ARM).

Prerequisites

Before you use the SDKs, you need:

  • Python 3.10 or later.
  • An Azure subscription.
  • A Microsoft Entra identity with permissions for the operations that you want to perform.
  • For data-plane operations, an existing Microsoft Discovery workspace or bookshelf.
  • For control-plane operations, the Azure subscription ID that contains or will contain your Microsoft Discovery resources.

Install the SDKs

Install the data-plane SDK:

python -m pip install azure-ai-discovery

Install the control-plane SDK:

python -m pip install azure-mgmt-discovery

To authenticate with Microsoft Entra ID, install the Azure Identity client library:

python -m pip install azure-identity