README.md

Azure SDK for Node.js

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

Non-Interactive Authentication

If you need to create an automation account for non interactive or scripting scenarios then please take a look at the documentation over here.

Install from npm

We provide both fine-grained modules for different Microsoft Azure services which you can install separately, and an all-up module which contains everything.

Notice: we haven't provided fine-grained modules for every supported Microsoft Azure services yet. This will come soon.

Install the all-up module

npm install azure

 

Install individual modules

| Azure Services | | :----------------------------------------------------------------------------- | :--------------------------- | | Gallery | npm install azure-gallery | | Graph | npm install azure-graph | | Key Vault | npm install azure-keyvault | | Monitoring | npm install azure-monitoring | | Scheduler | npm install azure-scheduler | | Service Fabric | npm install azure-servicefabric | | Service Bus | npm install azure-sb | | Storage | npm install azure-storage | | Batch | npm install azure-batch | |   | | | Azure Resource Management (ARM) | | API Apps | npm install azure-arm-apiapp | | Authorization | npm install azure-arm-authorization | | CDN | npm install azure-arm-cdn| | Compute | npm install azure-arm-compute| | Datalake Analytics | azure-arm-datalake-analytics | | Datalake Storage | azure-arm-datalake-storage | | DNS | npm install azure-arm-dns | | Insights | npm install azure-arm-insights | | Key Vault | npm install azure-arm-keyvault | | Redis Cache | npm install azure-arm-rediscache | | Resource Manager | npm install azure-arm-resource | | Storage | npm install azure-arm-storage | | Traffic Manager | npm install azure-arm-trafficManager| | Virtual Networks | npm install azure-arm-network | | WebApps (WebSites) | npm install azure-arm-website | | Batch | npm install azure-arm-batch | |   | | | Azure Service Management (ASM) | | Compute | npm install azure-asm-compute | | HDInsight | npm install azure-asm-hdinsight | | Service Bus | npm install azure-asm-sb | | Service Manager | npm install azure-asm-mgmt | | Store | npm install azure-asm-store | | Scheduler | npm install azure-asm-scheduler | | SQL Database | npm install azure-asm-sql | | Storage | npm install azure-asm-storage | | Subscriptions | npm install azure-asm-subscription| | Traffic Manager | npm install azure-asm-trafficManager | | Virtual Networks | npm install azure-asm-network | | WebSites | npm install azure-asm-website | |   | | | Base Libraries | | | Common Functionality (for ASM & ARM clients generated from old code generator) | npm install azure-common | | Common Functionality for ARM clients generated from Autorest (Generic) | npm install ms-rest | | Common Functionality for ARM clients generated from Autorest (Azure) | npm install ms-rest-azure |

Need Help?

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

Related Projects

• Azure CLI

Contribute

• If you would like to become an active contributor to this project please follow the instructions provided in Microsoft Azure Projects Contribution 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