Azure.Analytics.Purview.Scanning 1.0.0-beta.2

The ID prefix of this package has been reserved for one of the owners of this package by Prefix Reserved
.NET Standard 2.0
This is a prerelease version of Azure.Analytics.Purview.Scanning.
dotnet add package Azure.Analytics.Purview.Scanning --version 1.0.0-beta.2
NuGet\Install-Package Azure.Analytics.Purview.Scanning -Version 1.0.0-beta.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Azure.Analytics.Purview.Scanning" Version="1.0.0-beta.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Azure.Analytics.Purview.Scanning --version 1.0.0-beta.2
#r "nuget: Azure.Analytics.Purview.Scanning, 1.0.0-beta.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Azure.Analytics.Purview.Scanning as a Cake Addin
#addin nuget:?package=Azure.Analytics.Purview.Scanning&version=1.0.0-beta.2&prerelease

// Install Azure.Analytics.Purview.Scanning as a Cake Tool
#tool nuget:?package=Azure.Analytics.Purview.Scanning&version=1.0.0-beta.2&prerelease

Azure Purview Scanning client library for .NET

Azure Purview Scanning is a fully managed cloud service whose users can scan your data into your data estate (also known as your catalog). Scanning is a process by which the catalog connects directly to a data source on a user-specified schedule.

  • Scan your data into your catalog
  • Examine your data
  • Extract schemas from your 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 Scanning client library for .NET with NuGet:

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


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

var credential = new DefaultAzureCredential();
var client = new PurviewScanningClient(new Url("https://<my-account-name>"), credential);

Key concepts

Protocol Methods

Operations exposed by the Purview Scanning 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


The following section shows you how to initialize and authenticate your client, then list all of your data sources.

List All Data Sources

var credential = new DefaultAzureCredential();
var client = new PurviewScanningServiceClient(new Uri("https://<my-account-name>"), credential);

var response = await client.GetDataSourcesAsync();
var responseDocument = JsonDocument.Parse(response.Content);


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.


See the 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

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 with any additional questions or comments.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.0-beta.2 6,121 10/15/2021
1.0.0-beta.1 3,622 5/13/2021