LoadTestRunClient Class

These APIs allow end users to create, view and run load tests using Azure Load Test Service.

Constructor

LoadTestRunClient(endpoint: str, credential: AsyncTokenCredential, **kwargs: Any)

Parameters

Name	Description
endpoint Required	str URL to perform data plane API operations on the resource. Required.
credential Required	AsyncTokenCredential Credential needed for the client to connect to Azure. Required.

Keyword-Only Parameters

Name	Description
api_version	str Api Version. Default value is "2022-11-01". Note that overriding this default value may result in unsupported behavior.

Methods

begin_test_run	Create and start a new test run with the given name. Create and start a new test run with the given name.
close
create_or_update_app_components	Associate an app component (collection of azure resources) to a test run. Associate an app component (collection of azure resources) to a test run.
create_or_update_server_metrics_config	Configure server metrics for a test run. Configure server metrics for a test run.
delete_test_run	Delete a test run by its name. Delete a test run by its name.
get_app_components	Get associated app component (collection of azure resources) for the given test run. Get associated app component (collection of azure resources) for the given test run.
get_metric_definitions	List the metric definitions for a load test run. List the metric definitions for a load test run.
get_metric_namespaces	List the metric namespaces for a load test run. List the metric namespaces for a load test run.
get_server_metrics_config	List server metrics configuration for the given test run. List server metrics configuration for the given test run.
get_test_run	Get test run details by name. Get test run details by name.
get_test_run_file	Get test run file by file name. Get test run file by file name.
list_metric_dimension_values	List the dimension values for the given metric dimension name. List the dimension values for the given metric dimension name.
list_metrics	List the metric values for a load test run. List the metric values for a load test run.
list_test_runs	Get all test runs with given filters. Get all test runs with given filters.
send_request	Runs the network request through the client's chained policies. `>>> from azure.core.rest import HttpRequest >>> request = HttpRequest("GET", "https://www.example.org/") <HttpRequest [GET], url: 'https://www.example.org/'> >>> response = await client.send_request(request) <AsyncHttpResponse: 200 OK>` For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request
stop_test_run	Stop test run by name. Stop test run by name.

begin_test_run

Create and start a new test run with the given name.

begin_test_run(test_run_id: str, body: MutableMapping[str, Any] | IO, *, old_test_run_id: str | None = None, **kwargs: Any) -> AsyncLROPoller[MutableMapping[str, Any]]

Parameters

Name	Description
test_run_id Required	str Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. Required.
body Required	<xref:JSON> or IO Load test run model. Is either a model type or a IO type. Required.

Keyword-Only Parameters

Name	Description
old_test_run_id	str Existing test run identifier that should be rerun, if this is provided, the test will run with the JMX file, configuration and app components from the existing test run. You can override the configuration values for new test run in the request body. Default value is None. Default value: None
content_type	str Body Parameter content-type. Known values are: 'application/merge-patch+json'. Default value is None.

Returns

Type	Description
<xref:azure.developer.loadtesting._polling.LoadTestingLROPoller>

Exceptions

Type	Description
HttpResponseError
ResourceNotFoundError

close

async close() -> None

create_or_update_app_components

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

async create_or_update_app_components(test_run_id: str, body: MutableMapping[str, Any] | IO, **kwargs: Any) -> MutableMapping[str, Any]

Parameters

Name	Description
test_run_id Required	str Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. Required.
body Required	<xref:JSON> or IO App Component model. Is either a JSON type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/merge-patch+json'. Default value is None.

Returns

Type	Description
<xref:JSON>	JSON object

Exceptions

Type	Description
HttpResponseError

Examples


   # JSON input template you can fill out and use as your body input.
   body = {
       "components": {
           "str": {
               "displayName": "str",  # Optional. Azure resource display
                 name.
               "kind": "str",  # Optional. Kind of Azure resource type.
               "resourceGroup": "str",  # Optional. Resource group name of
                 the Azure resource.
               "resourceId": "str",  # Optional. fully qualified resource Id
                 e.g
                 subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}.
               "resourceName": "str",  # Optional. Azure resource name,
                 required while creating the app component.
               "resourceType": "str",  # Optional. Azure resource type,
                 required while creating the app component.
               "subscriptionId": "str"  # Optional. Subscription Id of the
                 Azure resource.
           }
       },
       "createdBy": "str",  # Optional. The user that created.
       "createdDateTime": "2020-02-20 00:00:00",  # Optional. The creation
         datetime(ISO 8601 literal format).
       "lastModifiedBy": "str",  # Optional. The user that last modified.
       "lastModifiedDateTime": "2020-02-20 00:00:00",  # Optional. The last Modified
         datetime(ISO 8601 literal format).
       "testRunId": "str"  # Optional. Test run identifier.
   }

   # response body for status code(s): 200, 201
   response == {
       "components": {
           "str": {
               "displayName": "str",  # Optional. Azure resource display
                 name.
               "kind": "str",  # Optional. Kind of Azure resource type.
               "resourceGroup": "str",  # Optional. Resource group name of
                 the Azure resource.
               "resourceId": "str",  # Optional. fully qualified resource Id
                 e.g
                 subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}.
               "resourceName": "str",  # Optional. Azure resource name,
                 required while creating the app component.
               "resourceType": "str",  # Optional. Azure resource type,
                 required while creating the app component.
               "subscriptionId": "str"  # Optional. Subscription Id of the
                 Azure resource.
           }
       },
       "createdBy": "str",  # Optional. The user that created.
       "createdDateTime": "2020-02-20 00:00:00",  # Optional. The creation
         datetime(ISO 8601 literal format).
       "lastModifiedBy": "str",  # Optional. The user that last modified.
       "lastModifiedDateTime": "2020-02-20 00:00:00",  # Optional. The last Modified
         datetime(ISO 8601 literal format).
       "testRunId": "str"  # Optional. Test run identifier.
   }

create_or_update_server_metrics_config

Configure server metrics for a test run.

async create_or_update_server_metrics_config(test_run_id: str, body: MutableMapping[str, Any] | IO, **kwargs: Any) -> MutableMapping[str, Any]

Parameters

Name	Description
test_run_id Required	str Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. Required.
body Required	<xref:JSON> or IO Server metric configuration model. Is either a JSON type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/merge-patch+json'. Default value is None.

Returns

Type	Description
<xref:JSON>	JSON object

Exceptions

Type	Description
HttpResponseError

Examples


   # JSON input template you can fill out and use as your body input.
   body = {
       "createdBy": "str",  # Optional. The user that created.
       "createdDateTime": "2020-02-20 00:00:00",  # Optional. The creation
         datetime(ISO 8601 literal format).
       "lastModifiedBy": "str",  # Optional. The user that last modified.
       "lastModifiedDateTime": "2020-02-20 00:00:00",  # Optional. The last Modified
         datetime(ISO 8601 literal format).
       "metrics": {
           "str": {
               "aggregation": "str",  # Metric aggregation. Required.
               "metricNamespace": "str",  # Metric name space. Required.
               "name": "str",  # The invariant value of metric name.
                 Required.
               "resourceId": "str",  # Azure resource id. Required.
               "resourceType": "str",  # Azure resource type. Required.
               "displayDescription": "str",  # Optional. Metric description.
               "id": "str",  # Optional. Unique name for metric.
               "unit": "str"  # Optional. Metric unit.
           }
       },
       "testRunId": "str"  # Optional. Test run identifier.
   }

   # response body for status code(s): 200, 201
   response == {
       "createdBy": "str",  # Optional. The user that created.
       "createdDateTime": "2020-02-20 00:00:00",  # Optional. The creation
         datetime(ISO 8601 literal format).
       "lastModifiedBy": "str",  # Optional. The user that last modified.
       "lastModifiedDateTime": "2020-02-20 00:00:00",  # Optional. The last Modified
         datetime(ISO 8601 literal format).
       "metrics": {
           "str": {
               "aggregation": "str",  # Metric aggregation. Required.
               "metricNamespace": "str",  # Metric name space. Required.
               "name": "str",  # The invariant value of metric name.
                 Required.
               "resourceId": "str",  # Azure resource id. Required.
               "resourceType": "str",  # Azure resource type. Required.
               "displayDescription": "str",  # Optional. Metric description.
               "id": "str",  # Optional. Unique name for metric.
               "unit": "str"  # Optional. Metric unit.
           }
       },
       "testRunId": "str"  # Optional. Test run identifier.
   }

delete_test_run

Delete a test run by its name.

async delete_test_run(test_run_id: str, **kwargs: Any) -> None

Parameters

Name	Description
test_run_id Required	str Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. Required.

Returns

Type	Description
None	None

Exceptions

Type	Description
HttpResponseError

get_app_components

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

async get_app_components(test_run_id: str, **kwargs: Any) -> MutableMapping[str, Any]

Parameters

Name	Description
test_run_id Required	str Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. Required.

Returns

Type	Description
<xref:JSON>	JSON object

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 200
   response == {
       "components": {
           "str": {
               "displayName": "str",  # Optional. Azure resource display
                 name.
               "kind": "str",  # Optional. Kind of Azure resource type.
               "resourceGroup": "str",  # Optional. Resource group name of
                 the Azure resource.
               "resourceId": "str",  # Optional. fully qualified resource Id
                 e.g
                 subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}.
               "resourceName": "str",  # Optional. Azure resource name,
                 required while creating the app component.
               "resourceType": "str",  # Optional. Azure resource type,
                 required while creating the app component.
               "subscriptionId": "str"  # Optional. Subscription Id of the
                 Azure resource.
           }
       },
       "createdBy": "str",  # Optional. The user that created.
       "createdDateTime": "2020-02-20 00:00:00",  # Optional. The creation
         datetime(ISO 8601 literal format).
       "lastModifiedBy": "str",  # Optional. The user that last modified.
       "lastModifiedDateTime": "2020-02-20 00:00:00",  # Optional. The last Modified
         datetime(ISO 8601 literal format).
       "testRunId": "str"  # Optional. Test run identifier.
   }

get_metric_definitions

List the metric definitions for a load test run.

async get_metric_definitions(test_run_id: str, *, metric_namespace: str, **kwargs: Any) -> MutableMapping[str, Any]

Parameters

Name	Description
test_run_id Required	str Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. Required.

Keyword-Only Parameters

Name	Description
metric_namespace	str Metric namespace to query metric definitions for. Required.

Returns

Type	Description
<xref:JSON>	JSON object

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 200
   response == {
       "value": [
           {
               "description": "str",  # Optional. The metric description.
               "dimensions": [
                   {
                       "description": "str",  # Optional. The
                         description.
                       "name": "str"  # Optional. The name.
                   }
               ],
               "metricAvailabilities": [
                   {
                       "timeGrain": "str"  # Optional. The time
                         grain specifies the aggregation interval for the metric.
                         Expressed as a duration 'PT1M', 'PT1H', etc. Known values are:
                         "PT5S", "PT10S", "PT1M", "PT5M", and "PT1H".
                   }
               ],
               "name": "str",  # Optional. The metric name.
               "namespace": "str",  # Optional. The namespace the metric
                 belongs to.
               "primaryAggregationType": "str",  # Optional. The primary
                 aggregation type value defining how to use the values for display. Known
                 values are: "Average", "Count", "None", "Total", "Percentile90",
                 "Percentile95", and "Percentile99".
               "supportedAggregationTypes": [
                   "str"  # Optional. The collection of what all
                     aggregation types are supported.
               ],
               "unit": "str"  # Optional. The unit of the metric. Known
                 values are: "NotSpecified", "Percent", "Count", "Seconds",
                 "Milliseconds", "Bytes", "BytesPerSecond", and "CountPerSecond".
           }
       ]
   }

get_metric_namespaces

List the metric namespaces for a load test run.

async get_metric_namespaces(test_run_id: str, **kwargs: Any) -> MutableMapping[str, Any]

Parameters

Name	Description
test_run_id Required	str Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. Required.

Returns

Type	Description
<xref:JSON>	JSON object

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 200
   response == {
       "value": [
           {
               "description": "str",  # Optional. The namespace description.
               "name": "str"  # Optional. The metric namespace name.
           }
       ]
   }

get_server_metrics_config

List server metrics configuration for the given test run.

async get_server_metrics_config(test_run_id: str, **kwargs: Any) -> MutableMapping[str, Any]

Parameters

Name	Description
test_run_id Required	str Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. Required.

Returns

Type	Description
<xref:JSON>	JSON object

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 200
   response == {
       "createdBy": "str",  # Optional. The user that created.
       "createdDateTime": "2020-02-20 00:00:00",  # Optional. The creation
         datetime(ISO 8601 literal format).
       "lastModifiedBy": "str",  # Optional. The user that last modified.
       "lastModifiedDateTime": "2020-02-20 00:00:00",  # Optional. The last Modified
         datetime(ISO 8601 literal format).
       "metrics": {
           "str": {
               "aggregation": "str",  # Metric aggregation. Required.
               "metricNamespace": "str",  # Metric name space. Required.
               "name": "str",  # The invariant value of metric name.
                 Required.
               "resourceId": "str",  # Azure resource id. Required.
               "resourceType": "str",  # Azure resource type. Required.
               "displayDescription": "str",  # Optional. Metric description.
               "id": "str",  # Optional. Unique name for metric.
               "unit": "str"  # Optional. Metric unit.
           }
       },
       "testRunId": "str"  # Optional. Test run identifier.
   }

get_test_run

Get test run details by name.

async get_test_run(test_run_id: str, **kwargs: Any) -> MutableMapping[str, Any]

Parameters

Name	Description
test_run_id Required	str Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. Required.

Returns

Type	Description
<xref:JSON>	JSON object

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 200
   response == {
       "certificate": {
           "name": "str",  # Optional. Name of the certificate.
           "type": "str",  # Optional. Type of certificate. "AKV_CERT_URI"
           "value": "str"  # Optional. The value of the certificate for
             respective type.
       },
       "createdBy": "str",  # Optional. The user that created.
       "createdDateTime": "2020-02-20 00:00:00",  # Optional. The creation
         datetime(ISO 8601 literal format).
       "description": "str",  # Optional. The test run description.
       "displayName": "str",  # Optional. Display name of a testRun.
       "duration": 0,  # Optional. Test run duration in milliseconds.
       "endDateTime": "2020-02-20 00:00:00",  # Optional. The test run end
         DateTime(ISO 8601 literal format).
       "environmentVariables": {
           "str": "str"  # Optional. Environment variables which are defined as
             a set of <name,value> pairs.
       },
       "errorDetails": [
           {
               "message": "str"  # Optional. Error details in case test run
                 was not successfully run.
           }
       ],
       "executedDateTime": "2020-02-20 00:00:00",  # Optional. Test run initiated
         time.
       "lastModifiedBy": "str",  # Optional. The user that last modified.
       "lastModifiedDateTime": "2020-02-20 00:00:00",  # Optional. The last Modified
         datetime(ISO 8601 literal format).
       "loadTestConfiguration": {
           "engineInstances": 0,  # Optional. The number of engine instances to
             execute load test. Supported values are in range of 1-45. Required for
             creating a new test.
           "optionalLoadTestConfig": {
               "duration": 0,  # Optional. Test run duration.
               "endpointUrl": "str",  # Optional. Test URL. Provide the
                 complete HTTP URL. For example,
                 http://contoso-app.azurewebsites.net/login.
               "rampUpTime": 0,  # Optional. Ramp up time.
               "virtualUsers": 0  # Optional. No of concurrent virtual
                 users.
           },
           "quickStartTest": False,  # Optional. Default value is False. If
             true, optionalLoadTestConfig is required and JMX script for the load test is
             not required to upload.
           "splitAllCSVs": False  # Optional. Default value is False. If false,
             Azure Load Testing copies and processes your input files unmodified across
             all test engine instances. If true, Azure Load Testing splits the CSV input
             data evenly across all engine instances. If you provide multiple CSV files,
             each file will be split evenly.
       },
       "passFailCriteria": {
           "passFailMetrics": {
               "str": {
                   "action": "continue",  # Optional. Default value is
                     "continue". Action taken after the threshold is met. Default is
                     "u2018continue"u2019. Known values are: "continue" and "stop".
                   "actualValue": 0.0,  # Optional. The actual value of
                     the client metric for the test run.
                   "aggregate": "str",  # Optional. The aggregation
                     function to be applied on the client metric. Allowed functions -
                     "u2018percentage"u2019 - for error metric , "u2018avg"u2019,
                     "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019,
                     "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency
                     metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 -
                     for requests. Known values are: "count", "percentage", "avg", "p50",
                     "p90", "p95", "p99", "min", and "max".
                   "clientMetric": "str",  # Optional. The client metric
                     on which the criteria should be applied. Known values are:
                     "response_time_ms", "latency", "error", "requests", and
                     "requests_per_sec".
                   "condition": "str",  # Optional. The comparison
                     operator. Supported types "u2018>"u2019, "u2018<"u2019.
                   "requestName": "str",  # Optional. Request name for
                     which the Pass fail criteria has to be applied.
                   "result": "str",  # Optional. Outcome of the test
                     run. Known values are: "passed", "undetermined", and "failed".
                   "value": 0.0  # Optional. The value to compare with
                     the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit-
                     % "u2019, response_time_ms and latency : any integer value unit- ms.
               }
           }
       },
       "portalUrl": "str",  # Optional. Portal url.
       "secrets": {
           "str": {
               "type": "str",  # Optional. Type of secret. Known values are:
                 "AKV_SECRET_URI" and "SECRET_VALUE".
               "value": "str"  # Optional. The value of the secret for the
                 respective type.
           }
       },
       "startDateTime": "2020-02-20 00:00:00",  # Optional. The test run start
         DateTime(ISO 8601 literal format).
       "status": "str",  # Optional. The test run status. Known values are:
         "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING",
         "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE",
         "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and
         "VALIDATION_FAILURE".
       "subnetId": "str",  # Optional. Subnet ID on which the load test instances
         should run.
       "testArtifacts": {
           "inputArtifacts": {
               "additionalFileInfo": [
                   {
                       "expireDateTime": "2020-02-20 00:00:00",  #
                         Optional. Expiry time of the file (ISO 8601 literal format).
                       "fileName": "str",  # Optional. Name of the
                         file.
                       "fileType": "str",  # Optional. File type.
                         Known values are: "JMX_FILE", "USER_PROPERTIES", and
                         "ADDITIONAL_ARTIFACTS".
                       "url": "str",  # Optional. File URL.
                       "validationFailureDetails": "str",  #
                         Optional. Validation failure error details.
                       "validationStatus": "str"  # Optional.
                         Validation status of the file. Known values are: "NOT_VALIDATED",
                         "VALIDATION_SUCCESS", "VALIDATION_FAILURE",
                         "VALIDATION_INITIATED", and "VALIDATION_NOT_REQUIRED".
                   }
               ],
               "configFileInfo": {
                   "expireDateTime": "2020-02-20 00:00:00",  # Optional.
                     Expiry time of the file (ISO 8601 literal format).
                   "fileName": "str",  # Optional. Name of the file.
                   "fileType": "str",  # Optional. File type. Known
                     values are: "JMX_FILE", "USER_PROPERTIES", and
                     "ADDITIONAL_ARTIFACTS".
                   "url": "str",  # Optional. File URL.
                   "validationFailureDetails": "str",  # Optional.
                     Validation failure error details.
                   "validationStatus": "str"  # Optional. Validation
                     status of the file. Known values are: "NOT_VALIDATED",
                     "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED",
                     and "VALIDATION_NOT_REQUIRED".
               },
               "inputArtifactsZipFileInfo": {
                   "expireDateTime": "2020-02-20 00:00:00",  # Optional.
                     Expiry time of the file (ISO 8601 literal format).
                   "fileName": "str",  # Optional. Name of the file.
                   "fileType": "str",  # Optional. File type. Known
                     values are: "JMX_FILE", "USER_PROPERTIES", and
                     "ADDITIONAL_ARTIFACTS".
                   "url": "str",  # Optional. File URL.
                   "validationFailureDetails": "str",  # Optional.
                     Validation failure error details.
                   "validationStatus": "str"  # Optional. Validation
                     status of the file. Known values are: "NOT_VALIDATED",
                     "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED",
                     and "VALIDATION_NOT_REQUIRED".
               },
               "testScriptFileInfo": {
                   "expireDateTime": "2020-02-20 00:00:00",  # Optional.
                     Expiry time of the file (ISO 8601 literal format).
                   "fileName": "str",  # Optional. Name of the file.
                   "fileType": "str",  # Optional. File type. Known
                     values are: "JMX_FILE", "USER_PROPERTIES", and
                     "ADDITIONAL_ARTIFACTS".
                   "url": "str",  # Optional. File URL.
                   "validationFailureDetails": "str",  # Optional.
                     Validation failure error details.
                   "validationStatus": "str"  # Optional. Validation
                     status of the file. Known values are: "NOT_VALIDATED",
                     "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED",
                     and "VALIDATION_NOT_REQUIRED".
               },
               "userPropFileInfo": {
                   "expireDateTime": "2020-02-20 00:00:00",  # Optional.
                     Expiry time of the file (ISO 8601 literal format).
                   "fileName": "str",  # Optional. Name of the file.
                   "fileType": "str",  # Optional. File type. Known
                     values are: "JMX_FILE", "USER_PROPERTIES", and
                     "ADDITIONAL_ARTIFACTS".
                   "url": "str",  # Optional. File URL.
                   "validationFailureDetails": "str",  # Optional.
                     Validation failure error details.
                   "validationStatus": "str"  # Optional. Validation
                     status of the file. Known values are: "NOT_VALIDATED",
                     "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED",
                     and "VALIDATION_NOT_REQUIRED".
               }
           },
           "outputArtifacts": {
               "logsFileInfo": {
                   "expireDateTime": "2020-02-20 00:00:00",  # Optional.
                     Expiry time of the file (ISO 8601 literal format).
                   "fileName": "str",  # Optional. Name of the file.
                   "fileType": "str",  # Optional. File type. Known
                     values are: "JMX_FILE", "USER_PROPERTIES", and
                     "ADDITIONAL_ARTIFACTS".
                   "url": "str",  # Optional. File URL.
                   "validationFailureDetails": "str",  # Optional.
                     Validation failure error details.
                   "validationStatus": "str"  # Optional. Validation
                     status of the file. Known values are: "NOT_VALIDATED",
                     "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED",
                     and "VALIDATION_NOT_REQUIRED".
               },
               "resultFileInfo": {
                   "expireDateTime": "2020-02-20 00:00:00",  # Optional.
                     Expiry time of the file (ISO 8601 literal format).
                   "fileName": "str",  # Optional. Name of the file.
                   "fileType": "str",  # Optional. File type. Known
                     values are: "JMX_FILE", "USER_PROPERTIES", and
                     "ADDITIONAL_ARTIFACTS".
                   "url": "str",  # Optional. File URL.
                   "validationFailureDetails": "str",  # Optional.
                     Validation failure error details.
                   "validationStatus": "str"  # Optional. Validation
                     status of the file. Known values are: "NOT_VALIDATED",
                     "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED",
                     and "VALIDATION_NOT_REQUIRED".
               }
           }
       },
       "testId": "str",  # Optional. Associated test Id.
       "testResult": "str",  # Optional. Test result for pass/Fail criteria used
         during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED".
       "testRunId": "str",  # Optional. Unique test run name as identifier.
       "testRunStatistics": {
           "str": {
               "errorCount": 0.0,  # Optional. Error count.
               "errorPct": 0.0,  # Optional. Error percentage.
               "maxResTime": 0.0,  # Optional. Max response time.
               "meanResTime": 0.0,  # Optional. Mean response time.
               "medianResTime": 0.0,  # Optional. Median response time.
               "minResTime": 0.0,  # Optional. Minimum response time.
               "pct1ResTime": 0.0,  # Optional. 90 percentile response time.
               "pct2ResTime": 0.0,  # Optional. 95 percentile response time.
               "pct3ResTime": 0.0,  # Optional. 99 percentile response time.
               "receivedKBytesPerSec": 0.0,  # Optional. Received network
                 bytes.
               "sampleCount": 0.0,  # Optional. Sampler count.
               "sentKBytesPerSec": 0.0,  # Optional. Send network bytes.
               "throughput": 0.0,  # Optional. Throughput.
               "transaction": "str"  # Optional. Transaction name.
           }
       },
       "virtualUsers": 0  # Optional. Number of virtual users, for which test has
         been run.
   }

get_test_run_file

Get test run file by file name.

async get_test_run_file(test_run_id: str, file_name: str, **kwargs: Any) -> MutableMapping[str, Any]

Parameters

Name	Description
test_run_id Required	str Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. Required.
file_name Required	str Test run file name with file extension. Required.

Returns

Type	Description
<xref:JSON>	JSON object

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 200
   response == {
       "expireDateTime": "2020-02-20 00:00:00",  # Optional. Expiry time of the file
         (ISO 8601 literal format).
       "fileName": "str",  # Optional. Name of the file.
       "fileType": "str",  # Optional. File type. Known values are: "JMX_FILE",
         "USER_PROPERTIES", and "ADDITIONAL_ARTIFACTS".
       "url": "str",  # Optional. File URL.
       "validationFailureDetails": "str",  # Optional. Validation failure error
         details.
       "validationStatus": "str"  # Optional. Validation status of the file. Known
         values are: "NOT_VALIDATED", "VALIDATION_SUCCESS", "VALIDATION_FAILURE",
         "VALIDATION_INITIATED", and "VALIDATION_NOT_REQUIRED".
   }

list_metric_dimension_values

List the dimension values for the given metric dimension name.

list_metric_dimension_values(test_run_id: str, name: str, *, metric_name: str, metric_namespace: str, time_interval: str, interval: str | None = None, **kwargs: Any) -> AsyncIterable[str]

Parameters

Name	Description
test_run_id Required	str Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. Required.
name Required	str Dimension name. Required.

Keyword-Only Parameters

Name	Description
metric_name	str Metric name. Required.
metric_namespace	str Metric namespace to query metric definitions for. Required.
time_interval	str The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'. Required.
interval	str The interval (i.e. timegrain) of the query. Known values are: "PT5S", "PT10S", "PT1M", "PT5M", and "PT1H". Default value is None. Default value: None

Returns

Type	Description
AsyncItemPaged[str]	An iterator like instance of str

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 200
   response == "str"  # Optional.

list_metrics

List the metric values for a load test run.

list_metrics(test_run_id: str, body: MutableMapping[str, Any] | IO | None = None, *, metric_name: str, metric_namespace: str, time_interval: str, aggregation: str | None = None, interval: str | None = None, **kwargs: Any) -> AsyncIterable[MutableMapping[str, Any]]

Parameters

Name	Description
test_run_id Required	str Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. Required.
body	<xref:JSON> or IO Metric dimension filter. Is either a JSON type or a IO type. Default value is None. Default value: None

Keyword-Only Parameters

Name	Description
metric_name	str Metric name. Required.
metric_namespace	str Metric namespace to query metric definitions for. Required.
time_interval	str The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'. Required.
aggregation	str The aggregation. Default value is None. Default value: None
interval	str The interval (i.e. timegrain) of the query. Known values are: "PT5S", "PT10S", "PT1M", "PT5M", and "PT1H". Default value is None. Default value: None
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.

Returns

Type	Description
AsyncItemPaged[<xref:JSON>]	An iterator like instance of JSON object

Exceptions

Type	Description
HttpResponseError

Examples


   # JSON input template you can fill out and use as your body input.
   body = {
       "filters": [
           {
               "name": "str",  # Optional. The dimension name.
               "values": [
                   "str"  # Optional. The dimension values. Maximum
                     values can be 20.
               ]
           }
       ]
   }

   # response body for status code(s): 200
   response == {
       "data": [
           {
               "timestamp": "str",  # Optional. The timestamp for the metric
                 value in ISO 8601 format.
               "value": 0.0  # Optional. The metric value.
           }
       ],
       "dimensionValues": [
           {
               "name": "str",  # Optional. The name of the dimension.
               "value": "str"  # Optional. The value of the dimension.
           }
       ]
   }

list_test_runs

Get all test runs with given filters.

list_test_runs(*, orderby: str | None = None, search: str | None = None, test_id: str | None = None, execution_from: datetime | None = None, execution_to: datetime | None = None, status: str | None = None, **kwargs: Any) -> AsyncIterable[MutableMapping[str, Any]]

Keyword-Only Parameters

Name	Description
orderby	str Sort on the supported fields in (field asc/desc) format. eg: executedDateTime asc. Supported fields - executedDateTime. Default value is None. Default value: None
search	str 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. Default value is None. Default value: None
test_id	str Unique name of an existing load test. Default value is None. Default value: None
execution_from	datetime Start DateTime(ISO 8601 literal format) of test-run execution time filter range. Default value is None. Default value: None
execution_to	datetime End DateTime(ISO 8601 literal format) of test-run execution time filter range. Default value is None. Default value: None
status	str Comma separated list of test run status. Default value is None. Default value: None

Returns

Type	Description
AsyncItemPaged[<xref:JSON>]	An iterator like instance of JSON object

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 200
   response == {
       "certificate": {
           "name": "str",  # Optional. Name of the certificate.
           "type": "str",  # Optional. Type of certificate. "AKV_CERT_URI"
           "value": "str"  # Optional. The value of the certificate for
             respective type.
       },
       "createdBy": "str",  # Optional. The user that created.
       "createdDateTime": "2020-02-20 00:00:00",  # Optional. The creation
         datetime(ISO 8601 literal format).
       "description": "str",  # Optional. The test run description.
       "displayName": "str",  # Optional. Display name of a testRun.
       "duration": 0,  # Optional. Test run duration in milliseconds.
       "endDateTime": "2020-02-20 00:00:00",  # Optional. The test run end
         DateTime(ISO 8601 literal format).
       "environmentVariables": {
           "str": "str"  # Optional. Environment variables which are defined as
             a set of <name,value> pairs.
       },
       "errorDetails": [
           {
               "message": "str"  # Optional. Error details in case test run
                 was not successfully run.
           }
       ],
       "executedDateTime": "2020-02-20 00:00:00",  # Optional. Test run initiated
         time.
       "lastModifiedBy": "str",  # Optional. The user that last modified.
       "lastModifiedDateTime": "2020-02-20 00:00:00",  # Optional. The last Modified
         datetime(ISO 8601 literal format).
       "loadTestConfiguration": {
           "engineInstances": 0,  # Optional. The number of engine instances to
             execute load test. Supported values are in range of 1-45. Required for
             creating a new test.
           "optionalLoadTestConfig": {
               "duration": 0,  # Optional. Test run duration.
               "endpointUrl": "str",  # Optional. Test URL. Provide the
                 complete HTTP URL. For example,
                 http://contoso-app.azurewebsites.net/login.
               "rampUpTime": 0,  # Optional. Ramp up time.
               "virtualUsers": 0  # Optional. No of concurrent virtual
                 users.
           },
           "quickStartTest": False,  # Optional. Default value is False. If
             true, optionalLoadTestConfig is required and JMX script for the load test is
             not required to upload.
           "splitAllCSVs": False  # Optional. Default value is False. If false,
             Azure Load Testing copies and processes your input files unmodified across
             all test engine instances. If true, Azure Load Testing splits the CSV input
             data evenly across all engine instances. If you provide multiple CSV files,
             each file will be split evenly.
       },
       "passFailCriteria": {
           "passFailMetrics": {
               "str": {
                   "action": "continue",  # Optional. Default value is
                     "continue". Action taken after the threshold is met. Default is
                     "u2018continue"u2019. Known values are: "continue" and "stop".
                   "actualValue": 0.0,  # Optional. The actual value of
                     the client metric for the test run.
                   "aggregate": "str",  # Optional. The aggregation
                     function to be applied on the client metric. Allowed functions -
                     "u2018percentage"u2019 - for error metric , "u2018avg"u2019,
                     "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019,
                     "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency
                     metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 -
                     for requests. Known values are: "count", "percentage", "avg", "p50",
                     "p90", "p95", "p99", "min", and "max".
                   "clientMetric": "str",  # Optional. The client metric
                     on which the criteria should be applied. Known values are:
                     "response_time_ms", "latency", "error", "requests", and
                     "requests_per_sec".
                   "condition": "str",  # Optional. The comparison
                     operator. Supported types "u2018>"u2019, "u2018<"u2019.
                   "requestName": "str",  # Optional. Request name for
                     which the Pass fail criteria has to be applied.
                   "result": "str",  # Optional. Outcome of the test
                     run. Known values are: "passed", "undetermined", and "failed".
                   "value": 0.0  # Optional. The value to compare with
                     the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit-
                     % "u2019, response_time_ms and latency : any integer value unit- ms.
               }
           }
       },
       "portalUrl": "str",  # Optional. Portal url.
       "secrets": {
           "str": {
               "type": "str",  # Optional. Type of secret. Known values are:
                 "AKV_SECRET_URI" and "SECRET_VALUE".
               "value": "str"  # Optional. The value of the secret for the
                 respective type.
           }
       },
       "startDateTime": "2020-02-20 00:00:00",  # Optional. The test run start
         DateTime(ISO 8601 literal format).
       "status": "str",  # Optional. The test run status. Known values are:
         "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING",
         "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE",
         "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and
         "VALIDATION_FAILURE".
       "subnetId": "str",  # Optional. Subnet ID on which the load test instances
         should run.
       "testArtifacts": {
           "inputArtifacts": {
               "additionalFileInfo": [
                   {
                       "expireDateTime": "2020-02-20 00:00:00",  #
                         Optional. Expiry time of the file (ISO 8601 literal format).
                       "fileName": "str",  # Optional. Name of the
                         file.
                       "fileType": "str",  # Optional. File type.
                         Known values are: "JMX_FILE", "USER_PROPERTIES", and
                         "ADDITIONAL_ARTIFACTS".
                       "url": "str",  # Optional. File URL.
                       "validationFailureDetails": "str",  #
                         Optional. Validation failure error details.
                       "validationStatus": "str"  # Optional.
                         Validation status of the file. Known values are: "NOT_VALIDATED",
                         "VALIDATION_SUCCESS", "VALIDATION_FAILURE",
                         "VALIDATION_INITIATED", and "VALIDATION_NOT_REQUIRED".
                   }
               ],
               "configFileInfo": {
                   "expireDateTime": "2020-02-20 00:00:00",  # Optional.
                     Expiry time of the file (ISO 8601 literal format).
                   "fileName": "str",  # Optional. Name of the file.
                   "fileType": "str",  # Optional. File type. Known
                     values are: "JMX_FILE", "USER_PROPERTIES", and
                     "ADDITIONAL_ARTIFACTS".
                   "url": "str",  # Optional. File URL.
                   "validationFailureDetails": "str",  # Optional.
                     Validation failure error details.
                   "validationStatus": "str"  # Optional. Validation
                     status of the file. Known values are: "NOT_VALIDATED",
                     "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED",
                     and "VALIDATION_NOT_REQUIRED".
               },
               "inputArtifactsZipFileInfo": {
                   "expireDateTime": "2020-02-20 00:00:00",  # Optional.
                     Expiry time of the file (ISO 8601 literal format).
                   "fileName": "str",  # Optional. Name of the file.
                   "fileType": "str",  # Optional. File type. Known
                     values are: "JMX_FILE", "USER_PROPERTIES", and
                     "ADDITIONAL_ARTIFACTS".
                   "url": "str",  # Optional. File URL.
                   "validationFailureDetails": "str",  # Optional.
                     Validation failure error details.
                   "validationStatus": "str"  # Optional. Validation
                     status of the file. Known values are: "NOT_VALIDATED",
                     "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED",
                     and "VALIDATION_NOT_REQUIRED".
               },
               "testScriptFileInfo": {
                   "expireDateTime": "2020-02-20 00:00:00",  # Optional.
                     Expiry time of the file (ISO 8601 literal format).
                   "fileName": "str",  # Optional. Name of the file.
                   "fileType": "str",  # Optional. File type. Known
                     values are: "JMX_FILE", "USER_PROPERTIES", and
                     "ADDITIONAL_ARTIFACTS".
                   "url": "str",  # Optional. File URL.
                   "validationFailureDetails": "str",  # Optional.
                     Validation failure error details.
                   "validationStatus": "str"  # Optional. Validation
                     status of the file. Known values are: "NOT_VALIDATED",
                     "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED",
                     and "VALIDATION_NOT_REQUIRED".
               },
               "userPropFileInfo": {
                   "expireDateTime": "2020-02-20 00:00:00",  # Optional.
                     Expiry time of the file (ISO 8601 literal format).
                   "fileName": "str",  # Optional. Name of the file.
                   "fileType": "str",  # Optional. File type. Known
                     values are: "JMX_FILE", "USER_PROPERTIES", and
                     "ADDITIONAL_ARTIFACTS".
                   "url": "str",  # Optional. File URL.
                   "validationFailureDetails": "str",  # Optional.
                     Validation failure error details.
                   "validationStatus": "str"  # Optional. Validation
                     status of the file. Known values are: "NOT_VALIDATED",
                     "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED",
                     and "VALIDATION_NOT_REQUIRED".
               }
           },
           "outputArtifacts": {
               "logsFileInfo": {
                   "expireDateTime": "2020-02-20 00:00:00",  # Optional.
                     Expiry time of the file (ISO 8601 literal format).
                   "fileName": "str",  # Optional. Name of the file.
                   "fileType": "str",  # Optional. File type. Known
                     values are: "JMX_FILE", "USER_PROPERTIES", and
                     "ADDITIONAL_ARTIFACTS".
                   "url": "str",  # Optional. File URL.
                   "validationFailureDetails": "str",  # Optional.
                     Validation failure error details.
                   "validationStatus": "str"  # Optional. Validation
                     status of the file. Known values are: "NOT_VALIDATED",
                     "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED",
                     and "VALIDATION_NOT_REQUIRED".
               },
               "resultFileInfo": {
                   "expireDateTime": "2020-02-20 00:00:00",  # Optional.
                     Expiry time of the file (ISO 8601 literal format).
                   "fileName": "str",  # Optional. Name of the file.
                   "fileType": "str",  # Optional. File type. Known
                     values are: "JMX_FILE", "USER_PROPERTIES", and
                     "ADDITIONAL_ARTIFACTS".
                   "url": "str",  # Optional. File URL.
                   "validationFailureDetails": "str",  # Optional.
                     Validation failure error details.
                   "validationStatus": "str"  # Optional. Validation
                     status of the file. Known values are: "NOT_VALIDATED",
                     "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED",
                     and "VALIDATION_NOT_REQUIRED".
               }
           }
       },
       "testId": "str",  # Optional. Associated test Id.
       "testResult": "str",  # Optional. Test result for pass/Fail criteria used
         during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED".
       "testRunId": "str",  # Optional. Unique test run name as identifier.
       "testRunStatistics": {
           "str": {
               "errorCount": 0.0,  # Optional. Error count.
               "errorPct": 0.0,  # Optional. Error percentage.
               "maxResTime": 0.0,  # Optional. Max response time.
               "meanResTime": 0.0,  # Optional. Mean response time.
               "medianResTime": 0.0,  # Optional. Median response time.
               "minResTime": 0.0,  # Optional. Minimum response time.
               "pct1ResTime": 0.0,  # Optional. 90 percentile response time.
               "pct2ResTime": 0.0,  # Optional. 95 percentile response time.
               "pct3ResTime": 0.0,  # Optional. 99 percentile response time.
               "receivedKBytesPerSec": 0.0,  # Optional. Received network
                 bytes.
               "sampleCount": 0.0,  # Optional. Sampler count.
               "sentKBytesPerSec": 0.0,  # Optional. Send network bytes.
               "throughput": 0.0,  # Optional. Throughput.
               "transaction": "str"  # Optional. Transaction name.
           }
       },
       "virtualUsers": 0  # Optional. Number of virtual users, for which test has
         been run.
   }

send_request

Runs the network request through the client's chained policies.


>>> from azure.core.rest import HttpRequest
>>> request = HttpRequest("GET", "https://www.example.org/")
<HttpRequest [GET], url: 'https://www.example.org/'>
>>> response = await client.send_request(request)
<AsyncHttpResponse: 200 OK>

For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request

send_request(request: HttpRequest, **kwargs: Any) -> Awaitable[AsyncHttpResponse]

Parameters

Name	Description
request Required	HttpRequest The network request you want to make. Required.

Keyword-Only Parameters

Name	Description
stream	bool Whether the response payload will be streamed. Defaults to False.

Returns

Type	Description
AsyncHttpResponse	The response of your network call. Does not do error handling on your response.

stop_test_run

Stop test run by name.

async stop_test_run(test_run_id: str, **kwargs: Any) -> MutableMapping[str, Any]

Parameters

Name	Description
test_run_id Required	str Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. Required.

Returns

Type	Description
<xref:JSON>	JSON object

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 200
   response == {
       "certificate": {
           "name": "str",  # Optional. Name of the certificate.
           "type": "str",  # Optional. Type of certificate. "AKV_CERT_URI"
           "value": "str"  # Optional. The value of the certificate for
             respective type.
       },
       "createdBy": "str",  # Optional. The user that created.
       "createdDateTime": "2020-02-20 00:00:00",  # Optional. The creation
         datetime(ISO 8601 literal format).
       "description": "str",  # Optional. The test run description.
       "displayName": "str",  # Optional. Display name of a testRun.
       "duration": 0,  # Optional. Test run duration in milliseconds.
       "endDateTime": "2020-02-20 00:00:00",  # Optional. The test run end
         DateTime(ISO 8601 literal format).
       "environmentVariables": {
           "str": "str"  # Optional. Environment variables which are defined as
             a set of <name,value> pairs.
       },
       "errorDetails": [
           {
               "message": "str"  # Optional. Error details in case test run
                 was not successfully run.
           }
       ],
       "executedDateTime": "2020-02-20 00:00:00",  # Optional. Test run initiated
         time.
       "lastModifiedBy": "str",  # Optional. The user that last modified.
       "lastModifiedDateTime": "2020-02-20 00:00:00",  # Optional. The last Modified
         datetime(ISO 8601 literal format).
       "loadTestConfiguration": {
           "engineInstances": 0,  # Optional. The number of engine instances to
             execute load test. Supported values are in range of 1-45. Required for
             creating a new test.
           "optionalLoadTestConfig": {
               "duration": 0,  # Optional. Test run duration.
               "endpointUrl": "str",  # Optional. Test URL. Provide the
                 complete HTTP URL. For example,
                 http://contoso-app.azurewebsites.net/login.
               "rampUpTime": 0,  # Optional. Ramp up time.
               "virtualUsers": 0  # Optional. No of concurrent virtual
                 users.
           },
           "quickStartTest": False,  # Optional. Default value is False. If
             true, optionalLoadTestConfig is required and JMX script for the load test is
             not required to upload.
           "splitAllCSVs": False  # Optional. Default value is False. If false,
             Azure Load Testing copies and processes your input files unmodified across
             all test engine instances. If true, Azure Load Testing splits the CSV input
             data evenly across all engine instances. If you provide multiple CSV files,
             each file will be split evenly.
       },
       "passFailCriteria": {
           "passFailMetrics": {
               "str": {
                   "action": "continue",  # Optional. Default value is
                     "continue". Action taken after the threshold is met. Default is
                     "u2018continue"u2019. Known values are: "continue" and "stop".
                   "actualValue": 0.0,  # Optional. The actual value of
                     the client metric for the test run.
                   "aggregate": "str",  # Optional. The aggregation
                     function to be applied on the client metric. Allowed functions -
                     "u2018percentage"u2019 - for error metric , "u2018avg"u2019,
                     "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019,
                     "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency
                     metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 -
                     for requests. Known values are: "count", "percentage", "avg", "p50",
                     "p90", "p95", "p99", "min", and "max".
                   "clientMetric": "str",  # Optional. The client metric
                     on which the criteria should be applied. Known values are:
                     "response_time_ms", "latency", "error", "requests", and
                     "requests_per_sec".
                   "condition": "str",  # Optional. The comparison
                     operator. Supported types "u2018>"u2019, "u2018<"u2019.
                   "requestName": "str",  # Optional. Request name for
                     which the Pass fail criteria has to be applied.
                   "result": "str",  # Optional. Outcome of the test
                     run. Known values are: "passed", "undetermined", and "failed".
                   "value": 0.0  # Optional. The value to compare with
                     the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit-
                     % "u2019, response_time_ms and latency : any integer value unit- ms.
               }
           }
       },
       "portalUrl": "str",  # Optional. Portal url.
       "secrets": {
           "str": {
               "type": "str",  # Optional. Type of secret. Known values are:
                 "AKV_SECRET_URI" and "SECRET_VALUE".
               "value": "str"  # Optional. The value of the secret for the
                 respective type.
           }
       },
       "startDateTime": "2020-02-20 00:00:00",  # Optional. The test run start
         DateTime(ISO 8601 literal format).
       "status": "str",  # Optional. The test run status. Known values are:
         "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING",
         "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE",
         "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and
         "VALIDATION_FAILURE".
       "subnetId": "str",  # Optional. Subnet ID on which the load test instances
         should run.
       "testArtifacts": {
           "inputArtifacts": {
               "additionalFileInfo": [
                   {
                       "expireDateTime": "2020-02-20 00:00:00",  #
                         Optional. Expiry time of the file (ISO 8601 literal format).
                       "fileName": "str",  # Optional. Name of the
                         file.
                       "fileType": "str",  # Optional. File type.
                         Known values are: "JMX_FILE", "USER_PROPERTIES", and
                         "ADDITIONAL_ARTIFACTS".
                       "url": "str",  # Optional. File URL.
                       "validationFailureDetails": "str",  #
                         Optional. Validation failure error details.
                       "validationStatus": "str"  # Optional.
                         Validation status of the file. Known values are: "NOT_VALIDATED",
                         "VALIDATION_SUCCESS", "VALIDATION_FAILURE",
                         "VALIDATION_INITIATED", and "VALIDATION_NOT_REQUIRED".
                   }
               ],
               "configFileInfo": {
                   "expireDateTime": "2020-02-20 00:00:00",  # Optional.
                     Expiry time of the file (ISO 8601 literal format).
                   "fileName": "str",  # Optional. Name of the file.
                   "fileType": "str",  # Optional. File type. Known
                     values are: "JMX_FILE", "USER_PROPERTIES", and
                     "ADDITIONAL_ARTIFACTS".
                   "url": "str",  # Optional. File URL.
                   "validationFailureDetails": "str",  # Optional.
                     Validation failure error details.
                   "validationStatus": "str"  # Optional. Validation
                     status of the file. Known values are: "NOT_VALIDATED",
                     "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED",
                     and "VALIDATION_NOT_REQUIRED".
               },
               "inputArtifactsZipFileInfo": {
                   "expireDateTime": "2020-02-20 00:00:00",  # Optional.
                     Expiry time of the file (ISO 8601 literal format).
                   "fileName": "str",  # Optional. Name of the file.
                   "fileType": "str",  # Optional. File type. Known
                     values are: "JMX_FILE", "USER_PROPERTIES", and
                     "ADDITIONAL_ARTIFACTS".
                   "url": "str",  # Optional. File URL.
                   "validationFailureDetails": "str",  # Optional.
                     Validation failure error details.
                   "validationStatus": "str"  # Optional. Validation
                     status of the file. Known values are: "NOT_VALIDATED",
                     "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED",
                     and "VALIDATION_NOT_REQUIRED".
               },
               "testScriptFileInfo": {
                   "expireDateTime": "2020-02-20 00:00:00",  # Optional.
                     Expiry time of the file (ISO 8601 literal format).
                   "fileName": "str",  # Optional. Name of the file.
                   "fileType": "str",  # Optional. File type. Known
                     values are: "JMX_FILE", "USER_PROPERTIES", and
                     "ADDITIONAL_ARTIFACTS".
                   "url": "str",  # Optional. File URL.
                   "validationFailureDetails": "str",  # Optional.
                     Validation failure error details.
                   "validationStatus": "str"  # Optional. Validation
                     status of the file. Known values are: "NOT_VALIDATED",
                     "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED",
                     and "VALIDATION_NOT_REQUIRED".
               },
               "userPropFileInfo": {
                   "expireDateTime": "2020-02-20 00:00:00",  # Optional.
                     Expiry time of the file (ISO 8601 literal format).
                   "fileName": "str",  # Optional. Name of the file.
                   "fileType": "str",  # Optional. File type. Known
                     values are: "JMX_FILE", "USER_PROPERTIES", and
                     "ADDITIONAL_ARTIFACTS".
                   "url": "str",  # Optional. File URL.
                   "validationFailureDetails": "str",  # Optional.
                     Validation failure error details.
                   "validationStatus": "str"  # Optional. Validation
                     status of the file. Known values are: "NOT_VALIDATED",
                     "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED",
                     and "VALIDATION_NOT_REQUIRED".
               }
           },
           "outputArtifacts": {
               "logsFileInfo": {
                   "expireDateTime": "2020-02-20 00:00:00",  # Optional.
                     Expiry time of the file (ISO 8601 literal format).
                   "fileName": "str",  # Optional. Name of the file.
                   "fileType": "str",  # Optional. File type. Known
                     values are: "JMX_FILE", "USER_PROPERTIES", and
                     "ADDITIONAL_ARTIFACTS".
                   "url": "str",  # Optional. File URL.
                   "validationFailureDetails": "str",  # Optional.
                     Validation failure error details.
                   "validationStatus": "str"  # Optional. Validation
                     status of the file. Known values are: "NOT_VALIDATED",
                     "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED",
                     and "VALIDATION_NOT_REQUIRED".
               },
               "resultFileInfo": {
                   "expireDateTime": "2020-02-20 00:00:00",  # Optional.
                     Expiry time of the file (ISO 8601 literal format).
                   "fileName": "str",  # Optional. Name of the file.
                   "fileType": "str",  # Optional. File type. Known
                     values are: "JMX_FILE", "USER_PROPERTIES", and
                     "ADDITIONAL_ARTIFACTS".
                   "url": "str",  # Optional. File URL.
                   "validationFailureDetails": "str",  # Optional.
                     Validation failure error details.
                   "validationStatus": "str"  # Optional. Validation
                     status of the file. Known values are: "NOT_VALIDATED",
                     "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED",
                     and "VALIDATION_NOT_REQUIRED".
               }
           }
       },
       "testId": "str",  # Optional. Associated test Id.
       "testResult": "str",  # Optional. Test result for pass/Fail criteria used
         during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED".
       "testRunId": "str",  # Optional. Unique test run name as identifier.
       "testRunStatistics": {
           "str": {
               "errorCount": 0.0,  # Optional. Error count.
               "errorPct": 0.0,  # Optional. Error percentage.
               "maxResTime": 0.0,  # Optional. Max response time.
               "meanResTime": 0.0,  # Optional. Mean response time.
               "medianResTime": 0.0,  # Optional. Median response time.
               "minResTime": 0.0,  # Optional. Minimum response time.
               "pct1ResTime": 0.0,  # Optional. 90 percentile response time.
               "pct2ResTime": 0.0,  # Optional. 95 percentile response time.
               "pct3ResTime": 0.0,  # Optional. 99 percentile response time.
               "receivedKBytesPerSec": 0.0,  # Optional. Received network
                 bytes.
               "sampleCount": 0.0,  # Optional. Sampler count.
               "sentKBytesPerSec": 0.0,  # Optional. Send network bytes.
               "throughput": 0.0,  # Optional. Throughput.
               "transaction": "str"  # Optional. Transaction name.
           }
       },
       "virtualUsers": 0  # Optional. Number of virtual users, for which test has
         been run.
   }

Feedback

Was this page helpful?

Share via

LoadTestRunClient Class

Constructor

Parameters

Keyword-Only Parameters

Methods

begin_test_run

Parameters

Keyword-Only Parameters

Returns

Exceptions

close

create_or_update_app_components

Parameters

Keyword-Only Parameters

Returns

Exceptions

Examples

create_or_update_server_metrics_config

Parameters

Keyword-Only Parameters

Returns

Exceptions

Examples

delete_test_run

Parameters

Returns

Exceptions

get_app_components

Parameters

Returns

Exceptions

Examples

get_metric_definitions

Parameters

Keyword-Only Parameters

Returns

Exceptions

Examples

get_metric_namespaces

Parameters

Returns

Exceptions

Examples

get_server_metrics_config

Parameters

Returns

Exceptions

Examples

get_test_run

Parameters

Returns

Exceptions

Examples

get_test_run_file

Parameters

Returns

Exceptions

Examples

list_metric_dimension_values

Parameters

Keyword-Only Parameters

Returns

Exceptions

Examples

list_metrics

Parameters

Keyword-Only Parameters

Returns

Exceptions

Examples

list_test_runs

Keyword-Only Parameters

Returns

Exceptions

Examples

send_request

Parameters

Keyword-Only Parameters

Returns