Azure Purview Administration client library for Java - version 1.0.0-beta.1

Article
07/26/2022

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

Please rely heavily on the service's documentation and Protocol method documentation to use this library

Package (Maven) | API reference documentation | Product Documentation

Getting started

Prerequisites

A Java Development Kit (JDK), version 8 or later.
Azure Subscription
An existing Azure Purview administration.

For more information about creating the account see here.

Some API in administration requires permissions for the user or the service principal authenticated with the client. For more information about permissions, see here.

Include the Package

<dependency>
  <groupId>com.azure</groupId>
  <artifactId>azure-analytics-purview-administration</artifactId>
  <version>1.0.0-beta.1</version>
</dependency>

Authenticate the client

In order to interact with the Azure Purview service, your client must present an Azure Active Directory bearer token to the service.

The simplest way of providing a bearer token is to use the DefaultAzureCredential authentication method by providing client secret credentials is being used in this getting started section but you can find more ways to authenticate with azure-identity.

Create AccountsClient with Azure Active Directory Credential

You can authenticate with Azure Active Directory using the Azure Identity library.

To use the DefaultAzureCredential provider shown below, or other credential providers provided with the Azure SDK, please include the azure-identity package:

<dependency>
    <groupId>com.azure</groupId>
    <artifactId>azure-identity</artifactId>
    <version>1.3.6</version>
</dependency>

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.

Example

AccountsClient client = new PurviewAccountClientBuilder()
    .endpoint(System.getenv("ACCOUNT_ENDPOINT"))
    .credential(new DefaultAzureCredentialBuilder().build())
    .buildAccountsClient();

Key concepts

Examples

AccountsClient client = new PurviewAccountClientBuilder()
    .endpoint(System.getenv("ACCOUNT_ENDPOINT"))
    .credential(new DefaultAzureCredentialBuilder().build())
    .buildAccountsClient();
BinaryData response = client.getAccountPropertiesWithResponse(null, null).getValue();

Troubleshooting

Enabling Logging

Azure SDKs for Java offer a consistent logging story to help aid in troubleshooting application errors and expedite their resolution. The logs produced will capture the flow of an application before reaching the terminal state to help locate the root issue. View the logging wiki for guidance about enabling logging.

Next steps

Contributing

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.

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