azure-sdk · azure-sdk · Apr 29, 2025
diff --git a/sdk/loadtesting/ci.yml b/sdk/loadtesting/ci.yml
@@ -1,5 +1,5 @@
 # NOTE: Please refer to https://aka.ms/azsdk/engsys/ci-yaml before editing this file.
-
+                
 trigger:
   branches:
     include:
@@ -19,6 +19,8 @@ pr:
       - feature/*
       - release/*
       - hotfix/*
+    exclude:
+      - feature/v4
   paths:
     include:
       - sdk/loadtesting/

diff --git a/sdk/loadtesting/load-testing-rest/CHANGELOG.md b/sdk/loadtesting/load-testing-rest/CHANGELOG.md
diff --git a/sdk/loadtesting/load-testing-rest/LICENSE b/sdk/loadtesting/load-testing-rest/LICENSE
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.
diff --git a/sdk/loadtesting/load-testing-rest/README.md b/sdk/loadtesting/load-testing-rest/README.md
@@ -1,282 +1,55 @@
-# Azure Load Testing client library for JavaScript
+# AzureLoadTesting REST client library for JavaScript
 
-Azure Load Testing provides client library in JavaScript to the user by which they can interact natively with Azure Load Testing service. Azure Load Testing is a fully managed load-testing service that enables you to generate high-scale load. The service simulates traffic for your applications, regardless of where they're hosted. Developers, testers, and quality assurance (QA) engineers can use it to optimize application performance, scalability, or capacity.
+These APIs allow end users to create, view and run load tests using Azure Load Test Service.
 
 **Please rely heavily on our [REST client docs](https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/rest-clients.md) to use this library**
 
-## Documentation
+Key links:
 
-Various documentation is available to help you get started
-
-- [Source code][source_code]
-- [API reference documentation][api_reference_doc]
-- [Product Documentation][product_documentation]
+- [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/loadtesting/load-testing-rest)
+- [Package (NPM)](https://www.npmjs.com/package/@azure-rest/load-testing)
+- [API reference documentation](https://learn.microsoft.com/javascript/api/@azure-rest/load-testing)
 
 ## Getting started
 
 ### Currently supported environments
 
-- [LTS versions of Node.js](https://github.com/nodejs/release#release-schedule)
-- Latest versions of Safari, Chrome, Edge and Firefox
+- LTS versions of Node.js
 
 ### Prerequisites
 
-- You must have an [Azure subscription](https://azure.microsoft.com/free/) and [Azure Load Test Service Resource](https://learn.microsoft.com/azure/load-testing/) to use this package. You can create the resource via the [Azure Portal](https://portal.azure.com), or the [Azure CLI](https://learn.microsoft.com/cli/azure).
+- You must have an [Azure subscription](https://azure.microsoft.com/free/) to use this package.
 
 ### Install the `@azure-rest/load-testing` package
 
-Install the Azure Load Testing client REST client library for JavaScript with `npm`:
+Install the AzureLoadTesting REST client REST client library for JavaScript with `npm`:
 
 ```bash
 npm install @azure-rest/load-testing
 ```
 
-### Create and authenticate a `AzureLoadTesting` client
+### Create and authenticate a `AzureLoadTestingClient`
 
 To use an [Azure Active Directory (AAD) token credential](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token),
 provide an instance of the desired credential type obtained from the
 [@azure/identity](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) library.
 
-To authenticate with AAD, you must first `npm` install [`@azure/identity`](https://www.npmjs.com/package/@azure/identity)
+To authenticate with AAD, you must first `npm` install [`@azure/identity`](https://www.npmjs.com/package/@azure/identity) 
 
 After setup, you can choose which type of [credential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) from `@azure/identity` to use.
 As an example, [DefaultAzureCredential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential)
 can be used to authenticate the client.
 
-Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables:
-AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET
-
-```ts snippet:ReadmeSampleCreateClient_Node
-import AzureLoadTesting from "@azure-rest/load-testing";
-import { DefaultAzureCredential } from "@azure/identity";
-
-const endpoint = "https://<endpoint>";
-const client = AzureLoadTesting(endpoint, new DefaultAzureCredential());
-```
-
-## Key concepts
-
-The following components make up the Azure Load Testing Service. The Azure Load Test client library for JavaScript allows you to interact with each of these components through the use of a dedicated client object.
-
-#### Test
-
-A test specifies the test script, and configuration settings for running a load test. You can create one or more tests in an Azure Load Testing resource.
-
-#### App Component
-
-When you run a load test for an Azure-hosted application, you can monitor resource metrics for the different Azure application components (server-side metrics). While the load test runs, and after completion of the test, you can monitor and analyze the resource metrics in the Azure Load Testing dashboard.
-
-#### Metrics
-
-During a load test, Azure Load Testing collects metrics about the test execution. There are two types of metrics:
-
-1. Client-side metrics give you details reported by the test engine. These metrics include the number of virtual users, the request response time, the number of failed requests, or the number of requests per second.
-
-2. Server-side metrics are available for Azure-hosted applications and provide information about your Azure application components. Metrics can be for the number of database reads, the type of HTTP responses, or container resource consumption.
-
-### Test Engine
-
-A test engine is computing infrastructure that runs the Apache JMeter or Locust test script. You can scale out your load test by configuring the number of test engines. The test script runs in parallel across the specified number of test engines.
-
-### Test Run
-
-A test run represents one execution of a load test. It collects the logs associated with running the Apache JMeter or Locust script, the load test YAML configuration, the list of app components to monitor, and the results of the test.
-
-### Data-Plane Endpoint
-
-Data-plane of Azure Load Testing resources is addressable using the following URL format:
-
-`00000000-0000-0000-0000-000000000000.aaa.cnt-prod.loadtesting.azure.com`
-
-The first GUID `00000000-0000-0000-0000-000000000000` is the unique identifier used for accessing the Azure Load Testing resource. This is followed by `aaa` which is the Azure region of the resource.
-
-The data-plane endpoint is obtained from Control Plane APIs. To obtain the data-plane endpoint for your resource, follow [this documentation][obtaining_data_plane_uri].
-
-**Example:** `1234abcd-12ab-12ab-12ab-123456abcdef.eus.cnt-prod.loadtesting.azure.com`
-
-In the above example, `eus` represents the Azure region `East US`.
-
-## Examples
-
-### Creating a load test
-
-```ts snippet:ReadmeSampleCreateLoadTest
-import AzureLoadTesting from "@azure-rest/load-testing";
-import { DefaultAzureCredential } from "@azure/identity";
-
-const endpoint = "https://<endpoint>";
-const client = AzureLoadTesting(endpoint, new DefaultAzureCredential());
-
-const TEST_ID = "some-test-id";
-const DISPLAY_NAME = "my-load-test";
-
-await client.path("/tests/{testId}", TEST_ID).patch({
-  contentType: "application/merge-patch+json",
-  body: {
-    displayName: DISPLAY_NAME,
-    description: "",
-    loadTestConfiguration: {
-      engineInstances: 1,
-      splitAllCSVs: false,
-    },
-    secrets: {},
-    environmentVariables: {},
-    passFailCriteria: { passFailMetrics: {} },
-  },
-});
-```
-
-### Uploading Test script file to a Test
-
-```ts snippet:ReadmeSampleUploadTestScriptFile
-import AzureLoadTesting, { isUnexpected, getLongRunningPoller } from "@azure-rest/load-testing";
-import { DefaultAzureCredential } from "@azure/identity";
-import { createReadStream } from "node:fs";
-
-const endpoint = "https://<endpoint>";
-const client = AzureLoadTesting(endpoint, new DefaultAzureCredential());
-
-const TEST_ID = "some-test-id";
-const readStream = createReadStream("./sample.jmx");
-
-const fileUploadResult = await client
-  .path("/tests/{testId}/files/{fileName}", TEST_ID, "sample.jmx")
-  .put({
-    contentType: "application/octet-stream",
-    body: readStream,
-  });
-
-if (isUnexpected(fileUploadResult)) {
-  throw fileUploadResult.body.error;
-}
-
-const fileValidatePoller = await getLongRunningPoller(client, fileUploadResult);
-const fileValidateResult = await fileValidatePoller.pollUntilDone();
-```
-
-### Running a Test and fetching Metrics
-
-```ts snippet:ReadmeSampleRunTest
-import AzureLoadTesting, { isUnexpected, getLongRunningPoller } from "@azure-rest/load-testing";
-import { DefaultAzureCredential } from "@azure/identity";
-
-const endpoint = "https://<endpoint>";
-const client = AzureLoadTesting(endpoint, new DefaultAzureCredential());
-
-const TEST_ID = "some-test-id";
-const DISPLAY_NAME = "my-load-test";
-const TEST_RUN_ID = "some-test-run-id";
-
-// Creating/Updating the test run
-const testRunCreationResult = await client.path("/test-runs/{testRunId}", TEST_RUN_ID).patch({
-  contentType: "application/merge-patch+json",
-  body: {
-    testId: TEST_ID,
-    displayName: DISPLAY_NAME,
-  },
-});
-
-if (isUnexpected(testRunCreationResult)) {
-  throw testRunCreationResult.body.error;
-}
-
-const testRunPoller = await getLongRunningPoller(client, testRunCreationResult);
-const testRunResult = await testRunPoller.pollUntilDone();
-
-const testRunStarttime = testRunResult.body.startDateTime;
-const testRunEndTime = testRunResult.body.endDateTime;
-
-// get list of all metric namespaces and pick the first one
-const metricNamespaces = await client
-  .path("/test-runs/{testRunId}/metric-namespaces", TEST_RUN_ID)
-  .get();
-
-if (isUnexpected(metricNamespaces)) {
-  throw metricNamespaces.body.error;
-}
-
-const metricNamespace = metricNamespaces.body.value[0];
-
-if (metricNamespace.name === undefined) {
-  throw "No Metric Namespace name is defined.";
-}
-
-// get list of all metric definitions and pick the first one
-const metricDefinitions = await client
-  .path("/test-runs/{testRunId}/metric-definitions", TEST_RUN_ID)
-  .get({
-    queryParameters: {
-      metricNamespace: metricNamespace.name,
-    },
-  });
-
-if (isUnexpected(metricDefinitions)) {
-  throw metricDefinitions.body.error;
-}
-
-const metricDefinition = metricDefinitions.body.value[0];
-
-if (metricDefinition.name === undefined) {
-  throw "No Metric Namespace name is defined.";
-}
-
-// fetch client metrics using metric namespace and metric name
-const metricsResult = await client.path("/test-runs/{testRunId}/metrics", TEST_RUN_ID).post({
-  queryParameters: {
-    metricname: metricDefinition.name,
-    metricNamespace: metricNamespace.name,
-    timespan: testRunStarttime + "/" + testRunEndTime,
-  },
-});
-
-if (isUnexpected(metricsResult)) {
-  throw metricsResult.body.error;
-}
-
-for (const timeSeries of metricsResult.body.value) {
-  console.log(timeSeries);
-}
-```
-
 ## Troubleshooting
 
 ### Logging
 
 Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:
 
-```ts snippet:SetLogLevel
+```ts 
 import { setLogLevel } from "@azure/logger";
 
 setLogLevel("info");
 ```
 
 For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger).
-
-## Next steps
-
-Azure Loading Testing JavaScript SDK samples are available to you in the SDK's GitHub repository. These samples provide example code for additional scenarios commonly encountered.
-
-See [Azure Load Testing samples][sample_code].
-
-## Contributing
-
-For details on contributing to this repository, see the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more on how to build and test the code.
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
-
-## Related Projects
-
-- [Microsoft Azure SDK for JavaScript](https://github.com/Azure/azure-sdk-for-js)
-
-<!-- LINKS -->
-
-[source_code]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/loadtesting/load-testing-rest/src
-[sample_code]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/loadtesting/load-testing-rest/samples/v1-beta
-[api_reference_doc]: https://learn.microsoft.com/rest/api/loadtesting/
-[obtaining_data_plane_uri]: https://learn.microsoft.com/rest/api/loadtesting/data-plane-uri
-[product_documentation]: https://azure.microsoft.com/services/load-testing/
-[azure_subscription]: https://azure.microsoft.com/free/
diff --git a/sdk/loadtesting/load-testing-rest/api-extractor.json b/sdk/loadtesting/load-testing-rest/api-extractor.json
@@ -28,4 +28,4 @@
       }
     }
   }
-}
+}
diff --git a/sdk/loadtesting/load-testing-rest/assets.json b/sdk/loadtesting/load-testing-rest/assets.json
diff --git a/sdk/loadtesting/load-testing-rest/eslint.config.mjs b/sdk/loadtesting/load-testing-rest/eslint.config.mjs
@@ -3,6 +3,11 @@ import azsdkEslint from "@azure/eslint-plugin-azure-sdk";
 export default azsdkEslint.config([
   {
     rules: {
+      "@azure/azure-sdk/ts-modules-only-named": "warn",
+      "@azure/azure-sdk/ts-package-json-types": "warn",
+      "@azure/azure-sdk/ts-package-json-engine-is-present": "warn",
+      "@azure/azure-sdk/ts-package-json-files-required": "off",
+      "@azure/azure-sdk/ts-package-json-main-is-cjs": "off",
       "tsdoc/syntax": "warn",
     },
   },
-Original file line number
+Diff line change
@@ Expand Up / @@ -28,4 +28,4 @@ @@
           }
         }
       }
-    }
+    }