README.md

WARNING

• All the management plane azure-arm-* sdks and most of the data plane azure-* sdks, along with the rollup package azure in this repository, will be deprecated in July, 2019. They will be replaced by JS sdks in azure-sdk-for-js.
• The packages in azure-sdk-for-js are isomorphic (can be run in the browser and on the server (node.js)) with accurate TypeScript type definitions.
• They will be actively supported moving forward.
• You will find any equivalent JS package in @azure org on npm for the existing node sdk package. For example: azure-arm-compute node sdk's equivalent JS sdk is @azure/arm-compute.
• All the management plane sdks for the V1 Azure API (Azure Service Management) azure-asm-* will still be maintained from this repository. We would expect customers using these packages to move to Azure Resource Manager API packages at the earliest.

NOTE: Apart from the noticable changes in require/import statements, we have tried our level best to make lesser breaking changes in the API calls.

Migration

You can find more information on migrating your scripts from node sdk to JS sdk over here.

Azure SDK for Node.js

This project provides Node.js packages that makes it easy to consume and manage Microsoft Azure Services.

If you are new to Azure and Node.js, see Azure for Node.js developers.

For documentation specific to the Azure SDK Node.js packages, see the Azure Node SDK Reference.

Usage

To install an individual Node.js package, look up the package name and use npm to install it into your project.

For example to install the Storage package, you would run:

$ npm install azure-storage

Note: You can install all the packages in this SDK by using npm install azure. This will include helper modules (ms-rest-azure) as well as all of the individual modules. This organization method also allows for submodules (and peer dependent modules) to always be in sync with each other.

Supported services

This SDK has support for:

• Azure services (packages with the naming convention of azure-<servicename>).
• ARM services (packages with the naming convention of azure-arm-*)
• Legacy ASM services (packages with the naming convention of azure-asm-*)

Documentation

Documentation of the supported SDKs can be found at two places:

• https://azure.github.io/azure-sdk-for-node - This website primarily provides SDK documentation for
  • ASM based services (azure-asm-*)
  • Older data plane SDKs like azure-sb, azure-scheduler, azure-storage-legacy, azure-monitoring, etc.
  • Runtime SDKs like ms-rest, ms-rest-azure, azure-common
• https://aka.ms/azure-node-sdk - This website primarily provides SDK documentation for
  • ARM based services (azure-arm-*)
  • Newer data plane SDKs like azure-batch, azure-graph, etc.

Authenticating

There are three ways to authenticate against Azure while using the management plane (azure-arm-*) SDKs and the azure-graph SDK, use this guide to determine which method to use.

Azure service modules

Note: If there is a Microsoft Azure service that doesn't have a package yet, open an issue so that we may prioritize it in the backlog.

Azure Resource Management (ARM)

Azure Service Management (ASM)

Base Libraries

Need Help?

• Read the docs
• Open an issue in GitHub
• Microsoft Azure Forums on MSDN and Stack Overflow

Related Projects

• Azure CLI

License

This project is licensed under MIT and Apache-2.0.

• "MIT" license is usually used for the client libraries generated using Autorest that are targeting ARM (V2 version of Azure REST API). The license can be found in "LICENSE.MIT.txt" file in this repository.
• "Apache-2.0" license is usually used for the client libraries generated using an internal code generator that are targeting ASM (V1 version of Azure REST API). The license can be found in "LICENSE.Apache.txt" file in this repository.

Contribute

This project has adopted the Microsoft Open Source Code of Conduct.

For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

If you would like to become an active contributor to this project please follow the instructions provided in Microsoft Open Source Guidelines.

Getting Started Developing

Want to get started hacking on the code, super! Follow the following instructions to get up and running. These instructions expect you have Git and a supported version of Node installed.

1. Fork it
2. Git Clone your fork (git clone {your repo})
3. Move into SDK directory (cd azure-sdk-for-node)
4. Install all dependencies (npm install)
5. Run the tests (npm test). You should see all tests passing.

Contributing Code to the Project

You found something you'd like to change, great! Please submit a pull request and we'll do our best to work with you to get your code included into the project.

1. Commit your changes (git commit -am 'Add some feature')
2. Push to the branch (git push origin my-new-feature)
3. Create new Pull Request