azure.developer.loadtesting.aio.operations package¶

class azure.developer.loadtesting.aio.operations.AppComponentOperations(*args, **kwargs)[source]¶

create_or_update_app_components(name: str, body: JSON, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON[source]¶

create_or_update_app_components(name: str, body: IO, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON

Associate an App Component (Azure resource) to a test or test run.

Parameters

name (str) – Unique name of the App Component, must be a valid URL character ^[a-z0-9_-]*$. Required.
body (JSON or IO) – App Component model. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/merge-patch+json’. Default value is None.

Returns

JSON object

Return type

JSON

Raises

HttpResponseError –

Example

# response body for status code(s): 200, 201
response == {
    "name": "str",  # Optional. AppComponent name.
    "resourceId": "str",  # Optional. Azure Load Testing resource Id.
    "testId": "str",  # Optional. [Required, if testRunId is not given] Load test
      unique identifier.
    "testRunId": "str",  # Optional. [Required if testId is not given] Load test
      run unique identifier.
    "value": {
        "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",  # Fully qualified resource Id e.g
              subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}.
              Required.
            "resourceName": "str",  # Azure resource name. Required.
            "resourceType": "str",  # Azure resource type. Required.
            "subscriptionId": "str"  # Optional. Subscription Id of the
              Azure resource.
        }
    }
}

get_app_components(*, test_run_id: Optional[str] = None, test_id: Optional[str] = None, name: Optional[str] = None, **kwargs: Any) → Coroutine[Any, Any, MutableMapping[str, Any]][source]¶

Get App Components for a test or a test run by its name.

Keyword Arguments

test_run_id (st) – [Required, if testId is not provided] Test run Id. Default value is None.
test_id (str) – Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. Default value is None.
name (str) – Unique name of the App Component, must be a valid URL character ^[a-z0-9_-]*$. Default value is None.

Returns

JSON object

Return type

JSON

Raises

HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "name": "str",  # Optional. AppComponent name.
    "resourceId": "str",  # Optional. Azure Load Testing resource Id.
    "testId": "str",  # Optional. [Required, if testRunId is not given] Load test
      unique identifier.
    "testRunId": "str",  # Optional. [Required if testId is not given] Load test
      run unique identifier.
    "value": {
        "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",  # Fully qualified resource Id e.g
              subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}.
              Required.
            "resourceName": "str",  # Azure resource name. Required.
            "resourceType": "str",  # Azure resource type. Required.
            "subscriptionId": "str"  # Optional. Subscription Id of the
              Azure resource.
        }
    }
}

class azure.developer.loadtesting.aio.operations.ServerMetricsOperations(*args, **kwargs)[source]¶

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through LoadTestingClient’s server_metrics attribute.

async create_or_update_server_metrics_config(name: str, body: JSON, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON[source]¶

async create_or_update_server_metrics_config(name: str, body: IO, *, content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON

Configure server metrics for a test or test run.

Parameters

name (str) – Unique name for server metrics, must be a valid URL character ^[a-z0-9_-]*$. Required.
body (JSON or IO) – Server metrics configuration model. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/merge-patch+json’. Default value is None.

Returns

JSON object

Return type

JSON

Raises

HttpResponseError –

Example

# response body for status code(s): 200, 201
response == {
    "metrics": {
        "str": {
            "aggregation": "str",  # Metric aggregation. Required.
            "metricnamespace": "str",  # Metric name space. Required.
            "name": {
                "localizedValue": "str",  # Metric localized name.
                  Required.
                "value": "str"  # Metric name value. Required.
            },
            "resourceId": "str",  # Azure resource Id. Required.
            "resourceType": "str",  # Azure resource type. Required.
            "displayDescription": "str",  # Optional. Metric description.
            "id": "str",  # Optional. Unique identifier for metric.
            "unit": "str"  # Optional. Metric unit.
        }
    },
    "name": "str",  # Optional. Server metrics config name.
    "testId": "str",  # Optional. [Required, if testRunId is not given] Load test
      unique identifier.
    "testRunId": "str"  # Optional. [Required, if testId is not given] Load test
      run unique identifier.
}

async delete_server_metrics_config(name: str, **kwargs: Any) → None [source]¶

Delete server metrics configuration by its name.

Parameters: name (str) – Unique name for server metrics, must be a valid URL character ^[a-z0-9_-]*$. Required.
Returns: None
Return type: None
Raises: HttpResponseError –

async get_server_default_metrics_config(**kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶

Get all default server metrics configuration for supported resource types.

Returns: JSON object
Return type: JSON
Raises: HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "defaultMetrics": {
        "str": [
            {
                "aggregation": "str",  # Optional. Default metrics
                  map {resourceType : list of metrics config} (Refer for metrics
                  structure:
                  https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition).
                "displayDescription": "str",  # Optional. Default
                  metrics map {resourceType : list of metrics config} (Refer for
                  metrics structure:
                  https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition).
                "metricnamespace": "str",  # Optional. Default
                  metrics map {resourceType : list of metrics config} (Refer for
                  metrics structure:
                  https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition).
                "name": {
                    "localizedValue": "str",  # Optional. Default
                      metrics map {resourceType : list of metrics config} (Refer for
                      metrics structure:
                      https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition).
                    "value": "str"  # Optional. Default metrics
                      map {resourceType : list of metrics config} (Refer for metrics
                      structure:
                      https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition).
                },
                "unit": "str"  # Optional. Default metrics map
                  {resourceType : list of metrics config} (Refer for metrics structure:
                  https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition).
            }
        ]
    }
}

async get_server_metrics_config(*, test_run_id: Optional[str] = None, test_id: Optional[str] = None, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶

Get server metrics configuration for a test or test run by its name.

Keyword Arguments

test_run_id (str) – [Required, if testId is not provided] Test run Id. Default value is None.
test_id (str) – Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. Default value is None.

Returns

JSON object

Return type

JSON

Raises

HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "metrics": {
        "str": {
            "aggregation": "str",  # Metric aggregation. Required.
            "metricnamespace": "str",  # Metric name space. Required.
            "name": {
                "localizedValue": "str",  # Metric localized name.
                  Required.
                "value": "str"  # Metric name value. Required.
            },
            "resourceId": "str",  # Azure resource Id. Required.
            "resourceType": "str",  # Azure resource type. Required.
            "displayDescription": "str",  # Optional. Metric description.
            "id": "str",  # Optional. Unique identifier for metric.
            "unit": "str"  # Optional. Metric unit.
        }
    },
    "name": "str",  # Optional. Server metrics config name.
    "testId": "str",  # Optional. [Required, if testRunId is not given] Load test
      unique identifier.
    "testRunId": "str"  # Optional. [Required, if testId is not given] Load test
      run unique identifier.
}

async get_server_metrics_config_by_name(name: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶

Get server metrics configuration by its name.

Parameters: name (str) – Unique name for server metrics, must be a valid URL character ^[a-z0-9_-]*$. Required.
Returns: JSON object
Return type: JSON
Raises: HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "metrics": {
        "str": {
            "aggregation": "str",  # Metric aggregation. Required.
            "metricnamespace": "str",  # Metric name space. Required.
            "name": {
                "localizedValue": "str",  # Metric localized name.
                  Required.
                "value": "str"  # Metric name value. Required.
            },
            "resourceId": "str",  # Azure resource Id. Required.
            "resourceType": "str",  # Azure resource type. Required.
            "displayDescription": "str",  # Optional. Metric description.
            "id": "str",  # Optional. Unique identifier for metric.
            "unit": "str"  # Optional. Metric unit.
        }
    },
    "name": "str",  # Optional. Server metrics config name.
    "testId": "str",  # Optional. [Required, if testRunId is not given] Load test
      unique identifier.
    "testRunId": "str"  # Optional. [Required, if testId is not given] Load test
      run unique identifier.
}

async list_supported_resource_types(**kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶

Get all supported resource types for App Components(Azure resource types).

Returns: JSON object
Return type: JSON
Raises: HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "value": [
        "str"  # Optional.
    ]
}

class azure.developer.loadtesting.aio.operations.TestOperations(*args, **kwargs)[source]¶

for performing the operations on test

async create_or_update_test(test_id: str, body: Union[collections.abc.MutableMapping[str, Any], IO], **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶

Create a new test or Update an existing test.

Parameters

test_id (str) – Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. Required.
body (JSON or IO) – Load test model. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/merge-patch+json’. Default value is None.

Returns

JSON object

Return type

JSON

Raises

HttpResponseError –

Example

# response body for status code(s): 200, 201
response == {
    "createdBy": "str",  # Optional. The user that created the test model.
    "createdDateTime": "2020-02-20 00:00:00",  # Optional. The created
      DateTime(ISO 8601 literal format) of the test model.
    "description": "str",  # Optional. The test description.
    "displayName": "str",  # Optional. Display name of a test.
    "environmentVariables": {
        "str": "str"  # Optional. Environment variables which are defined as
          a set of <name,value> pairs.
    },
    "inputArtifacts": {
        "additionalUrls": [
            {
                "expireTime": "2020-02-20 00:00:00",  # Optional.
                  Expiry time of the file.
                "fileId": "str",  # Optional. File unique identifier.
                "fileType": 0,  # Optional. Integer representation of
                  the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 =
                  ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2.
                "filename": "str",  # Optional. Name of the file.
                "url": "str",  # Optional. File URL.
                "validationStatus": "str"  # Optional. Validation
                  status of the file.
            }
        ],
        "configUrl": {
            "expireTime": "2020-02-20 00:00:00",  # Optional. Expiry time
              of the file.
            "fileId": "str",  # Optional. File unique identifier.
            "fileType": 0,  # Optional. Integer representation of the
              file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS).
              Known values are: 0, 1, and 2.
            "filename": "str",  # Optional. Name of the file.
            "url": "str",  # Optional. File URL.
            "validationStatus": "str"  # Optional. Validation status of
              the file.
        },
        "inputArtifactsZipFileurl": {
            "expireTime": "2020-02-20 00:00:00",  # Optional. Expiry time
              of the file.
            "fileId": "str",  # Optional. File unique identifier.
            "fileType": 0,  # Optional. Integer representation of the
              file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS).
              Known values are: 0, 1, and 2.
            "filename": "str",  # Optional. Name of the file.
            "url": "str",  # Optional. File URL.
            "validationStatus": "str"  # Optional. Validation status of
              the file.
        },
        "testScriptUrl": {
            "expireTime": "2020-02-20 00:00:00",  # Optional. Expiry time
              of the file.
            "fileId": "str",  # Optional. File unique identifier.
            "fileType": 0,  # Optional. Integer representation of the
              file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS).
              Known values are: 0, 1, and 2.
            "filename": "str",  # Optional. Name of the file.
            "url": "str",  # Optional. File URL.
            "validationStatus": "str"  # Optional. Validation status of
              the file.
        },
        "userPropUrl": {
            "expireTime": "2020-02-20 00:00:00",  # Optional. Expiry time
              of the file.
            "fileId": "str",  # Optional. File unique identifier.
            "fileType": 0,  # Optional. Integer representation of the
              file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS).
              Known values are: 0, 1, and 2.
            "filename": "str",  # Optional. Name of the file.
            "url": "str",  # Optional. File URL.
            "validationStatus": "str"  # Optional. Validation status of
              the file.
        }
    },
    "keyvaultReferenceIdentityId": "str",  # Optional. Resource Id of the managed
      identity referencing the Key vault.
    "keyvaultReferenceIdentityType": "str",  # Optional. Type of the managed
      identity referencing the Key vault.
    "lastModifiedBy": "str",  # Optional. The user that last modified the test
      model.
    "lastModifiedDateTime": "2020-02-20 00:00:00",  # Optional. The last Modified
      DateTime(ISO 8601 literal format) of the test model.
    "loadTestConfig": {
        "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.
        "splitAllCSVs": bool  # Optional. Whether all the input CSV files
          should be split evenly across all engines.
    },
    "passFailCriteria": {
        "passFailMetrics": {
            "str": {
                "action": "str",  # Optional. Either "u2018stop"u2019
                  or "u2018continue"u2019 after the threshold is met. Default is
                  "u2018continue"u2019.
                "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.
                "clientmetric": "str",  # Optional. The client metric
                  on which the criteria should be applied. Allowed values -
                  "u2018response_time_ms"u2019 , "u2018latency"u2019,
                  "u2018error"u2019, "u2018requests"u2019,
                  "u2018requests_per_sec"u2019.
                "condition": "str",  # Optional. The comparison
                  operator. Supported types "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. possible outcome - "u2018passed"u2019 , "u2018failed"u2019 ,
                  "u2018undetermined"u2019.
                "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.
            }
        }
    },
    "resourceId": "str",  # Optional. Fully qualified resource Id e.g
      /subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}.
    "secrets": {
        "str": {
            "type": "str",  # Optional. Type of secret. eg.
              AKV_SECRET_URI/SECRET_VALUE.
            "value": "str"  # Optional. The value of the secret, of type
              AKV_SECRET_URI or SECRET_VALUE.
        }
    },
    "subnetId": "str",  # Optional. Subnet ID on which the load test instances
      should run.
    "testId": "str"  # Optional. Unique test name as identifier.
}

async delete_load_test(test_id: str, **kwargs: Any) → None [source]¶

Delete a test by its name.

Parameters: test_id (str) – Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. Required.
Returns: None
Return type: None
Raises: HttpResponseError –

async delete_test_file(test_id: str, file_id: str, **kwargs: Any) → None [source]¶

Delete file by the file name for a test.

Parameters

test_id (str) – Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. Required.
file_id (str) – Unique identifier for test file, must be a valid URL character ^[a-z0-9_-]*$. Required.

Returns

None

Return type

None

Raises

HttpResponseError –

async get_load_test(test_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶

Get load test details by test name.

Parameters: test_id (str) – Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. Required.
Returns: JSON object
Return type: JSON
Raises: HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "createdBy": "str",  # Optional. The user that created the test model.
    "createdDateTime": "2020-02-20 00:00:00",  # Optional. The created
      DateTime(ISO 8601 literal format) of the test model.
    "description": "str",  # Optional. The test description.
    "displayName": "str",  # Optional. Display name of a test.
    "environmentVariables": {
        "str": "str"  # Optional. Environment variables which are defined as
          a set of <name,value> pairs.
    },
    "inputArtifacts": {
        "additionalUrls": [
            {
                "expireTime": "2020-02-20 00:00:00",  # Optional.
                  Expiry time of the file.
                "fileId": "str",  # Optional. File unique identifier.
                "fileType": 0,  # Optional. Integer representation of
                  the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 =
                  ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2.
                "filename": "str",  # Optional. Name of the file.
                "url": "str",  # Optional. File URL.
                "validationStatus": "str"  # Optional. Validation
                  status of the file.
            }
        ],
        "configUrl": {
            "expireTime": "2020-02-20 00:00:00",  # Optional. Expiry time
              of the file.
            "fileId": "str",  # Optional. File unique identifier.
            "fileType": 0,  # Optional. Integer representation of the
              file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS).
              Known values are: 0, 1, and 2.
            "filename": "str",  # Optional. Name of the file.
            "url": "str",  # Optional. File URL.
            "validationStatus": "str"  # Optional. Validation status of
              the file.
        },
        "inputArtifactsZipFileurl": {
            "expireTime": "2020-02-20 00:00:00",  # Optional. Expiry time
              of the file.
            "fileId": "str",  # Optional. File unique identifier.
            "fileType": 0,  # Optional. Integer representation of the
              file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS).
              Known values are: 0, 1, and 2.
            "filename": "str",  # Optional. Name of the file.
            "url": "str",  # Optional. File URL.
            "validationStatus": "str"  # Optional. Validation status of
              the file.
        },
        "testScriptUrl": {
            "expireTime": "2020-02-20 00:00:00",  # Optional. Expiry time
              of the file.
            "fileId": "str",  # Optional. File unique identifier.
            "fileType": 0,  # Optional. Integer representation of the
              file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS).
              Known values are: 0, 1, and 2.
            "filename": "str",  # Optional. Name of the file.
            "url": "str",  # Optional. File URL.
            "validationStatus": "str"  # Optional. Validation status of
              the file.
        },
        "userPropUrl": {
            "expireTime": "2020-02-20 00:00:00",  # Optional. Expiry time
              of the file.
            "fileId": "str",  # Optional. File unique identifier.
            "fileType": 0,  # Optional. Integer representation of the
              file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS).
              Known values are: 0, 1, and 2.
            "filename": "str",  # Optional. Name of the file.
            "url": "str",  # Optional. File URL.
            "validationStatus": "str"  # Optional. Validation status of
              the file.
        }
    },
    "keyvaultReferenceIdentityId": "str",  # Optional. Resource Id of the managed
      identity referencing the Key vault.
    "keyvaultReferenceIdentityType": "str",  # Optional. Type of the managed
      identity referencing the Key vault.
    "lastModifiedBy": "str",  # Optional. The user that last modified the test
      model.
    "lastModifiedDateTime": "2020-02-20 00:00:00",  # Optional. The last Modified
      DateTime(ISO 8601 literal format) of the test model.
    "loadTestConfig": {
        "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.
        "splitAllCSVs": bool  # Optional. Whether all the input CSV files
          should be split evenly across all engines.
    },
    "passFailCriteria": {
        "passFailMetrics": {
            "str": {
                "action": "str",  # Optional. Either "u2018stop"u2019
                  or "u2018continue"u2019 after the threshold is met. Default is
                  "u2018continue"u2019.
                "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.
                "clientmetric": "str",  # Optional. The client metric
                  on which the criteria should be applied. Allowed values -
                  "u2018response_time_ms"u2019 , "u2018latency"u2019,
                  "u2018error"u2019, "u2018requests"u2019,
                  "u2018requests_per_sec"u2019.
                "condition": "str",  # Optional. The comparison
                  operator. Supported types "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. possible outcome - "u2018passed"u2019 , "u2018failed"u2019 ,
                  "u2018undetermined"u2019.
                "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.
            }
        }
    },
    "resourceId": "str",  # Optional. Fully qualified resource Id e.g
      /subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}.
    "secrets": {
        "str": {
            "type": "str",  # Optional. Type of secret. eg.
              AKV_SECRET_URI/SECRET_VALUE.
            "value": "str"  # Optional. The value of the secret, of type
              AKV_SECRET_URI or SECRET_VALUE.
        }
    },
    "subnetId": "str",  # Optional. Subnet ID on which the load test instances
      should run.
    "testId": "str"  # Optional. Unique test name as identifier.
}

async get_test_file(test_id: str, file_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶

Get test file by the file name.

Parameters

test_id (str) – Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. Required.
file_id (str) – Unique identifier for test file, must be a valid URL character ^[a-z0-9_-]*$. Required.

Returns

JSON object

Return type

JSON

Raises

HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "expireTime": "2020-02-20 00:00:00",  # Optional. Expiry time of the file.
    "fileId": "str",  # Optional. File unique identifier.
    "fileType": 0,  # Optional. Integer representation of the file type (0 =
      JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: 0, 1,
      and 2.
    "filename": "str",  # Optional. Name of the file.
    "url": "str",  # Optional. File URL.
    "validationStatus": "str"  # Optional. Validation status of the file.
}

async list_load_test_search(*, order_by: Optional[str] = None, search: Optional[str] = None, last_updated_start_time: Optional[datetime.datetime] = None, last_updated_end_time: Optional[datetime.datetime] = None, continuation_token_parameter: Optional[str] = None, max_page_size: int = 50, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶

Get all load tests by the fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}.

Keyword Arguments

order_by (str) – Sort on one of the field - lastModifiedDateTime, displayName, createdBy in (field asc/desc) format. eg: displayName asc. Default value is None.
search (str) – Filter search based on searchable fields - testId, createdBy. Default value is None.
last_updated_start_time (datetime) – Start DateTime(ISO 8601 literal format) of the last updated time range to filter tests. Default value is None.
last_updated_end_time (datetime) – End DateTime(ISO 8601 literal format) of the last updated time range to filter tests. Default value is None.
continuation_token_parameter (str) – Continuation token to get the next page of response. Default value is None.
max_page_size (int) – Number of results in response. Default value is 50.

Returns

JSON object

Return type

JSON

Raises

HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "value": [
        {
            "createdBy": "str",  # Optional. The user that created the
              test model.
            "createdDateTime": "2020-02-20 00:00:00",  # Optional. The
              created DateTime(ISO 8601 literal format) of the test model.
            "description": "str",  # Optional. The test description.
            "displayName": "str",  # Optional. Display name of a test.
            "environmentVariables": {
                "str": "str"  # Optional. Environment variables which
                  are defined as a set of <name,value> pairs.
            },
            "inputArtifacts": {
                "additionalUrls": [
                    {
                        "expireTime": "2020-02-20 00:00:00",
                          # Optional. Expiry time of the file.
                        "fileId": "str",  # Optional. File
                          unique identifier.
                        "fileType": 0,  # Optional. Integer
                          representation of the file type (0 = JMX_FILE, 1 =
                          USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are:
                          0, 1, and 2.
                        "filename": "str",  # Optional. Name
                          of the file.
                        "url": "str",  # Optional. File URL.
                        "validationStatus": "str"  #
                          Optional. Validation status of the file.
                    }
                ],
                "configUrl": {
                    "expireTime": "2020-02-20 00:00:00",  #
                      Optional. Expiry time of the file.
                    "fileId": "str",  # Optional. File unique
                      identifier.
                    "fileType": 0,  # Optional. Integer
                      representation of the file type (0 = JMX_FILE, 1 =
                      USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: 0,
                      1, and 2.
                    "filename": "str",  # Optional. Name of the
                      file.
                    "url": "str",  # Optional. File URL.
                    "validationStatus": "str"  # Optional.
                      Validation status of the file.
                },
                "inputArtifactsZipFileurl": {
                    "expireTime": "2020-02-20 00:00:00",  #
                      Optional. Expiry time of the file.
                    "fileId": "str",  # Optional. File unique
                      identifier.
                    "fileType": 0,  # Optional. Integer
                      representation of the file type (0 = JMX_FILE, 1 =
                      USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: 0,
                      1, and 2.
                    "filename": "str",  # Optional. Name of the
                      file.
                    "url": "str",  # Optional. File URL.
                    "validationStatus": "str"  # Optional.
                      Validation status of the file.
                },
                "testScriptUrl": {
                    "expireTime": "2020-02-20 00:00:00",  #
                      Optional. Expiry time of the file.
                    "fileId": "str",  # Optional. File unique
                      identifier.
                    "fileType": 0,  # Optional. Integer
                      representation of the file type (0 = JMX_FILE, 1 =
                      USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: 0,
                      1, and 2.
                    "filename": "str",  # Optional. Name of the
                      file.
                    "url": "str",  # Optional. File URL.
                    "validationStatus": "str"  # Optional.
                      Validation status of the file.
                },
                "userPropUrl": {
                    "expireTime": "2020-02-20 00:00:00",  #
                      Optional. Expiry time of the file.
                    "fileId": "str",  # Optional. File unique
                      identifier.
                    "fileType": 0,  # Optional. Integer
                      representation of the file type (0 = JMX_FILE, 1 =
                      USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: 0,
                      1, and 2.
                    "filename": "str",  # Optional. Name of the
                      file.
                    "url": "str",  # Optional. File URL.
                    "validationStatus": "str"  # Optional.
                      Validation status of the file.
                }
            },
            "keyvaultReferenceIdentityId": "str",  # Optional. Resource
              Id of the managed identity referencing the Key vault.
            "keyvaultReferenceIdentityType": "str",  # Optional. Type of
              the managed identity referencing the Key vault.
            "lastModifiedBy": "str",  # Optional. The user that last
              modified the test model.
            "lastModifiedDateTime": "2020-02-20 00:00:00",  # Optional.
              The last Modified DateTime(ISO 8601 literal format) of the test model.
            "loadTestConfig": {
                "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.
                "splitAllCSVs": bool  # Optional. Whether all the
                  input CSV files should be split evenly across all engines.
            },
            "passFailCriteria": {
                "passFailMetrics": {
                    "str": {
                        "action": "str",  # Optional. Either
                          "u2018stop"u2019 or "u2018continue"u2019 after the threshold
                          is met. Default is "u2018continue"u2019.
                        "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.
                        "clientmetric": "str",  # Optional.
                          The client metric on which the criteria should be applied.
                          Allowed values - "u2018response_time_ms"u2019 ,
                          "u2018latency"u2019, "u2018error"u2019, "u2018requests"u2019,
                          "u2018requests_per_sec"u2019.
                        "condition": "str",  # Optional. The
                          comparison operator. Supported types "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. possible outcome - "u2018passed"u2019 ,
                          "u2018failed"u2019 , "u2018undetermined"u2019.
                        "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.
                    }
                }
            },
            "resourceId": "str",  # Optional. Fully qualified resource Id
              e.g
              /subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}.
            "secrets": {
                "str": {
                    "type": "str",  # Optional. Type of secret.
                      eg. AKV_SECRET_URI/SECRET_VALUE.
                    "value": "str"  # Optional. The value of the
                      secret, of type AKV_SECRET_URI or SECRET_VALUE.
                }
            },
            "subnetId": "str",  # Optional. Subnet ID on which the load
              test instances should run.
            "testId": "str"  # Optional. Unique test name as identifier.
        }
    ],
    "nextLink": "str"  # Optional. Link for the next list of resources in case of
      paginated results, if applicable.
}

async list_test_files(test_id: str, *, continuation_token_parameter: Optional[str] = None, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶

Get all test files.

Parameters: test_id (str) – Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. Required.
Keyword Arguments: continuation_token_parameter (str) – Continuation token to get the next page of response. Default value is None.
Returns: JSON object
Return type: JSON
Raises: HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "value": [
        {
            "expireTime": "2020-02-20 00:00:00",  # Optional. Expiry time
              of the file.
            "fileId": "str",  # Optional. File unique identifier.
            "fileType": 0,  # Optional. Integer representation of the
              file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS).
              Known values are: 0, 1, and 2.
            "filename": "str",  # Optional. Name of the file.
            "url": "str",  # Optional. File URL.
            "validationStatus": "str"  # Optional. Validation status of
              the file.
        }
    ],
    "nextLink": "str"  # Optional. Link for the next list of file URLs, if
      applicable.
}

async upload_test_file(test_id: str, file_id: str, file: BinaryIO, **kwargs) → collections.abc.MutableMapping[str, Any][source]¶

Upload test file and link it to a test.

Upload a test file to an existing test.

Parameters

test_id (str) – Unique id for the test
file_id (str) – Unique id for the file
file_content – dictionary containing file contet

Returns

JSON object

Return type

JSON

Raises

HttpResponseError –

class azure.developer.loadtesting.aio.operations.TestRunOperations(*args, **kwargs)[source]¶

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through LoadTestingClient’s test_run attribute.

async create_or_update_test(test_run_id: str, body: JSON, *, old_test_run_id: Optional[str] = 'None', content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON[source]¶

async create_or_update_test(test_run_id: str, body: IO, *, old_test_run_id: Optional[str] = 'None', content_type: str = "'application/merge-patch+json'", **kwargs: Any) → JSON

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

Parameters

test_run_id (str) – Unique name of the load test run, must be a valid URL character ^[a-z0-9_-]*$. Required.
body (JSON or IO) – Load test run model. Is either a model type or a IO type. Required.

Keyword Arguments

old_test_run_id (str) – Existing test run Id that should be rerun. Default value is None.
content_type (str) – Body Parameter content-type. Known values are: ‘application/merge-patch+json’. Default value is None.

Returns

JSON object

Return type

JSON

Raises

HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "createdBy": "str",  # Optional. The user that created the test run.
    "createdDateTime": "2020-02-20 00:00:00",  # Optional. The created
      DateTime(ISO 8601 literal format) of the test run.
    "description": "str",  # Optional. The test run description.
    "displayName": "str",  # Optional. Display name of a test run.
    "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.
    },
    "executedDateTime": "2020-02-20 00:00:00",  # Optional. Test run initiated
      time.
    "lastModifiedBy": "str",  # Optional. The user that updated the test run.
    "lastModifiedDateTime": "2020-02-20 00:00:00",  # Optional. The last updated
      DateTime(ISO 8601 literal format) of the test run.
    "loadTestConfig": {
        "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.
        "splitAllCSVs": bool  # Optional. Whether all the input CSV files
          should be split evenly across all engines.
    },
    "passFailCriteria": {
        "passFailMetrics": {
            "str": {
                "action": "str",  # Optional. Either "u2018stop"u2019
                  or "u2018continue"u2019 after the threshold is met. Default is
                  "u2018continue"u2019.
                "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.
                "clientmetric": "str",  # Optional. The client metric
                  on which the criteria should be applied. Allowed values -
                  "u2018response_time_ms"u2019 , "u2018latency"u2019,
                  "u2018error"u2019, "u2018requests"u2019,
                  "u2018requests_per_sec"u2019.
                "condition": "str",  # Optional. The comparison
                  operator. Supported types "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. possible outcome - "u2018passed"u2019 , "u2018failed"u2019 ,
                  "u2018undetermined"u2019.
                "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.
    "resourceId": "str",  # Optional. Load test resource Id.
    "secrets": {
        "str": {
            "type": "str",  # Optional. Type of secret. eg.
              AKV_SECRET_URI/SECRET_VALUE.
            "value": "str"  # Optional. The value of the secret, of type
              AKV_SECRET_URI or SECRET_VALUE.
        }
    },
    "startDateTime": "2020-02-20 00:00:00",  # Optional. The test run start
      DateTime(ISO 8601 literal format).
    "status": "str",  # Optional. The test run status.
    "subnetId": "str",  # Optional. Subnet ID on which the load test instances
      should run.
    "testArtifacts": {
        "inputArtifacts": {
            "additionalUrls": [
                {
                    "expireTime": "2020-02-20 00:00:00",  #
                      Optional. Expiry time of the file.
                    "fileId": "str",  # Optional. File unique
                      identifier.
                    "fileType": 0,  # Optional. Integer
                      representation of the file type (0 = JMX_FILE, 1 =
                      USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: 0,
                      1, and 2.
                    "filename": "str",  # Optional. Name of the
                      file.
                    "url": "str",  # Optional. File URL.
                    "validationStatus": "str"  # Optional.
                      Validation status of the file.
                }
            ],
            "configUrl": {
                "expireTime": "2020-02-20 00:00:00",  # Optional.
                  Expiry time of the file.
                "fileId": "str",  # Optional. File unique identifier.
                "fileType": 0,  # Optional. Integer representation of
                  the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 =
                  ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2.
                "filename": "str",  # Optional. Name of the file.
                "url": "str",  # Optional. File URL.
                "validationStatus": "str"  # Optional. Validation
                  status of the file.
            },
            "inputArtifactsZipFileurl": {
                "expireTime": "2020-02-20 00:00:00",  # Optional.
                  Expiry time of the file.
                "fileId": "str",  # Optional. File unique identifier.
                "fileType": 0,  # Optional. Integer representation of
                  the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 =
                  ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2.
                "filename": "str",  # Optional. Name of the file.
                "url": "str",  # Optional. File URL.
                "validationStatus": "str"  # Optional. Validation
                  status of the file.
            },
            "testScriptUrl": {
                "expireTime": "2020-02-20 00:00:00",  # Optional.
                  Expiry time of the file.
                "fileId": "str",  # Optional. File unique identifier.
                "fileType": 0,  # Optional. Integer representation of
                  the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 =
                  ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2.
                "filename": "str",  # Optional. Name of the file.
                "url": "str",  # Optional. File URL.
                "validationStatus": "str"  # Optional. Validation
                  status of the file.
            },
            "userPropUrl": {
                "expireTime": "2020-02-20 00:00:00",  # Optional.
                  Expiry time of the file.
                "fileId": "str",  # Optional. File unique identifier.
                "fileType": 0,  # Optional. Integer representation of
                  the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 =
                  ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2.
                "filename": "str",  # Optional. Name of the file.
                "url": "str",  # Optional. File URL.
                "validationStatus": "str"  # Optional. Validation
                  status of the file.
            }
        },
        "outputArtifacts": {
            "logsUrl": {
                "expireTime": "2020-02-20 00:00:00",  # Optional.
                  Expiry time of the file.
                "fileId": "str",  # Optional. File unique identifier.
                "fileType": 0,  # Optional. Integer representation of
                  the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 =
                  ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2.
                "filename": "str",  # Optional. Name of the file.
                "url": "str",  # Optional. File URL.
                "validationStatus": "str"  # Optional. Validation
                  status of the file.
            },
            "resultUrl": {
                "expireTime": "2020-02-20 00:00:00",  # Optional.
                  Expiry time of the file.
                "fileId": "str",  # Optional. File unique identifier.
                "fileType": 0,  # Optional. Integer representation of
                  the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 =
                  ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2.
                "filename": "str",  # Optional. Name of the file.
                "url": "str",  # Optional. File URL.
                "validationStatus": "str"  # Optional. Validation
                  status of the file.
            }
        }
    },
    "testId": "str",  # Optional. Associated test Id.
    "testResult": "str",  # Optional. Test result for pass/Fail criteria used
      during the test run. possible outcome - "u2018Passed"u2019 , "u2018Failed"u2019 ,
      "u2018Not Applicable"u2019.
    "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. Sent network bytes.
            "throughput": 0.0,  # Optional. Throughput.
            "transaction": "str"  # Optional. Transaction name.
        }
    },
    "vusers": 0  # Optional. Number of virtual users, for which test has been
      run.
}

async delete_test_run(test_run_id: str, **kwargs: Any) → None [source]¶

Delete a test run by its name.

Parameters: test_run_id (str) – Unique name of the load test run, must be a valid URL character ^[a-z0-9_-]*$. Required.
Returns: None
Return type: None
Raises: HttpResponseError –

async get_test_run(test_run_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶

Get test run details by name.

Parameters: test_run_id (str) – Unique name of load test run, must be a valid URL character ^[a-z0-9_-]*$. Required.
Returns: JSON object
Return type: JSON
Raises: HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "createdBy": "str",  # Optional. The user that created the test run.
    "createdDateTime": "2020-02-20 00:00:00",  # Optional. The created
      DateTime(ISO 8601 literal format) of the test run.
    "description": "str",  # Optional. The test run description.
    "displayName": "str",  # Optional. Display name of a test run.
    "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.
    },
    "executedDateTime": "2020-02-20 00:00:00",  # Optional. Test run initiated
      time.
    "lastModifiedBy": "str",  # Optional. The user that updated the test run.
    "lastModifiedDateTime": "2020-02-20 00:00:00",  # Optional. The last updated
      DateTime(ISO 8601 literal format) of the test run.
    "loadTestConfig": {
        "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.
        "splitAllCSVs": bool  # Optional. Whether all the input CSV files
          should be split evenly across all engines.
    },
    "passFailCriteria": {
        "passFailMetrics": {
            "str": {
                "action": "str",  # Optional. Either "u2018stop"u2019
                  or "u2018continue"u2019 after the threshold is met. Default is
                  "u2018continue"u2019.
                "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.
                "clientmetric": "str",  # Optional. The client metric
                  on which the criteria should be applied. Allowed values -
                  "u2018response_time_ms"u2019 , "u2018latency"u2019,
                  "u2018error"u2019, "u2018requests"u2019,
                  "u2018requests_per_sec"u2019.
                "condition": "str",  # Optional. The comparison
                  operator. Supported types "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. possible outcome - "u2018passed"u2019 , "u2018failed"u2019 ,
                  "u2018undetermined"u2019.
                "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.
    "resourceId": "str",  # Optional. Load test resource Id.
    "secrets": {
        "str": {
            "type": "str",  # Optional. Type of secret. eg.
              AKV_SECRET_URI/SECRET_VALUE.
            "value": "str"  # Optional. The value of the secret, of type
              AKV_SECRET_URI or SECRET_VALUE.
        }
    },
    "startDateTime": "2020-02-20 00:00:00",  # Optional. The test run start
      DateTime(ISO 8601 literal format).
    "status": "str",  # Optional. The test run status.
    "subnetId": "str",  # Optional. Subnet ID on which the load test instances
      should run.
    "testArtifacts": {
        "inputArtifacts": {
            "additionalUrls": [
                {
                    "expireTime": "2020-02-20 00:00:00",  #
                      Optional. Expiry time of the file.
                    "fileId": "str",  # Optional. File unique
                      identifier.
                    "fileType": 0,  # Optional. Integer
                      representation of the file type (0 = JMX_FILE, 1 =
                      USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: 0,
                      1, and 2.
                    "filename": "str",  # Optional. Name of the
                      file.
                    "url": "str",  # Optional. File URL.
                    "validationStatus": "str"  # Optional.
                      Validation status of the file.
                }
            ],
            "configUrl": {
                "expireTime": "2020-02-20 00:00:00",  # Optional.
                  Expiry time of the file.
                "fileId": "str",  # Optional. File unique identifier.
                "fileType": 0,  # Optional. Integer representation of
                  the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 =
                  ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2.
                "filename": "str",  # Optional. Name of the file.
                "url": "str",  # Optional. File URL.
                "validationStatus": "str"  # Optional. Validation
                  status of the file.
            },
            "inputArtifactsZipFileurl": {
                "expireTime": "2020-02-20 00:00:00",  # Optional.
                  Expiry time of the file.
                "fileId": "str",  # Optional. File unique identifier.
                "fileType": 0,  # Optional. Integer representation of
                  the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 =
                  ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2.
                "filename": "str",  # Optional. Name of the file.
                "url": "str",  # Optional. File URL.
                "validationStatus": "str"  # Optional. Validation
                  status of the file.
            },
            "testScriptUrl": {
                "expireTime": "2020-02-20 00:00:00",  # Optional.
                  Expiry time of the file.
                "fileId": "str",  # Optional. File unique identifier.
                "fileType": 0,  # Optional. Integer representation of
                  the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 =
                  ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2.
                "filename": "str",  # Optional. Name of the file.
                "url": "str",  # Optional. File URL.
                "validationStatus": "str"  # Optional. Validation
                  status of the file.
            },
            "userPropUrl": {
                "expireTime": "2020-02-20 00:00:00",  # Optional.
                  Expiry time of the file.
                "fileId": "str",  # Optional. File unique identifier.
                "fileType": 0,  # Optional. Integer representation of
                  the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 =
                  ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2.
                "filename": "str",  # Optional. Name of the file.
                "url": "str",  # Optional. File URL.
                "validationStatus": "str"  # Optional. Validation
                  status of the file.
            }
        },
        "outputArtifacts": {
            "logsUrl": {
                "expireTime": "2020-02-20 00:00:00",  # Optional.
                  Expiry time of the file.
                "fileId": "str",  # Optional. File unique identifier.
                "fileType": 0,  # Optional. Integer representation of
                  the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 =
                  ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2.
                "filename": "str",  # Optional. Name of the file.
                "url": "str",  # Optional. File URL.
                "validationStatus": "str"  # Optional. Validation
                  status of the file.
            },
            "resultUrl": {
                "expireTime": "2020-02-20 00:00:00",  # Optional.
                  Expiry time of the file.
                "fileId": "str",  # Optional. File unique identifier.
                "fileType": 0,  # Optional. Integer representation of
                  the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 =
                  ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2.
                "filename": "str",  # Optional. Name of the file.
                "url": "str",  # Optional. File URL.
                "validationStatus": "str"  # Optional. Validation
                  status of the file.
            }
        }
    },
    "testId": "str",  # Optional. Associated test Id.
    "testResult": "str",  # Optional. Test result for pass/Fail criteria used
      during the test run. possible outcome - "u2018Passed"u2019 , "u2018Failed"u2019 ,
      "u2018Not Applicable"u2019.
    "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. Sent network bytes.
            "throughput": 0.0,  # Optional. Throughput.
            "transaction": "str"  # Optional. Transaction name.
        }
    },
    "vusers": 0  # Optional. Number of virtual users, for which test has been
      run.
}

async get_test_run_client_metrics(test_run_id: str, body: JSON, *, content_type: str = "'application/json'", **kwargs: Any) → JSON[source]¶

async get_test_run_client_metrics(test_run_id: str, body: IO, *, content_type: str = "'application/json'", **kwargs: Any) → JSON

Get all client metrics for a load test run.

Parameters

test_run_id (str) – Unique name of the load test run, must be a valid URL character ^[a-z0-9_-]*$. Required.
body (JSON or IO) – Client metrics request model. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

Returns

JSON object

Return type

JSON

Raises

HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "testRunId": "str",  # Optional. Test run name for which client metrics
      results is required.
    "timeSeries": {
        "activeUsers": {
            "str": [
                {
                    "timestamp": "2020-02-20 00:00:00",  #
                      Optional. Timestamp(ISO 8601 literal format).
                    "value": 0.0  # Optional. Value at timestamp.
                }
            ]
        },
        "errors": {
            "str": [
                {
                    "timestamp": "2020-02-20 00:00:00",  #
                      Optional. Timestamp(ISO 8601 literal format).
                    "value": 0.0  # Optional. Value at timestamp.
                }
            ]
        },
        "responseTime": {
            "str": [
                {
                    "timestamp": "2020-02-20 00:00:00",  #
                      Optional. Timestamp(ISO 8601 literal format).
                    "value": 0.0  # Optional. Value at timestamp.
                }
            ]
        },
        "throughput": {
            "str": [
                {
                    "timestamp": "2020-02-20 00:00:00",  #
                      Optional. Timestamp(ISO 8601 literal format).
                    "value": 0.0  # Optional. Value at timestamp.
                }
            ]
        }
    }
}

async get_test_run_client_metrics_filters(test_run_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶

Get all filters that are supported for client metrics for a given load test run.

Parameters: test_run_id (str) – Unique name for load test run, must be a valid URL character ^[a-z0-9_-]*$. Required.
Returns: JSON object
Return type: JSON
Raises: HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "filters": {
        "errorFiltersValues": [
            "str"  # Optional. List of errors occurred for the test run,
              for which client metrics can be filtered.
        ],
        "requestSamplerValues": [
            "str"  # Optional. List of request sampler for the test run,
              for which client metrics can be filtered.
        ]
    },
    "testRunId": "str",  # Optional. Test run name for which client metrics
      filters is required.
    "timeRange": {
        "endTime": "2020-02-20 00:00:00",  # Optional. end DateTime(ISO 8601
          literal format) for the requested client metrics filter.
        "startTime": "2020-02-20 00:00:00"  # Optional. start DateTime(ISO
          8601 literal format) for the requested client metrics filter.
    }
}

async get_test_run_file(test_run_id: str, file_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶

Get test run file by file name.

Parameters

test_run_id (str) – Unique name of load test run, must be a valid URL character ^[a-z0-9_-]*$. Required.
file_id (str) – Unique identifier for test run file, must be a valid URL character ^[a-z0-9_-]*$. Required.

Returns

JSON object

Return type

JSON

Raises

HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "expireTime": "2020-02-20 00:00:00",  # Optional. Expiry time of the file.
    "fileId": "str",  # Optional. File unique identifier.
    "fileType": 0,  # Optional. Integer representation of the file type (0 =
      JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: 0, 1,
      and 2.
    "filename": "str",  # Optional. Name of the file.
    "url": "str",  # Optional. File URL.
    "validationStatus": "str"  # Optional. Validation status of the file.
}

async list_test_runs(*, order_by: Optional[str] = None, continuation_token_parameter: Optional[str] = None, search: Optional[str] = None, execution_from: Optional[datetime.datetime] = None, execution_to: Optional[datetime.datetime] = None, status: Optional[str] = None, max_page_size: int = 50, test_id: Optional[str] = None, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶

Get all test runs with given filters.

Keyword Arguments

order_by (str) – Sort on one of the field - status, displayName, executedDateTime in (field asc/desc) format. eg: displayName asc. Default value is None.
continuation_token_parameter (str) – Continuation token to get the next page of response. Default value is None.
search (str) – Filter search based on searchable fields - description, executedUser. Default value is None.
execution_from (datetime) – The end DateTime(ISO 8601 literal format) of test-run execution time filter range. Default value is None.
execution_to (datetime) – The start DateTime(ISO 8601 literal format) of test-run execution time filter range. Default value is None.
status – Comma separated list of test run status, value can be - “ACCEPTED”, “NOTSTARTED”,”PROVISIONING”,”PROVISIONED”,”CONFIGURING”,

“CONFIGURED”,”EXECUTING”,”EXECUTED”,”DEPROVISIONING”,”DEPROVISIONED”,”DONE”,”CANCELLED”,”FAILED”.: Default value is None.

Keyword Arguments

max_page_size (int) – Number of results in response. Default value is 50.
test_id (str) – Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. Default value is None.

Returns

JSON object

Return type

JSON

Raises

HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "value": [
        {
            "createdBy": "str",  # Optional. The user that created the
              test run.
            "createdDateTime": "2020-02-20 00:00:00",  # Optional. The
              created DateTime(ISO 8601 literal format) of the test run.
            "description": "str",  # Optional. The test run description.
            "displayName": "str",  # Optional. Display name of a test
              run.
            "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.
            },
            "executedDateTime": "2020-02-20 00:00:00",  # Optional. Test
              run initiated time.
            "lastModifiedBy": "str",  # Optional. The user that updated
              the test run.
            "lastModifiedDateTime": "2020-02-20 00:00:00",  # Optional.
              The last updated  DateTime(ISO 8601 literal format) of the test run.
            "loadTestConfig": {
                "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.
                "splitAllCSVs": bool  # Optional. Whether all the
                  input CSV files should be split evenly across all engines.
            },
            "passFailCriteria": {
                "passFailMetrics": {
                    "str": {
                        "action": "str",  # Optional. Either
                          "u2018stop"u2019 or "u2018continue"u2019 after the threshold
                          is met. Default is "u2018continue"u2019.
                        "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.
                        "clientmetric": "str",  # Optional.
                          The client metric on which the criteria should be applied.
                          Allowed values - "u2018response_time_ms"u2019 ,
                          "u2018latency"u2019, "u2018error"u2019, "u2018requests"u2019,
                          "u2018requests_per_sec"u2019.
                        "condition": "str",  # Optional. The
                          comparison operator. Supported types "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. possible outcome - "u2018passed"u2019 ,
                          "u2018failed"u2019 , "u2018undetermined"u2019.
                        "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.
            "resourceId": "str",  # Optional. Load test resource Id.
            "secrets": {
                "str": {
                    "type": "str",  # Optional. Type of secret.
                      eg. AKV_SECRET_URI/SECRET_VALUE.
                    "value": "str"  # Optional. The value of the
                      secret, of type AKV_SECRET_URI or SECRET_VALUE.
                }
            },
            "startDateTime": "2020-02-20 00:00:00",  # Optional. The test
              run start DateTime(ISO 8601 literal format).
            "status": "str",  # Optional. The test run status.
            "subnetId": "str",  # Optional. Subnet ID on which the load
              test instances should run.
            "testArtifacts": {
                "inputArtifacts": {
                    "additionalUrls": [
                        {
                            "expireTime": "2020-02-20
                              00:00:00",  # Optional. Expiry time of the file.
                            "fileId": "str",  # Optional.
                              File unique identifier.
                            "fileType": 0,  # Optional.
                              Integer representation of the file type (0 = JMX_FILE, 1
                              = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known
                              values are: 0, 1, and 2.
                            "filename": "str",  #
                              Optional. Name of the file.
                            "url": "str",  # Optional.
                              File URL.
                            "validationStatus": "str"  #
                              Optional. Validation status of the file.
                        }
                    ],
                    "configUrl": {
                        "expireTime": "2020-02-20 00:00:00",
                          # Optional. Expiry time of the file.
                        "fileId": "str",  # Optional. File
                          unique identifier.
                        "fileType": 0,  # Optional. Integer
                          representation of the file type (0 = JMX_FILE, 1 =
                          USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are:
                          0, 1, and 2.
                        "filename": "str",  # Optional. Name
                          of the file.
                        "url": "str",  # Optional. File URL.
                        "validationStatus": "str"  #
                          Optional. Validation status of the file.
                    },
                    "inputArtifactsZipFileurl": {
                        "expireTime": "2020-02-20 00:00:00",
                          # Optional. Expiry time of the file.
                        "fileId": "str",  # Optional. File
                          unique identifier.
                        "fileType": 0,  # Optional. Integer
                          representation of the file type (0 = JMX_FILE, 1 =
                          USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are:
                          0, 1, and 2.
                        "filename": "str",  # Optional. Name
                          of the file.
                        "url": "str",  # Optional. File URL.
                        "validationStatus": "str"  #
                          Optional. Validation status of the file.
                    },
                    "testScriptUrl": {
                        "expireTime": "2020-02-20 00:00:00",
                          # Optional. Expiry time of the file.
                        "fileId": "str",  # Optional. File
                          unique identifier.
                        "fileType": 0,  # Optional. Integer
                          representation of the file type (0 = JMX_FILE, 1 =
                          USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are:
                          0, 1, and 2.
                        "filename": "str",  # Optional. Name
                          of the file.
                        "url": "str",  # Optional. File URL.
                        "validationStatus": "str"  #
                          Optional. Validation status of the file.
                    },
                    "userPropUrl": {
                        "expireTime": "2020-02-20 00:00:00",
                          # Optional. Expiry time of the file.
                        "fileId": "str",  # Optional. File
                          unique identifier.
                        "fileType": 0,  # Optional. Integer
                          representation of the file type (0 = JMX_FILE, 1 =
                          USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are:
                          0, 1, and 2.
                        "filename": "str",  # Optional. Name
                          of the file.
                        "url": "str",  # Optional. File URL.
                        "validationStatus": "str"  #
                          Optional. Validation status of the file.
                    }
                },
                "outputArtifacts": {
                    "logsUrl": {
                        "expireTime": "2020-02-20 00:00:00",
                          # Optional. Expiry time of the file.
                        "fileId": "str",  # Optional. File
                          unique identifier.
                        "fileType": 0,  # Optional. Integer
                          representation of the file type (0 = JMX_FILE, 1 =
                          USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are:
                          0, 1, and 2.
                        "filename": "str",  # Optional. Name
                          of the file.
                        "url": "str",  # Optional. File URL.
                        "validationStatus": "str"  #
                          Optional. Validation status of the file.
                    },
                    "resultUrl": {
                        "expireTime": "2020-02-20 00:00:00",
                          # Optional. Expiry time of the file.
                        "fileId": "str",  # Optional. File
                          unique identifier.
                        "fileType": 0,  # Optional. Integer
                          representation of the file type (0 = JMX_FILE, 1 =
                          USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are:
                          0, 1, and 2.
                        "filename": "str",  # Optional. Name
                          of the file.
                        "url": "str",  # Optional. File URL.
                        "validationStatus": "str"  #
                          Optional. Validation status of the file.
                    }
                }
            },
            "testId": "str",  # Optional. Associated test Id.
            "testResult": "str",  # Optional. Test result for pass/Fail
              criteria used during the test run. possible outcome - "u2018Passed"u2019
              , "u2018Failed"u2019 , "u2018Not Applicable"u2019.
            "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. Sent
                      network bytes.
                    "throughput": 0.0,  # Optional. Throughput.
                    "transaction": "str"  # Optional. Transaction
                      name.
                }
            },
            "vusers": 0  # Optional. Number of virtual users, for which
              test has been run.
        }
    ],
    "nextLink": "str"  # Optional. Link for the next list of resources in case of
      paginated results, if applicable.
}

async stop_test_run(test_run_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶

Stop test run by name.

Parameters: test_run_id (str) – Unique name of the load test run, must be a valid URL character ^[a-z0-9_-]*$. Required.
Returns: JSON object
Return type: JSON
Raises: HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "createdBy": "str",  # Optional. The user that created the test run.
    "createdDateTime": "2020-02-20 00:00:00",  # Optional. The created
      DateTime(ISO 8601 literal format) of the test run.
    "description": "str",  # Optional. The test run description.
    "displayName": "str",  # Optional. Display name of a test run.
    "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.
    },
    "executedDateTime": "2020-02-20 00:00:00",  # Optional. Test run initiated
      time.
    "lastModifiedBy": "str",  # Optional. The user that updated the test run.
    "lastModifiedDateTime": "2020-02-20 00:00:00",  # Optional. The last updated
      DateTime(ISO 8601 literal format) of the test run.
    "loadTestConfig": {
        "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.
        "splitAllCSVs": bool  # Optional. Whether all the input CSV files
          should be split evenly across all engines.
    },
    "passFailCriteria": {
        "passFailMetrics": {
            "str": {
                "action": "str",  # Optional. Either "u2018stop"u2019
                  or "u2018continue"u2019 after the threshold is met. Default is
                  "u2018continue"u2019.
                "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.
                "clientmetric": "str",  # Optional. The client metric
                  on which the criteria should be applied. Allowed values -
                  "u2018response_time_ms"u2019 , "u2018latency"u2019,
                  "u2018error"u2019, "u2018requests"u2019,
                  "u2018requests_per_sec"u2019.
                "condition": "str",  # Optional. The comparison
                  operator. Supported types "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. possible outcome - "u2018passed"u2019 , "u2018failed"u2019 ,
                  "u2018undetermined"u2019.
                "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.
    "resourceId": "str",  # Optional. Load test resource Id.
    "secrets": {
        "str": {
            "type": "str",  # Optional. Type of secret. eg.
              AKV_SECRET_URI/SECRET_VALUE.
            "value": "str"  # Optional. The value of the secret, of type
              AKV_SECRET_URI or SECRET_VALUE.
        }
    },
    "startDateTime": "2020-02-20 00:00:00",  # Optional. The test run start
      DateTime(ISO 8601 literal format).
    "status": "str",  # Optional. The test run status.
    "subnetId": "str",  # Optional. Subnet ID on which the load test instances
      should run.
    "testArtifacts": {
        "inputArtifacts": {
            "additionalUrls": [
                {
                    "expireTime": "2020-02-20 00:00:00",  #
                      Optional. Expiry time of the file.
                    "fileId": "str",  # Optional. File unique
                      identifier.
                    "fileType": 0,  # Optional. Integer
                      representation of the file type (0 = JMX_FILE, 1 =
                      USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: 0,
                      1, and 2.
                    "filename": "str",  # Optional. Name of the
                      file.
                    "url": "str",  # Optional. File URL.
                    "validationStatus": "str"  # Optional.
                      Validation status of the file.
                }
            ],
            "configUrl": {
                "expireTime": "2020-02-20 00:00:00",  # Optional.
                  Expiry time of the file.
                "fileId": "str",  # Optional. File unique identifier.
                "fileType": 0,  # Optional. Integer representation of
                  the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 =
                  ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2.
                "filename": "str",  # Optional. Name of the file.
                "url": "str",  # Optional. File URL.
                "validationStatus": "str"  # Optional. Validation
                  status of the file.
            },
            "inputArtifactsZipFileurl": {
                "expireTime": "2020-02-20 00:00:00",  # Optional.
                  Expiry time of the file.
                "fileId": "str",  # Optional. File unique identifier.
                "fileType": 0,  # Optional. Integer representation of
                  the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 =
                  ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2.
                "filename": "str",  # Optional. Name of the file.
                "url": "str",  # Optional. File URL.
                "validationStatus": "str"  # Optional. Validation
                  status of the file.
            },
            "testScriptUrl": {
                "expireTime": "2020-02-20 00:00:00",  # Optional.
                  Expiry time of the file.
                "fileId": "str",  # Optional. File unique identifier.
                "fileType": 0,  # Optional. Integer representation of
                  the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 =
                  ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2.
                "filename": "str",  # Optional. Name of the file.
                "url": "str",  # Optional. File URL.
                "validationStatus": "str"  # Optional. Validation
                  status of the file.
            },
            "userPropUrl": {
                "expireTime": "2020-02-20 00:00:00",  # Optional.
                  Expiry time of the file.
                "fileId": "str",  # Optional. File unique identifier.
                "fileType": 0,  # Optional. Integer representation of
                  the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 =
                  ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2.
                "filename": "str",  # Optional. Name of the file.
                "url": "str",  # Optional. File URL.
                "validationStatus": "str"  # Optional. Validation
                  status of the file.
            }
        },
        "outputArtifacts": {
            "logsUrl": {
                "expireTime": "2020-02-20 00:00:00",  # Optional.
                  Expiry time of the file.
                "fileId": "str",  # Optional. File unique identifier.
                "fileType": 0,  # Optional. Integer representation of
                  the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 =
                  ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2.
                "filename": "str",  # Optional. Name of the file.
                "url": "str",  # Optional. File URL.
                "validationStatus": "str"  # Optional. Validation
                  status of the file.
            },
            "resultUrl": {
                "expireTime": "2020-02-20 00:00:00",  # Optional.
                  Expiry time of the file.
                "fileId": "str",  # Optional. File unique identifier.
                "fileType": 0,  # Optional. Integer representation of
                  the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 =
                  ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2.
                "filename": "str",  # Optional. Name of the file.
                "url": "str",  # Optional. File URL.
                "validationStatus": "str"  # Optional. Validation
                  status of the file.
            }
        }
    },
    "testId": "str",  # Optional. Associated test Id.
    "testResult": "str",  # Optional. Test result for pass/Fail criteria used
      during the test run. possible outcome - "u2018Passed"u2019 , "u2018Failed"u2019 ,
      "u2018Not Applicable"u2019.
    "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. Sent network bytes.
            "throughput": 0.0,  # Optional. Throughput.
            "transaction": "str"  # Optional. Transaction name.
        }
    },
    "vusers": 0  # Optional. Number of virtual users, for which test has been
      run.
}