Azure Purview Catalog client library for .NET - version 1.0.0-beta.4

Article
04/17/2024

Azure Purview Catalog is a fully managed cloud service whose users can discover the data sources they need and understand the data sources they find. At the same time, Data Catalog helps organizations get more value from their existing investments.

Search for data using technical or business terms
Browse associated technical, business, semantic, and operational metadata
Identify the sensitivity level of data.

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

Source code | Package (NuGet) | Product documentation

Getting started

Install the package

Install the Azure Purview Catalog client library for .NET with NuGet:

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

Prerequisites

You must have an Azure subscription and a Purview resource to use this package.

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

var credential = new DefaultAzureCredential();
var client = new PurviewCatalogClient(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

Examples

The following section shows you how to initialize and authenticate your client, then get all of the type definitions in the catalog.

Get All Type Definitions

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

var response = await client.Types.GetAllTypeDefinitionsAsync();
var responseDocument = JsonDocument.Parse(response.Content);
Console.WriteLine(responseDocument.RootElement.GetProperty("entityDefs"));

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

Share via