azure-sdk-for-js/sdk/purview/purview-administration-rest

Azure Purview Administration REST client library for JavaScript

Azure Purview data plane administration. It supports data plane operations. It can manage account, collections, keys, resource set rule, metadata policy, metadata roles.

Azure Purview Metadata Policies

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

Key links:

• Source code
• Package (NPM)
• API reference documentation
• Product documentation

Getting started

Currently supported environments

• LTS versions of Node.js

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

Install the @azure-rest/purview-administration package

Install the Azure Purview Administration client library for JavaScript with npm:

npm install @azure-rest/purview-administration

Create and authenticate a PurviewAccount

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 {
  PurviewAccountClient,
  PurviewMetadataPoliciesClient,
} from "@azure-rest/purview-administration";
import { DefaultAzureCredential } from "@azure/identity";
const accountClient = PurviewAccountClient(
  "https://<my-account-name>.purview.azure.com",
  new DefaultAzureCredential()
);

const metadataClient = PurviewAccountClient(
  "https://<my-account-name>.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 get all of your type-defs.

• Get A List of Collections

import { PurviewAccountClient } from "@azure-rest/purview-administration";
import { DefaultAzureCredential } from "@azure/identity";
import dotenv from "dotenv";

dotenv.config();

const endpoint = process.env["ENDPOINT"] || "";

async function main() {
  console.log("== List collections sample ==");
  const client = PurviewAccountClient(endpoint, new DefaultAzureCredential());

  const response = await client.path("/collections").get();

  if (response.status !== "200") {
    console.log(`GET "/collections" failed with ${response.status}`);
  }

  console.log(response.body);
}

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.

Related projects

• Microsoft Azure SDK for JavaScript