| 1 | # ms-rest-azure-js [](https://dev.azure.com/azure-public/azsdk/_build/latest?definitionId=31&branchName=master)
|
| 2 | Azure Runtime with support for long running operations used by packages generated via the code generator [@microsoft.azure/autorest.typescript](https://www.npmjs.com/package/@microsoft.azure/autorest.typescript).
|
| 3 |
|
| 4 | Use this package if you are writing a library for one of the Azure services whose API requires support for long running operations.
|
| 5 | To write a library for one of the Azure services whose API does not need support for long running operations, [@azure/ms-rest-js](https://www.npmjs.com/package/@azure/ms-rest-js) should suffice.
|
| 6 |
|
| 7 | If you are not a library writer for any of the Azure services, you should not need to use this package except for one scenario which is authenticating to any of the Cognitive Services using the below packages. This is when you would use the [CognitiveServicesCredentials](https://github.com/Azure/ms-rest-azure-js/blob/71b0b77ab7c3b9ecb731baab61d207eaa8bb2e97/lib/credentials/cognitiveServicesCredentials.ts#L12) exported from this package.
|
| 8 |
|
| 9 | - [@azure/cognitiveservices-computervision](https://www.npmjs.com/package/@azure/cognitiveservices-computervision)
|
| 10 | - [@azure/cognitiveservices-luis-authoring](https://www.npmjs.com/package/@azure/cognitiveservices-luis-authoring)
|
| 11 | - [@azure/cognitiveservices-luis-runtime](https://www.npmjs.com/package/@azure/cognitiveservices-luis-runtime)
|
| 12 | - [@azure/cognitiveservices-qnamaker](https://www.npmjs.com/package/@azure/cognitiveservices-qnamaker)
|
| 13 | - [@azure/cognitiveservices-qnamaker-runtime](https://www.npmjs.com/package/@azure/cognitiveservices-qnamaker-runtime)
|
| 14 | - [@azure/cognitiveservices-imagesearch](https://www.npmjs.com/package/@azure/cognitiveservices-imagesearch)
|
| 15 | - [@azure/cognitiveservices-contentmoderator](https://www.npmjs.com/package/@azure/cognitiveservices-contentmoderator)
|
| 16 | - [@azure/cognitiveservices-anomalydetector](https://www.npmjs.com/package/@azure/cognitiveservices-anomalydetector)
|
| 17 | - [@azure/cognitiveservices-face](https://www.npmjs.com/package/@azure/cognitiveservices-face)
|
| 18 | - [@azure/cognitiveservices-websearch](https://www.npmjs.com/package/@azure/cognitiveservices-websearch)
|
| 19 | - [@azure/cognitiveservices-spellcheck](https://www.npmjs.com/package/@azure/cognitiveservices-spellcheck)
|
| 20 | - [@azure/cognitiveservices-customvision-prediction](https://www.npmjs.com/package/@azure/cognitiveservices-customvision-prediction)
|
| 21 | - [@azure/cognitiveservices-customvision-training](https://www.npmjs.com/package/@azure/cognitiveservices-customvision-training)
|
| 22 | - [@azure/cognitiveservices-customsearch](https://www.npmjs.com/package/@azure/cognitiveservices-customsearch)
|
| 23 | - [@azure/cognitiveservices-localsearch](https://www.npmjs.com/package/@azure/cognitiveservices-localsearch)
|
| 24 | - [@azure/cognitiveservices-personalizer](https://www.npmjs.com/package/@azure/cognitiveservices-personalizer)
|
| 25 | - [@azure/cognitiveservices-newssearch](https://www.npmjs.com/package/@azure/cognitiveservices-newssearch)
|
| 26 | - [@azure/cognitiveservices-visualsearch](https://www.npmjs.com/package/@azure/cognitiveservices-visualsearch)
|
| 27 | - [@azure/cognitiveservices-videosearch](https://www.npmjs.com/package/@azure/cognitiveservices-videosearch)
|
| 28 | - [@azure/cognitiveservices-formrecognizer](https://www.npmjs.com/package/@azure/cognitiveservices-formrecognizer)
|
| 29 | - [@azure/cognitiveservices-autosuggest](https://www.npmjs.com/package/@azure/cognitiveservices-autosuggest)
|
| 30 | - [@azure/cognitiveservices-entitysearch](https://www.npmjs.com/package/@azure/cognitiveservices-entitysearch)
|
| 31 | - [@azure/cognitiveservices-customimagesearch](https://www.npmjs.com/package/@azure/cognitiveservices-customimagesearch)
|
| 32 | - [@azure/cognitiveservices-translatortext](https://www.npmjs.com/package/@azure/cognitiveservices-translatortext)
|
| 33 | - [@azure/cognitiveservices-textanalytics](https://www.npmjs.com/package/@azure/cognitiveservices-textanalytics)
|
| 34 |
|
| 35 | ## Requirements
|
| 36 | - node.js version > 6.x
|
| 37 | - npm install -g typescript
|
| 38 |
|
| 39 | ## Installation
|
| 40 | - After cloning the repo, execute `npm install`
|
| 41 |
|
| 42 | ## Execution
|
| 43 |
|
| 44 | ### node.js
|
| 45 | - Set the subscriptionId and token
|
| 46 | - Run `node samples/node-sample.js`
|
| 47 |
|
| 48 | ### In the browser
|
| 49 | - Set the subscriptionId and token and then run
|
| 50 | - Open index.html file in the browser. It should show the response from GET request on the storage account. From Chrome type Ctrl + Shift + I and you can see the logs in console.
|
| 51 |
|
| 52 | # Contributing
|
| 53 |
|
| 54 | This project welcomes contributions and suggestions. Most contributions require you to agree to a
|
| 55 | Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
|
| 56 | the rights to use your contribution. For details, visit https://cla.microsoft.com.
|
| 57 |
|
| 58 | When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
|
| 59 | a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
|
| 60 | provided by the bot. You will only need to do this once across all repos using our CLA.
|
| 61 |
|
| 62 | This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
| 63 | For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
|
| 64 | contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|