Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/core-http

Package version

Azure Core HTTP client library for JavaScript

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 and autorest.typescript.

Getting started

Requirements

  • Node.js version > 8.x
  • Typescript compiler
npm install -g typescript

Installation

This package is primarily used in generated code and not meant to be consumed directly by end users.

Key concepts

You can find an explanation of how this repository's code works by going to our architecture overview.

Examples

Examples can be found in the samples folder.

Next steps

  • Build this library (core-http). For more information on how to build project in this repo, please refer to the Contributing Guide.

  • The code in samples\node-sample.ts shows how to create a ServiceClient instance with a test TokenCredential implementation and use the client instance to perform a GET operation from the Azure management service endpoint for subscriptions. To run the code, first obtain an access token to the Azure management service.

One easy way to get an access token is using Azure CLI

  1. Sign in
    az login
  2. Select the subscription to use
    az account set -s <subscription id>
  3. Obtain an access token
    az account get-access-token --resource=https://management.azure.com

NodeJS

  • Set values of subscriptionId and token variable in samples/node-sample.ts

  • Change directory to samples folder, compile the TypeScript code, then run the sample

cd samples
tsc node-sample.ts
node node-sample.js

Browser

Troubleshooting

If you run into issues while using this library, please feel free to file an issue.

Contributing

If you'd like to contribute to this library, please read the contributing guide to learn more about how to build and test the code.

Impressions

Generated using TypeDoc