This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure Visual Studio Resource Provider client.

Use these APIs to manage Visual Studio Team Services resources through the Azure Resource Manager. All task operations conform to the HTTP/1.1 protocol specification and each operation returns an x-ms-request-id header that can be used to obtain information about the request. You must make sure that requests made to these resources are secure. For more information, see https://learn.microsoft.com/rest/api/index.

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

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

See our support policy for more details.

• An Azure subscription.

Install the Azure Visual Studio Resource Provider client library for JavaScript with npm:

npm install @azure/arm-visualstudio

To create a client object to access the Azure Visual Studio Resource Provider API, you will need the endpoint of your Azure Visual Studio Resource Provider resource and a credential. The Azure Visual Studio Resource Provider client can use Azure Active Directory credentials to authenticate. You can find the endpoint for your Azure Visual Studio Resource Provider 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 Visual Studio Resource Provider 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.

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 { VisualStudioResourceProviderClient } from "@azure/arm-visualstudio";
import { DefaultAzureCredential } from "@azure/identity";

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

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

import { InteractiveBrowserCredential } from "@azure/identity";
import { VisualStudioResourceProviderClient } from "@azure/arm-visualstudio";

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

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.

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

• Microsoft Azure SDK for JavaScript