This repository is intended for active development of the Azure SDK for JavaScript (NodeJS & Browser). For consumers of the SDK we recommend visiting our public developer docs or our versioned developer docs.
For your convenience, each service has a separate set of libraries that you can choose to use instead of one, large Azure package. To get started with a specific library, see the README.md file located in the library's project folder. You can find service libraries in the /sdk directory.
Each service might have a number of libraries available from each of the following categories:
New wave of packages that we are announcing as GA and several that are currently releasing in preview on npm. These libraries allow you to use and consume existing resources and interact with them. These libraries share a number of core functionalities found in the Azure Core package such as retries, logging, transport protocols, authentication protocols, etc. Learn more about these libraries by reading the guidelines that they follow.
The libraries released in the November 2019 GA release:
- @azure/storage-blob
- @azure/storage-queue
- @azure/keyvault-keys
- @azure/keyvault-secrets
- @azure/identity
The libraries released in the November 2019 preview:
- @azure/storage-file-share@next
- @azure/event-hubs@next
- @azure/keyvault-certificates@next
- @azure/app-configuration@next
NOTE: If you need to ensure your code is ready for production use one of the stable, non-preview libraries.
Last stable versions of packages that have been provided for usage with Azure and are production-ready. These libraries provide you with similar functionalities to the Preview ones as they allow you to use and consume existing resources and interact with them, for example: upload a blob. They might not implement the guidelines or have the same feature set as the Novemeber releases. They do however offer wider coverage of services.
Libraries which enable you to provision specific resources. They are responsible for directly mirroring and consuming Azure service's REST endpoints. You can recognize these libraries by mgmt or arm in their package names.
- For detailed documentation visit our Azure SDK for JavaScript documentation
- File an issue via Github Issues
- Check previous questions or ask new ones on StackOverflow using
azure-sdk-jstag.
Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) secure@microsoft.com. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the MSRC PGP key, can be found in the Security TechCenter.
For details on contributing to this repository, see the contributing guide.
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
