LoadTestRunAsyncClient Class

Package:: com.azure.developer.loadtesting

Maven Artifact:: com.azure:azure-developer-loadtesting:1.0.28

java.lang.Object
- com.azure.developer.loadtesting.LoadTestRunAsyncClient

public final class LoadTestRunAsyncClient

Initializes a new instance of the asynchronous LoadTestingClient type.

Method Summary

Modifier and Type	Method and Description
PollerFlux<BinaryData,BinaryData>	beginTestRun(String testRunId, BinaryData body, RequestOptions testRunRequestOptions) Starts a test run and polls the status of the test run.
reactor.core.publisher.Mono<Response<BinaryData>>	createOrUpdateAppComponentsWithResponse(String testRunId, BinaryData body, RequestOptions requestOptions) Associate an app component (collection of azure resources) to a test run.
reactor.core.publisher.Mono<Response<BinaryData>>	createOrUpdateServerMetricsConfigWithResponse(String testRunId, BinaryData body, RequestOptions requestOptions) Configure server metrics for a test run.
reactor.core.publisher.Mono<Response<Void>>	deleteTestRunWithResponse(String testRunId, RequestOptions requestOptions) Delete a test run by its name.
reactor.core.publisher.Mono<Response<BinaryData>>	getAppComponentsWithResponse(String testRunId, RequestOptions requestOptions) Get associated app component (collection of azure resources) for the given test run.
reactor.core.publisher.Mono<Response<BinaryData>>	getMetricDefinitionsWithResponse(String testRunId, String metricNamespace, RequestOptions requestOptions) List the metric definitions for a load test run.
reactor.core.publisher.Mono<Response<BinaryData>>	getMetricNamespacesWithResponse(String testRunId, RequestOptions requestOptions) List the metric namespaces for a load test run.
reactor.core.publisher.Mono<Response<BinaryData>>	getServerMetricsConfigWithResponse(String testRunId, RequestOptions requestOptions) List server metrics configuration for the given test run.
reactor.core.publisher.Mono<Response<BinaryData>>	getTestRunFileWithResponse(String testRunId, String fileName, RequestOptions requestOptions) Get test run file by file name.
reactor.core.publisher.Mono<Response<BinaryData>>	getTestRunWithResponse(String testRunId, RequestOptions requestOptions) Get test run details by name.
PagedFlux<BinaryData>	listMetricDimensionValues(String testRunId, String name, String metricName, String metricNamespace, String timespan, RequestOptions requestOptions) List the dimension values for the given metric dimension name.
PagedFlux<BinaryData>	listMetrics(String testRunId, String metricName, String metricNamespace, String timespan, RequestOptions requestOptions) List the metric values for a load test run.
PagedFlux<BinaryData>	listTestRuns(RequestOptions requestOptions) Get all test runs with given filters.
reactor.core.publisher.Mono<Response<BinaryData>>	stopTestRunWithResponse(String testRunId, RequestOptions requestOptions) Stop test run by name.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

beginTestRun

public PollerFlux<BinaryData,BinaryData> beginTestRun(String testRunId, BinaryData body, RequestOptions testRunRequestOptions)

Starts a test run and polls the status of the test run.

Parameters:

testRunId - Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.

body - Load test run model.

testRunRequestOptions - The options to configure the file upload HTTP request before HTTP client sends it.

Returns:

A PollerFlux<T,U> to poll on and retrieve the test run status(ACCEPTED/NOTSTARTED/PROVISIONING/PROVISIONED/CONFIGURING/CONFIGURED/EXECUTING/EXECUTED/DEPROVISIONING/DEPROVISIONED/DONE/CANCELLING/CANCELLED/FAILED/VALIDATION_SUCCESS/VALIDATION_FAILURE).

createOrUpdateAppComponentsWithResponse

public Mono<Response<BinaryData>> createOrUpdateAppComponentsWithResponse(String testRunId, BinaryData body, RequestOptions requestOptions)

Associate an app component (collection of azure resources) to a test run.

Request Body Schema

{
     components (Required): {
         String (Required): {
             resourceId: String (Optional)
             resourceName: String (Optional)
             resourceType: String (Optional)
             displayName: String (Optional)
             resourceGroup: String (Optional)
             subscriptionId: String (Optional)
             kind: String (Optional)
         }
     }
     testRunId: String (Optional)
     createdDateTime: OffsetDateTime (Optional)
     createdBy: String (Optional)
     lastModifiedDateTime: OffsetDateTime (Optional)
     lastModifiedBy: String (Optional)
 }

Response Body Schema

{
     components (Required): {
         String (Required): {
             resourceId: String (Optional)
             resourceName: String (Optional)
             resourceType: String (Optional)
             displayName: String (Optional)
             resourceGroup: String (Optional)
             subscriptionId: String (Optional)
             kind: String (Optional)
         }
     }
     testRunId: String (Optional)
     createdDateTime: OffsetDateTime (Optional)
     createdBy: String (Optional)
     lastModifiedDateTime: OffsetDateTime (Optional)
     lastModifiedBy: String (Optional)
 }

Parameters:

testRunId - Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.

body - App Component model.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

test run app component along with Response<T> on successful completion of Mono.

createOrUpdateServerMetricsConfigWithResponse

public Mono<Response<BinaryData>> createOrUpdateServerMetricsConfigWithResponse(String testRunId, BinaryData body, RequestOptions requestOptions)

Configure server metrics for a test run.

Request Body Schema

{
     testRunId: String (Optional)
     metrics (Optional): {
         String (Required): {
             id: String (Optional)
             resourceId: String (Required)
             metricNamespace: String (Required)
             displayDescription: String (Optional)
             name: String (Required)
             aggregation: String (Required)
             unit: String (Optional)
             resourceType: String (Required)
         }
     }
     createdDateTime: OffsetDateTime (Optional)
     createdBy: String (Optional)
     lastModifiedDateTime: OffsetDateTime (Optional)
     lastModifiedBy: String (Optional)
 }

Response Body Schema

{
     testRunId: String (Optional)
     metrics (Optional): {
         String (Required): {
             id: String (Optional)
             resourceId: String (Required)
             metricNamespace: String (Required)
             displayDescription: String (Optional)
             name: String (Required)
             aggregation: String (Required)
             unit: String (Optional)
             resourceType: String (Required)
         }
     }
     createdDateTime: OffsetDateTime (Optional)
     createdBy: String (Optional)
     lastModifiedDateTime: OffsetDateTime (Optional)
     lastModifiedBy: String (Optional)
 }

Parameters:

testRunId - Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.

body - Server metric configuration model.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

test run server metrics configuration along with Response<T> on successful completion of Mono.

deleteTestRunWithResponse

public Mono<Response<Void>> deleteTestRunWithResponse(String testRunId, RequestOptions requestOptions)

Delete a test run by its name.

Parameters:

testRunId - Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response<T> on successful completion of Mono.

getAppComponentsWithResponse

public Mono<Response<BinaryData>> getAppComponentsWithResponse(String testRunId, RequestOptions requestOptions)

Get associated app component (collection of azure resources) for the given test run.

Response Body Schema

{
     components (Required): {
         String (Required): {
             resourceId: String (Optional)
             resourceName: String (Optional)
             resourceType: String (Optional)
             displayName: String (Optional)
             resourceGroup: String (Optional)
             subscriptionId: String (Optional)
             kind: String (Optional)
         }
     }
     testRunId: String (Optional)
     createdDateTime: OffsetDateTime (Optional)
     createdBy: String (Optional)
     lastModifiedDateTime: OffsetDateTime (Optional)
     lastModifiedBy: String (Optional)
 }

Parameters:

testRunId - Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

associated app component (collection of azure resources) for the given test run along with Response<T> on successful completion of Mono.

getMetricDefinitionsWithResponse

public Mono<Response<BinaryData>> getMetricDefinitionsWithResponse(String testRunId, String metricNamespace, RequestOptions requestOptions)

List the metric definitions for a load test run.

Response Body Schema

{
     value (Required): [
          (Required){
             dimensions (Optional): [
                  (Optional){
                     description: String (Optional)
                     name: String (Optional)
                 }
             ]
             description: String (Optional)
             name: String (Optional)
             namespace: String (Optional)
             primaryAggregationType: String(Average/Count/None/Total/Percentile90/Percentile95/Percentile99) (Optional)
             supportedAggregationTypes (Optional): [
                 String (Optional)
             ]
             unit: String(NotSpecified/Percent/Count/Seconds/Milliseconds/Bytes/BytesPerSecond/CountPerSecond) (Optional)
             metricAvailabilities (Optional): [
                  (Optional){
                     timeGrain: String(PT5S/PT10S/PT1M/PT5M/PT1H) (Optional)
                 }
             ]
         }
     ]
 }

Parameters:

testRunId - Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.

metricNamespace - Metric namespace to query metric definitions for.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

represents collection of metric definitions along with Response<T> on successful completion of Mono.

getMetricNamespacesWithResponse

public Mono<Response<BinaryData>> getMetricNamespacesWithResponse(String testRunId, RequestOptions requestOptions)

List the metric namespaces for a load test run.

Response Body Schema

{
     value (Required): [
          (Required){
             description: String (Optional)
             name: String (Optional)
         }
     ]
 }

Parameters:

testRunId - Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

represents collection of metric namespaces along with Response<T> on successful completion of Mono.

getServerMetricsConfigWithResponse

public Mono<Response<BinaryData>> getServerMetricsConfigWithResponse(String testRunId, RequestOptions requestOptions)

List server metrics configuration for the given test run.

Response Body Schema

{
     testRunId: String (Optional)
     metrics (Optional): {
         String (Required): {
             id: String (Optional)
             resourceId: String (Required)
             metricNamespace: String (Required)
             displayDescription: String (Optional)
             name: String (Required)
             aggregation: String (Required)
             unit: String (Optional)
             resourceType: String (Required)
         }
     }
     createdDateTime: OffsetDateTime (Optional)
     createdBy: String (Optional)
     lastModifiedDateTime: OffsetDateTime (Optional)
     lastModifiedBy: String (Optional)
 }

Parameters:

testRunId - Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

test run server metrics configuration along with Response<T> on successful completion of Mono.

getTestRunFileWithResponse

public Mono<Response<BinaryData>> getTestRunFileWithResponse(String testRunId, String fileName, RequestOptions requestOptions)

Get test run file by file name.

Response Body Schema

{
     url: String (Optional)
     fileName: String (Optional)
     fileType: String(JMX_FILE/USER_PROPERTIES/ADDITIONAL_ARTIFACTS) (Optional)
     expireDateTime: OffsetDateTime (Optional)
     validationStatus: String(NOT_VALIDATED/VALIDATION_SUCCESS/VALIDATION_FAILURE/VALIDATION_INITIATED/VALIDATION_NOT_REQUIRED) (Optional)
     validationFailureDetails: String (Optional)
 }

Parameters:

testRunId - Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.

fileName - Test run file name with file extension.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

test run file by file name along with Response<T> on successful completion of Mono.

getTestRunWithResponse

public Mono<Response<BinaryData>> getTestRunWithResponse(String testRunId, RequestOptions requestOptions)

Get test run details by name.

Response Body Schema

{
     passFailCriteria (Optional): {
         passFailMetrics (Optional): {
             String (Required): {
                 clientMetric: String(response_time_ms/latency/error/requests/requests_per_sec) (Optional)
                 aggregate: String(count/percentage/avg/p50/p90/p95/p99/min/max) (Optional)
                 condition: String (Optional)
                 requestName: String (Optional)
                 value: Double (Optional)
                 action: String(continue/stop) (Optional)
                 actualValue: Double (Optional)
                 result: String(passed/undetermined/failed) (Optional)
             }
         }
     }
     secrets (Optional): {
         String (Required): {
             value: String (Optional)
             type: String(AKV_SECRET_URI/SECRET_VALUE) (Optional)
         }
     }
     certificate (Optional): {
         value: String (Optional)
         type: String(AKV_CERT_URI) (Optional)
         name: String (Optional)
     }
     environmentVariables (Optional): {
         String: String (Required)
     }
     errorDetails (Optional): [
          (Optional){
             message: String (Optional)
         }
     ]
     testRunStatistics (Optional): {
         String (Required): {
             transaction: String (Optional)
             sampleCount: Double (Optional)
             errorCount: Double (Optional)
             errorPct: Double (Optional)
             meanResTime: Double (Optional)
             medianResTime: Double (Optional)
             maxResTime: Double (Optional)
             minResTime: Double (Optional)
             pct1ResTime: Double (Optional)
             pct2ResTime: Double (Optional)
             pct3ResTime: Double (Optional)
             throughput: Double (Optional)
             receivedKBytesPerSec: Double (Optional)
             sentKBytesPerSec: Double (Optional)
         }
     }
     loadTestConfiguration (Optional): {
         engineInstances: Integer (Optional)
         splitAllCSVs: Boolean (Optional)
         quickStartTest: Boolean (Optional)
         optionalLoadTestConfig (Optional): {
             endpointUrl: String (Optional)
             virtualUsers: Integer (Optional)
             rampUpTime: Integer (Optional)
             duration: Integer (Optional)
         }
     }
     testArtifacts (Optional): {
         inputArtifacts (Optional): {
             configFileInfo (Optional): {
                 url: String (Optional)
                 fileName: String (Optional)
                 fileType: String(JMX_FILE/USER_PROPERTIES/ADDITIONAL_ARTIFACTS) (Optional)
                 expireDateTime: OffsetDateTime (Optional)
                 validationStatus: String(NOT_VALIDATED/VALIDATION_SUCCESS/VALIDATION_FAILURE/VALIDATION_INITIATED/VALIDATION_NOT_REQUIRED) (Optional)
                 validationFailureDetails: String (Optional)
             }
             testScriptFileInfo (Optional): (recursive schema, see testScriptFileInfo above)
             userPropFileInfo (Optional): (recursive schema, see userPropFileInfo above)
             inputArtifactsZipFileInfo (Optional): (recursive schema, see inputArtifactsZipFileInfo above)
             additionalFileInfo (Optional): [
                 (recursive schema, see above)
             ]
         }
         outputArtifacts (Optional): {
             resultFileInfo (Optional): (recursive schema, see resultFileInfo above)
             logsFileInfo (Optional): (recursive schema, see logsFileInfo above)
         }
     }
     testResult: String(PASSED/NOT_APPLICABLE/FAILED) (Optional)
     virtualUsers: Integer (Optional)
     testRunId: String (Optional)
     displayName: String (Optional)
     testId: String (Optional)
     description: String (Optional)
     status: String(ACCEPTED/NOTSTARTED/PROVISIONING/PROVISIONED/CONFIGURING/CONFIGURED/EXECUTING/EXECUTED/DEPROVISIONING/DEPROVISIONED/DONE/CANCELLING/CANCELLED/FAILED/VALIDATION_SUCCESS/VALIDATION_FAILURE) (Optional)
     startDateTime: OffsetDateTime (Optional)
     endDateTime: OffsetDateTime (Optional)
     executedDateTime: OffsetDateTime (Optional)
     portalUrl: String (Optional)
     duration: Long (Optional)
     subnetId: String (Optional)
     createdDateTime: OffsetDateTime (Optional)
     createdBy: String (Optional)
     lastModifiedDateTime: OffsetDateTime (Optional)
     lastModifiedBy: String (Optional)
 }

Parameters:

testRunId - Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

test run details by name along with Response<T> on successful completion of Mono.

listMetricDimensionValues

public PagedFlux<BinaryData> listMetricDimensionValues(String testRunId, String name, String metricName, String metricNamespace, String timespan, RequestOptions requestOptions)

List the dimension values for the given metric dimension name.

Query Parameters

| -------- | ------ | -------- | ---------------------------------------------------------------------------------------------------- |
| Name     | Type   | Required | Description                                                                                          |
| interval | String | No       | The interval (i.e. timegrain) of the query. Allowed values: "PT5S", "PT10S", "PT1M", "PT5M", "PT1H". |

You can add these to a request with RequestOptions#addQueryParam

Response Body Schema

String

Parameters:

testRunId - Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.

name - Dimension name.

metricName - Metric name.

metricNamespace - Metric namespace to query metric definitions for.

timespan - The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

metrics dimension values as paginated response with PagedFlux<T>.

listMetrics

public PagedFlux<BinaryData> listMetrics(String testRunId, String metricName, String metricNamespace, String timespan, RequestOptions requestOptions)

List the metric values for a load test run.

Query Parameters

| ----------- | ------ | -------- | ---------------------------------------------------------------------------------------------------- |
| Name        | Type   | Required | Description                                                                                          |
| aggregation | String | No       | The aggregation                                                                                      |
| interval    | String | No       | The interval (i.e. timegrain) of the query. Allowed values: "PT5S", "PT10S", "PT1M", "PT5M", "PT1H". |

You can add these to a request with RequestOptions#addQueryParam

Request Body Schema

{
     filters (Optional): [
          (Optional){
             name: String (Optional)
             values (Optional): [
                 String (Optional)
             ]
         }
     ]
 }

Response Body Schema

{
     value (Optional): [
          (Optional){
             data (Optional): [
                  (Optional){
                     timestamp: String (Optional)
                     value: Double (Optional)
                 }
             ]
             dimensionValues (Optional): [
                  (Optional){
                     name: String (Optional)
                     value: String (Optional)
                 }
             ]
         }
     ]
     nextLink: String (Optional)
 }

Parameters:

testRunId - Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.

metricName - Metric name.

metricNamespace - Metric namespace to query metric definitions for.

timespan - The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response to a metrics query as paginated response with PagedFlux<T>.

listTestRuns

public PagedFlux<BinaryData> listTestRuns(RequestOptions requestOptions)

Get all test runs with given filters.

Query Parameters

| ------------- | -------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Name          | Type           | Required | Description                                                                                                                                                                             |
| orderby       | String         | No       | Sort on the supported fields in (field asc/desc) format. eg: executedDateTime asc. Supported fields - executedDateTime                                                                  |
| search        | String         | No       | Prefix based, case sensitive search on searchable fields - description, executedUser. For example, to search for a test run, with description 500 VUs, the search parameter can be 500. |
| testId        | String         | No       | Unique name of an existing load test.                                                                                                                                                   |
| executionFrom | OffsetDateTime | No       | Start DateTime(ISO 8601 literal format) of test-run execution time filter range.                                                                                                        |
| executionTo   | OffsetDateTime | No       | End DateTime(ISO 8601 literal format) of test-run execution time filter range.                                                                                                          |
| status        | String         | No       | Comma separated list of test run status.                                                                                                                                                |
| maxpagesize   | Integer        | No       | Number of results in response.                                                                                                                                                          |

You can add these to a request with RequestOptions#addQueryParam

Response Body Schema

{
     passFailCriteria (Optional): {
         passFailMetrics (Optional): {
             String (Required): {
                 clientMetric: String(response_time_ms/latency/error/requests/requests_per_sec) (Optional)
                 aggregate: String(count/percentage/avg/p50/p90/p95/p99/min/max) (Optional)
                 condition: String (Optional)
                 requestName: String (Optional)
                 value: Double (Optional)
                 action: String(continue/stop) (Optional)
                 actualValue: Double (Optional)
                 result: String(passed/undetermined/failed) (Optional)
             }
         }
     }
     secrets (Optional): {
         String (Required): {
             value: String (Optional)
             type: String(AKV_SECRET_URI/SECRET_VALUE) (Optional)
         }
     }
     certificate (Optional): {
         value: String (Optional)
         type: String(AKV_CERT_URI) (Optional)
         name: String (Optional)
     }
     environmentVariables (Optional): {
         String: String (Required)
     }
     errorDetails (Optional): [
          (Optional){
             message: String (Optional)
         }
     ]
     testRunStatistics (Optional): {
         String (Required): {
             transaction: String (Optional)
             sampleCount: Double (Optional)
             errorCount: Double (Optional)
             errorPct: Double (Optional)
             meanResTime: Double (Optional)
             medianResTime: Double (Optional)
             maxResTime: Double (Optional)
             minResTime: Double (Optional)
             pct1ResTime: Double (Optional)
             pct2ResTime: Double (Optional)
             pct3ResTime: Double (Optional)
             throughput: Double (Optional)
             receivedKBytesPerSec: Double (Optional)
             sentKBytesPerSec: Double (Optional)
         }
     }
     loadTestConfiguration (Optional): {
         engineInstances: Integer (Optional)
         splitAllCSVs: Boolean (Optional)
         quickStartTest: Boolean (Optional)
         optionalLoadTestConfig (Optional): {
             endpointUrl: String (Optional)
             virtualUsers: Integer (Optional)
             rampUpTime: Integer (Optional)
             duration: Integer (Optional)
         }
     }
     testArtifacts (Optional): {
         inputArtifacts (Optional): {
             configFileInfo (Optional): {
                 url: String (Optional)
                 fileName: String (Optional)
                 fileType: String(JMX_FILE/USER_PROPERTIES/ADDITIONAL_ARTIFACTS) (Optional)
                 expireDateTime: OffsetDateTime (Optional)
                 validationStatus: String(NOT_VALIDATED/VALIDATION_SUCCESS/VALIDATION_FAILURE/VALIDATION_INITIATED/VALIDATION_NOT_REQUIRED) (Optional)
                 validationFailureDetails: String (Optional)
             }
             testScriptFileInfo (Optional): (recursive schema, see testScriptFileInfo above)
             userPropFileInfo (Optional): (recursive schema, see userPropFileInfo above)
             inputArtifactsZipFileInfo (Optional): (recursive schema, see inputArtifactsZipFileInfo above)
             additionalFileInfo (Optional): [
                 (recursive schema, see above)
             ]
         }
         outputArtifacts (Optional): {
             resultFileInfo (Optional): (recursive schema, see resultFileInfo above)
             logsFileInfo (Optional): (recursive schema, see logsFileInfo above)
         }
     }
     testResult: String(PASSED/NOT_APPLICABLE/FAILED) (Optional)
     virtualUsers: Integer (Optional)
     testRunId: String (Optional)
     displayName: String (Optional)
     testId: String (Optional)
     description: String (Optional)
     status: String(ACCEPTED/NOTSTARTED/PROVISIONING/PROVISIONED/CONFIGURING/CONFIGURED/EXECUTING/EXECUTED/DEPROVISIONING/DEPROVISIONED/DONE/CANCELLING/CANCELLED/FAILED/VALIDATION_SUCCESS/VALIDATION_FAILURE) (Optional)
     startDateTime: OffsetDateTime (Optional)
     endDateTime: OffsetDateTime (Optional)
     executedDateTime: OffsetDateTime (Optional)
     portalUrl: String (Optional)
     duration: Long (Optional)
     subnetId: String (Optional)
     createdDateTime: OffsetDateTime (Optional)
     createdBy: String (Optional)
     lastModifiedDateTime: OffsetDateTime (Optional)
     lastModifiedBy: String (Optional)
 }

Parameters:

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

all test runs with given filters as paginated response with PagedFlux<T>.

stopTestRunWithResponse

public Mono<Response<BinaryData>> stopTestRunWithResponse(String testRunId, RequestOptions requestOptions)

Stop test run by name.

Response Body Schema

{
     passFailCriteria (Optional): {
         passFailMetrics (Optional): {
             String (Required): {
                 clientMetric: String(response_time_ms/latency/error/requests/requests_per_sec) (Optional)
                 aggregate: String(count/percentage/avg/p50/p90/p95/p99/min/max) (Optional)
                 condition: String (Optional)
                 requestName: String (Optional)
                 value: Double (Optional)
                 action: String(continue/stop) (Optional)
                 actualValue: Double (Optional)
                 result: String(passed/undetermined/failed) (Optional)
             }
         }
     }
     secrets (Optional): {
         String (Required): {
             value: String (Optional)
             type: String(AKV_SECRET_URI/SECRET_VALUE) (Optional)
         }
     }
     certificate (Optional): {
         value: String (Optional)
         type: String(AKV_CERT_URI) (Optional)
         name: String (Optional)
     }
     environmentVariables (Optional): {
         String: String (Required)
     }
     errorDetails (Optional): [
          (Optional){
             message: String (Optional)
         }
     ]
     testRunStatistics (Optional): {
         String (Required): {
             transaction: String (Optional)
             sampleCount: Double (Optional)
             errorCount: Double (Optional)
             errorPct: Double (Optional)
             meanResTime: Double (Optional)
             medianResTime: Double (Optional)
             maxResTime: Double (Optional)
             minResTime: Double (Optional)
             pct1ResTime: Double (Optional)
             pct2ResTime: Double (Optional)
             pct3ResTime: Double (Optional)
             throughput: Double (Optional)
             receivedKBytesPerSec: Double (Optional)
             sentKBytesPerSec: Double (Optional)
         }
     }
     loadTestConfiguration (Optional): {
         engineInstances: Integer (Optional)
         splitAllCSVs: Boolean (Optional)
         quickStartTest: Boolean (Optional)
         optionalLoadTestConfig (Optional): {
             endpointUrl: String (Optional)
             virtualUsers: Integer (Optional)
             rampUpTime: Integer (Optional)
             duration: Integer (Optional)
         }
     }
     testArtifacts (Optional): {
         inputArtifacts (Optional): {
             configFileInfo (Optional): {
                 url: String (Optional)
                 fileName: String (Optional)
                 fileType: String(JMX_FILE/USER_PROPERTIES/ADDITIONAL_ARTIFACTS) (Optional)
                 expireDateTime: OffsetDateTime (Optional)
                 validationStatus: String(NOT_VALIDATED/VALIDATION_SUCCESS/VALIDATION_FAILURE/VALIDATION_INITIATED/VALIDATION_NOT_REQUIRED) (Optional)
                 validationFailureDetails: String (Optional)
             }
             testScriptFileInfo (Optional): (recursive schema, see testScriptFileInfo above)
             userPropFileInfo (Optional): (recursive schema, see userPropFileInfo above)
             inputArtifactsZipFileInfo (Optional): (recursive schema, see inputArtifactsZipFileInfo above)
             additionalFileInfo (Optional): [
                 (recursive schema, see above)
             ]
         }
         outputArtifacts (Optional): {
             resultFileInfo (Optional): (recursive schema, see resultFileInfo above)
             logsFileInfo (Optional): (recursive schema, see logsFileInfo above)
         }
     }
     testResult: String(PASSED/NOT_APPLICABLE/FAILED) (Optional)
     virtualUsers: Integer (Optional)
     testRunId: String (Optional)
     displayName: String (Optional)
     testId: String (Optional)
     description: String (Optional)
     status: String(ACCEPTED/NOTSTARTED/PROVISIONING/PROVISIONED/CONFIGURING/CONFIGURED/EXECUTING/EXECUTED/DEPROVISIONING/DEPROVISIONED/DONE/CANCELLING/CANCELLED/FAILED/VALIDATION_SUCCESS/VALIDATION_FAILURE) (Optional)
     startDateTime: OffsetDateTime (Optional)
     endDateTime: OffsetDateTime (Optional)
     executedDateTime: OffsetDateTime (Optional)
     portalUrl: String (Optional)
     duration: Long (Optional)
     subnetId: String (Optional)
     createdDateTime: OffsetDateTime (Optional)
     createdBy: String (Optional)
     lastModifiedDateTime: OffsetDateTime (Optional)
     lastModifiedBy: String (Optional)
 }

Parameters:

testRunId - Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

load test run model along with Response<T> on successful completion of Mono.

Applies to

Feedback

Was this page helpful?