2015-07-03 10:52:46 +03:00
# Azure SDK for Node.js
2013-10-16 21:04:18 +04:00
2014-04-08 17:28:05 +04:00
[![NPM version ](https://badge.fury.io/js/azure.png )](http://badge.fury.io/js/azure) [![Build Status ](https://travis-ci.org/Azure/azure-sdk-for-node.png?branch=master )](https://travis-ci.org/Azure/azure-sdk-for-node)
2012-02-24 07:16:26 +04:00
2014-04-23 19:26:21 +04:00
This project provides a Node.js package that makes it easy to consume and manage Microsoft Azure Services.
2016-02-17 02:24:31 +03:00
## Non-Interactive Authentication
2016-02-28 06:30:26 +03:00
If you need to create an automation account for non interactive or scripting scenarios then please take a look at the documentation over [here ](./Documentation/Authentication.md ).
2014-01-10 22:17:35 +04:00
## Install from npm
2014-04-23 19:26:21 +04:00
We provide both fine-grained modules for different Microsoft Azure services which you can install separately, and an all-up module which contains everything.
2012-02-24 07:19:37 +04:00
2014-04-23 19:26:21 +04:00
**Notice**: we haven't provided fine-grained modules for every supported Microsoft Azure services yet. This will come soon.
2012-02-24 07:16:26 +04:00
2014-01-10 22:17:35 +04:00
### Install the all-up module
2012-02-24 07:16:26 +04:00
2014-01-10 22:17:35 +04:00
```
npm install azure
```
2015-07-03 10:52:46 +03:00
### Install individual modules
| **Azure Services** |
| :----------------------------------------------------------------------------- | :--------------------------- |
| [Gallery ](http://azure.microsoft.com/en-us/marketplace/ ) | `npm install azure-gallery` |
2016-03-08 01:16:25 +03:00
| [Graph ](https://azure.microsoft.com/en-us/services/active-directory/ ) | `npm install azure-graph` |
2015-07-03 10:52:46 +03:00
| [Key Vault ](http://azure.microsoft.com/en-us/services/key-vault/ ) | `npm install azure-keyvault` |
| [Monitoring ](https://msdn.microsoft.com/library/azure/dn306639.aspx ) | `npm install azure-monitoring` |
| [Scheduler ](http://azure.microsoft.com/en-us/services/scheduler/ ) | `npm install azure-scheduler` |
2016-03-08 01:16:25 +03:00
| [Service Fabric ](https://azure.microsoft.com/en-us/services/service-fabric/ ) | `npm install azure-servicefabric` |
2015-07-03 10:52:46 +03:00
| [Service Bus ](http://azure.microsoft.com/en-us/services/service-bus/ ) | `npm install azure-sb` |
| [Storage ](http://azure.microsoft.com/en-us/services/storage/ ) | `npm install azure-storage` |
| | |
2016-03-08 01:16:25 +03:00
| **Azure Resource Management (ARM)** |
2015-07-03 10:52:46 +03:00
| [API Apps ](http://azure.microsoft.com/en-us/services/app-service/api/ ) | `npm install azure-arm-apiapp` |
| [Authorization ](https://azure.microsoft.com/en-us/documentation/articles/role-based-access-control-configure/ ) | `npm install azure-arm-authorization` |
2016-03-08 01:16:25 +03:00
| [CDN ](https://azure.microsoft.com/en-us/services/cdn/ ) | `npm install azure-arm-cdn` |
2015-07-03 10:52:46 +03:00
| [Compute ](http://azure.microsoft.com/en-us/services/virtual-machines/ ) | `npm install azure-arm-compute` |
2016-03-08 01:16:25 +03:00
| [Datalake Analytics ](https://azure.microsoft.com/en-us/services/data-lake-analytics/ ) | `azure-arm-datalake-analytics` |
| [Datalake Storage ](https://azure.microsoft.com/en-us/services/data-lake-store/ ) | `azure-arm-datalake-storage` |
2015-07-03 10:52:46 +03:00
| [DNS ](http://azure.microsoft.com/en-us/services/dns/ ) | `npm install azure-arm-dns` |
| [Insights ](https://msdn.microsoft.com/en-us/library/azure/dn931943.aspx ) | `npm install azure-arm-insights` |
| [Key Vault ](http://azure.microsoft.com/en-us/services/key-vault/ ) | `npm install azure-arm-keyvault` |
2016-03-08 01:16:25 +03:00
| [Redis Cache ](https://azure.microsoft.com/en-us/services/cache/ ) | `npm install azure-arm-rediscache` |
| [Resource Manager ](https://azure.microsoft.com/en-us/documentation/articles/resource-group-overview/ ) | `npm install azure-arm-resource` |
2015-07-03 10:52:46 +03:00
| [Storage ](http://azure.microsoft.com/en-us/services/storage/ ) | `npm install azure-arm-storage` |
| [Traffic Manager ](http://azure.microsoft.com/en-us/services/traffic-manager/ ) | `npm install azure-arm-trafficManager` |
2016-03-08 01:16:25 +03:00
| [Virtual Networks ](http://azure.microsoft.com/en-us/services/virtual-network/ ) | `npm install azure-arm-network` |
2015-07-03 10:52:46 +03:00
| [WebApps (WebSites) ](http://azure.microsoft.com/en-us/services/app-service/web/ ) | `npm install azure-arm-website` |
2016-03-15 00:51:04 +03:00
| [Batch ](https://azure.microsoft.com/en-us/services/batch/ ) | `npm install azure-arm-batch` |
2015-07-03 10:52:46 +03:00
| | |
2016-03-08 01:16:25 +03:00
| **Azure Service Management (ASM)** |
2015-07-03 10:52:46 +03:00
| [Compute ](http://azure.microsoft.com/en-us/services/virtual-machines/ ) | `npm install azure-asm-compute` |
| [HDInsight ](http://azure.microsoft.com/en-us/services/hdinsight/ ) | `npm install azure-asm-hdinsight` |
| [Service Bus ](http://azure.microsoft.com/en-us/services/service-bus/ ) | `npm install azure-asm-sb` |
| [Service Manager ](https://msdn.microsoft.com/en-us/library/azure/ee460799.aspx ) | `npm install azure-asm-mgmt` |
| [Store ](http://azure.microsoft.com/en-us/marketplace/ ) | `npm install azure-asm-store` |
| [Scheduler ](http://azure.microsoft.com/en-us/services/scheduler/ ) | `npm install azure-asm-scheduler` |
| [SQL Database ](http://azure.microsoft.com/en-us/services/sql-database/ ) | `npm install azure-asm-sql` |
| [Storage ](http://azure.microsoft.com/en-us/services/storage/ ) | `npm install azure-asm-storage` |
| [Subscriptions ](https://msdn.microsoft.com/en-us/library/azure/gg715315.aspx ) | `npm install azure-asm-subscription` |
2016-03-08 01:16:25 +03:00
| [Traffic Manager ](http://azure.microsoft.com/en-us/services/traffic-manager/ ) | `npm install azure-asm-trafficManager` |
2015-07-03 10:52:46 +03:00
| [Virtual Networks ](http://azure.microsoft.com/en-us/services/virtual-network/ ) | `npm install azure-asm-network` |
| [WebSites ](http://azure.microsoft.com/en-us/services/app-service/web/ ) | `npm install azure-asm-website` |
| | |
| **Base Libraries** | |
2016-03-08 01:16:25 +03:00
| 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` |
2015-07-03 10:52:46 +03:00
## Need Help?
* [Read the docs ](http://azure.github.io/azure-sdk-for-node )
* [Open an issue in GitHub ](http://github.com/azure/azure-sdk-for-node )
2014-04-23 19:26:21 +04:00
* [Microsoft Azure Forums on MSDN and Stack Overflow ](http://go.microsoft.com/fwlink/?LinkId=234489 )
2011-12-10 03:47:08 +04:00
2015-07-03 10:52:46 +03:00
## Related Projects
2012-11-20 19:36:24 +04:00
2015-07-03 10:52:46 +03:00
* [Azure CLI ](http://github.com/azure/azure-xplat-cli )
2012-11-20 19:36:24 +04:00
2015-07-03 10:52:46 +03:00
## Contribute
2012-11-20 19:36:24 +04:00
2016-02-15 09:44:14 +03:00
* If you would like to become an active contributor to this project please follow the instructions provided in [Microsoft Azure Projects Contribution Guidelines ](http://azure.github.io/guidelines/ ).
2015-04-12 20:38:21 +03:00
2015-07-03 10:52:46 +03:00
### Getting Started Developing
Want to get started hacking on the code, super! Follow the following instructions to get up and running. These
2015-04-12 20:38:21 +03:00
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.
2015-07-03 10:52:46 +03:00
### Contributing Code to the Project
2015-04-12 20:38:21 +03:00
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