From abf6c5ad5e9b48f5866b1fd5dae597eedcd3ba56 Mon Sep 17 00:00:00 2001 From: Matt Ellis Date: Tue, 11 May 2021 16:58:06 -0700 Subject: [PATCH] [Purview Scanning] Update README.md and CHANGELOG.md --- .../CHANGELOG.md | 7 +- .../README.md | 74 +++++++++++++++---- 2 files changed, 66 insertions(+), 15 deletions(-) diff --git a/sdk/purview/Azure.Analytics.Purview.Scanning/CHANGELOG.md b/sdk/purview/Azure.Analytics.Purview.Scanning/CHANGELOG.md index c0d06b1c26867..42e4b48b0bd24 100644 --- a/sdk/purview/Azure.Analytics.Purview.Scanning/CHANGELOG.md +++ b/sdk/purview/Azure.Analytics.Purview.Scanning/CHANGELOG.md @@ -1,5 +1,8 @@ # Release History -## 1.0.0-beta.1 (Unreleased) +## 1.0.0-beta.1 (2021-05-12) + +### New Features + +- Initial preview release of the Purview Scanning client library for .NET -- Initial Preview Release diff --git a/sdk/purview/Azure.Analytics.Purview.Scanning/README.md b/sdk/purview/Azure.Analytics.Purview.Scanning/README.md index 6f81e7584c222..22aea24327580 100644 --- a/sdk/purview/Azure.Analytics.Purview.Scanning/README.md +++ b/sdk/purview/Azure.Analytics.Purview.Scanning/README.md @@ -1,28 +1,47 @@ -# Azure Purview Scaning client library for .NET +# Azure Purview Scanning client library for .NET -**Introduction**: +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. -TODO +- Scan your data into your catalog +- Examine your data +- Extract schemas from your data -## Getting started +**Please rely heavily on the [service's documentation][catalog_product_documentation] and our [protocol client docs][protocol_client_quickstart] to use this library** + +[Source code][source_code] | [Package (NuGet)][client_nuget_package] | [Product documentation][catalog_product_documentation] -TODO +## Getting started ### Install the package -TODO +Install the Azure Purview Scanning client library for .NET with [NuGet][client_nuget_package]: + +``` +dotnet add package Azure.Analysis.Purview.Scanning --prerelease +``` ### Prerequisites -TODO +- You must have an [Azure subscription][azure_subscription] and a [Purview resource][purview_resource] to use this package. ### Authenticate the client -TODO +#### Using Azure Active Directory + +This document demonstrates using [DefaultAzureCredential][default_cred_ref] to authenticate via Azure Active Directory. However, any of the credentials offered by the [Azure.Identity][azure_identity] will be accepted. See the [Azure.Identity][azure_identity] documentation for more information about other credentials. + +Once you have chosen and configured your credential, you can create instances of the `PurviewScanningClient`. + +```C# +var credential = new DefaultAzureCredential(); +var client = new PurviewScanningClient(new Url("https://.scanning.purview.azure.com"), credential); +``` ## Key concepts -TODO +### 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][protocol_client_quickstart]. ### Thread safety @@ -41,15 +60,35 @@ We guarantee that all client instance methods are thread-safe and independent of ## Examples -TODO +The following section shows you how to initialize and authenticate your client, then list all of your data sources. + +### List All Data Sources + +```C# +var credential = new DefaultAzureCredential(); +var client = new PurviewScanningServiceClient(new Uri("https://.scanning.purview.azure.com"), credential); + +var response = await client.GetDataSourcesAsync(); +var responseDocument = JsonDocument.Parse(response.Content); +Console.WriteLine(responseDocument.RootElement.GetProperty("value")); +``` ## Troubleshooting -TODO +### 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. + +```C# +// Setup a listener to monitor logged events. +using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger(); +``` + +To learn more about other logging mechanisms see [here][azure_core_diagnostics]. ## Next steps -TODO +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][protocol_client_quickstart]. ## Contributing @@ -62,9 +101,18 @@ When you submit a pull request, a CLA-bot will automatically determine whether y This project has adopted the [Microsoft Open Source Code of Conduct][code_of_conduct]. For more information see the [Code of Conduct FAQ][coc_faq] or contact [opencode@microsoft.com][coc_contact] with any additional questions or comments. +[source_code]: https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/purview/Azure.Analytics.Purview.Scanning/src +[client_nuget_package]: https://www.nuget.org/packages?q=Azure.Analytics.Purview.Scanning +[catalog_product_documentation]: https://azure.microsoft.com/services/purview/ +[azure_identity]: https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/identity/Azure.Identity +[protocol_client_quickstart]: https://aka.ms/azsdk/net/protocol/quickstart +[default_cred_ref]: https://docs.microsoft.com/dotnet/api/azure.identity.defaultazurecredential?view=azure-dotnet +[azure_subscription]: https://azure.microsoft.com/free/ +[purview_resource]: https://docs.microsoft.com/azure/purview/create-catalog-portal +[azure_core_diagnostics]: https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/samples/Diagnostics.md [cla]: https://cla.microsoft.com [code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ [coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/ [coc_contact]: mailto:opencode@microsoft.com -![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-net%2Fsdk%2Fpurview%2FAzure.Analysis.Purview.Scanning%2FREADME.png) +![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-net%2Fsdk%2Fpurview%2FAzure.Analytics.Purview.Scanning%2FREADME.png) \ No newline at end of file