2.3.1-preview • Published 7 years ago

azure v2.3.1-preview

Weekly downloads
9,525
License
(MIT OR Apache-2....
Repository
github
Last release
7 years ago

Azure SDK for Node.js

NPM version Build Status

This project provides a Node.js package that makes it easy to consume and manage Microsoft Azure Services. It supports sdks for:

  • old ASM services (packages with the naming convention of azure-asm-*)
  • new ARM services (packages with the naming convention of azure-arm-*)
  • data plane of some Azure services (packages with the naming convention of azure-<servicename>).

Usage

This module includes all of the individual Azure Node.js modules in a single place. If your application only needs access to specific management modules, see the list of individual modules below.

$ npm install azure

This will allow you access to some helper methods as well as all of the individual modules. For example, by installing the azure module, you can directly require and use the ms-rest-azure common module. This organization method allows for submodules (and peer dependent modules) to always be in sync with each other.

Note: We haven't provided fine-grained modules for every supported Microsoft Azure service yet. This will come soon. If there is a module that you find is missing, open an issue so that we may prioritize it in the backlog.

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-*)
    • some old 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.

AzureNodeEssentials VSCode extension

The AzureNodeEssentials extension helps you easily interact with Azure. It helps you:

  • create a project scaffolding
  • install correct dependencies
  • ready to use snippets for authentication and deploying templates to azure

Please feel free to provide feedback for the extension by opening github issues over here.

Install individual modules

Azure Service (Data plane)Install Command
Gallerynpm install azure-gallery
Graphnpm install azure-graph
Key Vaultnpm install azure-keyvault
Monitoringnpm install azure-monitoring
Schedulernpm install azure-scheduler
Service Fabricnpm install azure-servicefabric
Service Busnpm install azure-sb
Storagenpm install azure-storage
Batchnpm install azure-batch
Azure Resource Management (ARM) (Control plane)
Advisornpm install azure-arm-advisor
Api Managementnpm install azure-arm-apimanagement
App Insightsnpm install azure-arm-appinsights
Automationnpm install azure-arm-automation
Authorizationnpm install azure-arm-authorization
Batchnpm install azure-arm-batch
BatchAInpm install azure-arm-batchai
Billingnpm install azure-arm-billing
CDNnpm install azure-arm-cdn
CognitiveServicesnpm install azure-arm-cognitiveservices
ContainerInstancenpm install azure-arm-containerinstance
CosmosDBnpm install azure-arm-cosmosdb
Commerce/Usagenpm install azure-arm-commerce
Container Registrynpm install azure-arm-containerregistry
CustomerInsightsnpm install azure-arm-customerinsights
Computenpm install azure-arm-compute
Datafactorynpm install azure-arm-datafactory
Datalake Analyticsnpm install azure-arm-datalake-analytics
Datalake Storenpm install azure-arm-datalake-store
DevTest Labsnpm install azure-arm-devtestlabs
DNSnpm install azure-arm-dns
DomainServicesnpm install azure-arm-domainservices
EventGridnpm install azure-arm-eventgrid
EventHubsnpm install azure-arm-eventhub
HDInsightnpm install azure-arm-hdinsight
HDInsightJobsnpm install azure-arm-hdinsight-jobs
Insightsnpm install azure-arm-insights
IotHubnpm install azure-arm-iothub
Key Vaultnpm install azure-arm-keyvault
Logic Appsnpm install azure-arm-logic
Machine Learningnpm install azure-arm-machinelearning
Machine Learning Computenpm install azure-arm-machinelearningcompute
Media Servicesnpm install azure-arm-mediaservices
Mobile Engagementnpm install azure-arm-mobileengagement
Monitor Managementnpm install azure-arm-monitor
Notification Hubsnpm install azure-arm-notificationhubs
Operations Managementnpm install azure-arm-operations
Operational Insightsnpm install azure-arm-operationalinsights
PowerBi Embeddednpm install azure-arm-powerbiembedded
RecoveryServicesnpm install azure-arm-recoveryservices
RecoveryServices Backupnpm install azure-arm-recoveryservicesbackup
RecoveryServices SiteRecoverynpm install azure-arm-recoveryservices-siterecovery
Redis Cachenpm install azure-arm-rediscache
Relaynpm install azure-arm-relay
Resource Healthnpm install azure-arm-resourcehealth
Resource Managernpm install azure-arm-resource
Schedulernpm install azure-arm-scheduler
Searchnpm install azure-arm-search
ServerManagementnpm install azure-arm-servermanagement
Servicebusnpm install azure-arm-sb
Service Fabricnpm install azure-arm-servicefabric
Storagenpm install azure-arm-storage
Storage Import-Exportnpm install azure-arm-storageimportexport
Storsimple8000seriesnpm install azure-arm-storsimple8000series
Stream Analyticsnpm install azure-arm-streamanalytics
Sqlnpm install azure-arm-sql
Traffic Managernpm install azure-arm-trafficmanager
Virtual Networksnpm install azure-arm-network
VisualStudionpm install azure-arm-visualstudio
WebApps (WebSites)npm install azure-arm-website
Azure Service Management (ASM) (Control plane)
Computenpm install azure-asm-compute
HDInsightnpm install azure-asm-hdinsight
Service Busnpm install azure-asm-sb
Service Managernpm install azure-asm-mgmt
Storenpm install azure-asm-store
Schedulernpm install azure-asm-scheduler
SQL Databasenpm install azure-asm-sql
Storagenpm install azure-asm-storage
Subscriptionsnpm install azure-asm-subscription
Traffic Managernpm install azure-asm-trafficmanager
Virtual Networksnpm install azure-asm-network
WebSitesnpm install azure-asm-website
Base Libraries
Common Functionality (for ASM & ARM clients)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?

Related Projects

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

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
azure-arm-advisorazure-arm-analysisservicesazure-arm-apimanagementazure-arm-appinsightsazure-arm-authorizationazure-arm-automationazure-arm-batchazure-arm-billingazure-arm-cdnazure-arm-cognitiveservicesazure-arm-commerceazure-arm-computeazure-arm-consumptionazure-arm-containerinstanceazure-arm-containerregistryazure-arm-containerserviceazure-arm-cosmosdbazure-arm-customerinsightsazure-arm-datafactoryazure-arm-datalake-analyticsazure-arm-datalake-storeazure-arm-devtestlabsazure-arm-dnsazure-arm-domainservicesazure-arm-eventgridazure-arm-eventhubazure-arm-hdinsightazure-arm-hdinsight-jobsazure-arm-iothubazure-arm-keyvaultazure-arm-logicazure-arm-machinelearningazure-arm-machinelearningcomputeazure-arm-marketplaceorderingazure-arm-mediaservicesazure-arm-mobileengagementazure-arm-monitorazure-arm-mysqlazure-arm-networkazure-arm-notificationhubsazure-arm-operationalinsightsazure-arm-operationsazure-arm-postgresqlazure-arm-powerbiembeddedazure-arm-recoveryservicesazure-arm-recoveryservices-siterecoveryazure-arm-recoveryservicesbackupazure-arm-rediscacheazure-arm-relayazure-arm-resourceazure-arm-resourcehealthazure-arm-sbazure-arm-schedulerazure-arm-searchazure-arm-servermanagementazure-arm-servicefabricazure-arm-servicemapazure-arm-sqlazure-arm-storageazure-arm-storageimportexportazure-arm-storsimple8000seriesazure-arm-streamanalyticsazure-arm-trafficmanagerazure-arm-visualstudioazure-arm-websiteazure-asm-computeazure-asm-hdinsightazure-asm-mgmtazure-asm-networkazure-asm-sbazure-asm-schedulerazure-asm-sqlazure-asm-storageazure-asm-storeazure-asm-subscriptionazure-asm-trafficmanagerazure-asm-websiteazure-batchazure-commonazure-extraazure-galleryazure-graphazure-keyvaultazure-loganalyticsazure-monitoringazure-sbazure-schedulerazure-servicefabricazure-storageazure-storage-legacymimemomentms-restms-rest-azurerequestunderscoreuuid
altiros-azure-cloud-printerlive-azure-queue@infinitebrahmanuniverse/nolb-azu@everything-registry/sub-chunk-1198terrahub-azurermvz-storageservicebus-notifications-readersb-readersbnotitelepat-modelsseneca-servicebus-transporttestoutvso-clientmeeteric-jsjgg-keystonehubot-vsonlineiotsuite-cliiotpcslog2sbk7processkoala-servicehimanshuv-clihooq-provider-azurehubot-davidford-vsonlinegrunt-azuregrunt-azure-downloadfilegrunt-azure-manualygrunt-azure-storagegrunt-azure-syncgrunt-azureblobgrunt-ensure-containerkeystone-advkeystone-azure-fileskeystone-password-resetkeystone-with-multi-selectkeystone_osslab-queuelandmark-servegit-azurenebulosamashuply-apiparse-to-anhnitrogen-azure-providersput-blobpushtocontainersscc-bootstrapsocket.io-servicebustwreporter-keystone47pages-keystoneyaml-config-azure@fathym-it/fathym-forecast@habistack/fathym-forecast@fundcount/fc-keystone@nicwong/keystonejs@naustudio/keystone@saaskit/azure@stationfive/azure-func-js-utildreedrc-backendexpress-session-azurefdback.commonff-keystonefc-keystone@twreporter/keystoneexpressts-coreGitAzurealtair-keystoneaek7processacast-content-client@zalastax/nolb-azuanecdote-enginefogjsgas-scheduling-function-appsblueskyazure-handlerazure-metricsazure-metrics-for-nodeazure-odmazure-queueazure-mobile-servicesazure-storage-backupazure-tables-promisesazure-uploaderazure-service-busazure-service-bus-clientazureleveldownazureqlazurestoragebinderazuretablebackupazworkshops-cliazure-awesome-queueazpcsazkvsazure-abstract-queue-adapterasb-cliappesteem-utilarch-keystonebunyan-azureceruleanccfoo
2.3.1-preview

7 years ago

2.3.0-preview

7 years ago

2.2.1-preview

7 years ago

2.2.0-preview

7 years ago

2.1.0-preview

7 years ago

2.0.0-preview

8 years ago

1.2.0-preview

8 years ago

1.1.1-preview

8 years ago

1.1.0-preview

8 years ago

0.10.6

10 years ago

0.10.5

10 years ago

0.10.4

10 years ago

0.10.3

10 years ago

0.10.2

10 years ago

0.10.1

10 years ago

0.10.0

10 years ago

0.9.16

10 years ago

0.6.9-zumo

10 years ago

0.9.15

10 years ago

0.9.14

10 years ago

0.9.13

10 years ago

0.9.12

10 years ago

0.9.11

10 years ago

0.9.10

11 years ago

0.9.9

11 years ago

0.9.8

11 years ago

0.9.7

11 years ago

0.9.6

11 years ago

0.9.5

11 years ago

0.9.4

11 years ago

0.9.3

11 years ago

0.9.2

11 years ago

0.8.1

11 years ago

0.8.0

11 years ago

0.7.19

11 years ago

0.7.18

11 years ago

0.7.17

11 years ago

0.7.16

11 years ago

0.7.15

11 years ago

0.7.14

11 years ago

0.7.13

11 years ago

0.7.12

11 years ago

0.7.11

11 years ago

0.7.10

11 years ago

0.7.9

12 years ago

0.7.8

12 years ago

0.7.7

12 years ago

0.7.6

12 years ago

0.6.7-zumo

12 years ago

0.7.5

12 years ago

0.7.4

12 years ago

0.7.3

12 years ago

0.7.2

12 years ago

0.7.1

12 years ago

0.7.0

12 years ago

0.6.11

12 years ago

0.6.10

12 years ago

0.6.9

12 years ago

0.6.8

12 years ago

0.6.7

12 years ago

0.6.6

12 years ago

0.6.5

12 years ago

0.6.4

12 years ago

0.6.3

12 years ago

0.6.2

12 years ago

0.6.1

12 years ago

0.6.0

13 years ago

0.5.3

13 years ago

0.5.2

13 years ago

0.5.1

13 years ago

0.5.0

13 years ago