@azure/arm-links v2.0.1

Azure ManagementLink client library for JavaScript

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

Azure resources can be linked together to form logical relationships. You can establish links between resources belonging to different resource groups. However, all the linked resources must belong to the same subscription. Each resource can be linked to 50 other resources. If any of the linked resources are deleted or moved, the link owner must clean up the remaining link.

Source code | Package (NPM) | API reference documentation | Samples

Getting started

Currently supported environments

• LTS versions of Node.js
• Latest versions of Safari, Chrome, Edge and Firefox.

Prerequisites

• An Azure subscription.

Install the @azure/arm-links package

Install the Azure ManagementLink client library for JavaScript with npm:

npm install @azure/arm-links

Create and authenticate a ManagementLinkClient

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

Using an 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 install the @azure/identity package:

npm install @azure/identity

You will also need to register a new AAD application and grant access to Azure ManagementLink by assigning the suitable role to your service principal (note: roles such as "Owner" will not grant the necessary permissions). 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.

const { ManagementLinkClient } = require("@azure/arm-links");
const { DefaultAzureCredential } = require("@azure/identity");
const client = new ManagementLinkClient("<endpoint>", new DefaultAzureCredential());

Key concepts

ManagementLinkClient

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

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

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

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