Skip to content

Commit cfb3d54

Browse files
Merge pull request #222290 from ninallam/patch-2
Update reference-test-config-yaml.md
2 parents e9a6024 + 950bc1a commit cfb3d54

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

articles/load-testing/reference-test-config-yaml.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,12 @@ A test configuration uses the following keys:
2525
| Key | Type | Default value | Description |
2626
| ----- | ----- | ----- | ---- |
2727
| `version` | string | | Version of the YAML configuration file that the service uses. Currently, the only valid value is `v0.1`. |
28-
| `testName` | string | | *Required*. Name of the test to run. The results of various test runs will be collected under this test name in the Azure portal. |
28+
| `testId` | string | | *Required*. Id of the test to run. For a new test, enter an Id with characters [a-z0-9_-]. For an existing test, you can get the test Id from the test details page in Azure portal. This field was called `testName` earlier, which has been deprecated. You can still run existing tests with `testName`field. |
29+
| `displayName` | string | | Display name of the test. This will be shown in the list of tests in Azure portal. If not provided, testId is used as the display name. |
2930
| `testPlan` | string | | *Required*. Relative path to the Apache JMeter test script to run. |
3031
| `engineInstances` | integer | | *Required*. Number of parallel instances of the test engine to execute the provided test plan. You can update this property to increase the amount of load that the service can generate. |
3132
| `configurationFiles` | array | | List of relevant configuration files or other files that you reference in the Apache JMeter script. For example, a CSV data set file, images, or any other data file. These files will be uploaded to the Azure Load Testing resource alongside the test script. If the files are in a subfolder on your local machine, use file paths that are relative to the location of the test script. <BR><BR>Azure Load Testing currently doesn't support the use of file paths in the JMX file. When you reference an external file in the test script, make sure to only specify the file name. |
32-
| `description` | string | | Short description of the test run. |
33+
| `description` | string | | Short description of the test. |
3334
| `subnetId` | string | | Resource ID of the subnet for testing privately hosted endpoints (VNET injection). This subnet will host the injected test engine VMs. For more information, see [how to load test privately hosted endpoints](./how-to-test-private-endpoint.md). |
3435
| `failureCriteria` | object | | Criteria that indicate when a test should fail. The structure of a fail criterion is: `Request: Aggregate_function (client_metric) condition threshold`. For more information on the supported values, see [Define load test fail criteria](./how-to-define-test-criteria.md#load-test-fail-criteria). |
3536
| `properties` | object | | List of properties to configure the load test. |
@@ -50,7 +51,8 @@ The following YAML snippet contains an example load test configuration:
5051

5152
```yaml
5253
version: v0.1
53-
testName: SampleTest
54+
testId: SampleTest
55+
displayName: Sample Test
5456
testPlan: SampleTest.jmx
5557
description: Load test website home page
5658
engineInstances: 1

0 commit comments

Comments
 (0)