Share via

Azure Purview DataMap client library for .NET - version 1.0.0-beta.1

  • Article

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. Azure PurviewDataMap client provides a set of APIs in Purview Data Map Data Plane. For a full list of APIs, please refer to Data Map API.

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

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

Getting started

This section should include everything a developer needs to do to install and create their first client connection very quickly.

Install the package

Install the client library for .NET with NuGet:

dotnet add package Azure.Analytics.Purview.DataMap --prerelease

Prerequisites

Authenticate the client

Using Azure Active Directory

This document demonstrates using DefaultAzureCredential to authenticate via Azure Active Directory. However, any of the credentials offered by the Azure.Identity will be accepted. See the Azure.Identity documentation for more information about other credentials.

Once you have chosen and configured your credential, you can create instances of the DataMapClient.

var credential = new DefaultAzureCredential();
var client = new DataMapClient(new Uri("https://<my-account-name>.purview.azure.com"), credential);

Key concepts

Protocol Methods

Operations exposed by the Purview Catalog SDK for .NET use protocol methods to expose the underlying REST operations. You can learn more about how to use SDK Clients which use protocol methods in our documentation.

Thread safety

We guarantee that all client instance methods are thread-safe and independent of each other (guideline). This ensures that the recommendation of reusing client instances is always safe, even across threads.

Additional concepts

Client options | Accessing the response | Long-running operations | Handling failures | Diagnostics | Mocking | Client lifetime

Examples

The following section shows you how to initialize and authenticate your client, then get type definition by name.

Create Data Map Client

Uri endpoint = TestEnvironment.Endpoint;
TokenCredential credential = new DefaultAzureCredential();
DataMapClient dataMapClient = new DataMapClient(endpoint, credential);

Get Type Definition By Name

TypeDefinition client = dataMapClient.GetTypeDefinitionClient();
Response response = client.GetByName("AtlasGlossary", null);

Get Type By Name Asynchronously

TypeDefinition client = dataMapClient.GetTypeDefinitionClient();
var response = await client.GetByNameAsync("AtlasGlossary", null);

Troubleshooting

Setting up console logging

The simplest way to see the logs is to enable the console logging. To create an Azure SDK log listener that outputs messages to console use AzureEventSourceListener.CreateConsoleLogger method.

// Setup a listener to monitor logged events.
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger();

To learn more about other logging mechanisms see here.

Next steps

This client SDK exposes operations using protocol methods, you can learn more about how to use SDK Clients which use protocol methods in our documentation.

Contributing

See the CONTRIBUTING.md for details on building, testing, and contributing to this library.

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 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.

Impressions