Azure Purview Datamap client library for Python - version 1.0.0b1

Article
03/06/2024

Microsoft Purview Data Map provides the foundation for data discovery and data governance. Microsoft Purview Data Map is a cloud native PaaS service that captures metadata about enterprise data present in analytics and operation systems on-premises and cloud. DataMapClient provides a set of APIs in the Purview Data Map service. For a full list of APIs, please refer to Data Map API.

Getting started

Installing the package

python -m pip install azure-purview-datamap

Prequisites

Python 3.8 or later is required to use this package.
You need an Azure subscription to use this package.
An existing Azure Purview Datamap instance.

Create with an Azure Active Directory Credential

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

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.datamap import DataMapClient
>>> from azure.identity import DefaultAzureCredential
>>> client = DataMapClient(endpoint='<endpoint>', credential=DefaultAzureCredential())

Key concepts

Client

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.

Examples

>>> from azure.purview.datamap import DataMapClient
>>> from azure.identity import DefaultAzureCredential
>>> from azure.core.exceptions import HttpResponseError

>>> client = DataMapClient(endpoint='<endpoint>', credential=DefaultAzureCredential())
>>> try:
        client.type_definition.get()
    except HttpResponseError as e:
        print('service responds error: {}'.format(e.response.json()))

Troubleshooting

Next steps

For more generic samples, see our client docs.

Contributing

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 https://cla.microsoft.com.

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 opencode@microsoft.com with any additional questions or comments.

Partager via