Package version:

@azure/arm-relationships

Azure Relationships client library for JavaScript

This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure Relationships client.

Microsoft.Relationships Resource Provider management API.

Key links:

See our support policy for more details.

Install the Azure Relationships client library for JavaScript with npm:

npm install @azure/arm-relationships

To create a client object to access the Azure Relationships API, you will need the endpoint of your Azure Relationships resource and a credential. The Azure Relationships client can use Azure Active Directory credentials to authenticate. You can find the endpoint for your Azure Relationships resource in the Azure Portal.

You can authenticate with Azure Active Directory using a credential from the @azure/identity library or an existing AAD Token.

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

npm install @azure/identity

You will also need to register a new AAD application and grant access to Azure Relationships by assigning the suitable role to your service principal (note: roles such as "Owner" will not grant the necessary permissions).

For more information about how to create an Azure AD Application check out this guide.

Using Node.js and Node-like environments, you can use the DefaultAzureCredential class to authenticate the client.

import { RelationshipsClient } from "@azure/arm-relationships";
import { DefaultAzureCredential } from "@azure/identity";

const client = new RelationshipsClient(new DefaultAzureCredential());

For browser environments, use the InteractiveBrowserCredential from the @azure/identity package to authenticate.

import { InteractiveBrowserCredential } from "@azure/identity";
import { RelationshipsClient } from "@azure/arm-relationships";

const credential = new InteractiveBrowserCredential({
  tenantId: "<YOUR_TENANT_ID>",
  clientId: "<YOUR_CLIENT_ID>",
});
const client = new RelationshipsClient(credential);

To use this client library in the browser, first you need to use a bundler. For details on how to do this, please refer to our bundling documentation.

RelationshipsClient is the primary interface for developers using the Azure Relationships client library. Explore the methods on this client object to understand the different features of the Azure Relationships service that you can access.

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.

Please take a look at the samples directory for detailed examples on how to use this library.

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.

Settings

Member Visibility

On This Page

Azure Relationships client library for JavaScript