LoadTestAdministrationClient Class

These APIs allow end users to do various administrative operations on Azure Load Test Service.

Constructor

LoadTestAdministrationClient(endpoint: str, credential: TokenCredential, **kwargs: Any)

Parameters

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

Keyword-Only Parameters

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

Methods

begin_upload_test_file	Upload file to the test
close
create_or_update_app_components	Associate an app component (collection of azure resources) to a test. Associate an app component (collection of azure resources) to a test.
create_or_update_server_metrics_config	Configure server metrics for a test. Configure server metrics for a test.
create_or_update_test	Create a new test or update an existing test. Create a new test or update an existing test.
delete_test	Delete a test by its name. Delete a test by its name.
delete_test_file	Delete file by the file name for a test. Delete file by the file name for a test.
get_app_components	Get associated app component (collection of azure resources) for the given test. Get associated app component (collection of azure resources) for the given test.
get_server_metrics_config	List server metrics configuration for the given test. List server metrics configuration for the given test.
get_test	Get load test details by test name. Get load test details by test name.
get_test_file	Get test file by the file name. Get test file by the file name.
list_test_files	Get all test files. Get all test files.
list_tests	Get all load tests by the fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. Get all load tests by the fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}.
send_request	Runs the network request through the client's chained policies. `>>> from azure.core.rest import HttpRequest >>> request = HttpRequest("GET", "https://www.example.org/") <HttpRequest [GET], url: 'https://www.example.org/'> >>> response = client.send_request(request) <HttpResponse: 200 OK>` For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request

begin_upload_test_file

Upload file to the test

begin_upload_test_file(test_id: str, file_name: str, body: IO, *, file_type: str | None = None, **kwargs: Any) -> LROPoller[MutableMapping[str, Any]]

Parameters

Name	Description
test_id Required	str Unique id for the test
file_name Required	str Name of the file to be uploaded
body Required	IO File content to be uploaded
file_type Required	str Type of the file to be uploaded

Keyword-Only Parameters

Name	Description
file_type	Default value: None

Returns

Type	Description
<xref:azure.developer.loadtesting._polling.LoadTestingLROPoller>	An instance of LROPoller object to check the validation status of file

Exceptions

Type	Description
HttpResponseError
ResourceNotFoundError

close

close() -> None

create_or_update_app_components

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

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

Parameters

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

Keyword-Only Parameters

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

Returns

Type	Description
<xref:JSON>	JSON object

Exceptions

Type	Description
HttpResponseError

Examples


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

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

create_or_update_server_metrics_config

Configure server metrics for a test.

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

Parameters

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

Keyword-Only Parameters

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

Returns

Type	Description
<xref:JSON>	JSON object

Exceptions

Type	Description
HttpResponseError

Examples


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

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

create_or_update_test

Create a new test or update an existing test.

create_or_update_test(test_id: str, body: MutableMapping[str, Any] | IO, **kwargs: Any) -> MutableMapping[str, Any]

Parameters

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

Keyword-Only Parameters

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

Returns

Type	Description
<xref:JSON>	JSON object

Exceptions

Type	Description
HttpResponseError

Examples


   # JSON input template you can fill out and use as your body input.
   body = {
       "certificate": {
           "name": "str",  # Optional. Name of the certificate.
           "type": "str",  # Optional. Type of certificate. "AKV_CERT_URI"
           "value": "str"  # Optional. The value of the certificate for
             respective type.
       },
       "createdBy": "str",  # Optional. The user that created.
       "createdDateTime": "2020-02-20 00:00:00",  # Optional. The creation
         datetime(ISO 8601 literal format).
       "description": "str",  # Optional. The test 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": {
           "additionalFileInfo": [
               {
                   "expireDateTime": "2020-02-20 00:00:00",  # Optional.
                     Expiry time of the file (ISO 8601 literal format).
                   "fileName": "str",  # Optional. Name of the file.
                   "fileType": "str",  # Optional. File type. Known
                     values are: "JMX_FILE", "USER_PROPERTIES", and
                     "ADDITIONAL_ARTIFACTS".
                   "url": "str",  # Optional. File URL.
                   "validationFailureDetails": "str",  # Optional.
                     Validation failure error details.
                   "validationStatus": "str"  # Optional. Validation
                     status of the file. Known values are: "NOT_VALIDATED",
                     "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED",
                     and "VALIDATION_NOT_REQUIRED".
               }
           ],
           "configFileInfo": {
               "expireDateTime": "2020-02-20 00:00:00",  # Optional. Expiry
                 time of the file (ISO 8601 literal format).
               "fileName": "str",  # Optional. Name of the file.
               "fileType": "str",  # Optional. File type. Known values are:
                 "JMX_FILE", "USER_PROPERTIES", and "ADDITIONAL_ARTIFACTS".
               "url": "str",  # Optional. File URL.
               "validationFailureDetails": "str",  # Optional. Validation
                 failure error details.
               "validationStatus": "str"  # Optional. Validation status of
                 the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS",
                 "VALIDATION_FAILURE", "VALIDATION_INITIATED", and
                 "VALIDATION_NOT_REQUIRED".
           },
           "inputArtifactsZipFileInfo": {
               "expireDateTime": "2020-02-20 00:00:00",  # Optional. Expiry
                 time of the file (ISO 8601 literal format).
               "fileName": "str",  # Optional. Name of the file.
               "fileType": "str",  # Optional. File type. Known values are:
                 "JMX_FILE", "USER_PROPERTIES", and "ADDITIONAL_ARTIFACTS".
               "url": "str",  # Optional. File URL.
               "validationFailureDetails": "str",  # Optional. Validation
                 failure error details.
               "validationStatus": "str"  # Optional. Validation status of
                 the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS",
                 "VALIDATION_FAILURE", "VALIDATION_INITIATED", and
                 "VALIDATION_NOT_REQUIRED".
           },
           "testScriptFileInfo": {
               "expireDateTime": "2020-02-20 00:00:00",  # Optional. Expiry
                 time of the file (ISO 8601 literal format).
               "fileName": "str",  # Optional. Name of the file.
               "fileType": "str",  # Optional. File type. Known values are:
                 "JMX_FILE", "USER_PROPERTIES", and "ADDITIONAL_ARTIFACTS".
               "url": "str",  # Optional. File URL.
               "validationFailureDetails": "str",  # Optional. Validation
                 failure error details.
               "validationStatus": "str"  # Optional. Validation status of
                 the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS",
                 "VALIDATION_FAILURE", "VALIDATION_INITIATED", and
                 "VALIDATION_NOT_REQUIRED".
           },
           "userPropFileInfo": {
               "expireDateTime": "2020-02-20 00:00:00",  # Optional. Expiry
                 time of the file (ISO 8601 literal format).
               "fileName": "str",  # Optional. Name of the file.
               "fileType": "str",  # Optional. File type. Known values are:
                 "JMX_FILE", "USER_PROPERTIES", and "ADDITIONAL_ARTIFACTS".
               "url": "str",  # Optional. File URL.
               "validationFailureDetails": "str",  # Optional. Validation
                 failure error details.
               "validationStatus": "str"  # Optional. Validation status of
                 the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS",
                 "VALIDATION_FAILURE", "VALIDATION_INITIATED", and
                 "VALIDATION_NOT_REQUIRED".
           }
       },
       "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.
       "lastModifiedDateTime": "2020-02-20 00:00:00",  # Optional. The last Modified
         datetime(ISO 8601 literal format).
       "loadTestConfiguration": {
           "engineInstances": 0,  # Optional. The number of engine instances to
             execute load test. Supported values are in range of 1-45. Required for
             creating a new test.
           "optionalLoadTestConfig": {
               "duration": 0,  # Optional. Test run duration.
               "endpointUrl": "str",  # Optional. Test URL. Provide the
                 complete HTTP URL. For example,
                 http://contoso-app.azurewebsites.net/login.
               "rampUpTime": 0,  # Optional. Ramp up time.
               "virtualUsers": 0  # Optional. No of concurrent virtual
                 users.
           },
           "quickStartTest": False,  # Optional. Default value is False. If
             true, optionalLoadTestConfig is required and JMX script for the load test is
             not required to upload.
           "splitAllCSVs": False  # Optional. Default value is False. If false,
             Azure Load Testing copies and processes your input files unmodified across
             all test engine instances. If true, Azure Load Testing splits the CSV input
             data evenly across all engine instances. If you provide multiple CSV files,
             each file will be split evenly.
       },
       "passFailCriteria": {
           "passFailMetrics": {
               "str": {
                   "action": "continue",  # Optional. Default value is
                     "continue". Action taken after the threshold is met. Default is
                     "u2018continue"u2019. Known values are: "continue" and "stop".
                   "actualValue": 0.0,  # Optional. The actual value of
                     the client metric for the test run.
                   "aggregate": "str",  # Optional. The aggregation
                     function to be applied on the client metric. Allowed functions -
                     "u2018percentage"u2019 - for error metric , "u2018avg"u2019,
                     "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019,
                     "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency
                     metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 -
                     for requests. Known values are: "count", "percentage", "avg", "p50",
                     "p90", "p95", "p99", "min", and "max".
                   "clientMetric": "str",  # Optional. The client metric
                     on which the criteria should be applied. Known values are:
                     "response_time_ms", "latency", "error", "requests", and
                     "requests_per_sec".
                   "condition": "str",  # Optional. The comparison
                     operator. Supported types "u2018>"u2019, "u2018<"u2019.
                   "requestName": "str",  # Optional. Request name for
                     which the Pass fail criteria has to be applied.
                   "result": "str",  # Optional. Outcome of the test
                     run. Known values are: "passed", "undetermined", and "failed".
                   "value": 0.0  # Optional. The value to compare with
                     the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit-
                     % "u2019, response_time_ms and latency : any integer value unit- ms.
               }
           }
       },
       "secrets": {
           "str": {
               "type": "str",  # Optional. Type of secret. Known values are:
                 "AKV_SECRET_URI" and "SECRET_VALUE".
               "value": "str"  # Optional. The value of the secret for the
                 respective type.
           }
       },
       "subnetId": "str",  # Optional. Subnet ID on which the load test instances
         should run.
       "testId": "str"  # Optional. Unique test name as identifier.
   }

   # response body for status code(s): 200, 201
   response == {
       "certificate": {
           "name": "str",  # Optional. Name of the certificate.
           "type": "str",  # Optional. Type of certificate. "AKV_CERT_URI"
           "value": "str"  # Optional. The value of the certificate for
             respective type.
       },
       "createdBy": "str",  # Optional. The user that created.
       "createdDateTime": "2020-02-20 00:00:00",  # Optional. The creation
         datetime(ISO 8601 literal format).
       "description": "str",  # Optional. The test 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": {
           "additionalFileInfo": [
               {
                   "expireDateTime": "2020-02-20 00:00:00",  # Optional.
                     Expiry time of the file (ISO 8601 literal format).
                   "fileName": "str",  # Optional. Name of the file.
                   "fileType": "str",  # Optional. File type. Known
                     values are: "JMX_FILE", "USER_PROPERTIES", and
                     "ADDITIONAL_ARTIFACTS".
                   "url": "str",  # Optional. File URL.
                   "validationFailureDetails": "str",  # Optional.
                     Validation failure error details.
                   "validationStatus": "str"  # Optional. Validation
                     status of the file. Known values are: "NOT_VALIDATED",
                     "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED",
                     and "VALIDATION_NOT_REQUIRED".
               }
           ],
           "configFileInfo": {
               "expireDateTime": "2020-02-20 00:00:00",  # Optional. Expiry
                 time of the file (ISO 8601 literal format).
               "fileName": "str",  # Optional. Name of the file.
               "fileType": "str",  # Optional. File type. Known values are:
                 "JMX_FILE", "USER_PROPERTIES", and "ADDITIONAL_ARTIFACTS".
               "url": "str",  # Optional. File URL.
               "validationFailureDetails": "str",  # Optional. Validation
                 failure error details.
               "validationStatus": "str"  # Optional. Validation status of
                 the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS",
                 "VALIDATION_FAILURE", "VALIDATION_INITIATED", and
                 "VALIDATION_NOT_REQUIRED".
           },
           "inputArtifactsZipFileInfo": {
               "expireDateTime": "2020-02-20 00:00:00",  # Optional. Expiry
                 time of the file (ISO 8601 literal format).
               "fileName": "str",  # Optional. Name of the file.
               "fileType": "str",  # Optional. File type. Known values are:
                 "JMX_FILE", "USER_PROPERTIES", and "ADDITIONAL_ARTIFACTS".
               "url": "str",  # Optional. File URL.
               "validationFailureDetails": "str",  # Optional. Validation
                 failure error details.
               "validationStatus": "str"  # Optional. Validation status of
                 the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS",
                 "VALIDATION_FAILURE", "VALIDATION_INITIATED", and
                 "VALIDATION_NOT_REQUIRED".
           },
           "testScriptFileInfo": {
               "expireDateTime": "2020-02-20 00:00:00",  # Optional. Expiry
                 time of the file (ISO 8601 literal format).
               "fileName": "str",  # Optional. Name of the file.
               "fileType": "str",  # Optional. File type. Known values are:
                 "JMX_FILE", "USER_PROPERTIES", and "ADDITIONAL_ARTIFACTS".
               "url": "str",  # Optional. File URL.
               "validationFailureDetails": "str",  # Optional. Validation
                 failure error details.
               "validationStatus": "str"  # Optional. Validation status of
                 the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS",
                 "VALIDATION_FAILURE", "VALIDATION_INITIATED", and
                 "VALIDATION_NOT_REQUIRED".
           },
           "userPropFileInfo": {
               "expireDateTime": "2020-02-20 00:00:00",  # Optional. Expiry
                 time of the file (ISO 8601 literal format).
               "fileName": "str",  # Optional. Name of the file.
               "fileType": "str",  # Optional. File type. Known values are:
                 "JMX_FILE", "USER_PROPERTIES", and "ADDITIONAL_ARTIFACTS".
               "url": "str",  # Optional. File URL.
               "validationFailureDetails": "str",  # Optional. Validation
                 failure error details.
               "validationStatus": "str"  # Optional. Validation status of
                 the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS",
                 "VALIDATION_FAILURE", "VALIDATION_INITIATED", and
                 "VALIDATION_NOT_REQUIRED".
           }
       },
       "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.
       "lastModifiedDateTime": "2020-02-20 00:00:00",  # Optional. The last Modified
         datetime(ISO 8601 literal format).
       "loadTestConfiguration": {
           "engineInstances": 0,  # Optional. The number of engine instances to
             execute load test. Supported values are in range of 1-45. Required for
             creating a new test.
           "optionalLoadTestConfig": {
               "duration": 0,  # Optional. Test run duration.
               "endpointUrl": "str",  # Optional. Test URL. Provide the
                 complete HTTP URL. For example,
                 http://contoso-app.azurewebsites.net/login.
               "rampUpTime": 0,  # Optional. Ramp up time.
               "virtualUsers": 0  # Optional. No of concurrent virtual
                 users.
           },
           "quickStartTest": False,  # Optional. Default value is False. If
             true, optionalLoadTestConfig is required and JMX script for the load test is
             not required to upload.
           "splitAllCSVs": False  # Optional. Default value is False. If false,
             Azure Load Testing copies and processes your input files unmodified across
             all test engine instances. If true, Azure Load Testing splits the CSV input
             data evenly across all engine instances. If you provide multiple CSV files,
             each file will be split evenly.
       },
       "passFailCriteria": {
           "passFailMetrics": {
               "str": {
                   "action": "continue",  # Optional. Default value is
                     "continue". Action taken after the threshold is met. Default is
                     "u2018continue"u2019. Known values are: "continue" and "stop".
                   "actualValue": 0.0,  # Optional. The actual value of
                     the client metric for the test run.
                   "aggregate": "str",  # Optional. The aggregation
                     function to be applied on the client metric. Allowed functions -
                     "u2018percentage"u2019 - for error metric , "u2018avg"u2019,
                     "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019,
                     "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency
                     metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 -
                     for requests. Known values are: "count", "percentage", "avg", "p50",
                     "p90", "p95", "p99", "min", and "max".
                   "clientMetric": "str",  # Optional. The client metric
                     on which the criteria should be applied. Known values are:
                     "response_time_ms", "latency", "error", "requests", and
                     "requests_per_sec".
                   "condition": "str",  # Optional. The comparison
                     operator. Supported types "u2018>"u2019, "u2018<"u2019.
                   "requestName": "str",  # Optional. Request name for
                     which the Pass fail criteria has to be applied.
                   "result": "str",  # Optional. Outcome of the test
                     run. Known values are: "passed", "undetermined", and "failed".
                   "value": 0.0  # Optional. The value to compare with
                     the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit-
                     % "u2019, response_time_ms and latency : any integer value unit- ms.
               }
           }
       },
       "secrets": {
           "str": {
               "type": "str",  # Optional. Type of secret. Known values are:
                 "AKV_SECRET_URI" and "SECRET_VALUE".
               "value": "str"  # Optional. The value of the secret for the
                 respective type.
           }
       },
       "subnetId": "str",  # Optional. Subnet ID on which the load test instances
         should run.
       "testId": "str"  # Optional. Unique test name as identifier.
   }

delete_test

Delete a test by its name.

delete_test(test_id: str, **kwargs: Any) -> None

Parameters

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

Returns

Type	Description
None	None

Exceptions

Type	Description
HttpResponseError

delete_test_file

Delete file by the file name for a test.

delete_test_file(test_id: str, file_name: str, **kwargs: Any) -> None

Parameters

Name	Description
test_id Required	str Unique name for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. Required.
file_name Required	str File name with file extension like app.jmx. Required.

Returns

Type	Description
None	None

Exceptions

Type	Description
HttpResponseError

get_app_components

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

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

Parameters

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

Returns

Type	Description
<xref:JSON>	JSON object

Exceptions

Type	Description
HttpResponseError

Examples


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

get_server_metrics_config

List server metrics configuration for the given test.

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

Parameters

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

Returns

Type	Description
<xref:JSON>	JSON object

Exceptions

Type	Description
HttpResponseError

Examples


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

get_test

Get load test details by test name.

get_test(test_id: str, **kwargs: Any) -> MutableMapping[str, Any]

Parameters

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

Returns

Type	Description
<xref:JSON>	JSON object

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 200
   response == {
       "certificate": {
           "name": "str",  # Optional. Name of the certificate.
           "type": "str",  # Optional. Type of certificate. "AKV_CERT_URI"
           "value": "str"  # Optional. The value of the certificate for
             respective type.
       },
       "createdBy": "str",  # Optional. The user that created.
       "createdDateTime": "2020-02-20 00:00:00",  # Optional. The creation
         datetime(ISO 8601 literal format).
       "description": "str",  # Optional. The test 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": {
           "additionalFileInfo": [
               {
                   "expireDateTime": "2020-02-20 00:00:00",  # Optional.
                     Expiry time of the file (ISO 8601 literal format).
                   "fileName": "str",  # Optional. Name of the file.
                   "fileType": "str",  # Optional. File type. Known
                     values are: "JMX_FILE", "USER_PROPERTIES", and
                     "ADDITIONAL_ARTIFACTS".
                   "url": "str",  # Optional. File URL.
                   "validationFailureDetails": "str",  # Optional.
                     Validation failure error details.
                   "validationStatus": "str"  # Optional. Validation
                     status of the file. Known values are: "NOT_VALIDATED",
                     "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED",
                     and "VALIDATION_NOT_REQUIRED".
               }
           ],
           "configFileInfo": {
               "expireDateTime": "2020-02-20 00:00:00",  # Optional. Expiry
                 time of the file (ISO 8601 literal format).
               "fileName": "str",  # Optional. Name of the file.
               "fileType": "str",  # Optional. File type. Known values are:
                 "JMX_FILE", "USER_PROPERTIES", and "ADDITIONAL_ARTIFACTS".
               "url": "str",  # Optional. File URL.
               "validationFailureDetails": "str",  # Optional. Validation
                 failure error details.
               "validationStatus": "str"  # Optional. Validation status of
                 the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS",
                 "VALIDATION_FAILURE", "VALIDATION_INITIATED", and
                 "VALIDATION_NOT_REQUIRED".
           },
           "inputArtifactsZipFileInfo": {
               "expireDateTime": "2020-02-20 00:00:00",  # Optional. Expiry
                 time of the file (ISO 8601 literal format).
               "fileName": "str",  # Optional. Name of the file.
               "fileType": "str",  # Optional. File type. Known values are:
                 "JMX_FILE", "USER_PROPERTIES", and "ADDITIONAL_ARTIFACTS".
               "url": "str",  # Optional. File URL.
               "validationFailureDetails": "str",  # Optional. Validation
                 failure error details.
               "validationStatus": "str"  # Optional. Validation status of
                 the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS",
                 "VALIDATION_FAILURE", "VALIDATION_INITIATED", and
                 "VALIDATION_NOT_REQUIRED".
           },
           "testScriptFileInfo": {
               "expireDateTime": "2020-02-20 00:00:00",  # Optional. Expiry
                 time of the file (ISO 8601 literal format).
               "fileName": "str",  # Optional. Name of the file.
               "fileType": "str",  # Optional. File type. Known values are:
                 "JMX_FILE", "USER_PROPERTIES", and "ADDITIONAL_ARTIFACTS".
               "url": "str",  # Optional. File URL.
               "validationFailureDetails": "str",  # Optional. Validation
                 failure error details.
               "validationStatus": "str"  # Optional. Validation status of
                 the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS",
                 "VALIDATION_FAILURE", "VALIDATION_INITIATED", and
                 "VALIDATION_NOT_REQUIRED".
           },
           "userPropFileInfo": {
               "expireDateTime": "2020-02-20 00:00:00",  # Optional. Expiry
                 time of the file (ISO 8601 literal format).
               "fileName": "str",  # Optional. Name of the file.
               "fileType": "str",  # Optional. File type. Known values are:
                 "JMX_FILE", "USER_PROPERTIES", and "ADDITIONAL_ARTIFACTS".
               "url": "str",  # Optional. File URL.
               "validationFailureDetails": "str",  # Optional. Validation
                 failure error details.
               "validationStatus": "str"  # Optional. Validation status of
                 the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS",
                 "VALIDATION_FAILURE", "VALIDATION_INITIATED", and
                 "VALIDATION_NOT_REQUIRED".
           }
       },
       "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.
       "lastModifiedDateTime": "2020-02-20 00:00:00",  # Optional. The last Modified
         datetime(ISO 8601 literal format).
       "loadTestConfiguration": {
           "engineInstances": 0,  # Optional. The number of engine instances to
             execute load test. Supported values are in range of 1-45. Required for
             creating a new test.
           "optionalLoadTestConfig": {
               "duration": 0,  # Optional. Test run duration.
               "endpointUrl": "str",  # Optional. Test URL. Provide the
                 complete HTTP URL. For example,
                 http://contoso-app.azurewebsites.net/login.
               "rampUpTime": 0,  # Optional. Ramp up time.
               "virtualUsers": 0  # Optional. No of concurrent virtual
                 users.
           },
           "quickStartTest": False,  # Optional. Default value is False. If
             true, optionalLoadTestConfig is required and JMX script for the load test is
             not required to upload.
           "splitAllCSVs": False  # Optional. Default value is False. If false,
             Azure Load Testing copies and processes your input files unmodified across
             all test engine instances. If true, Azure Load Testing splits the CSV input
             data evenly across all engine instances. If you provide multiple CSV files,
             each file will be split evenly.
       },
       "passFailCriteria": {
           "passFailMetrics": {
               "str": {
                   "action": "continue",  # Optional. Default value is
                     "continue". Action taken after the threshold is met. Default is
                     "u2018continue"u2019. Known values are: "continue" and "stop".
                   "actualValue": 0.0,  # Optional. The actual value of
                     the client metric for the test run.
                   "aggregate": "str",  # Optional. The aggregation
                     function to be applied on the client metric. Allowed functions -
                     "u2018percentage"u2019 - for error metric , "u2018avg"u2019,
                     "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019,
                     "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency
                     metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 -
                     for requests. Known values are: "count", "percentage", "avg", "p50",
                     "p90", "p95", "p99", "min", and "max".
                   "clientMetric": "str",  # Optional. The client metric
                     on which the criteria should be applied. Known values are:
                     "response_time_ms", "latency", "error", "requests", and
                     "requests_per_sec".
                   "condition": "str",  # Optional. The comparison
                     operator. Supported types "u2018>"u2019, "u2018<"u2019.
                   "requestName": "str",  # Optional. Request name for
                     which the Pass fail criteria has to be applied.
                   "result": "str",  # Optional. Outcome of the test
                     run. Known values are: "passed", "undetermined", and "failed".
                   "value": 0.0  # Optional. The value to compare with
                     the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit-
                     % "u2019, response_time_ms and latency : any integer value unit- ms.
               }
           }
       },
       "secrets": {
           "str": {
               "type": "str",  # Optional. Type of secret. Known values are:
                 "AKV_SECRET_URI" and "SECRET_VALUE".
               "value": "str"  # Optional. The value of the secret for the
                 respective type.
           }
       },
       "subnetId": "str",  # Optional. Subnet ID on which the load test instances
         should run.
       "testId": "str"  # Optional. Unique test name as identifier.
   }

get_test_file

Get test file by the file name.

get_test_file(test_id: str, file_name: str, **kwargs: Any) -> MutableMapping[str, Any]

Parameters

Name	Description
test_id Required	str Unique name for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. Required.
file_name Required	str File name with file extension like app.jmx. Required.

Returns

Type	Description
<xref:JSON>	JSON object

Exceptions

Type	Description
HttpResponseError

Examples


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

list_test_files

Get all test files.

list_test_files(test_id: str, **kwargs: Any) -> Iterable[MutableMapping[str, Any]]

Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

Examples


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

list_tests

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

list_tests(*, orderby: str | None = None, search: str | None = None, last_modified_start_time: datetime | None = None, last_modified_end_time: datetime | None = None, **kwargs: Any) -> Iterable[MutableMapping[str, Any]]

Keyword-Only Parameters

Name	Description
orderby	str Sort on the supported fields in (field asc/desc) format. eg: lastModifiedDateTime asc. Supported fields - lastModifiedDateTime. Default value is None. Default value: None
search	str Prefix based, case sensitive search on searchable fields - displayName, createdBy. For example, to search for a test, with display name is Login Test, the search parameter can be Login. Default value is None. Default value: None
last_modified_start_time	datetime Start DateTime(ISO 8601 literal format) of the last updated time range to filter tests. Default value is None. Default value: None
last_modified_end_time	datetime End DateTime(ISO 8601 literal format) of the last updated time range to filter tests. Default value is None. Default value: None

Returns

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

Exceptions

Type	Description
HttpResponseError

Examples


   # response body for status code(s): 200
   response == {
       "certificate": {
           "name": "str",  # Optional. Name of the certificate.
           "type": "str",  # Optional. Type of certificate. "AKV_CERT_URI"
           "value": "str"  # Optional. The value of the certificate for
             respective type.
       },
       "createdBy": "str",  # Optional. The user that created.
       "createdDateTime": "2020-02-20 00:00:00",  # Optional. The creation
         datetime(ISO 8601 literal format).
       "description": "str",  # Optional. The test 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": {
           "additionalFileInfo": [
               {
                   "expireDateTime": "2020-02-20 00:00:00",  # Optional.
                     Expiry time of the file (ISO 8601 literal format).
                   "fileName": "str",  # Optional. Name of the file.
                   "fileType": "str",  # Optional. File type. Known
                     values are: "JMX_FILE", "USER_PROPERTIES", and
                     "ADDITIONAL_ARTIFACTS".
                   "url": "str",  # Optional. File URL.
                   "validationFailureDetails": "str",  # Optional.
                     Validation failure error details.
                   "validationStatus": "str"  # Optional. Validation
                     status of the file. Known values are: "NOT_VALIDATED",
                     "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED",
                     and "VALIDATION_NOT_REQUIRED".
               }
           ],
           "configFileInfo": {
               "expireDateTime": "2020-02-20 00:00:00",  # Optional. Expiry
                 time of the file (ISO 8601 literal format).
               "fileName": "str",  # Optional. Name of the file.
               "fileType": "str",  # Optional. File type. Known values are:
                 "JMX_FILE", "USER_PROPERTIES", and "ADDITIONAL_ARTIFACTS".
               "url": "str",  # Optional. File URL.
               "validationFailureDetails": "str",  # Optional. Validation
                 failure error details.
               "validationStatus": "str"  # Optional. Validation status of
                 the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS",
                 "VALIDATION_FAILURE", "VALIDATION_INITIATED", and
                 "VALIDATION_NOT_REQUIRED".
           },
           "inputArtifactsZipFileInfo": {
               "expireDateTime": "2020-02-20 00:00:00",  # Optional. Expiry
                 time of the file (ISO 8601 literal format).
               "fileName": "str",  # Optional. Name of the file.
               "fileType": "str",  # Optional. File type. Known values are:
                 "JMX_FILE", "USER_PROPERTIES", and "ADDITIONAL_ARTIFACTS".
               "url": "str",  # Optional. File URL.
               "validationFailureDetails": "str",  # Optional. Validation
                 failure error details.
               "validationStatus": "str"  # Optional. Validation status of
                 the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS",
                 "VALIDATION_FAILURE", "VALIDATION_INITIATED", and
                 "VALIDATION_NOT_REQUIRED".
           },
           "testScriptFileInfo": {
               "expireDateTime": "2020-02-20 00:00:00",  # Optional. Expiry
                 time of the file (ISO 8601 literal format).
               "fileName": "str",  # Optional. Name of the file.
               "fileType": "str",  # Optional. File type. Known values are:
                 "JMX_FILE", "USER_PROPERTIES", and "ADDITIONAL_ARTIFACTS".
               "url": "str",  # Optional. File URL.
               "validationFailureDetails": "str",  # Optional. Validation
                 failure error details.
               "validationStatus": "str"  # Optional. Validation status of
                 the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS",
                 "VALIDATION_FAILURE", "VALIDATION_INITIATED", and
                 "VALIDATION_NOT_REQUIRED".
           },
           "userPropFileInfo": {
               "expireDateTime": "2020-02-20 00:00:00",  # Optional. Expiry
                 time of the file (ISO 8601 literal format).
               "fileName": "str",  # Optional. Name of the file.
               "fileType": "str",  # Optional. File type. Known values are:
                 "JMX_FILE", "USER_PROPERTIES", and "ADDITIONAL_ARTIFACTS".
               "url": "str",  # Optional. File URL.
               "validationFailureDetails": "str",  # Optional. Validation
                 failure error details.
               "validationStatus": "str"  # Optional. Validation status of
                 the file. Known values are: "NOT_VALIDATED", "VALIDATION_SUCCESS",
                 "VALIDATION_FAILURE", "VALIDATION_INITIATED", and
                 "VALIDATION_NOT_REQUIRED".
           }
       },
       "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.
       "lastModifiedDateTime": "2020-02-20 00:00:00",  # Optional. The last Modified
         datetime(ISO 8601 literal format).
       "loadTestConfiguration": {
           "engineInstances": 0,  # Optional. The number of engine instances to
             execute load test. Supported values are in range of 1-45. Required for
             creating a new test.
           "optionalLoadTestConfig": {
               "duration": 0,  # Optional. Test run duration.
               "endpointUrl": "str",  # Optional. Test URL. Provide the
                 complete HTTP URL. For example,
                 http://contoso-app.azurewebsites.net/login.
               "rampUpTime": 0,  # Optional. Ramp up time.
               "virtualUsers": 0  # Optional. No of concurrent virtual
                 users.
           },
           "quickStartTest": False,  # Optional. Default value is False. If
             true, optionalLoadTestConfig is required and JMX script for the load test is
             not required to upload.
           "splitAllCSVs": False  # Optional. Default value is False. If false,
             Azure Load Testing copies and processes your input files unmodified across
             all test engine instances. If true, Azure Load Testing splits the CSV input
             data evenly across all engine instances. If you provide multiple CSV files,
             each file will be split evenly.
       },
       "passFailCriteria": {
           "passFailMetrics": {
               "str": {
                   "action": "continue",  # Optional. Default value is
                     "continue". Action taken after the threshold is met. Default is
                     "u2018continue"u2019. Known values are: "continue" and "stop".
                   "actualValue": 0.0,  # Optional. The actual value of
                     the client metric for the test run.
                   "aggregate": "str",  # Optional. The aggregation
                     function to be applied on the client metric. Allowed functions -
                     "u2018percentage"u2019 - for error metric , "u2018avg"u2019,
                     "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019,
                     "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency
                     metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 -
                     for requests. Known values are: "count", "percentage", "avg", "p50",
                     "p90", "p95", "p99", "min", and "max".
                   "clientMetric": "str",  # Optional. The client metric
                     on which the criteria should be applied. Known values are:
                     "response_time_ms", "latency", "error", "requests", and
                     "requests_per_sec".
                   "condition": "str",  # Optional. The comparison
                     operator. Supported types "u2018>"u2019, "u2018<"u2019.
                   "requestName": "str",  # Optional. Request name for
                     which the Pass fail criteria has to be applied.
                   "result": "str",  # Optional. Outcome of the test
                     run. Known values are: "passed", "undetermined", and "failed".
                   "value": 0.0  # Optional. The value to compare with
                     the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit-
                     % "u2019, response_time_ms and latency : any integer value unit- ms.
               }
           }
       },
       "secrets": {
           "str": {
               "type": "str",  # Optional. Type of secret. Known values are:
                 "AKV_SECRET_URI" and "SECRET_VALUE".
               "value": "str"  # Optional. The value of the secret for the
                 respective type.
           }
       },
       "subnetId": "str",  # Optional. Subnet ID on which the load test instances
         should run.
       "testId": "str"  # Optional. Unique test name as identifier.
   }

send_request

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


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

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

send_request(request: HttpRequest, **kwargs: Any) -> HttpResponse

Parameters

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

Keyword-Only Parameters

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

Returns

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

Comentários

Esta página foi útil?

Partilhar via

LoadTestAdministrationClient Class

Constructor

Parameters

Keyword-Only Parameters

Methods

begin_upload_test_file

Parameters

Keyword-Only Parameters

Returns

Exceptions

close

create_or_update_app_components

Parameters

Keyword-Only Parameters

Returns

Exceptions

Examples

create_or_update_server_metrics_config

Parameters

Keyword-Only Parameters

Returns

Exceptions

Examples

create_or_update_test

Parameters

Keyword-Only Parameters

Returns

Exceptions

Examples

delete_test

Parameters

Returns

Exceptions

delete_test_file

Parameters

Returns

Exceptions

get_app_components

Parameters

Returns

Exceptions

Examples

get_server_metrics_config

Parameters

Returns

Exceptions

Examples

get_test

Parameters

Returns

Exceptions

Examples

get_test_file

Parameters

Returns

Exceptions

Examples

list_test_files

Parameters

Returns

Exceptions

Examples

list_tests

Keyword-Only Parameters

Returns

Exceptions

Examples

send_request

Parameters

Keyword-Only Parameters

Returns

Comentários