@azure/arm-subscriptions

Azure Subscription client library for JavaScript

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

The subscription client

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.

See our support policy for more details.

Prerequisites

• An Azure subscription.

Install the @azure/arm-subscriptions package

Install the Azure Subscription client library for JavaScript with npm:

npm install @azure/arm-subscriptions

Create and authenticate a SubscriptionClient

To create a client object to access the Azure Subscription API, you will need the endpoint of your Azure Subscription resource and a credential. The Azure Subscription client can use Azure Active Directory credentials to authenticate. You can find the endpoint for your Azure Subscription 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 Subscription 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 { SubscriptionClient } from "@azure/arm-subscriptions";
import { DefaultAzureCredential } from "@azure/identity";

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

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

import { InteractiveBrowserCredential } from "@azure/identity";
import { SubscriptionClient } from "@azure/arm-subscriptions";

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

JavaScript Bundle

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.

Key concepts

SubscriptionClient

SubscriptionClient is the primary interface for developers using the Azure Subscription client library. Explore the methods on this client object to understand the different features of the Azure Subscription 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

Similar packages

Other packages similar to @azure/arm-subscriptions

@azure/arm-resources

The @azure/arm-resources package is used for managing Azure resources, including resource groups and deployments. While it focuses on resource management, it complements @azure/arm-subscriptions by allowing users to manage the resources within their subscriptions.

@azure/arm-billing

The @azure/arm-billing package provides functionalities for managing Azure billing accounts and invoices. It is similar to @azure/arm-subscriptions in that both deal with account-level management, but @azure/arm-billing focuses specifically on billing aspects.