Azure Compute client library for JavaScript - version 1.0.0-beta.1

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

Key links:

Getting started

Currently supported environments

See our support policy for more details.

Prerequisites

Install the @azure/arm-compute-bulkactions package

Install the Azure Compute client library for JavaScript with npm:

npm install @azure/arm-compute-bulkactions

Create and authenticate a ComputeClient

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

You can authenticate with Microsoft Entra ID using a credential from the @azure/identity library or an existing Microsoft Entra 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 Microsoft Entra application and grant access to Azure Compute 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 a Microsoft Entra application check out this guide.

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

import { ComputeClient } from "@azure/arm-compute-bulkactions";
import { DefaultAzureCredential } from "@azure/identity";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new ComputeClient(new DefaultAzureCredential(), subscriptionId);

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

import { InteractiveBrowserCredential } from "@azure/identity";
import { ComputeClient } from "@azure/arm-compute-bulkactions";

const credential = new InteractiveBrowserCredential({
  tenantId: "<YOUR_TENANT_ID>",
  clientId: "<YOUR_CLIENT_ID>",
});
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new ComputeClient(credential, subscriptionId);

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

ComputeClient

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

  • Last updated on