@azure/arm-network

What is @azure/arm-network?

@azure/arm-network is a Node.js client library for Azure Network Management. It provides a set of tools to manage and interact with Azure's networking resources, such as virtual networks, subnets, network interfaces, and more.

What are @azure/arm-network's main functionalities?

Virtual Network Management

This feature allows you to create or update virtual networks in Azure. The code sample demonstrates how to use the NetworkManagementClient to create a virtual network by specifying the resource group, network name, and parameters.

const { NetworkManagementClient } = require('@azure/arm-network');
const client = new NetworkManagementClient(credentials, subscriptionId);
client.virtualNetworks.createOrUpdate(resourceGroupName, virtualNetworkName, parameters).then(result => {
  console.log('Virtual Network created:', result);
}).catch(err => {
  console.error('Error creating virtual network:', err);
});

Subnet Management

This feature enables the management of subnets within a virtual network. The code sample shows how to create or update a subnet by providing the necessary parameters.

client.subnets.createOrUpdate(resourceGroupName, virtualNetworkName, subnetName, subnetParameters).then(result => {
  console.log('Subnet created:', result);
}).catch(err => {
  console.error('Error creating subnet:', err);
});

Network Interface Management

This feature allows for the creation and management of network interfaces. The code sample illustrates how to create or update a network interface using the NetworkManagementClient.

client.networkInterfaces.createOrUpdate(resourceGroupName, networkInterfaceName, parameters).then(result => {
  console.log('Network Interface created:', result);
}).catch(err => {
  console.error('Error creating network interface:', err);
});

Other packages similar to @azure/arm-network

aws-sdk

The aws-sdk package is the official AWS SDK for JavaScript, providing a comprehensive set of tools to interact with AWS services, including networking resources like VPCs and subnets. While it offers similar functionalities for AWS, it is specific to Amazon's cloud platform, whereas @azure/arm-network is specific to Azure.

google-cloud

The google-cloud package is a client library for Google Cloud Platform services, including networking services like VPCs and subnets. It provides similar functionalities for managing network resources but is tailored for Google Cloud, unlike @azure/arm-network which is designed for Azure.

README

Azure NetworkManagement client library for JavaScript

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

Network 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-network package

Install the Azure NetworkManagement client library for JavaScript with npm:

npm install @azure/arm-network

Create and authenticate a NetworkManagementClient

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

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

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

import { InteractiveBrowserCredential } from "@azure/identity";
import { NetworkManagementClient } from "@azure/arm-network";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const credential = new InteractiveBrowserCredential({
  tenantId: "<YOUR_TENANT_ID>",
  clientId: "<YOUR_CLIENT_ID>",
});
const client = new NetworkManagementClient(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

NetworkManagementClient

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