Share via

Azure SqlVirtualMachineManagement client library for JavaScript - version 5.0.0-beta.8

  • Article

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

The SQL virtual machine management API provides a RESTful set of web APIs that interact with Azure Compute, Network & Storage services to manage your SQL Server virtual machine. The API enables users to create, delete and retrieve a SQL virtual machine, SQL virtual machine group or availability group listener.

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

Getting started

Currently supported environments

See our support policy for more details.

Prerequisites

Install the @azure/arm-sqlvirtualmachine package

Install the Azure SqlVirtualMachineManagement client library for JavaScript with npm:

npm install @azure/arm-sqlvirtualmachine

Create and authenticate a SqlVirtualMachineManagementClient

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

const { SqlVirtualMachineManagementClient } = require("@azure/arm-sqlvirtualmachine");
const { DefaultAzureCredential } = require("@azure/identity");
// For client-side applications running in the browser, use InteractiveBrowserCredential instead of DefaultAzureCredential. See https://aka.ms/azsdk/js/identity/examples for more details.

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

// For client-side applications running in the browser, use this code instead:
// const credential = new InteractiveBrowserCredential({
//   tenantId: "<YOUR_TENANT_ID>",
//   clientId: "<YOUR_CLIENT_ID>"
// });
// const client = new SqlVirtualMachineManagementClient(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

SqlVirtualMachineManagementClient

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

const { setLogLevel } = require("@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.

Impressions