Azure Purview Scanning Rest-Level client library for JavaScript
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 Rest client docs to use this library
Key links:
Getting started
Currently supported environments
- Node.js version 14.x.x or higher
Prerequisites
- You must have an Azure subscription and a Purview to use this package.
Create a Purview Resource
Follow these instructions to create your Purview resource
@azure-rest/purview-scanning
package
Install the Install the Azure Purview Scanning client library for JavaScript with npm
:
npm install @azure-rest/purview-scanning
PurviewScanning
Create and authenticate a 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 npm
install @azure/identity
and
enable AAD authentication on your Purview resource
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:
import PurviewScanning from "@azure-rest/purview-scanning";
import { DefaultAzureCredential } from "@azure/identity";
const client = PurviewScanning(
"https://<my-account-name>.scan.purview.azure.com",
new DefaultAzureCredential()
);
Key concepts
Rest Client
This client is one of our Rest clients. We highly recommend you read how to use a Rest client here.
Examples
The following section shows you how to initialize and authenticate your client, then list all of your data sources.
List All Data Sources
import PurviewScanning, { paginate, DataSource } from "@azure-rest/purview-scanning";
import { PagedAsyncIterableIterator, PageSettings } from "@azure/core-paging";
import { DefaultAzureCredential } from "@azure/identity";
async function main() {
console.log("== List dataSources ==");
const client = PurviewScanning(
"https://<my-account-name>.scan.purview.azure.com",
new DefaultAzureCredential()
);
const dataSources = await client.path("/datasources").get();
if (dataSources.status !== "200") {
throw dataSources.body.error;
}
const iter = paginate(client, dataSources)
const items: DataSource[] = [];
for await (const item of <PagedAsyncIterableIterator<DataSource, (DataSource)[], PageSettings>>iter) {
items.push(item);
}
console.log(items?.map((ds) => ds.name).join("\n"));
}
main().catch(console.error);
Troubleshooting
Logging
Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the AZURE_LOG_LEVEL
environment variable to info
. Alternatively, logging can be enabled at runtime by calling setLogLevel
in the @azure/logger
:
import { setLogLevel } from "@azure/logger";
setLogLevel("info");
For more detailed instructions on how to enable logs, you can look at the @azure/logger package docs.
Next steps
Contributing
If you'd like to contribute to this library, please read the contributing guide to learn more about how to build and test the code.