Package com.azure.developer.loadtesting
Class LoadTestRunClient
java.lang.Object
com.azure.developer.loadtesting.LoadTestRunClient
Initializes a new instance of the synchronous LoadTestingClient type.
-
Method Summary
Modifier and TypeMethodDescriptioncom.azure.core.util.polling.SyncPoller<com.azure.core.util.BinaryData,
com.azure.core.util.BinaryData> beginTestRun
(String testRunId, com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions testRunRequestOptions) Starts a test run and polls the status of the test run.com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
createOrUpdateAppComponentsWithResponse
(String testRunId, com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions) Associate an app component (collection of azure resources) to a test run.com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
createOrUpdateServerMetricsConfigWithResponse
(String testRunId, com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions) Configure server metrics for a test run.com.azure.core.http.rest.Response<Void>
deleteTestRunWithResponse
(String testRunId, com.azure.core.http.rest.RequestOptions requestOptions) Delete a test run by its name.com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
getAppComponentsWithResponse
(String testRunId, com.azure.core.http.rest.RequestOptions requestOptions) Get associated app component (collection of azure resources) for the given test run.com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
getServerMetricsConfigWithResponse
(String testRunId, com.azure.core.http.rest.RequestOptions requestOptions) List server metrics configuration for the given test run.com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
getTestRunFileWithResponse
(String testRunId, String fileName, com.azure.core.http.rest.RequestOptions requestOptions) Get test run file by file name.com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
getTestRunWithResponse
(String testRunId, com.azure.core.http.rest.RequestOptions requestOptions) Get test run details by name.com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
listMetricDefinitionsWithResponse
(String testRunId, String metricNamespace, com.azure.core.http.rest.RequestOptions requestOptions) List the metric definitions for a load test run.com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData>
listMetricDimensionValues
(String testRunId, String name, String metricname, String metricNamespace, String timespan, com.azure.core.http.rest.RequestOptions requestOptions) List the dimension values for the given metric dimension name.com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
listMetricNamespacesWithResponse
(String testRunId, com.azure.core.http.rest.RequestOptions requestOptions) List the metric namespaces for a load test run.com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData>
listMetrics
(String testRunId, String metricname, String metricNamespace, String timespan, com.azure.core.http.rest.RequestOptions requestOptions) List the metric values for a load test run.com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData>
listTestRuns
(com.azure.core.http.rest.RequestOptions requestOptions) Get all test runs with given filters.com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>
stopTestRunWithResponse
(String testRunId, com.azure.core.http.rest.RequestOptions requestOptions) Stop test run by name.
-
Method Details
-
listMetricNamespacesWithResponse
public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> listMetricNamespacesWithResponse(String testRunId, com.azure.core.http.rest.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
. - Throws:
com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.com.azure.core.exception.ClientAuthenticationException
- thrown if the request is rejected by server on status code 401.com.azure.core.exception.ResourceNotFoundException
- thrown if the request is rejected by server on status code 404.com.azure.core.exception.ResourceModifiedException
- thrown if the request is rejected by server on status code 409.
-
listMetricDefinitionsWithResponse
public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> listMetricDefinitionsWithResponse(String testRunId, String metricNamespace, com.azure.core.http.rest.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
. - Throws:
com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.com.azure.core.exception.ClientAuthenticationException
- thrown if the request is rejected by server on status code 401.com.azure.core.exception.ResourceNotFoundException
- thrown if the request is rejected by server on status code 404.com.azure.core.exception.ResourceModifiedException
- thrown if the request is rejected by server on status code 409.
-
createOrUpdateServerMetricsConfigWithResponse
public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> createOrUpdateServerMetricsConfigWithResponse(String testRunId, com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions) Configure server metrics for a test run.Request Body Schema
{ testRunId: String (Optional) metrics (Optional): { String (Optional): { 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 (Optional): { 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
. - Throws:
com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.com.azure.core.exception.ClientAuthenticationException
- thrown if the request is rejected by server on status code 401.com.azure.core.exception.ResourceNotFoundException
- thrown if the request is rejected by server on status code 404.com.azure.core.exception.ResourceModifiedException
- thrown if the request is rejected by server on status code 409.
-
beginTestRun
public com.azure.core.util.polling.SyncPoller<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData> beginTestRun(String testRunId, com.azure.core.util.BinaryData body, com.azure.core.http.rest.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
SyncPoller
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). - Throws:
com.azure.core.exception.ResourceNotFoundException
- when a test withtestRunId
doesn't exist.
-
createOrUpdateAppComponentsWithResponse
public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> createOrUpdateAppComponentsWithResponse(String testRunId, com.azure.core.util.BinaryData body, com.azure.core.http.rest.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
. - Throws:
com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.com.azure.core.exception.ClientAuthenticationException
- thrown if the request is rejected by server on status code 401.com.azure.core.exception.ResourceNotFoundException
- thrown if the request is rejected by server on status code 404.com.azure.core.exception.ResourceModifiedException
- thrown if the request is rejected by server on status code 409.
-
listMetrics
public com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData> listMetrics(String testRunId, String metricname, String metricNamespace, String timespan, com.azure.core.http.rest.RequestOptions requestOptions) List the metric values for a load test run.Query Parameters
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". RequestOptions.addQueryParam(java.lang.String, java.lang.String)
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
PagedIterable
. - Throws:
com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.com.azure.core.exception.ClientAuthenticationException
- thrown if the request is rejected by server on status code 401.com.azure.core.exception.ResourceNotFoundException
- thrown if the request is rejected by server on status code 404.com.azure.core.exception.ResourceModifiedException
- thrown if the request is rejected by server on status code 409.
-
listMetricDimensionValues
public com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData> listMetricDimensionValues(String testRunId, String name, String metricname, String metricNamespace, String timespan, com.azure.core.http.rest.RequestOptions requestOptions) List the dimension values for the given metric dimension name.Query Parameters
Query Parameters Name Type Required Description interval String No The interval (i.e. timegrain) of the query. Allowed values: "PT5S", "PT10S", "PT1M", "PT5M", "PT1H". RequestOptions.addQueryParam(java.lang.String, java.lang.String)
Response Body Schema
{ value (Optional): [ 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.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
PagedIterable
. - Throws:
com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.com.azure.core.exception.ClientAuthenticationException
- thrown if the request is rejected by server on status code 401.com.azure.core.exception.ResourceNotFoundException
- thrown if the request is rejected by server on status code 404.com.azure.core.exception.ResourceModifiedException
- thrown if the request is rejected by server on status code 409.
-
getAppComponentsWithResponse
public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getAppComponentsWithResponse(String testRunId, com.azure.core.http.rest.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
. - Throws:
com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.com.azure.core.exception.ClientAuthenticationException
- thrown if the request is rejected by server on status code 401.com.azure.core.exception.ResourceNotFoundException
- thrown if the request is rejected by server on status code 404.com.azure.core.exception.ResourceModifiedException
- thrown if the request is rejected by server on status code 409.
-
getServerMetricsConfigWithResponse
public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getServerMetricsConfigWithResponse(String testRunId, com.azure.core.http.rest.RequestOptions requestOptions) List server metrics configuration for the given test run.Response Body Schema
{ testRunId: String (Optional) metrics (Optional): { String (Optional): { 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
. - Throws:
com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.com.azure.core.exception.ClientAuthenticationException
- thrown if the request is rejected by server on status code 401.com.azure.core.exception.ResourceNotFoundException
- thrown if the request is rejected by server on status code 404.com.azure.core.exception.ResourceModifiedException
- thrown if the request is rejected by server on status code 409.
-
getTestRunWithResponse
public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getTestRunWithResponse(String testRunId, com.azure.core.http.rest.RequestOptions requestOptions) Get test run details by name.Response Body Schema
{ passFailCriteria (Optional): { passFailMetrics (Optional): { String (Optional): { 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 (Optional): { 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 (Optional) } errorDetails (Optional): [ (Optional){ message: String (Optional) } ] testRunStatistics (Optional): { String (Optional): { 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
. - Throws:
com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.com.azure.core.exception.ClientAuthenticationException
- thrown if the request is rejected by server on status code 401.com.azure.core.exception.ResourceNotFoundException
- thrown if the request is rejected by server on status code 404.com.azure.core.exception.ResourceModifiedException
- thrown if the request is rejected by server on status code 409.
-
deleteTestRunWithResponse
public com.azure.core.http.rest.Response<Void> deleteTestRunWithResponse(String testRunId, com.azure.core.http.rest.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
. - Throws:
com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.com.azure.core.exception.ClientAuthenticationException
- thrown if the request is rejected by server on status code 401.com.azure.core.exception.ResourceNotFoundException
- thrown if the request is rejected by server on status code 404.com.azure.core.exception.ResourceModifiedException
- thrown if the request is rejected by server on status code 409.
-
getTestRunFileWithResponse
public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getTestRunFileWithResponse(String testRunId, String fileName, com.azure.core.http.rest.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
. - Throws:
com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.com.azure.core.exception.ClientAuthenticationException
- thrown if the request is rejected by server on status code 401.com.azure.core.exception.ResourceNotFoundException
- thrown if the request is rejected by server on status code 404.com.azure.core.exception.ResourceModifiedException
- thrown if the request is rejected by server on status code 409.
-
listTestRuns
public com.azure.core.http.rest.PagedIterable<com.azure.core.util.BinaryData> listTestRuns(com.azure.core.http.rest.RequestOptions requestOptions) Get all test runs with given filters.Query Parameters
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. RequestOptions.addQueryParam(java.lang.String, java.lang.String)
Response Body Schema
{ value (Required): [ (Required){ passFailCriteria (Optional): { passFailMetrics (Optional): { String (Optional): { 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 (Optional): { 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 (Optional) } errorDetails (Optional): [ (Optional){ message: String (Optional) } ] testRunStatistics (Optional): { String (Optional): { 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) } ] nextLink: 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
PagedIterable
. - Throws:
com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.com.azure.core.exception.ClientAuthenticationException
- thrown if the request is rejected by server on status code 401.com.azure.core.exception.ResourceNotFoundException
- thrown if the request is rejected by server on status code 404.com.azure.core.exception.ResourceModifiedException
- thrown if the request is rejected by server on status code 409.
-
stopTestRunWithResponse
public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> stopTestRunWithResponse(String testRunId, com.azure.core.http.rest.RequestOptions requestOptions) Stop test run by name.Response Body Schema
{ passFailCriteria (Optional): { passFailMetrics (Optional): { String (Optional): { 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 (Optional): { 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 (Optional) } errorDetails (Optional): [ (Optional){ message: String (Optional) } ] testRunStatistics (Optional): { String (Optional): { 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
. - Throws:
com.azure.core.exception.HttpResponseException
- thrown if the request is rejected by server.com.azure.core.exception.ClientAuthenticationException
- thrown if the request is rejected by server on status code 401.com.azure.core.exception.ResourceNotFoundException
- thrown if the request is rejected by server on status code 404.com.azure.core.exception.ResourceModifiedException
- thrown if the request is rejected by server on status code 409.
-