Files
Minh-Anh PhanandGitHub 3181ad2806 [EngSys] Bump min-version to node 22 (#38887) ***NO_CI***
This pull request updates the Node.js version requirement across
multiple files and tools in the repository. The changes ensure
compatibility with Node.js version 22 and its corresponding type
definitions. Resolves #37945.

***NO_CI***
2026-06-23 16:25:55 -07:00
..

page_type, languages, products, urlFragment
page_type languages products urlFragment
sample
javascript
azure
azure-load-testing
load-testing-javascript

Azure Load Testing client library samples for JavaScript

These sample programs show how to use the JavaScript client libraries for Azure Load Testing in some common scenarios.

File Name Description
addAppComponents.js Demonstrates how to add app components to an existing test.
cloneTest.js Demonstrates how to clone an existing load test.
createOrUpdateTest.js Demonstrates how to create a load test
generateInsights.js Demonstrates how to generate insights for a completed test run.
generateTestPlanRecommendations.js Demonstrates how to generate test plan recommendations for a load test.
notificationRule.js Demonstrates how to create, get, list, and delete notification rules for load tests.
scheduleTestTrigger.js Demonstrates how to create, get, list, and delete schedule triggers for load tests.
startTestRunAndGetMetrics.js Demonstrates how to start a test run and get metrics.
stopTestRun.js Demonstrates how to stop a running load test
uploadTestScript.js Demonstrates how to upload a test script file.

Prerequisites

The sample programs are compatible with LTS versions of Node.js.

You need an Azure subscription and the following Azure resources to run these sample programs:

Samples retrieve credentials to access the service endpoint from environment variables. Alternatively, edit the source code to include the appropriate credentials. See each individual sample for details on which environment variables/credentials it requires to function.

Adapting the samples to run in the browser may require some additional consideration. For details, please see the package README.

Setup

To run the samples using the published version of the package:

  1. Install the dependencies using npm:
npm install
  1. Edit the file sample.env, adding the correct credentials to access the Azure service and run the samples. Then rename the file from sample.env to just .env. The sample programs will read this file automatically.

  2. Run whichever samples you like (note that some samples may require additional setup, see the table above):

node addAppComponents.js

Alternatively, run a single sample with the required environment variables set (setting up the .env file is not required if you do this), for example (cross-platform):

npx cross-env LOADTESTSERVICE_ENDPOINT="<loadtestservice endpoint>" LOADTESTSERVICE_TESTID="<loadtestservice testid>" node addAppComponents.js

Next Steps

Take a look at our API Documentation for more information about the APIs that are available in the clients.