diff --git a/.docsettings.yml b/.docsettings.yml index 196128c2e5f2..f851db1a7030 100644 --- a/.docsettings.yml +++ b/.docsettings.yml @@ -64,7 +64,6 @@ known_content_issues: - ["sdk/eventgrid/eventgrid/README.md", "#1583"] - ["sdk/core/abort-controller/README.md", "#1583"] - ["sdk/core/core-auth/README.md", "#1583"] - - ["sdk/core/core-arm/README.md", "#1583"] - ["sdk/cosmosdb/cosmos/README.md", "#1583"] - ["sdk/cosmosdb/cosmos/src/test/readme.md", "#1583"] - ["sdk/cosmosdb/cosmos/samples/readme.md", "#1583"] diff --git a/sdk/core/core-arm/README.md b/sdk/core/core-arm/README.md index 8b32314ef9e1..9451d4747d7e 100644 --- a/sdk/core/core-arm/README.md +++ b/sdk/core/core-arm/README.md @@ -1,19 +1,29 @@ -# ms-rest-azure-js [![Build Status](https://dev.azure.com/azure-public/azsdk/_apis/build/status/public.Azure.ms-rest-azure-js%20-%20CI?branchName=master)](https://dev.azure.com/azure-public/azsdk/_build/latest?definitionId=31&branchName=master) +# Azure Core ARM client library for JS -Azure Runtime for isomorphic javascript libraries (that work in the browser and node.js environemnt) generated via [Autorest](https://github.com/Azure/Autorest). +This is an Azure-specific layer for the core HTTP pipeline of Azure SDK JavaScript libraries which work in the browser and Node.js. This library is primarily intended to be used in code generated by [AutoRest](https://github.com/Azure/Autorest) and [`autorest.typescript`](https://github.com/Azure/autorest.typescript). -## Requirements +## Getting started -- node.js version > 6.x +### Requirements + +- Node.js version > 6.x - npm install -g typescript -## Installation +### Installation - After cloning the repo, execute `npm install` -## Execution +## Key concepts + +This library provides a `ServiceClient` subclass called `AzureServiceClient` which adds some Azure-specific behavior such as the management of long-running operations. For more information on the design of the underlying library `@azure/core-http`, consult the [architecture overview](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/core/core-http/docs/architectureOverview.md). + +## Examples + +Examples can be found in the `samples` folder. -### node.js +## Next steps + +### Node.js - Set the subscriptionId and token - Run `node samples/node-sample.js` @@ -23,6 +33,10 @@ Azure Runtime for isomorphic javascript libraries (that work in the browser and - Set the subscriptionId and token and then run - 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. +## Troubleshooting + +If you run into issues while using this library, please feel free to [file an issue](https://github.com/Azure/azure-sdk-for-js/issues/new). + # Contributing This project welcomes contributions and suggestions. Most contributions require you to agree to a diff --git a/sdk/core/core-http/README.md b/sdk/core/core-http/README.md index ac13adf33f88..0c0d8e229494 100644 --- a/sdk/core/core-http/README.md +++ b/sdk/core/core-http/README.md @@ -1,12 +1,12 @@ # Azure Core HTTP client library for JS -This is the core HTTP pipeline for Azure SDK JavaScript libraries which work in the browser and Node.js. This library is primarily intended to be used in code generated by [AutoRest](https://github.com/Azure/Autorest). +This is the core HTTP pipeline for Azure SDK JavaScript libraries which work in the browser and Node.js. This library is primarily intended to be used in code generated by [AutoRest](https://github.com/Azure/Autorest) and [`autorest.typescript`](https://github.com/Azure/autorest.typescript). ## Getting started ### Requirements -- node.js version > 6.x +- Node.js version > 6.x - npm install -g typescript ### Installation @@ -23,7 +23,7 @@ Examples can be found in the `samples` folder. ## Next steps -### node.js +### Node.js - Set the subscriptionId and token - Run `node samples/node-sample.js`