azure-arm-resource

What is azure-arm-resource?

The azure-arm-resource npm package is a client library for managing Azure resources. It provides functionalities to interact with Azure Resource Manager (ARM) APIs, allowing you to create, update, delete, and manage Azure resources programmatically.

What are azure-arm-resource's main functionalities?

Create Resource Group

This code sample demonstrates how to create a new resource group in Azure using the azure-arm-resource package. It logs in using a service principal and then creates a resource group in the specified location.

const msRestAzure = require('ms-rest-azure');
const ResourceManagementClient = require('azure-arm-resource').ResourceManagementClient;

msRestAzure.loginWithServicePrincipalSecret(clientId, secret, domain, (err, credentials) => {
  if (err) throw err;
  const client = new ResourceManagementClient(credentials, subscriptionId);
  const groupParameters = { location: 'westus' };
  client.resourceGroups.createOrUpdate('myResourceGroup', groupParameters, (err, result) => {
    if (err) throw err;
    console.log('Resource group created:', result);
  });
});

List Resource Groups

This code sample demonstrates how to list all resource groups in a subscription using the azure-arm-resource package. It logs in using a service principal and then retrieves and prints the list of resource groups.

const msRestAzure = require('ms-rest-azure');
const ResourceManagementClient = require('azure-arm-resource').ResourceManagementClient;

msRestAzure.loginWithServicePrincipalSecret(clientId, secret, domain, (err, credentials) => {
  if (err) throw err;
  const client = new ResourceManagementClient(credentials, subscriptionId);
  client.resourceGroups.list((err, result) => {
    if (err) throw err;
    console.log('List of resource groups:', result);
  });
});

Delete Resource Group

This code sample demonstrates how to delete a resource group in Azure using the azure-arm-resource package. It logs in using a service principal and then deletes the specified resource group.

const msRestAzure = require('ms-rest-azure');
const ResourceManagementClient = require('azure-arm-resource').ResourceManagementClient;

msRestAzure.loginWithServicePrincipalSecret(clientId, secret, domain, (err, credentials) => {
  if (err) throw err;
  const client = new ResourceManagementClient(credentials, subscriptionId);
  client.resourceGroups.deleteMethod('myResourceGroup', (err, result) => {
    if (err) throw err;
    console.log('Resource group deleted:', result);
  });
});

Other packages similar to azure-arm-resource

azure-arm-compute

The azure-arm-compute package is used for managing Azure compute resources, such as virtual machines, VM scale sets, and availability sets. It provides functionalities specific to compute resources, whereas azure-arm-resource is more general and can manage a wider range of Azure resources.

azure-arm-network

The azure-arm-network package is used for managing Azure networking resources, such as virtual networks, subnets, and network interfaces. It focuses on networking-specific functionalities, while azure-arm-resource provides a broader scope for managing various types of Azure resources.

azure-arm-storage

The azure-arm-storage package is used for managing Azure storage resources, such as storage accounts and blobs. It is specialized for storage-related operations, whereas azure-arm-resource offers a more comprehensive set of functionalities for managing different types of Azure resources.

README

Microsoft Azure SDK for Node.js - Resource Management

This project provides a Node.js package that makes it easy to manage Azure resources. Right now it supports:

• Node.js version: 6.x.x or higher

How to Install

npm install azure-arm-resource

How to Use

Authentication, client creation and listing resources as an example

var msRestAzure = require('ms-rest-azure');
var resourceManagement = require("azure-arm-resource");

// Interactive Login
msRestAzure.interactiveLogin(function(err, credentials) {
 var client = new resourceManagement.ResourceManagementClient(credentials, 'your-subscription-id');
 client.resources.list(function(err, result) {
   if (err) console.log(err);
   console.log(result);
 });
});

Creating a Resource Group

var util = require('util');
var groupParameters = {
  location: 'West US',
  tags: {
    tag1: 'val1',
    tag2: 'val2'
  }
};
var groupName = 'testGroup1';
client.resourceGroups.createOrUpdate(groupName, groupParameters, function (err, result, request, response) {
  if (err) {
    console.log(err);
    /*err has reference to the actual request and response, so you can see what was sent and received on the wire.
      The structure of err looks like this:
      err: {
        code: 'Error Code',
        message: 'Error Message',
        body: 'The response body if any',
        request: reference to a stripped version of http request
        response: reference to a stripped version of the response
      }
    */
  } else {
    console.log('result is: ' + util.inspect(result, {depth: null}));
  }
});

Create a Generic Resource in a Resource Group

var groupName = 'testGroup1';
var resourceName = 'autorestsite102';
var params = { 'location': 'West US', 'properties' : { 'SiteMode': 'Limited', 'ComputeMode': 'Shared' }, 'Name': resourceName };
var resourceType = 'sites';
var parentResourcePath = '';
var resourceProviderNamespace = 'Microsoft.Web';
var apiVersion = '2014-04-01';
client.resources.createOrUpdate(groupName, resourceProviderNamespace, parentResourcePath, 
  resourceType, resourceName , apiVersion, params, function (err, result, request, response) {
  if (err) {
    console.log(err);
  } else {
    console.log(result);
  }
});

Get a Generic Resource in a Resource Group

var groupName = 'testGroup1';
var resourceName = 'autorestsite102';
var resourceType = 'sites';
var parentResourcePath = '';
var resourceProviderNamespace = 'Microsoft.Web';
var apiVersion = '2014-04-01';
client.resources.get(groupName, resourceProviderNamespace, parentResourcePath, 
  resourceType, resourceName, apiVersion, function (err, result, request, response) {
  if (err) {
    console.log(err);
  } else {
    console.log(result);
  }
});

Listing all resources in your subscription

client.resources.list(function (err, result, request, response) {
  if (err) {
    console.log(err);
  } else {
    console.log(result);
  }
});

Deleting a Generic Resource in a Resource Group

var groupName = 'testGroup1';
var resourceName = 'autorestsite102';
var resourceType = 'sites';
var parentResourcePath = '';
var resourceProviderNamespace = 'Microsoft.Web';
var apiVersion = '2014-04-01';
client.resources.deleteMethod(groupName, resourceProviderNamespace, parentResourcePath, 
  resourceType, resourceName, apiVersion, function (err, result, request, response) {
  if (err) {
    console.log(err);
  } else {
    console.log(result);
  }
});

Deleting the Resource Group

var groupName = 'testGroup1';
client.resourceGroups.deleteMethod(groupName, function (err, result, request, response) {
  if (err) {
    console.log(err);
  } else {
    console.log(result);
  }
});

Please take a look at the tests over here for more examples.

Related projects

• Microsoft Azure SDK for Node.js - All-up

Changelog

2017.04.03 version 2.0.0-preview

• Updated type definition (.d.ts) files for all the packages and improved typescript support.
• Added Promise support for all the APIs. For each callback based API, we now have an overloaded method that returns a Promise.
• Moved Javascript code to ES6 syntax.
• Minimum required node.js version is 6.10
• Added a new vscode extension named Azure Node Essentials to help you easily interact with Azure.
• Improved the loading time of rollup azure package
• Added client libraries for following ARM services
  • Advisor Management (azure-arm-advisor)
  • Automation Management (azure-arm-automation)
  • Billing Management (azure-arm-billing)
  • Cognitive Services Management (azure-arm-cognitiveservices)
  • Container Registry Management (azure-arm-containerregistry)
  • Customer Insights Management (azure-arm-customerinsights)
  • DocumentDB Management (azure-arm-documentdb)
  • Logic Management (azure-arm-logic)
  • Machine Learning Management (azure-arm-machinelearning)
  • Media Services Management (azure-arm-mediaservices)
  • Operational Insights Management (azure-arm-operationalinsights)
  • Recovery Services Backup Management (azure-arm-recoveryservicesbackup)
  • Recovery Services Management (azure-arm-recoveryservices)
  • Relay Management (azure-arm-relay)
  • Scheduler Management (azure-arm-scheduler)
  • Search Management (azure-arm-search)
  • ServiceFabric Management (azure-arm-servicefabric)
  • ServiceMap Management (azure-arm-servicemap)
  • SQL Management (azure-arm-sql)
  • Storage Import Export Management (azure-arm-storageimportexport)
• Runtime (ms-rest and ms-rest-azure)
  • Updated d.ts files for ms-rest and ms-rest-azure
  • All the login methods (interactiveLogin, loginWithServicePrincipalSecret, loginWithUsernamePassword) now support callbacks as well as Promises.
  • Added support to send (a generic request, or a generic long running request (that polls)) using the authenticated base client in the runtime