diff --git a/sdk/loadtesting/azure-developer-loadtesting/_meta.json b/sdk/loadtesting/azure-developer-loadtesting/_meta.json new file mode 100644 index 000000000000..27dd44a11804 --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/_meta.json @@ -0,0 +1,6 @@ +{ + "commit": "a718913e51a489e2ed6fa6a5966e5291b8018435", + "repository_url": "https://github.com/Azure/azure-rest-api-specs", + "typespec_src": "specification/loadtestservice/LoadTestService", + "@azure-tools/typespec-python": "0.21.0" +} \ No newline at end of file diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/__init__.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/__init__.py index c9943fbd0915..d8df752ebf61 100644 --- a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/__init__.py +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/__init__.py @@ -1,10 +1,28 @@ -# ------------------------------------------------------------------------- +# coding=utf-8 +# -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. -# Licensed under the MIT License. See License.txt in the project root for -# license information. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -from ._client import LoadTestAdministrationClient, LoadTestRunClient + +from ._client import LoadTestAdministrationClient +from ._client import LoadTestRunClient from ._version import VERSION __version__ = VERSION -__all__ = ["LoadTestAdministrationClient", "LoadTestRunClient"] + +try: + from ._patch import __all__ as _patch_all + from ._patch import * # pylint: disable=unused-wildcard-import +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "LoadTestAdministrationClient", + "LoadTestRunClient", +] +__all__.extend([p for p in _patch_all if p not in __all__]) + +_patch_sdk() diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_client.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_client.py index c5c9808f7ed4..0b585d8edadc 100644 --- a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_client.py +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_client.py @@ -1,34 +1,69 @@ -# ------------------------------------------------------------------------- +# coding=utf-8 +# -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. -# Licensed under the MIT License. See License.txt in the project root for -# license information. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- + from copy import deepcopy from typing import Any, TYPE_CHECKING from azure.core import PipelineClient +from azure.core.pipeline import policies from azure.core.rest import HttpRequest, HttpResponse -from ._generated._configuration import LoadTestingClientConfiguration -from ._generated._serialization import Deserializer, Serializer -from ._generated.operations import AdministrationOperations, TestRunOperations +from ._configuration import LoadTestAdministrationClientConfiguration, LoadTestRunClientConfiguration +from ._operations import LoadTestAdministrationClientOperationsMixin, LoadTestRunClientOperationsMixin +from ._serialization import Deserializer, Serializer if TYPE_CHECKING: # pylint: disable=unused-import,ungrouped-imports from azure.core.credentials import TokenCredential -class _BaseClient: + +class LoadTestAdministrationClient( + LoadTestAdministrationClientOperationsMixin +): # pylint: disable=client-accepts-api-version-keyword + """LoadTestAdministrationClient. + + :param endpoint: Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials.TokenCredential + :keyword api_version: The API version to use for this operation. Default value is + "2023-04-01-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + def __init__(self, endpoint: str, credential: "TokenCredential", **kwargs: Any) -> None: - _endpoint = "https://{Endpoint}" - self._config = LoadTestingClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) - self._client = PipelineClient(base_url=_endpoint, config=self._config, **kwargs) + _endpoint = "https://{endpoint}" + self._config = LoadTestAdministrationClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: PipelineClient = PipelineClient(base_url=_endpoint, policies=_policies, **kwargs) self._serialize = Serializer() self._deserialize = Deserializer() self._serialize.client_side_validation = False - super().__init__(self._client, self._config, self._serialize, self._deserialize) - def send_request(self, request: HttpRequest, **kwargs: Any) -> HttpResponse: + def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse: """Runs the network request through the client's chained policies. >>> from azure.core.rest import HttpRequest @@ -48,50 +83,94 @@ def send_request(self, request: HttpRequest, **kwargs: Any) -> HttpResponse: request_copy = deepcopy(request) path_format_arguments = { - "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) - return self._client.send_request(request_copy, **kwargs) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore - def close(self): - # type: () -> None + def close(self) -> None: self._client.close() - def __exit__(self, *exc_details): - # type: (Any) -> None + def __enter__(self) -> "LoadTestAdministrationClient": + self._client.__enter__() + return self + + def __exit__(self, *exc_details: Any) -> None: self._client.__exit__(*exc_details) -class LoadTestAdministrationClient(_BaseClient, AdministrationOperations): # pylint: disable=client-accepts-api-version-keyword - """These APIs allow end users to do various administrative operations on Azure Load Test Service. +class LoadTestRunClient(LoadTestRunClientOperationsMixin): # pylint: disable=client-accepts-api-version-keyword + """LoadTestRunClient. - :param endpoint: URL to perform data plane API operations on the resource. Required. + :param endpoint: Required. :type endpoint: str :param credential: Credential needed for the client to connect to Azure. Required. :type credential: ~azure.core.credentials.TokenCredential - :keyword api_version: Api Version. Default value is "2022-11-01". Note that overriding this - default value may result in unsupported behavior. + :keyword api_version: The API version to use for this operation. Default value is + "2023-04-01-preview". Note that overriding this default value may result in unsupported + behavior. :paramtype api_version: str """ - def __enter__(self) -> "LoadTestAdministrationClient": - self._client.__enter__() - return self + def __init__(self, endpoint: str, credential: "TokenCredential", **kwargs: Any) -> None: + _endpoint = "https://{endpoint}" + self._config = LoadTestRunClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: PipelineClient = PipelineClient(base_url=_endpoint, policies=_policies, **kwargs) -class LoadTestRunClient(_BaseClient, TestRunOperations): # pylint: disable=client-accepts-api-version-keyword - """These APIs allow end users to run Azure Load Test and manage test run. + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False - :param endpoint: URL to perform data plane API operations on the resource. Required. - :type endpoint: str - :param credential: Credential needed for the client to connect to Azure. Required. - :type credential: ~azure.core.credentials.TokenCredential - :keyword api_version: Api Version. Default value is "2022-11-01". Note that overriding this - default value may result in unsupported behavior. - :paramtype api_version: str - """ + def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = client.send_request(request) + + + For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request + + :param request: The network request you want to make. Required. + :type request: ~azure.core.rest.HttpRequest + :keyword bool stream: Whether the response payload will be streamed. Defaults to False. + :return: The response of your network call. Does not do error handling on your response. + :rtype: ~azure.core.rest.HttpResponse + """ + + request_copy = deepcopy(request) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore + + def close(self) -> None: + self._client.close() def __enter__(self) -> "LoadTestRunClient": self._client.__enter__() return self + def __exit__(self, *exc_details: Any) -> None: + self._client.__exit__(*exc_details) diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_configuration.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_configuration.py new file mode 100644 index 000000000000..01698ee61185 --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_configuration.py @@ -0,0 +1,113 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Any, TYPE_CHECKING + +from azure.core.pipeline import policies + +from ._version import VERSION + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core.credentials import TokenCredential + + +class LoadTestAdministrationClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long + """Configuration for LoadTestAdministrationClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param endpoint: Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials.TokenCredential + :keyword api_version: The API version to use for this operation. Default value is + "2023-04-01-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: "TokenCredential", **kwargs: Any) -> None: + api_version: str = kwargs.pop("api_version", "2023-04-01-preview") + + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.endpoint = endpoint + self.credential = credential + self.api_version = api_version + self.credential_scopes = kwargs.pop("credential_scopes", ["https://cnt-prod.loadtesting.azure.com/.default"]) + kwargs.setdefault("sdk_moniker", "developer-loadtesting/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get("redirect_policy") or policies.RedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs) + self.authentication_policy = kwargs.get("authentication_policy") + if self.credential and not self.authentication_policy: + self.authentication_policy = policies.BearerTokenCredentialPolicy( + self.credential, *self.credential_scopes, **kwargs + ) + + +class LoadTestRunClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long + """Configuration for LoadTestRunClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param endpoint: Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials.TokenCredential + :keyword api_version: The API version to use for this operation. Default value is + "2023-04-01-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: "TokenCredential", **kwargs: Any) -> None: + api_version: str = kwargs.pop("api_version", "2023-04-01-preview") + + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.endpoint = endpoint + self.credential = credential + self.api_version = api_version + self.credential_scopes = kwargs.pop("credential_scopes", ["https://cnt-prod.loadtesting.azure.com/.default"]) + kwargs.setdefault("sdk_moniker", "developer-loadtesting/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get("redirect_policy") or policies.RedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs) + self.authentication_policy = kwargs.get("authentication_policy") + if self.credential and not self.authentication_policy: + self.authentication_policy = policies.BearerTokenCredentialPolicy( + self.credential, *self.credential_scopes, **kwargs + ) diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_model_base.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_model_base.py new file mode 100644 index 000000000000..1ddc071517d6 --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_model_base.py @@ -0,0 +1,874 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- +# pylint: disable=protected-access, arguments-differ, signature-differs, broad-except + +import calendar +import decimal +import functools +import sys +import logging +import base64 +import re +import copy +import typing +import enum +import email.utils +from datetime import datetime, date, time, timedelta, timezone +from json import JSONEncoder +from typing_extensions import Self +import isodate +from azure.core.exceptions import DeserializationError +from azure.core import CaseInsensitiveEnumMeta +from azure.core.pipeline import PipelineResponse +from azure.core.serialization import _Null + +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping + +_LOGGER = logging.getLogger(__name__) + +__all__ = ["SdkJSONEncoder", "Model", "rest_field", "rest_discriminator"] + +TZ_UTC = timezone.utc +_T = typing.TypeVar("_T") + + +def _timedelta_as_isostr(td: timedelta) -> str: + """Converts a datetime.timedelta object into an ISO 8601 formatted string, e.g. 'P4DT12H30M05S' + + Function adapted from the Tin Can Python project: https://github.com/RusticiSoftware/TinCanPython + + :param timedelta td: The timedelta to convert + :rtype: str + :return: ISO8601 version of this timedelta + """ + + # Split seconds to larger units + seconds = td.total_seconds() + minutes, seconds = divmod(seconds, 60) + hours, minutes = divmod(minutes, 60) + days, hours = divmod(hours, 24) + + days, hours, minutes = list(map(int, (days, hours, minutes))) + seconds = round(seconds, 6) + + # Build date + date_str = "" + if days: + date_str = "%sD" % days + + if hours or minutes or seconds: + # Build time + time_str = "T" + + # Hours + bigger_exists = date_str or hours + if bigger_exists: + time_str += "{:02}H".format(hours) + + # Minutes + bigger_exists = bigger_exists or minutes + if bigger_exists: + time_str += "{:02}M".format(minutes) + + # Seconds + try: + if seconds.is_integer(): + seconds_string = "{:02}".format(int(seconds)) + else: + # 9 chars long w/ leading 0, 6 digits after decimal + seconds_string = "%09.6f" % seconds + # Remove trailing zeros + seconds_string = seconds_string.rstrip("0") + except AttributeError: # int.is_integer() raises + seconds_string = "{:02}".format(seconds) + + time_str += "{}S".format(seconds_string) + else: + time_str = "" + + return "P" + date_str + time_str + + +def _serialize_bytes(o, format: typing.Optional[str] = None) -> str: + encoded = base64.b64encode(o).decode() + if format == "base64url": + return encoded.strip("=").replace("+", "-").replace("/", "_") + return encoded + + +def _serialize_datetime(o, format: typing.Optional[str] = None): + if hasattr(o, "year") and hasattr(o, "hour"): + if format == "rfc7231": + return email.utils.format_datetime(o, usegmt=True) + if format == "unix-timestamp": + return int(calendar.timegm(o.utctimetuple())) + + # astimezone() fails for naive times in Python 2.7, so make make sure o is aware (tzinfo is set) + if not o.tzinfo: + iso_formatted = o.replace(tzinfo=TZ_UTC).isoformat() + else: + iso_formatted = o.astimezone(TZ_UTC).isoformat() + # Replace the trailing "+00:00" UTC offset with "Z" (RFC 3339: https://www.ietf.org/rfc/rfc3339.txt) + return iso_formatted.replace("+00:00", "Z") + # Next try datetime.date or datetime.time + return o.isoformat() + + +def _is_readonly(p): + try: + return p._visibility == ["read"] # pylint: disable=protected-access + except AttributeError: + return False + + +class SdkJSONEncoder(JSONEncoder): + """A JSON encoder that's capable of serializing datetime objects and bytes.""" + + def __init__(self, *args, exclude_readonly: bool = False, format: typing.Optional[str] = None, **kwargs): + super().__init__(*args, **kwargs) + self.exclude_readonly = exclude_readonly + self.format = format + + def default(self, o): # pylint: disable=too-many-return-statements + if _is_model(o): + if self.exclude_readonly: + readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)] + return {k: v for k, v in o.items() if k not in readonly_props} + return dict(o.items()) + try: + return super(SdkJSONEncoder, self).default(o) + except TypeError: + if isinstance(o, _Null): + return None + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, self.format) + try: + # First try datetime.datetime + return _serialize_datetime(o, self.format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return super(SdkJSONEncoder, self).default(o) + + +_VALID_DATE = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" + r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") +_VALID_RFC7231 = re.compile( + r"(Mon|Tue|Wed|Thu|Fri|Sat|Sun),\s\d{2}\s" + r"(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s\d{4}\s\d{2}:\d{2}:\d{2}\sGMT" +) + + +def _deserialize_datetime(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + attr = attr.upper() + match = _VALID_DATE.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + check_decimal = attr.split(".") + if len(check_decimal) > 1: + decimal_str = "" + for digit in check_decimal[1]: + if digit.isdigit(): + decimal_str += digit + else: + break + if len(decimal_str) > 6: + attr = attr.replace(decimal_str, decimal_str[0:6]) + + date_obj = isodate.parse_datetime(attr) + test_utc = date_obj.utctimetuple() + if test_utc.tm_year > 9999 or test_utc.tm_year < 1: + raise OverflowError("Hit max or min date") + return date_obj + + +def _deserialize_datetime_rfc7231(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize RFC7231 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + match = _VALID_RFC7231.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + return email.utils.parsedate_to_datetime(attr) + + +def _deserialize_datetime_unix_timestamp(attr: typing.Union[float, datetime]) -> datetime: + """Deserialize unix timestamp into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + return datetime.fromtimestamp(attr, TZ_UTC) + + +def _deserialize_date(attr: typing.Union[str, date]) -> date: + """Deserialize ISO-8601 formatted string into Date object. + :param str attr: response string to be deserialized. + :rtype: date + :returns: The date object from that input + """ + # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. + if isinstance(attr, date): + return attr + return isodate.parse_date(attr, defaultmonth=None, defaultday=None) # type: ignore + + +def _deserialize_time(attr: typing.Union[str, time]) -> time: + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :rtype: datetime.time + :returns: The time object from that input + """ + if isinstance(attr, time): + return attr + return isodate.parse_time(attr) + + +def _deserialize_bytes(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + return bytes(base64.b64decode(attr)) + + +def _deserialize_bytes_base64(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return bytes(base64.b64decode(encoded)) + + +def _deserialize_duration(attr): + if isinstance(attr, timedelta): + return attr + return isodate.parse_duration(attr) + + +def _deserialize_decimal(attr): + if isinstance(attr, decimal.Decimal): + return attr + return decimal.Decimal(str(attr)) + + +_DESERIALIZE_MAPPING = { + datetime: _deserialize_datetime, + date: _deserialize_date, + time: _deserialize_time, + bytes: _deserialize_bytes, + bytearray: _deserialize_bytes, + timedelta: _deserialize_duration, + typing.Any: lambda x: x, + decimal.Decimal: _deserialize_decimal, +} + +_DESERIALIZE_MAPPING_WITHFORMAT = { + "rfc3339": _deserialize_datetime, + "rfc7231": _deserialize_datetime_rfc7231, + "unix-timestamp": _deserialize_datetime_unix_timestamp, + "base64": _deserialize_bytes, + "base64url": _deserialize_bytes_base64, +} + + +def get_deserializer(annotation: typing.Any, rf: typing.Optional["_RestField"] = None): + if rf and rf._format: + return _DESERIALIZE_MAPPING_WITHFORMAT.get(rf._format) + return _DESERIALIZE_MAPPING.get(annotation) + + +def _get_type_alias_type(module_name: str, alias_name: str): + types = { + k: v + for k, v in sys.modules[module_name].__dict__.items() + if isinstance(v, typing._GenericAlias) # type: ignore + } + if alias_name not in types: + return alias_name + return types[alias_name] + + +def _get_model(module_name: str, model_name: str): + models = {k: v for k, v in sys.modules[module_name].__dict__.items() if isinstance(v, type)} + module_end = module_name.rsplit(".", 1)[0] + models.update({k: v for k, v in sys.modules[module_end].__dict__.items() if isinstance(v, type)}) + if isinstance(model_name, str): + model_name = model_name.split(".")[-1] + if model_name not in models: + return model_name + return models[model_name] + + +_UNSET = object() + + +class _MyMutableMapping(MutableMapping[str, typing.Any]): # pylint: disable=unsubscriptable-object + def __init__(self, data: typing.Dict[str, typing.Any]) -> None: + self._data = copy.deepcopy(data) + + def __contains__(self, key: typing.Any) -> bool: + return key in self._data + + def __getitem__(self, key: str) -> typing.Any: + return self._data.__getitem__(key) + + def __setitem__(self, key: str, value: typing.Any) -> None: + self._data.__setitem__(key, value) + + def __delitem__(self, key: str) -> None: + self._data.__delitem__(key) + + def __iter__(self) -> typing.Iterator[typing.Any]: + return self._data.__iter__() + + def __len__(self) -> int: + return self._data.__len__() + + def __ne__(self, other: typing.Any) -> bool: + return not self.__eq__(other) + + def keys(self) -> typing.KeysView[str]: + return self._data.keys() + + def values(self) -> typing.ValuesView[typing.Any]: + return self._data.values() + + def items(self) -> typing.ItemsView[str, typing.Any]: + return self._data.items() + + def get(self, key: str, default: typing.Any = None) -> typing.Any: + try: + return self[key] + except KeyError: + return default + + @typing.overload + def pop(self, key: str) -> typing.Any: + ... + + @typing.overload + def pop(self, key: str, default: _T) -> _T: + ... + + @typing.overload + def pop(self, key: str, default: typing.Any) -> typing.Any: + ... + + def pop(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + if default is _UNSET: + return self._data.pop(key) + return self._data.pop(key, default) + + def popitem(self) -> typing.Tuple[str, typing.Any]: + return self._data.popitem() + + def clear(self) -> None: + self._data.clear() + + def update(self, *args: typing.Any, **kwargs: typing.Any) -> None: + self._data.update(*args, **kwargs) + + @typing.overload + def setdefault(self, key: str, default: None = None) -> None: + ... + + @typing.overload + def setdefault(self, key: str, default: typing.Any) -> typing.Any: + ... + + def setdefault(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + if default is _UNSET: + return self._data.setdefault(key) + return self._data.setdefault(key, default) + + def __eq__(self, other: typing.Any) -> bool: + try: + other_model = self.__class__(other) + except Exception: + return False + return self._data == other_model._data + + def __repr__(self) -> str: + return str(self._data) + + +def _is_model(obj: typing.Any) -> bool: + return getattr(obj, "_is_model", False) + + +def _serialize(o, format: typing.Optional[str] = None): # pylint: disable=too-many-return-statements + if isinstance(o, list): + return [_serialize(x, format) for x in o] + if isinstance(o, dict): + return {k: _serialize(v, format) for k, v in o.items()} + if isinstance(o, set): + return {_serialize(x, format) for x in o} + if isinstance(o, tuple): + return tuple(_serialize(x, format) for x in o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, format) + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, enum.Enum): + return o.value + try: + # First try datetime.datetime + return _serialize_datetime(o, format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return o + + +def _get_rest_field( + attr_to_rest_field: typing.Dict[str, "_RestField"], rest_name: str +) -> typing.Optional["_RestField"]: + try: + return next(rf for rf in attr_to_rest_field.values() if rf._rest_name == rest_name) + except StopIteration: + return None + + +def _create_value(rf: typing.Optional["_RestField"], value: typing.Any) -> typing.Any: + if not rf: + return _serialize(value, None) + if rf._is_multipart_file_input: + return value + if rf._is_model: + return _deserialize(rf._type, value) + return _serialize(value, rf._format) + + +class Model(_MyMutableMapping): + _is_model = True + + def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None: + class_name = self.__class__.__name__ + if len(args) > 1: + raise TypeError(f"{class_name}.__init__() takes 2 positional arguments but {len(args) + 1} were given") + dict_to_pass = { + rest_field._rest_name: rest_field._default + for rest_field in self._attr_to_rest_field.values() + if rest_field._default is not _UNSET + } + if args: + dict_to_pass.update( + {k: _create_value(_get_rest_field(self._attr_to_rest_field, k), v) for k, v in args[0].items()} + ) + else: + non_attr_kwargs = [k for k in kwargs if k not in self._attr_to_rest_field] + if non_attr_kwargs: + # actual type errors only throw the first wrong keyword arg they see, so following that. + raise TypeError(f"{class_name}.__init__() got an unexpected keyword argument '{non_attr_kwargs[0]}'") + dict_to_pass.update( + { + self._attr_to_rest_field[k]._rest_name: _create_value(self._attr_to_rest_field[k], v) + for k, v in kwargs.items() + if v is not None + } + ) + super().__init__(dict_to_pass) + + def copy(self) -> "Model": + return Model(self.__dict__) + + def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self: # pylint: disable=unused-argument + # we know the last three classes in mro are going to be 'Model', 'dict', and 'object' + mros = cls.__mro__[:-3][::-1] # ignore model, dict, and object parents, and reverse the mro order + attr_to_rest_field: typing.Dict[str, _RestField] = { # map attribute name to rest_field property + k: v for mro_class in mros for k, v in mro_class.__dict__.items() if k[0] != "_" and hasattr(v, "_type") + } + annotations = { + k: v + for mro_class in mros + if hasattr(mro_class, "__annotations__") # pylint: disable=no-member + for k, v in mro_class.__annotations__.items() # pylint: disable=no-member + } + for attr, rf in attr_to_rest_field.items(): + rf._module = cls.__module__ + if not rf._type: + rf._type = rf._get_deserialize_callable_from_annotation(annotations.get(attr, None)) + if not rf._rest_name_input: + rf._rest_name_input = attr + cls._attr_to_rest_field: typing.Dict[str, _RestField] = dict(attr_to_rest_field.items()) + + return super().__new__(cls) # pylint: disable=no-value-for-parameter + + def __init_subclass__(cls, discriminator: typing.Optional[str] = None) -> None: + for base in cls.__bases__: + if hasattr(base, "__mapping__"): # pylint: disable=no-member + base.__mapping__[discriminator or cls.__name__] = cls # type: ignore # pylint: disable=no-member + + @classmethod + def _get_discriminator(cls, exist_discriminators) -> typing.Optional[str]: + for v in cls.__dict__.values(): + if ( + isinstance(v, _RestField) and v._is_discriminator and v._rest_name not in exist_discriminators + ): # pylint: disable=protected-access + return v._rest_name # pylint: disable=protected-access + return None + + @classmethod + def _deserialize(cls, data, exist_discriminators): + if not hasattr(cls, "__mapping__"): # pylint: disable=no-member + return cls(data) + discriminator = cls._get_discriminator(exist_discriminators) + exist_discriminators.append(discriminator) + mapped_cls = cls.__mapping__.get(data.get(discriminator), cls) # pyright: ignore # pylint: disable=no-member + if mapped_cls == cls: + return cls(data) + return mapped_cls._deserialize(data, exist_discriminators) # pylint: disable=protected-access + + def as_dict(self, *, exclude_readonly: bool = False) -> typing.Dict[str, typing.Any]: + """Return a dict that can be JSONify using json.dump. + + :keyword bool exclude_readonly: Whether to remove the readonly properties. + :returns: A dict JSON compatible object + :rtype: dict + """ + + result = {} + if exclude_readonly: + readonly_props = [p._rest_name for p in self._attr_to_rest_field.values() if _is_readonly(p)] + for k, v in self.items(): + if exclude_readonly and k in readonly_props: # pyright: ignore + continue + is_multipart_file_input = False + try: + is_multipart_file_input = next( + rf for rf in self._attr_to_rest_field.values() if rf._rest_name == k + )._is_multipart_file_input + except StopIteration: + pass + result[k] = v if is_multipart_file_input else Model._as_dict_value(v, exclude_readonly=exclude_readonly) + return result + + @staticmethod + def _as_dict_value(v: typing.Any, exclude_readonly: bool = False) -> typing.Any: + if v is None or isinstance(v, _Null): + return None + if isinstance(v, (list, tuple, set)): + return type(v)(Model._as_dict_value(x, exclude_readonly=exclude_readonly) for x in v) + if isinstance(v, dict): + return {dk: Model._as_dict_value(dv, exclude_readonly=exclude_readonly) for dk, dv in v.items()} + return v.as_dict(exclude_readonly=exclude_readonly) if hasattr(v, "as_dict") else v + + +def _get_deserialize_callable_from_annotation( # pylint: disable=R0911, R0915, R0912 + annotation: typing.Any, + module: typing.Optional[str], + rf: typing.Optional["_RestField"] = None, +) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + if not annotation or annotation in [int, float]: + return None + + # is it a type alias? + if isinstance(annotation, str): + if module is not None: + annotation = _get_type_alias_type(module, annotation) + + # is it a forward ref / in quotes? + if isinstance(annotation, (str, typing.ForwardRef)): + try: + model_name = annotation.__forward_arg__ # type: ignore + except AttributeError: + model_name = annotation + if module is not None: + annotation = _get_model(module, model_name) + + try: + if module and _is_model(annotation): + if rf: + rf._is_model = True + + def _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj): + if _is_model(obj): + return obj + return _deserialize(model_deserializer, obj) + + return functools.partial(_deserialize_model, annotation) # pyright: ignore + except Exception: + pass + + # is it a literal? + try: + if annotation.__origin__ is typing.Literal: # pyright: ignore + return None + except AttributeError: + pass + + # is it optional? + try: + if any(a for a in annotation.__args__ if a == type(None)): # pyright: ignore + if_obj_deserializer = _get_deserialize_callable_from_annotation( + next(a for a in annotation.__args__ if a != type(None)), module, rf # pyright: ignore + ) + + def _deserialize_with_optional(if_obj_deserializer: typing.Optional[typing.Callable], obj): + if obj is None: + return obj + return _deserialize_with_callable(if_obj_deserializer, obj) + + return functools.partial(_deserialize_with_optional, if_obj_deserializer) + except AttributeError: + pass + + if getattr(annotation, "__origin__", None) is typing.Union: + # initial ordering is we make `string` the last deserialization option, because it is often them most generic + deserializers = [ + _get_deserialize_callable_from_annotation(arg, module, rf) + for arg in sorted( + annotation.__args__, key=lambda x: hasattr(x, "__name__") and x.__name__ == "str" # pyright: ignore + ) + ] + + def _deserialize_with_union(deserializers, obj): + for deserializer in deserializers: + try: + return _deserialize(deserializer, obj) + except DeserializationError: + pass + raise DeserializationError() + + return functools.partial(_deserialize_with_union, deserializers) + + try: + if annotation._name == "Dict": # pyright: ignore + value_deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[1], module, rf # pyright: ignore + ) + + def _deserialize_dict( + value_deserializer: typing.Optional[typing.Callable], + obj: typing.Dict[typing.Any, typing.Any], + ): + if obj is None: + return obj + return {k: _deserialize(value_deserializer, v, module) for k, v in obj.items()} + + return functools.partial( + _deserialize_dict, + value_deserializer, + ) + except (AttributeError, IndexError): + pass + try: + if annotation._name in ["List", "Set", "Tuple", "Sequence"]: # pyright: ignore + if len(annotation.__args__) > 1: # pyright: ignore + + def _deserialize_multiple_sequence( + entry_deserializers: typing.List[typing.Optional[typing.Callable]], + obj, + ): + if obj is None: + return obj + return type(obj)( + _deserialize(deserializer, entry, module) + for entry, deserializer in zip(obj, entry_deserializers) + ) + + entry_deserializers = [ + _get_deserialize_callable_from_annotation(dt, module, rf) + for dt in annotation.__args__ # pyright: ignore + ] + return functools.partial(_deserialize_multiple_sequence, entry_deserializers) + deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[0], module, rf # pyright: ignore + ) + + def _deserialize_sequence( + deserializer: typing.Optional[typing.Callable], + obj, + ): + if obj is None: + return obj + return type(obj)(_deserialize(deserializer, entry, module) for entry in obj) + + return functools.partial(_deserialize_sequence, deserializer) + except (TypeError, IndexError, AttributeError, SyntaxError): + pass + + def _deserialize_default( + deserializer, + obj, + ): + if obj is None: + return obj + try: + return _deserialize_with_callable(deserializer, obj) + except Exception: + pass + return obj + + if get_deserializer(annotation, rf): + return functools.partial(_deserialize_default, get_deserializer(annotation, rf)) + + return functools.partial(_deserialize_default, annotation) + + +def _deserialize_with_callable( + deserializer: typing.Optional[typing.Callable[[typing.Any], typing.Any]], + value: typing.Any, +): + try: + if value is None or isinstance(value, _Null): + return None + if deserializer is None: + return value + if isinstance(deserializer, CaseInsensitiveEnumMeta): + try: + return deserializer(value) + except ValueError: + # for unknown value, return raw value + return value + if isinstance(deserializer, type) and issubclass(deserializer, Model): + return deserializer._deserialize(value, []) + return typing.cast(typing.Callable[[typing.Any], typing.Any], deserializer)(value) + except Exception as e: + raise DeserializationError() from e + + +def _deserialize( + deserializer: typing.Any, + value: typing.Any, + module: typing.Optional[str] = None, + rf: typing.Optional["_RestField"] = None, + format: typing.Optional[str] = None, +) -> typing.Any: + if isinstance(value, PipelineResponse): + value = value.http_response.json() + if rf is None and format: + rf = _RestField(format=format) + if not isinstance(deserializer, functools.partial): + deserializer = _get_deserialize_callable_from_annotation(deserializer, module, rf) + return _deserialize_with_callable(deserializer, value) + + +class _RestField: + def __init__( + self, + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + is_discriminator: bool = False, + visibility: typing.Optional[typing.List[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, + ): + self._type = type + self._rest_name_input = name + self._module: typing.Optional[str] = None + self._is_discriminator = is_discriminator + self._visibility = visibility + self._is_model = False + self._default = default + self._format = format + self._is_multipart_file_input = is_multipart_file_input + + @property + def _class_type(self) -> typing.Any: + return getattr(self._type, "args", [None])[0] + + @property + def _rest_name(self) -> str: + if self._rest_name_input is None: + raise ValueError("Rest name was never set") + return self._rest_name_input + + def __get__(self, obj: Model, type=None): # pylint: disable=redefined-builtin + # by this point, type and rest_name will have a value bc we default + # them in __new__ of the Model class + item = obj.get(self._rest_name) + if item is None: + return item + if self._is_model: + return item + return _deserialize(self._type, _serialize(item, self._format), rf=self) + + def __set__(self, obj: Model, value) -> None: + if value is None: + # we want to wipe out entries if users set attr to None + try: + obj.__delitem__(self._rest_name) + except KeyError: + pass + return + if self._is_model: + if not _is_model(value): + value = _deserialize(self._type, value) + obj.__setitem__(self._rest_name, value) + return + obj.__setitem__(self._rest_name, _serialize(value, self._format)) + + def _get_deserialize_callable_from_annotation( + self, annotation: typing.Any + ) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + return _get_deserialize_callable_from_annotation(annotation, self._module, self) + + +def rest_field( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + visibility: typing.Optional[typing.List[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, +) -> typing.Any: + return _RestField( + name=name, + type=type, + visibility=visibility, + default=default, + format=format, + is_multipart_file_input=is_multipart_file_input, + ) + + +def rest_discriminator( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin +) -> typing.Any: + return _RestField(name=name, type=type, is_discriminator=True) diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_operations/__init__.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_operations/__init__.py new file mode 100644 index 000000000000..c433bf33381f --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_operations/__init__.py @@ -0,0 +1,21 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._operations import LoadTestAdministrationClientOperationsMixin +from ._operations import LoadTestRunClientOperationsMixin + +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "LoadTestAdministrationClientOperationsMixin", + "LoadTestRunClientOperationsMixin", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_operations/_operations.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_operations/_operations.py new file mode 100644 index 000000000000..8a9342a010d8 --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_operations/_operations.py @@ -0,0 +1,8663 @@ +# pylint: disable=too-many-lines,too-many-statements +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import datetime +from io import IOBase +import json +import sys +from typing import Any, Callable, Dict, IO, Iterable, List, Optional, TypeVar, Union, overload +import urllib.parse + +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + ResourceNotModifiedError, + map_error, +) +from azure.core.paging import ItemPaged +from azure.core.pipeline import PipelineResponse +from azure.core.rest import HttpRequest, HttpResponse +from azure.core.tracing.decorator import distributed_trace +from azure.core.utils import case_insensitive_dict + +from .. import models as _models +from .._model_base import SdkJSONEncoder, _deserialize +from .._serialization import Serializer +from .._vendor import LoadTestAdministrationClientMixinABC, LoadTestRunClientMixinABC + +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports +JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object +T = TypeVar("T") +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, Dict[str, Any]], Any]] + +_SERIALIZER = Serializer() +_SERIALIZER.client_side_validation = False + + +def build_load_test_administration_create_or_update_test_request( # pylint: disable=name-too-long + test_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/tests/{testId}" + path_format_arguments = { + "testId": _SERIALIZER.url("test_id", test_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="PATCH", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_administration_create_or_update_app_components_request( # pylint: disable=name-too-long + test_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("content-type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/tests/{testId}/app-components" + path_format_arguments = { + "testId": _SERIALIZER.url("test_id", test_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if content_type is not None: + _headers["content-type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="PATCH", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_administration_create_or_update_server_metrics_config_request( # pylint: disable=name-too-long + test_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("content-type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/tests/{testId}/server-metrics-config" + path_format_arguments = { + "testId": _SERIALIZER.url("test_id", test_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if content_type is not None: + _headers["content-type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="PATCH", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_administration_get_app_components_request( # pylint: disable=name-too-long + test_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/tests/{testId}/app-components" + path_format_arguments = { + "testId": _SERIALIZER.url("test_id", test_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_administration_get_server_metrics_config_request( # pylint: disable=name-too-long + test_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/tests/{testId}/server-metrics-config" + path_format_arguments = { + "testId": _SERIALIZER.url("test_id", test_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_administration_get_test_request( # pylint: disable=name-too-long + test_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/tests/{testId}" + path_format_arguments = { + "testId": _SERIALIZER.url("test_id", test_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_administration_get_test_file_request( # pylint: disable=name-too-long + test_id: str, file_name: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/tests/{testId}/files/{fileName}" + path_format_arguments = { + "testId": _SERIALIZER.url("test_id", test_id, "str"), + "fileName": _SERIALIZER.url("file_name", file_name, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_administration_list_test_files_request( # pylint: disable=name-too-long + test_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/tests/{testId}/files" + path_format_arguments = { + "testId": _SERIALIZER.url("test_id", test_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_administration_list_tests_request( # pylint: disable=name-too-long + *, + orderby: Optional[str] = None, + search: Optional[str] = None, + last_modified_start_time: Optional[datetime.datetime] = None, + last_modified_end_time: Optional[datetime.datetime] = None, + maxpagesize: Optional[int] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/tests" + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + if orderby is not None: + _params["orderby"] = _SERIALIZER.query("orderby", orderby, "str") + if search is not None: + _params["search"] = _SERIALIZER.query("search", search, "str") + if last_modified_start_time is not None: + _params["lastModifiedStartTime"] = _SERIALIZER.query( + "last_modified_start_time", last_modified_start_time, "iso-8601" + ) + if last_modified_end_time is not None: + _params["lastModifiedEndTime"] = _SERIALIZER.query("last_modified_end_time", last_modified_end_time, "iso-8601") + if maxpagesize is not None: + _params["maxpagesize"] = _SERIALIZER.query("maxpagesize", maxpagesize, "int") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_administration_begin_upload_test_file_request( # pylint: disable=name-too-long + test_id: str, file_name: str, *, file_type: Optional[Union[str, _models.FileType]] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: str = kwargs.pop("content_type") + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/tests/{testId}/files/{fileName}" + path_format_arguments = { + "testId": _SERIALIZER.url("test_id", test_id, "str"), + "fileName": _SERIALIZER.url("file_name", file_name, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + if file_type is not None: + _params["fileType"] = _SERIALIZER.query("file_type", file_type, "str") + + # Construct headers + _headers["content-type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="PUT", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_administration_delete_test_file_request( # pylint: disable=name-too-long + test_id: str, file_name: str, **kwargs: Any +) -> HttpRequest: + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + # Construct URL + _url = "/tests/{testId}/files/{fileName}" + path_format_arguments = { + "testId": _SERIALIZER.url("test_id", test_id, "str"), + "fileName": _SERIALIZER.url("file_name", file_name, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + return HttpRequest(method="DELETE", url=_url, params=_params, **kwargs) + + +def build_load_test_administration_delete_test_request( # pylint: disable=name-too-long + test_id: str, **kwargs: Any +) -> HttpRequest: + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + # Construct URL + _url = "/tests/{testId}" + path_format_arguments = { + "testId": _SERIALIZER.url("test_id", test_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + return HttpRequest(method="DELETE", url=_url, params=_params, **kwargs) + + +def build_load_test_run_begin_test_run_request( # pylint: disable=name-too-long + test_run_id: str, *, old_test_run_id: Optional[str] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/test-runs/{testRunId}" + path_format_arguments = { + "testRunId": _SERIALIZER.url("test_run_id", test_run_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + if old_test_run_id is not None: + _params["oldTestRunId"] = _SERIALIZER.query("old_test_run_id", old_test_run_id, "str") + + # Construct headers + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="PATCH", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_run_create_or_update_app_components_request( # pylint: disable=name-too-long + test_run_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("content-type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/test-runs/{testRunId}/app-components" + path_format_arguments = { + "testRunId": _SERIALIZER.url("test_run_id", test_run_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if content_type is not None: + _headers["content-type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="PATCH", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_run_create_or_update_server_metrics_config_request( # pylint: disable=name-too-long + test_run_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("content-type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/test-runs/{testRunId}/server-metrics-config" + path_format_arguments = { + "testRunId": _SERIALIZER.url("test_run_id", test_run_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + if content_type is not None: + _headers["content-type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="PATCH", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_run_delete_test_run_request( # pylint: disable=name-too-long + test_run_id: str, **kwargs: Any +) -> HttpRequest: + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + # Construct URL + _url = "/test-runs/{testRunId}" + path_format_arguments = { + "testRunId": _SERIALIZER.url("test_run_id", test_run_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + return HttpRequest(method="DELETE", url=_url, params=_params, **kwargs) + + +def build_load_test_run_get_app_components_request( # pylint: disable=name-too-long + test_run_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/test-runs/{testRunId}/app-components" + path_format_arguments = { + "testRunId": _SERIALIZER.url("test_run_id", test_run_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_run_get_server_metrics_config_request( # pylint: disable=name-too-long + test_run_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/test-runs/{testRunId}/server-metrics-config" + path_format_arguments = { + "testRunId": _SERIALIZER.url("test_run_id", test_run_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_run_get_test_run_request(test_run_id: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/test-runs/{testRunId}" + path_format_arguments = { + "testRunId": _SERIALIZER.url("test_run_id", test_run_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_run_get_test_run_file_request( # pylint: disable=name-too-long + test_run_id: str, file_name: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/test-runs/{testRunId}/files/{fileName}" + path_format_arguments = { + "testRunId": _SERIALIZER.url("test_run_id", test_run_id, "str"), + "fileName": _SERIALIZER.url("file_name", file_name, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_run_list_metric_dimension_values_request( # pylint: disable=name-too-long + test_run_id: str, + name: str, + *, + metricname: str, + metric_namespace: str, + time_interval: str, + interval: Optional[Union[str, _models.TimeGrain]] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/test-runs/{testRunId}/metric-dimensions/{name}/values" + path_format_arguments = { + "testRunId": _SERIALIZER.url("test_run_id", test_run_id, "str"), + "name": _SERIALIZER.url("name", name, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + _params["metricname"] = _SERIALIZER.query("metricname", metricname, "str") + if interval is not None: + _params["interval"] = _SERIALIZER.query("interval", interval, "str") + _params["metricNamespace"] = _SERIALIZER.query("metric_namespace", metric_namespace, "str") + _params["timespan"] = _SERIALIZER.query("time_interval", time_interval, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_run_get_metric_definitions_request( # pylint: disable=name-too-long + test_run_id: str, *, metric_namespace: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/test-runs/{testRunId}/metric-definitions" + path_format_arguments = { + "testRunId": _SERIALIZER.url("test_run_id", test_run_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + _params["metricNamespace"] = _SERIALIZER.query("metric_namespace", metric_namespace, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_run_get_metric_namespaces_request( # pylint: disable=name-too-long + test_run_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/test-runs/{testRunId}/metric-namespaces" + path_format_arguments = { + "testRunId": _SERIALIZER.url("test_run_id", test_run_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_run_list_metrics_request( + test_run_id: str, + *, + metricname: str, + metric_namespace: str, + time_interval: str, + aggregation: Optional[str] = None, + interval: Optional[Union[str, _models.TimeGrain]] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/test-runs/{testRunId}/metrics" + path_format_arguments = { + "testRunId": _SERIALIZER.url("test_run_id", test_run_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + if aggregation is not None: + _params["aggregation"] = _SERIALIZER.query("aggregation", aggregation, "str") + _params["metricname"] = _SERIALIZER.query("metricname", metricname, "str") + if interval is not None: + _params["interval"] = _SERIALIZER.query("interval", interval, "str") + _params["metricNamespace"] = _SERIALIZER.query("metric_namespace", metric_namespace, "str") + _params["timespan"] = _SERIALIZER.query("time_interval", time_interval, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + if content_type is not None: + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_run_list_test_runs_request( # pylint: disable=name-too-long + *, + orderby: Optional[str] = None, + search: Optional[str] = None, + test_id: Optional[str] = None, + execution_from: Optional[datetime.datetime] = None, + execution_to: Optional[datetime.datetime] = None, + status: Optional[str] = None, + maxpagesize: Optional[int] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/test-runs" + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + if orderby is not None: + _params["orderby"] = _SERIALIZER.query("orderby", orderby, "str") + if search is not None: + _params["search"] = _SERIALIZER.query("search", search, "str") + if test_id is not None: + _params["testId"] = _SERIALIZER.query("test_id", test_id, "str") + if execution_from is not None: + _params["executionFrom"] = _SERIALIZER.query("execution_from", execution_from, "iso-8601") + if execution_to is not None: + _params["executionTo"] = _SERIALIZER.query("execution_to", execution_to, "iso-8601") + if status is not None: + _params["status"] = _SERIALIZER.query("status", status, "str") + if maxpagesize is not None: + _params["maxpagesize"] = _SERIALIZER.query("maxpagesize", maxpagesize, "int") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_load_test_run_stop_test_run_request( # pylint: disable=name-too-long + test_run_id: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2023-04-01-preview")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/test-runs/{testRunId}:stopTestRun" + path_format_arguments = { + "testRunId": _SERIALIZER.url("test_run_id", test_run_id, "str"), + } + + _url: str = _url.format(**path_format_arguments) # type: ignore + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +class LoadTestAdministrationClientOperationsMixin( # pylint: disable=name-too-long + LoadTestAdministrationClientMixinABC +): + @overload + def create_or_update_test( + self, test_id: str, body: _models.Test, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.Test: + # pylint: disable=line-too-long + """Create a new test or update an existing test by providing the test Id. + + Create a new test or update an existing test by providing the test Id. + + :param test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: The resource instance. Required. + :type body: ~azure.developer.loadtesting.models.Test + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: Test. The Test is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.Test + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "testId": "str", # Unique test identifier for the load test, must contain + only lower-case alphabetic, numeric, underscore or hyphen characters. Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "baselineTestRunId": "str", # Optional. Id of the test run to be marked as + baseline to view trends of client-side metrics from recent test runs. + "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(RFC 3339 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 pairs. + }, + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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. + "kind": "str", # Optional. Kind of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. 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": "str", # Optional. 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. + } + } + }, + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "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. + } + + # response body for status code(s): 201, 200 + response == { + "testId": "str", # Unique test identifier for the load test, must contain + only lower-case alphabetic, numeric, underscore or hyphen characters. Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "baselineTestRunId": "str", # Optional. Id of the test run to be marked as + baseline to view trends of client-side metrics from recent test runs. + "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(RFC 3339 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 pairs. + }, + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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. + "kind": "str", # Optional. Kind of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. 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": "str", # Optional. 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. + } + } + }, + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "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. + } + """ + + @overload + def create_or_update_test( + self, test_id: str, body: JSON, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.Test: + # pylint: disable=line-too-long + """Create a new test or update an existing test by providing the test Id. + + Create a new test or update an existing test by providing the test Id. + + :param test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: The resource instance. Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: Test. The Test is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.Test + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "testId": "str", # Unique test identifier for the load test, must contain + only lower-case alphabetic, numeric, underscore or hyphen characters. Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "baselineTestRunId": "str", # Optional. Id of the test run to be marked as + baseline to view trends of client-side metrics from recent test runs. + "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(RFC 3339 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 pairs. + }, + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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. + "kind": "str", # Optional. Kind of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. 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": "str", # Optional. 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. + } + } + }, + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "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. + } + """ + + @overload + def create_or_update_test( + self, test_id: str, body: IO[bytes], *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.Test: + # pylint: disable=line-too-long + """Create a new test or update an existing test by providing the test Id. + + Create a new test or update an existing test by providing the test Id. + + :param test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: The resource instance. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: Test. The Test is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.Test + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "testId": "str", # Unique test identifier for the load test, must contain + only lower-case alphabetic, numeric, underscore or hyphen characters. Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "baselineTestRunId": "str", # Optional. Id of the test run to be marked as + baseline to view trends of client-side metrics from recent test runs. + "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(RFC 3339 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 pairs. + }, + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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. + "kind": "str", # Optional. Kind of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. 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": "str", # Optional. 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. + } + } + }, + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "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. + } + """ + + @distributed_trace + def create_or_update_test( + self, test_id: str, body: Union[_models.Test, JSON, IO[bytes]], **kwargs: Any + ) -> _models.Test: + # pylint: disable=line-too-long + """Create a new test or update an existing test by providing the test Id. + + Create a new test or update an existing test by providing the test Id. + + :param test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: The resource instance. Is one of the following types: Test, JSON, IO[bytes] + Required. + :type body: ~azure.developer.loadtesting.models.Test or JSON or IO[bytes] + :return: Test. The Test is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.Test + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "testId": "str", # Unique test identifier for the load test, must contain + only lower-case alphabetic, numeric, underscore or hyphen characters. Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "baselineTestRunId": "str", # Optional. Id of the test run to be marked as + baseline to view trends of client-side metrics from recent test runs. + "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(RFC 3339 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 pairs. + }, + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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. + "kind": "str", # Optional. Kind of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. 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": "str", # Optional. 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. + } + } + }, + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "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. + } + + # response body for status code(s): 201, 200 + response == { + "testId": "str", # Unique test identifier for the load test, must contain + only lower-case alphabetic, numeric, underscore or hyphen characters. Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "baselineTestRunId": "str", # Optional. Id of the test run to be marked as + baseline to view trends of client-side metrics from recent test runs. + "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(RFC 3339 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 pairs. + }, + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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. + "kind": "str", # Optional. Kind of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. 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": "str", # Optional. 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. + } + } + }, + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "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. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.Test] = kwargs.pop("cls", None) + + content_type = content_type or "application/merge-patch+json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_load_test_administration_create_or_update_test_request( + test_id=test_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.status_code == 200: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.Test, response.json()) + + if response.status_code == 201: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.Test, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def create_or_update_app_components( + self, + test_id: str, + body: _models.TestAppComponents, + *, + content_type: str = "application/merge-patch+json", + **kwargs: Any + ) -> _models.TestAppComponents: + # pylint: disable=line-too-long + """Add an app component to a test. + + Add an app component to a test by providing the resource Id, name and type. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: App Component model. Required. + :type body: ~azure.developer.loadtesting.models.TestAppComponents + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestAppComponents. The TestAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "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. + "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(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + + # response body for status code(s): 201, 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "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. + "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(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + + @overload + def create_or_update_app_components( + self, test_id: str, body: JSON, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.TestAppComponents: + # pylint: disable=line-too-long + """Add an app component to a test. + + Add an app component to a test by providing the resource Id, name and type. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: App Component model. Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestAppComponents. The TestAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "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. + "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(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + + @overload + def create_or_update_app_components( + self, test_id: str, body: IO[bytes], *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.TestAppComponents: + # pylint: disable=line-too-long + """Add an app component to a test. + + Add an app component to a test by providing the resource Id, name and type. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: App Component model. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestAppComponents. The TestAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "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. + "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(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + + @distributed_trace + def create_or_update_app_components( + self, test_id: str, body: Union[_models.TestAppComponents, JSON, IO[bytes]], **kwargs: Any + ) -> _models.TestAppComponents: + # pylint: disable=line-too-long + """Add an app component to a test. + + Add an app component to a test by providing the resource Id, name and type. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: App Component model. Is one of the following types: TestAppComponents, JSON, + IO[bytes] Required. + :type body: ~azure.developer.loadtesting.models.TestAppComponents or JSON or IO[bytes] + :return: TestAppComponents. The TestAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "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. + "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(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + + # response body for status code(s): 201, 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "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. + "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(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("content-type", None)) + cls: ClsType[_models.TestAppComponents] = kwargs.pop("cls", None) + + content_type = content_type or "application/merge-patch+json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_load_test_administration_create_or_update_app_components_request( + test_id=test_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.status_code == 200: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestAppComponents, response.json()) + + if response.status_code == 201: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestAppComponents, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def create_or_update_server_metrics_config( + self, + test_id: str, + body: _models.TestServerMetricConfig, + *, + content_type: str = "application/merge-patch+json", + **kwargs: Any + ) -> _models.TestServerMetricConfig: + """Configure server metrics for a test. + + Configure server metrics for a test. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: Server metric configuration model. Required. + :type body: ~azure.developer.loadtesting.models.TestServerMetricConfig + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestServerMetricConfig. The TestServerMetricConfig is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "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. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + + # response body for status code(s): 201, 200 + response == { + "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. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + + @overload + def create_or_update_server_metrics_config( + self, test_id: str, body: JSON, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.TestServerMetricConfig: + """Configure server metrics for a test. + + Configure server metrics for a test. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: Server metric configuration model. Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestServerMetricConfig. The TestServerMetricConfig is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "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. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + + @overload + def create_or_update_server_metrics_config( + self, test_id: str, body: IO[bytes], *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.TestServerMetricConfig: + """Configure server metrics for a test. + + Configure server metrics for a test. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: Server metric configuration model. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestServerMetricConfig. The TestServerMetricConfig is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "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. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + + @distributed_trace + def create_or_update_server_metrics_config( + self, test_id: str, body: Union[_models.TestServerMetricConfig, JSON, IO[bytes]], **kwargs: Any + ) -> _models.TestServerMetricConfig: + """Configure server metrics for a test. + + Configure server metrics for a test. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: Server metric configuration model. Is one of the following types: + TestServerMetricConfig, JSON, IO[bytes] Required. + :type body: ~azure.developer.loadtesting.models.TestServerMetricConfig or JSON or IO[bytes] + :return: TestServerMetricConfig. The TestServerMetricConfig is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "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. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + + # response body for status code(s): 201, 200 + response == { + "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. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("content-type", None)) + cls: ClsType[_models.TestServerMetricConfig] = kwargs.pop("cls", None) + + content_type = content_type or "application/merge-patch+json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_load_test_administration_create_or_update_server_metrics_config_request( + test_id=test_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.status_code == 200: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestServerMetricConfig, response.json()) + + if response.status_code == 201: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestServerMetricConfig, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_app_components(self, test_id: str, **kwargs: Any) -> _models.TestAppComponents: + # pylint: disable=line-too-long + """Get associated app component (collection of azure resources) for the given test. + + Get associated app component (collection of azure resources) for the given test. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :return: TestAppComponents. The TestAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "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. + "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(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TestAppComponents] = kwargs.pop("cls", None) + + _request = build_load_test_administration_get_app_components_request( + test_id=test_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestAppComponents, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_server_metrics_config(self, test_id: str, **kwargs: Any) -> _models.TestServerMetricConfig: + """List server metrics configuration for the given test. + + List server metrics configuration for the given test. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :return: TestServerMetricConfig. The TestServerMetricConfig is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "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. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TestServerMetricConfig] = kwargs.pop("cls", None) + + _request = build_load_test_administration_get_server_metrics_config_request( + test_id=test_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestServerMetricConfig, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_test(self, test_id: str, **kwargs: Any) -> _models.Test: + # pylint: disable=line-too-long + """Get load test details by test Id. + + Get load test details by test Id. + + :param test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :type test_id: str + :return: Test. The Test is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.Test + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "testId": "str", # Unique test identifier for the load test, must contain + only lower-case alphabetic, numeric, underscore or hyphen characters. Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "baselineTestRunId": "str", # Optional. Id of the test run to be marked as + baseline to view trends of client-side metrics from recent test runs. + "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(RFC 3339 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 pairs. + }, + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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. + "kind": "str", # Optional. Kind of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. 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": "str", # Optional. 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. + } + } + }, + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "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. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.Test] = kwargs.pop("cls", None) + + _request = build_load_test_administration_get_test_request( + test_id=test_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.Test, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_test_file(self, test_id: str, file_name: str, **kwargs: Any) -> _models.TestFileInfo: + # pylint: disable=line-too-long + """Get all the files that are associated with a test. + + Get all the files that are associated with a test. + + :param test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :type test_id: str + :param file_name: Name of the file. Required. + :type file_name: str + :return: TestFileInfo. The TestFileInfo is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestFileInfo + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry time of the file + (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: "JMX_FILE", + "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "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". + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TestFileInfo] = kwargs.pop("cls", None) + + _request = build_load_test_administration_get_test_file_request( + test_id=test_id, + file_name=file_name, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestFileInfo, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def list_test_files(self, test_id: str, **kwargs: Any) -> Iterable["_models.TestFileInfo"]: + # pylint: disable=line-too-long + """Get all test files. + + Get all test files. + + :param test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :type test_id: str + :return: An iterator like instance of TestFileInfo + :rtype: ~azure.core.paging.ItemPaged[~azure.developer.loadtesting.models.TestFileInfo] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry time of the file + (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: "JMX_FILE", + "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "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". + } + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.TestFileInfo]] = kwargs.pop("cls", None) + + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_load_test_administration_list_test_files_request( + test_id=test_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + return _request + + def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize(List[_models.TestFileInfo], deserialized["value"]) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") or None, iter(list_of_elem) + + def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + return pipeline_response + + return ItemPaged(get_next, extract_data) + + @distributed_trace + def list_tests( + self, + *, + orderby: Optional[str] = None, + search: Optional[str] = None, + last_modified_start_time: Optional[datetime.datetime] = None, + last_modified_end_time: Optional[datetime.datetime] = None, + **kwargs: Any + ) -> Iterable["_models.Test"]: + # pylint: disable=line-too-long + """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}. + + :keyword orderby: Sort on the supported fields in (field asc/desc) format. eg: + lastModifiedDateTime asc. Supported fields - lastModifiedDateTime. Default value is None. + :paramtype orderby: str + :keyword search: 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. + :paramtype search: str + :keyword last_modified_start_time: Start DateTime(RFC 3339 literal format) of the last updated + time range to filter tests. Default value is None. + :paramtype last_modified_start_time: ~datetime.datetime + :keyword last_modified_end_time: End DateTime(RFC 3339 literal format) of the last updated time + range to filter tests. Default value is None. + :paramtype last_modified_end_time: ~datetime.datetime + :return: An iterator like instance of Test + :rtype: ~azure.core.paging.ItemPaged[~azure.developer.loadtesting.models.Test] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "testId": "str", # Unique test identifier for the load test, must contain + only lower-case alphabetic, numeric, underscore or hyphen characters. Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "baselineTestRunId": "str", # Optional. Id of the test run to be marked as + baseline to view trends of client-side metrics from recent test runs. + "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(RFC 3339 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 pairs. + }, + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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. + "kind": "str", # Optional. Kind of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. 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": "str", # Optional. 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. + } + } + }, + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "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. + } + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + maxpagesize = kwargs.pop("maxpagesize", None) + cls: ClsType[List[_models.Test]] = kwargs.pop("cls", None) + + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_load_test_administration_list_tests_request( + orderby=orderby, + search=search, + last_modified_start_time=last_modified_start_time, + last_modified_end_time=last_modified_end_time, + maxpagesize=maxpagesize, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + return _request + + def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize(List[_models.Test], deserialized["value"]) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") or None, iter(list_of_elem) + + def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + return pipeline_response + + return ItemPaged(get_next, extract_data) + + @distributed_trace + def begin_upload_test_file( + self, + test_id: str, + file_name: str, + body: bytes, + *, + file_type: Optional[Union[str, _models.FileType]] = None, + **kwargs: Any + ) -> _models.TestFileInfo: + # pylint: disable=line-too-long + """Upload input file for a given test Id. File size can't be more than 50 MB. + Existing file with same name for the given test will be overwritten. File + should be provided in the request body as application/octet-stream. + + Upload input file for a given test Id. File size can't be more than 50 MB. + Existing file with same name for the given test will be overwritten. File + should be provided in the request body as application/octet-stream. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :param file_name: Unique name for test file with file extension like : App.jmx. Required. + :type file_name: str + :param body: The file content as application/octet-stream. Required. + :type body: bytes + :keyword file_type: File type. Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". Default value is None. + :paramtype file_type: str or ~azure.developer.loadtesting.models.FileType + :return: TestFileInfo. The TestFileInfo is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestFileInfo + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201 + response == { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry time of the file + (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: "JMX_FILE", + "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "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". + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: str = kwargs.pop("content_type", _headers.pop("content-type", "application/octet-stream")) + cls: ClsType[_models.TestFileInfo] = kwargs.pop("cls", None) + + _content = body + + _request = build_load_test_administration_begin_upload_test_file_request( + test_id=test_id, + file_name=file_name, + file_type=file_type, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [201]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestFileInfo, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def delete_test_file( # pylint: disable=inconsistent-return-statements + self, test_id: str, file_name: str, **kwargs: Any + ) -> None: + """Delete file by the file name for a test. + + Delete file by the file name for a test. + + :param test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :type test_id: str + :param file_name: Name of the file. Required. + :type file_name: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_load_test_administration_delete_test_file_request( + test_id=test_id, + file_name=file_name, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @distributed_trace + def delete_test(self, test_id: str, **kwargs: Any) -> None: # pylint: disable=inconsistent-return-statements + """Delete a test by its test Id. + + Delete a test by its test Id. + + :param test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :type test_id: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_load_test_administration_delete_test_request( + test_id=test_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + +class LoadTestRunClientOperationsMixin(LoadTestRunClientMixinABC): + @overload + def begin_test_run( + self, + test_run_id: str, + body: _models.TestRun, + *, + content_type: str = "application/merge-patch+json", + old_test_run_id: Optional[str] = None, + **kwargs: Any + ) -> _models.TestRun: + # pylint: disable=line-too-long + """Create and start a new test run with the given test run Id. + + Create and start a new test run with the given test run Id. + + :param test_run_id: Unique test run identifier for the load test run, must contain only + lower-case alphabetic, numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: The resource instance. Required. + :type body: ~azure.developer.loadtesting.models.TestRun + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :keyword old_test_run_id: Existing test run identifier that should be rerun, if this is + provided, the + test will run with the JMX file, configuration and app components from the + existing test run. You can override the configuration values for new test run + in the request body. Default value is None. + :paramtype old_test_run_id: str + :return: TestRun. The TestRun is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRun + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "testRunId": "str", # Unique test run identifier for the load test run, must + contain only lower-case alphabetic, numeric, underscore or hyphen characters. + Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "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(RFC 3339 literal format). + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a testRun. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(RFC 3339 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "errorDetails": [ + { + "message": "str" # Optional. Error details in case test run + was not successfully run. + } + ], + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "kind": "str", # Optional. Type of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. 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": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(RFC 3339 literal format). + "status": "str", # Optional. The test run status. Known values are: + "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", + "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", + "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. + Required. + "expireDateTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. + Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + }, + "outputArtifacts": { + "artifactsContainerInfo": { + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the container (RFC 3339 literal format). + "url": "str" # Optional. This is a SAS URI to an + Azure Storage Container that contains the test run artifacts. + }, + "logsFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "resultFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED". + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Send network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "virtualUsers": 0 # Optional. Number of virtual users, for which test has + been run. + } + + # response body for status code(s): 201, 200 + response == { + "testRunId": "str", # Unique test run identifier for the load test run, must + contain only lower-case alphabetic, numeric, underscore or hyphen characters. + Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "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(RFC 3339 literal format). + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a testRun. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(RFC 3339 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "errorDetails": [ + { + "message": "str" # Optional. Error details in case test run + was not successfully run. + } + ], + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "kind": "str", # Optional. Type of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. 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": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(RFC 3339 literal format). + "status": "str", # Optional. The test run status. Known values are: + "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", + "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", + "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. + Required. + "expireDateTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. + Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + }, + "outputArtifacts": { + "artifactsContainerInfo": { + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the container (RFC 3339 literal format). + "url": "str" # Optional. This is a SAS URI to an + Azure Storage Container that contains the test run artifacts. + }, + "logsFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "resultFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED". + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Send network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "virtualUsers": 0 # Optional. Number of virtual users, for which test has + been run. + } + """ + + @overload + def begin_test_run( + self, + test_run_id: str, + body: JSON, + *, + content_type: str = "application/merge-patch+json", + old_test_run_id: Optional[str] = None, + **kwargs: Any + ) -> _models.TestRun: + # pylint: disable=line-too-long + """Create and start a new test run with the given test run Id. + + Create and start a new test run with the given test run Id. + + :param test_run_id: Unique test run identifier for the load test run, must contain only + lower-case alphabetic, numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: The resource instance. Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :keyword old_test_run_id: Existing test run identifier that should be rerun, if this is + provided, the + test will run with the JMX file, configuration and app components from the + existing test run. You can override the configuration values for new test run + in the request body. Default value is None. + :paramtype old_test_run_id: str + :return: TestRun. The TestRun is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRun + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "testRunId": "str", # Unique test run identifier for the load test run, must + contain only lower-case alphabetic, numeric, underscore or hyphen characters. + Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "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(RFC 3339 literal format). + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a testRun. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(RFC 3339 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "errorDetails": [ + { + "message": "str" # Optional. Error details in case test run + was not successfully run. + } + ], + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "kind": "str", # Optional. Type of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. 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": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(RFC 3339 literal format). + "status": "str", # Optional. The test run status. Known values are: + "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", + "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", + "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. + Required. + "expireDateTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. + Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + }, + "outputArtifacts": { + "artifactsContainerInfo": { + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the container (RFC 3339 literal format). + "url": "str" # Optional. This is a SAS URI to an + Azure Storage Container that contains the test run artifacts. + }, + "logsFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "resultFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED". + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Send network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "virtualUsers": 0 # Optional. Number of virtual users, for which test has + been run. + } + """ + + @overload + def begin_test_run( + self, + test_run_id: str, + body: IO[bytes], + *, + content_type: str = "application/merge-patch+json", + old_test_run_id: Optional[str] = None, + **kwargs: Any + ) -> _models.TestRun: + # pylint: disable=line-too-long + """Create and start a new test run with the given test run Id. + + Create and start a new test run with the given test run Id. + + :param test_run_id: Unique test run identifier for the load test run, must contain only + lower-case alphabetic, numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: The resource instance. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :keyword old_test_run_id: Existing test run identifier that should be rerun, if this is + provided, the + test will run with the JMX file, configuration and app components from the + existing test run. You can override the configuration values for new test run + in the request body. Default value is None. + :paramtype old_test_run_id: str + :return: TestRun. The TestRun is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRun + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "testRunId": "str", # Unique test run identifier for the load test run, must + contain only lower-case alphabetic, numeric, underscore or hyphen characters. + Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "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(RFC 3339 literal format). + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a testRun. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(RFC 3339 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "errorDetails": [ + { + "message": "str" # Optional. Error details in case test run + was not successfully run. + } + ], + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "kind": "str", # Optional. Type of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. 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": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(RFC 3339 literal format). + "status": "str", # Optional. The test run status. Known values are: + "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", + "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", + "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. + Required. + "expireDateTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. + Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + }, + "outputArtifacts": { + "artifactsContainerInfo": { + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the container (RFC 3339 literal format). + "url": "str" # Optional. This is a SAS URI to an + Azure Storage Container that contains the test run artifacts. + }, + "logsFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "resultFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED". + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Send network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "virtualUsers": 0 # Optional. Number of virtual users, for which test has + been run. + } + """ + + @distributed_trace + def begin_test_run( + self, + test_run_id: str, + body: Union[_models.TestRun, JSON, IO[bytes]], + *, + old_test_run_id: Optional[str] = None, + **kwargs: Any + ) -> _models.TestRun: + # pylint: disable=line-too-long + """Create and start a new test run with the given test run Id. + + Create and start a new test run with the given test run Id. + + :param test_run_id: Unique test run identifier for the load test run, must contain only + lower-case alphabetic, numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: The resource instance. Is one of the following types: TestRun, JSON, IO[bytes] + Required. + :type body: ~azure.developer.loadtesting.models.TestRun or JSON or IO[bytes] + :keyword old_test_run_id: Existing test run identifier that should be rerun, if this is + provided, the + test will run with the JMX file, configuration and app components from the + existing test run. You can override the configuration values for new test run + in the request body. Default value is None. + :paramtype old_test_run_id: str + :return: TestRun. The TestRun is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRun + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "testRunId": "str", # Unique test run identifier for the load test run, must + contain only lower-case alphabetic, numeric, underscore or hyphen characters. + Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "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(RFC 3339 literal format). + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a testRun. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(RFC 3339 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "errorDetails": [ + { + "message": "str" # Optional. Error details in case test run + was not successfully run. + } + ], + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "kind": "str", # Optional. Type of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. 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": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(RFC 3339 literal format). + "status": "str", # Optional. The test run status. Known values are: + "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", + "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", + "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. + Required. + "expireDateTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. + Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + }, + "outputArtifacts": { + "artifactsContainerInfo": { + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the container (RFC 3339 literal format). + "url": "str" # Optional. This is a SAS URI to an + Azure Storage Container that contains the test run artifacts. + }, + "logsFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "resultFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED". + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Send network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "virtualUsers": 0 # Optional. Number of virtual users, for which test has + been run. + } + + # response body for status code(s): 201, 200 + response == { + "testRunId": "str", # Unique test run identifier for the load test run, must + contain only lower-case alphabetic, numeric, underscore or hyphen characters. + Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "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(RFC 3339 literal format). + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a testRun. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(RFC 3339 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "errorDetails": [ + { + "message": "str" # Optional. Error details in case test run + was not successfully run. + } + ], + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "kind": "str", # Optional. Type of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. 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": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(RFC 3339 literal format). + "status": "str", # Optional. The test run status. Known values are: + "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", + "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", + "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. + Required. + "expireDateTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. + Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + }, + "outputArtifacts": { + "artifactsContainerInfo": { + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the container (RFC 3339 literal format). + "url": "str" # Optional. This is a SAS URI to an + Azure Storage Container that contains the test run artifacts. + }, + "logsFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "resultFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED". + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Send network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "virtualUsers": 0 # Optional. Number of virtual users, for which test has + been run. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.TestRun] = kwargs.pop("cls", None) + + content_type = content_type or "application/merge-patch+json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_load_test_run_begin_test_run_request( + test_run_id=test_run_id, + old_test_run_id=old_test_run_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.status_code == 200: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRun, response.json()) + + if response.status_code == 201: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRun, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def create_or_update_app_components( + self, + test_run_id: str, + body: _models.TestRunAppComponents, + *, + content_type: str = "application/merge-patch+json", + **kwargs: Any + ) -> _models.TestRunAppComponents: + # pylint: disable=line-too-long + """Add an app component to a test run. + + Add an app component to a test run by providing the resource Id, name and type. + + :param test_run_id: Unique Id for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: App Component model. Required. + :type body: ~azure.developer.loadtesting.models.TestRunAppComponents + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestRunAppComponents. The TestRunAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "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. + "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(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testRunId": "str" # Optional. Test run identifier. + } + + # response body for status code(s): 201, 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "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. + "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(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testRunId": "str" # Optional. Test run identifier. + } + """ + + @overload + def create_or_update_app_components( + self, test_run_id: str, body: JSON, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.TestRunAppComponents: + # pylint: disable=line-too-long + """Add an app component to a test run. + + Add an app component to a test run by providing the resource Id, name and type. + + :param test_run_id: Unique Id for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: App Component model. Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestRunAppComponents. The TestRunAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "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. + "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(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testRunId": "str" # Optional. Test run identifier. + } + """ + + @overload + def create_or_update_app_components( + self, test_run_id: str, body: IO[bytes], *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.TestRunAppComponents: + # pylint: disable=line-too-long + """Add an app component to a test run. + + Add an app component to a test run by providing the resource Id, name and type. + + :param test_run_id: Unique Id for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: App Component model. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestRunAppComponents. The TestRunAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "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. + "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(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testRunId": "str" # Optional. Test run identifier. + } + """ + + @distributed_trace + def create_or_update_app_components( + self, test_run_id: str, body: Union[_models.TestRunAppComponents, JSON, IO[bytes]], **kwargs: Any + ) -> _models.TestRunAppComponents: + # pylint: disable=line-too-long + """Add an app component to a test run. + + Add an app component to a test run by providing the resource Id, name and type. + + :param test_run_id: Unique Id for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: App Component model. Is one of the following types: TestRunAppComponents, JSON, + IO[bytes] Required. + :type body: ~azure.developer.loadtesting.models.TestRunAppComponents or JSON or IO[bytes] + :return: TestRunAppComponents. The TestRunAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "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. + "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(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testRunId": "str" # Optional. Test run identifier. + } + + # response body for status code(s): 201, 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "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. + "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(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testRunId": "str" # Optional. Test run identifier. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("content-type", None)) + cls: ClsType[_models.TestRunAppComponents] = kwargs.pop("cls", None) + + content_type = content_type or "application/merge-patch+json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_load_test_run_create_or_update_app_components_request( + test_run_id=test_run_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.status_code == 200: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRunAppComponents, response.json()) + + if response.status_code == 201: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRunAppComponents, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def create_or_update_server_metrics_config( + self, + test_run_id: str, + body: _models.TestRunServerMetricConfig, + *, + content_type: str = "application/merge-patch+json", + **kwargs: Any + ) -> _models.TestRunServerMetricConfig: + """Configure server metrics for a test run. + + Configure server metrics for a test run. + + :param test_run_id: Unique Id for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: Server metric configuration model. Required. + :type body: ~azure.developer.loadtesting.models.TestRunServerMetricConfig + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestRunServerMetricConfig. The TestRunServerMetricConfig is compatible with + MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # 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(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "testRunId": "str" # Optional. Test run identifier. + } + + # response body for status code(s): 201, 200 + response == { + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "testRunId": "str" # Optional. Test run identifier. + } + """ + + @overload + def create_or_update_server_metrics_config( + self, test_run_id: str, body: JSON, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.TestRunServerMetricConfig: + """Configure server metrics for a test run. + + Configure server metrics for a test run. + + :param test_run_id: Unique Id for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: Server metric configuration model. Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestRunServerMetricConfig. The TestRunServerMetricConfig is compatible with + MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "testRunId": "str" # Optional. Test run identifier. + } + """ + + @overload + def create_or_update_server_metrics_config( + self, test_run_id: str, body: IO[bytes], *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.TestRunServerMetricConfig: + """Configure server metrics for a test run. + + Configure server metrics for a test run. + + :param test_run_id: Unique Id for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: Server metric configuration model. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestRunServerMetricConfig. The TestRunServerMetricConfig is compatible with + MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "testRunId": "str" # Optional. Test run identifier. + } + """ + + @distributed_trace + def create_or_update_server_metrics_config( + self, test_run_id: str, body: Union[_models.TestRunServerMetricConfig, JSON, IO[bytes]], **kwargs: Any + ) -> _models.TestRunServerMetricConfig: + """Configure server metrics for a test run. + + Configure server metrics for a test run. + + :param test_run_id: Unique Id for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: Server metric configuration model. Is one of the following types: + TestRunServerMetricConfig, JSON, IO[bytes] Required. + :type body: ~azure.developer.loadtesting.models.TestRunServerMetricConfig or JSON or IO[bytes] + :return: TestRunServerMetricConfig. The TestRunServerMetricConfig is compatible with + MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # 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(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "testRunId": "str" # Optional. Test run identifier. + } + + # response body for status code(s): 201, 200 + response == { + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "testRunId": "str" # Optional. Test run identifier. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("content-type", None)) + cls: ClsType[_models.TestRunServerMetricConfig] = kwargs.pop("cls", None) + + content_type = content_type or "application/merge-patch+json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_load_test_run_create_or_update_server_metrics_config_request( + test_run_id=test_run_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.status_code == 200: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRunServerMetricConfig, response.json()) + + if response.status_code == 201: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRunServerMetricConfig, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def delete_test_run( # pylint: disable=inconsistent-return-statements + self, test_run_id: str, **kwargs: Any + ) -> None: + """Delete an existing load test run. + + Delete an existing load test run by providing the testRunId. + + :param test_run_id: Unique test run identifier for the load test run, must contain only + lower-case alphabetic, numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_load_test_run_delete_test_run_request( + test_run_id=test_run_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @distributed_trace + def get_app_components(self, test_run_id: str, **kwargs: Any) -> _models.TestRunAppComponents: + # pylint: disable=line-too-long + """Get associated app component (collection of azure resources) for the given test + run. + + Get associated app component (collection of azure resources) for the given test + run. + + :param test_run_id: Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :return: TestRunAppComponents. The TestRunAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "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. + "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(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testRunId": "str" # Optional. Test run identifier. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TestRunAppComponents] = kwargs.pop("cls", None) + + _request = build_load_test_run_get_app_components_request( + test_run_id=test_run_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRunAppComponents, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_server_metrics_config(self, test_run_id: str, **kwargs: Any) -> _models.TestRunServerMetricConfig: + """Get associated server metrics configuration for the given test run. + + Get associated server metrics configuration for the given test run. + + :param test_run_id: Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :return: TestRunServerMetricConfig. The TestRunServerMetricConfig is compatible with + MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # 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(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "testRunId": "str" # Optional. Test run identifier. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TestRunServerMetricConfig] = kwargs.pop("cls", None) + + _request = build_load_test_run_get_server_metrics_config_request( + test_run_id=test_run_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRunServerMetricConfig, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_test_run(self, test_run_id: str, **kwargs: Any) -> _models.TestRun: + # pylint: disable=line-too-long + """Get test run details by test run Id. + + Get test run details by test run Id. + + :param test_run_id: Unique test run identifier for the load test run, must contain only + lower-case alphabetic, numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :return: TestRun. The TestRun is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRun + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "testRunId": "str", # Unique test run identifier for the load test run, must + contain only lower-case alphabetic, numeric, underscore or hyphen characters. + Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "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(RFC 3339 literal format). + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a testRun. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(RFC 3339 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "errorDetails": [ + { + "message": "str" # Optional. Error details in case test run + was not successfully run. + } + ], + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "kind": "str", # Optional. Type of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. 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": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(RFC 3339 literal format). + "status": "str", # Optional. The test run status. Known values are: + "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", + "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", + "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. + Required. + "expireDateTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. + Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + }, + "outputArtifacts": { + "artifactsContainerInfo": { + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the container (RFC 3339 literal format). + "url": "str" # Optional. This is a SAS URI to an + Azure Storage Container that contains the test run artifacts. + }, + "logsFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "resultFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED". + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Send network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "virtualUsers": 0 # Optional. Number of virtual users, for which test has + been run. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TestRun] = kwargs.pop("cls", None) + + _request = build_load_test_run_get_test_run_request( + test_run_id=test_run_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRun, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_test_run_file(self, test_run_id: str, file_name: str, **kwargs: Any) -> _models.TestRunFileInfo: + # pylint: disable=line-too-long + """Get test run file by file name. + + Get test run file by file name. + + :param test_run_id: Unique test run identifier for the load test run, must contain only + lower-case alphabetic, numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param file_name: Name of the file. Required. + :type file_name: str + :return: TestRunFileInfo. The TestRunFileInfo is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunFileInfo + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry time of the file + (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: "JMX_FILE", + "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "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". + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TestRunFileInfo] = kwargs.pop("cls", None) + + _request = build_load_test_run_get_test_run_file_request( + test_run_id=test_run_id, + file_name=file_name, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRunFileInfo, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def list_metric_dimension_values( + self, + test_run_id: str, + name: str, + *, + metricname: str, + metric_namespace: str, + time_interval: str, + interval: Optional[Union[str, _models.TimeGrain]] = None, + **kwargs: Any + ) -> _models.DimensionValueList: + """List the dimension values for the given metric dimension name. + + List the dimension values for the given metric dimension name. + + :param test_run_id: Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param name: Dimension name. Required. + :type name: str + :keyword metricname: Metric name. Required. + :paramtype metricname: str + :keyword metric_namespace: Metric namespace to query metric definitions for. Required. + :paramtype metric_namespace: str + :keyword time_interval: The timespan of the query. It is a string with the following format + 'startDateTime_ISO/endDateTime_ISO'. Required. + :paramtype time_interval: str + :keyword interval: The interval (i.e. timegrain) of the query. Known values are: "PT5S", + "PT10S", "PT1M", "PT5M", and "PT1H". Default value is None. + :paramtype interval: str or ~azure.developer.loadtesting.models.TimeGrain + :return: DimensionValueList. The DimensionValueList is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.DimensionValueList + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "name": "str", # Optional. The dimension name. + "nextLink": "str", # Optional. Link for the next set of values in case of + paginated results, if applicable. + "value": [ + "str" # Optional. The dimension value. + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.DimensionValueList] = kwargs.pop("cls", None) + + _request = build_load_test_run_list_metric_dimension_values_request( + test_run_id=test_run_id, + name=name, + metricname=metricname, + metric_namespace=metric_namespace, + time_interval=time_interval, + interval=interval, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.DimensionValueList, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_metric_definitions( + self, test_run_id: str, *, metric_namespace: str, **kwargs: Any + ) -> _models.MetricDefinitionCollection: + # pylint: disable=line-too-long + """List the metric definitions for a load test run. + + List the metric definitions for a load test run. + + :param test_run_id: Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :keyword metric_namespace: Metric namespace to query metric definitions for. Required. + :paramtype metric_namespace: str + :return: MetricDefinitionCollection. The MetricDefinitionCollection is compatible with + MutableMapping + :rtype: ~azure.developer.loadtesting.models.MetricDefinitionCollection + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "value": [ + { + "description": "str", # Optional. The metric description. + "dimensions": [ + { + "description": "str", # Optional. The + description. + "name": "str" # Optional. The name. + } + ], + "metricAvailabilities": [ + { + "timeGrain": "str" # Optional. The time + grain specifies the aggregation interval for the metric. + Expressed as a duration 'PT1M', 'PT1H', etc. Known values are: + "PT5S", "PT10S", "PT1M", "PT5M", and "PT1H". + } + ], + "name": "str", # Optional. The metric name. + "namespace": "str", # Optional. The namespace the metric + belongs to. + "primaryAggregationType": "str", # Optional. The primary + aggregation type value defining how to use the values for display. Known + values are: "Average", "Count", "None", "Total", "Percentile90", + "Percentile95", and "Percentile99". + "supportedAggregationTypes": [ + "str" # Optional. The collection of what all + aggregation types are supported. + ], + "unit": "str" # Optional. The unit of the metric. Known + values are: "NotSpecified", "Percent", "Count", "Seconds", + "Milliseconds", "Bytes", "BytesPerSecond", and "CountPerSecond". + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.MetricDefinitionCollection] = kwargs.pop("cls", None) + + _request = build_load_test_run_get_metric_definitions_request( + test_run_id=test_run_id, + metric_namespace=metric_namespace, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.MetricDefinitionCollection, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_metric_namespaces(self, test_run_id: str, **kwargs: Any) -> _models.MetricNamespaceCollection: + """List the metric namespaces for a load test run. + + List the metric namespaces for a load test run. + + :param test_run_id: Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :return: MetricNamespaceCollection. The MetricNamespaceCollection is compatible with + MutableMapping + :rtype: ~azure.developer.loadtesting.models.MetricNamespaceCollection + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "value": [ + { + "description": "str", # Optional. The namespace description. + "name": "str" # Optional. The metric namespace name. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.MetricNamespaceCollection] = kwargs.pop("cls", None) + + _request = build_load_test_run_get_metric_namespaces_request( + test_run_id=test_run_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.MetricNamespaceCollection, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def list_metrics( + self, + test_run_id: str, + body: Optional[_models.MetricRequestPayload] = None, + *, + metricname: str, + metric_namespace: str, + time_interval: str, + aggregation: Optional[str] = None, + interval: Optional[Union[str, _models.TimeGrain]] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> Iterable["_models.TimeSeriesElement"]: + """List the metric values for a load test run. + + List the metric values for a load test run. + + :param test_run_id: Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: Metric dimension filter. Default value is None. + :type body: ~azure.developer.loadtesting.models.MetricRequestPayload + :keyword metricname: Metric name. Required. + :paramtype metricname: str + :keyword metric_namespace: Metric namespace to query metric definitions for. Required. + :paramtype metric_namespace: str + :keyword time_interval: The timespan of the query. It is a string with the following format + 'startDateTime_ISO/endDateTime_ISO'. Required. + :paramtype time_interval: str + :keyword aggregation: The aggregation. Default value is None. + :paramtype aggregation: str + :keyword interval: The interval (i.e. timegrain) of the query. Known values are: "PT5S", + "PT10S", "PT1M", "PT5M", and "PT1H". Default value is None. + :paramtype interval: str or ~azure.developer.loadtesting.models.TimeGrain + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An iterator like instance of TimeSeriesElement + :rtype: ~azure.core.paging.ItemPaged[~azure.developer.loadtesting.models.TimeSeriesElement] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "filters": [ + { + "name": "str", # Optional. The dimension name. + "values": [ + "str" # Optional. The dimension values. Maximum + values can be 20. + ] + } + ] + } + + # response body for status code(s): 200 + response == { + "data": [ + { + "timestamp": "2020-02-20 00:00:00", # Optional. The + timestamp for the metric value in RFC 3339 format. + "value": 0.0 # Optional. The metric value. + } + ], + "dimensionValues": [ + { + "name": "str", # Optional. The name of the dimension. + "value": "str" # Optional. The value of the dimension. + } + ] + } + """ + + @overload + def list_metrics( + self, + test_run_id: str, + body: Optional[JSON] = None, + *, + metricname: str, + metric_namespace: str, + time_interval: str, + aggregation: Optional[str] = None, + interval: Optional[Union[str, _models.TimeGrain]] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> Iterable["_models.TimeSeriesElement"]: + """List the metric values for a load test run. + + List the metric values for a load test run. + + :param test_run_id: Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: Metric dimension filter. Default value is None. + :type body: JSON + :keyword metricname: Metric name. Required. + :paramtype metricname: str + :keyword metric_namespace: Metric namespace to query metric definitions for. Required. + :paramtype metric_namespace: str + :keyword time_interval: The timespan of the query. It is a string with the following format + 'startDateTime_ISO/endDateTime_ISO'. Required. + :paramtype time_interval: str + :keyword aggregation: The aggregation. Default value is None. + :paramtype aggregation: str + :keyword interval: The interval (i.e. timegrain) of the query. Known values are: "PT5S", + "PT10S", "PT1M", "PT5M", and "PT1H". Default value is None. + :paramtype interval: str or ~azure.developer.loadtesting.models.TimeGrain + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An iterator like instance of TimeSeriesElement + :rtype: ~azure.core.paging.ItemPaged[~azure.developer.loadtesting.models.TimeSeriesElement] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "data": [ + { + "timestamp": "2020-02-20 00:00:00", # Optional. The + timestamp for the metric value in RFC 3339 format. + "value": 0.0 # Optional. The metric value. + } + ], + "dimensionValues": [ + { + "name": "str", # Optional. The name of the dimension. + "value": "str" # Optional. The value of the dimension. + } + ] + } + """ + + @overload + def list_metrics( + self, + test_run_id: str, + body: Optional[IO[bytes]] = None, + *, + metricname: str, + metric_namespace: str, + time_interval: str, + aggregation: Optional[str] = None, + interval: Optional[Union[str, _models.TimeGrain]] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> Iterable["_models.TimeSeriesElement"]: + """List the metric values for a load test run. + + List the metric values for a load test run. + + :param test_run_id: Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: Metric dimension filter. Default value is None. + :type body: IO[bytes] + :keyword metricname: Metric name. Required. + :paramtype metricname: str + :keyword metric_namespace: Metric namespace to query metric definitions for. Required. + :paramtype metric_namespace: str + :keyword time_interval: The timespan of the query. It is a string with the following format + 'startDateTime_ISO/endDateTime_ISO'. Required. + :paramtype time_interval: str + :keyword aggregation: The aggregation. Default value is None. + :paramtype aggregation: str + :keyword interval: The interval (i.e. timegrain) of the query. Known values are: "PT5S", + "PT10S", "PT1M", "PT5M", and "PT1H". Default value is None. + :paramtype interval: str or ~azure.developer.loadtesting.models.TimeGrain + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An iterator like instance of TimeSeriesElement + :rtype: ~azure.core.paging.ItemPaged[~azure.developer.loadtesting.models.TimeSeriesElement] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "data": [ + { + "timestamp": "2020-02-20 00:00:00", # Optional. The + timestamp for the metric value in RFC 3339 format. + "value": 0.0 # Optional. The metric value. + } + ], + "dimensionValues": [ + { + "name": "str", # Optional. The name of the dimension. + "value": "str" # Optional. The value of the dimension. + } + ] + } + """ + + @distributed_trace + def list_metrics( + self, + test_run_id: str, + body: Optional[Union[_models.MetricRequestPayload, JSON, IO[bytes]]] = None, + *, + metricname: str, + metric_namespace: str, + time_interval: str, + aggregation: Optional[str] = None, + interval: Optional[Union[str, _models.TimeGrain]] = None, + **kwargs: Any + ) -> Iterable["_models.TimeSeriesElement"]: + """List the metric values for a load test run. + + List the metric values for a load test run. + + :param test_run_id: Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: Metric dimension filter. Is one of the following types: MetricRequestPayload, + JSON, IO[bytes] Default value is None. + :type body: ~azure.developer.loadtesting.models.MetricRequestPayload or JSON or IO[bytes] + :keyword metricname: Metric name. Required. + :paramtype metricname: str + :keyword metric_namespace: Metric namespace to query metric definitions for. Required. + :paramtype metric_namespace: str + :keyword time_interval: The timespan of the query. It is a string with the following format + 'startDateTime_ISO/endDateTime_ISO'. Required. + :paramtype time_interval: str + :keyword aggregation: The aggregation. Default value is None. + :paramtype aggregation: str + :keyword interval: The interval (i.e. timegrain) of the query. Known values are: "PT5S", + "PT10S", "PT1M", "PT5M", and "PT1H". Default value is None. + :paramtype interval: str or ~azure.developer.loadtesting.models.TimeGrain + :return: An iterator like instance of TimeSeriesElement + :rtype: ~azure.core.paging.ItemPaged[~azure.developer.loadtesting.models.TimeSeriesElement] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "filters": [ + { + "name": "str", # Optional. The dimension name. + "values": [ + "str" # Optional. The dimension values. Maximum + values can be 20. + ] + } + ] + } + + # response body for status code(s): 200 + response == { + "data": [ + { + "timestamp": "2020-02-20 00:00:00", # Optional. The + timestamp for the metric value in RFC 3339 format. + "value": 0.0 # Optional. The metric value. + } + ], + "dimensionValues": [ + { + "name": "str", # Optional. The name of the dimension. + "value": "str" # Optional. The value of the dimension. + } + ] + } + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[List[_models.TimeSeriesElement]] = kwargs.pop("cls", None) + + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + if body is not None: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + else: + _content = None + + def prepare_request(next_link=None): + if not next_link: + + _request = build_load_test_run_list_metrics_request( + test_run_id=test_run_id, + metricname=metricname, + metric_namespace=metric_namespace, + time_interval=time_interval, + aggregation=aggregation, + interval=interval, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + return _request + + def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize(List[_models.TimeSeriesElement], deserialized["value"]) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") or None, iter(list_of_elem) + + def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + return pipeline_response + + return ItemPaged(get_next, extract_data) + + @distributed_trace + def list_test_runs( + self, + *, + orderby: Optional[str] = None, + search: Optional[str] = None, + test_id: Optional[str] = None, + execution_from: Optional[datetime.datetime] = None, + execution_to: Optional[datetime.datetime] = None, + status: Optional[str] = None, + **kwargs: Any + ) -> Iterable["_models.TestRun"]: + # pylint: disable=line-too-long + """Get all test runs for the given filters. + + Get all test runs for the given filters. + + :keyword orderby: Sort on the supported fields in (field asc/desc) format. eg: executedDateTime + asc. Supported fields - executedDateTime. Default value is None. + :paramtype orderby: str + :keyword search: Prefix based, case sensitive search on searchable fields - description, + executedUser. For example, to search for a test run, with description 500 VUs, + the search parameter can be 500. Default value is None. + :paramtype search: str + :keyword test_id: Unique name of an existing load test. Default value is None. + :paramtype test_id: str + :keyword execution_from: Start DateTime(RFC 3339 literal format) of test-run execution time + filter range. Default value is None. + :paramtype execution_from: ~datetime.datetime + :keyword execution_to: End DateTime(RFC 3339 literal format) of test-run execution time filter + range. Default value is None. + :paramtype execution_to: ~datetime.datetime + :keyword status: Comma separated list of test run status. Default value is None. + :paramtype status: str + :return: An iterator like instance of TestRun + :rtype: ~azure.core.paging.ItemPaged[~azure.developer.loadtesting.models.TestRun] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "testRunId": "str", # Unique test run identifier for the load test run, must + contain only lower-case alphabetic, numeric, underscore or hyphen characters. + Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "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(RFC 3339 literal format). + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a testRun. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(RFC 3339 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "errorDetails": [ + { + "message": "str" # Optional. Error details in case test run + was not successfully run. + } + ], + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "kind": "str", # Optional. Type of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. 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": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(RFC 3339 literal format). + "status": "str", # Optional. The test run status. Known values are: + "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", + "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", + "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. + Required. + "expireDateTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. + Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + }, + "outputArtifacts": { + "artifactsContainerInfo": { + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the container (RFC 3339 literal format). + "url": "str" # Optional. This is a SAS URI to an + Azure Storage Container that contains the test run artifacts. + }, + "logsFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "resultFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED". + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Send network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "virtualUsers": 0 # Optional. Number of virtual users, for which test has + been run. + } + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + maxpagesize = kwargs.pop("maxpagesize", None) + cls: ClsType[List[_models.TestRun]] = kwargs.pop("cls", None) + + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_load_test_run_list_test_runs_request( + orderby=orderby, + search=search, + test_id=test_id, + execution_from=execution_from, + execution_to=execution_to, + status=status, + maxpagesize=maxpagesize, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + return _request + + def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize(List[_models.TestRun], deserialized["value"]) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") or None, iter(list_of_elem) + + def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + return pipeline_response + + return ItemPaged(get_next, extract_data) + + @distributed_trace + def stop_test_run(self, test_run_id: str, **kwargs: Any) -> _models.TestRun: + # pylint: disable=line-too-long + """Stop test run by test run Id. + + Stop test run by test run Id. + + :param test_run_id: Unique test run identifier for the load test run, must contain only + lower-case alphabetic, numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :return: TestRun. The TestRun is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRun + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "testRunId": "str", # Unique test run identifier for the load test run, must + contain only lower-case alphabetic, numeric, underscore or hyphen characters. + Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "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(RFC 3339 literal format). + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a testRun. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(RFC 3339 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "errorDetails": [ + { + "message": "str" # Optional. Error details in case test run + was not successfully run. + } + ], + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "kind": "str", # Optional. Type of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. 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": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(RFC 3339 literal format). + "status": "str", # Optional. The test run status. Known values are: + "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", + "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", + "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. + Required. + "expireDateTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. + Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + }, + "outputArtifacts": { + "artifactsContainerInfo": { + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the container (RFC 3339 literal format). + "url": "str" # Optional. This is a SAS URI to an + Azure Storage Container that contains the test run artifacts. + }, + "logsFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "resultFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED". + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Send network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "virtualUsers": 0 # Optional. Number of virtual users, for which test has + been run. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TestRun] = kwargs.pop("cls", None) + + _request = build_load_test_run_stop_test_run_request( + test_run_id=test_run_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRun, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_operations/_patch.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_operations/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_operations/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_patch.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_serialization.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_serialization.py new file mode 100644 index 000000000000..2f781d740827 --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_serialization.py @@ -0,0 +1,1998 @@ +# -------------------------------------------------------------------------- +# +# Copyright (c) Microsoft Corporation. All rights reserved. +# +# The MIT License (MIT) +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the ""Software""), to +# deal in the Software without restriction, including without limitation the +# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or +# sell copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS +# IN THE SOFTWARE. +# +# -------------------------------------------------------------------------- + +# pylint: skip-file +# pyright: reportUnnecessaryTypeIgnoreComment=false + +from base64 import b64decode, b64encode +import calendar +import datetime +import decimal +import email +from enum import Enum +import json +import logging +import re +import sys +import codecs +from typing import ( + Dict, + Any, + cast, + Optional, + Union, + AnyStr, + IO, + Mapping, + Callable, + TypeVar, + MutableMapping, + Type, + List, + Mapping, +) + +try: + from urllib import quote # type: ignore +except ImportError: + from urllib.parse import quote +import xml.etree.ElementTree as ET + +import isodate # type: ignore + +from azure.core.exceptions import DeserializationError, SerializationError +from azure.core.serialization import NULL as CoreNull + +_BOM = codecs.BOM_UTF8.decode(encoding="utf-8") + +ModelType = TypeVar("ModelType", bound="Model") +JSON = MutableMapping[str, Any] + + +class RawDeserializer: + + # Accept "text" because we're open minded people... + JSON_REGEXP = re.compile(r"^(application|text)/([a-z+.]+\+)?json$") + + # Name used in context + CONTEXT_NAME = "deserialized_data" + + @classmethod + def deserialize_from_text(cls, data: Optional[Union[AnyStr, IO]], content_type: Optional[str] = None) -> Any: + """Decode data according to content-type. + + Accept a stream of data as well, but will be load at once in memory for now. + + If no content-type, will return the string version (not bytes, not stream) + + :param data: Input, could be bytes or stream (will be decoded with UTF8) or text + :type data: str or bytes or IO + :param str content_type: The content type. + """ + if hasattr(data, "read"): + # Assume a stream + data = cast(IO, data).read() + + if isinstance(data, bytes): + data_as_str = data.decode(encoding="utf-8-sig") + else: + # Explain to mypy the correct type. + data_as_str = cast(str, data) + + # Remove Byte Order Mark if present in string + data_as_str = data_as_str.lstrip(_BOM) + + if content_type is None: + return data + + if cls.JSON_REGEXP.match(content_type): + try: + return json.loads(data_as_str) + except ValueError as err: + raise DeserializationError("JSON is invalid: {}".format(err), err) + elif "xml" in (content_type or []): + try: + + try: + if isinstance(data, unicode): # type: ignore + # If I'm Python 2.7 and unicode XML will scream if I try a "fromstring" on unicode string + data_as_str = data_as_str.encode(encoding="utf-8") # type: ignore + except NameError: + pass + + return ET.fromstring(data_as_str) # nosec + except ET.ParseError as err: + # It might be because the server has an issue, and returned JSON with + # content-type XML.... + # So let's try a JSON load, and if it's still broken + # let's flow the initial exception + def _json_attemp(data): + try: + return True, json.loads(data) + except ValueError: + return False, None # Don't care about this one + + success, json_result = _json_attemp(data) + if success: + return json_result + # If i'm here, it's not JSON, it's not XML, let's scream + # and raise the last context in this block (the XML exception) + # The function hack is because Py2.7 messes up with exception + # context otherwise. + _LOGGER.critical("Wasn't XML not JSON, failing") + raise DeserializationError("XML is invalid") from err + raise DeserializationError("Cannot deserialize content-type: {}".format(content_type)) + + @classmethod + def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], headers: Mapping) -> Any: + """Deserialize from HTTP response. + + Use bytes and headers to NOT use any requests/aiohttp or whatever + specific implementation. + Headers will tested for "content-type" + """ + # Try to use content-type from headers if available + content_type = None + if "content-type" in headers: + content_type = headers["content-type"].split(";")[0].strip().lower() + # Ouch, this server did not declare what it sent... + # Let's guess it's JSON... + # Also, since Autorest was considering that an empty body was a valid JSON, + # need that test as well.... + else: + content_type = "application/json" + + if body_bytes: + return cls.deserialize_from_text(body_bytes, content_type) + return None + + +_LOGGER = logging.getLogger(__name__) + +try: + _long_type = long # type: ignore +except NameError: + _long_type = int + + +class UTC(datetime.tzinfo): + """Time Zone info for handling UTC""" + + def utcoffset(self, dt): + """UTF offset for UTC is 0.""" + return datetime.timedelta(0) + + def tzname(self, dt): + """Timestamp representation.""" + return "Z" + + def dst(self, dt): + """No daylight saving for UTC.""" + return datetime.timedelta(hours=1) + + +try: + from datetime import timezone as _FixedOffset # type: ignore +except ImportError: # Python 2.7 + + class _FixedOffset(datetime.tzinfo): # type: ignore + """Fixed offset in minutes east from UTC. + Copy/pasted from Python doc + :param datetime.timedelta offset: offset in timedelta format + """ + + def __init__(self, offset): + self.__offset = offset + + def utcoffset(self, dt): + return self.__offset + + def tzname(self, dt): + return str(self.__offset.total_seconds() / 3600) + + def __repr__(self): + return "".format(self.tzname(None)) + + def dst(self, dt): + return datetime.timedelta(0) + + def __getinitargs__(self): + return (self.__offset,) + + +try: + from datetime import timezone + + TZ_UTC = timezone.utc +except ImportError: + TZ_UTC = UTC() # type: ignore + +_FLATTEN = re.compile(r"(? None: + self.additional_properties: Optional[Dict[str, Any]] = {} + for k in kwargs: + if k not in self._attribute_map: + _LOGGER.warning("%s is not a known attribute of class %s and will be ignored", k, self.__class__) + elif k in self._validation and self._validation[k].get("readonly", False): + _LOGGER.warning("Readonly attribute %s will be ignored in class %s", k, self.__class__) + else: + setattr(self, k, kwargs[k]) + + def __eq__(self, other: Any) -> bool: + """Compare objects by comparing all attributes.""" + if isinstance(other, self.__class__): + return self.__dict__ == other.__dict__ + return False + + def __ne__(self, other: Any) -> bool: + """Compare objects by comparing all attributes.""" + return not self.__eq__(other) + + def __str__(self) -> str: + return str(self.__dict__) + + @classmethod + def enable_additional_properties_sending(cls) -> None: + cls._attribute_map["additional_properties"] = {"key": "", "type": "{object}"} + + @classmethod + def is_xml_model(cls) -> bool: + try: + cls._xml_map # type: ignore + except AttributeError: + return False + return True + + @classmethod + def _create_xml_node(cls): + """Create XML node.""" + try: + xml_map = cls._xml_map # type: ignore + except AttributeError: + xml_map = {} + + return _create_xml_node(xml_map.get("name", cls.__name__), xml_map.get("prefix", None), xml_map.get("ns", None)) + + def serialize(self, keep_readonly: bool = False, **kwargs: Any) -> JSON: + """Return the JSON that would be sent to server from this model. + + This is an alias to `as_dict(full_restapi_key_transformer, keep_readonly=False)`. + + If you want XML serialization, you can pass the kwargs is_xml=True. + + :param bool keep_readonly: If you want to serialize the readonly attributes + :returns: A dict JSON compatible object + :rtype: dict + """ + serializer = Serializer(self._infer_class_models()) + return serializer._serialize(self, keep_readonly=keep_readonly, **kwargs) # type: ignore + + def as_dict( + self, + keep_readonly: bool = True, + key_transformer: Callable[[str, Dict[str, Any], Any], Any] = attribute_transformer, + **kwargs: Any + ) -> JSON: + """Return a dict that can be serialized using json.dump. + + Advanced usage might optionally use a callback as parameter: + + .. code::python + + def my_key_transformer(key, attr_desc, value): + return key + + Key is the attribute name used in Python. Attr_desc + is a dict of metadata. Currently contains 'type' with the + msrest type and 'key' with the RestAPI encoded key. + Value is the current value in this object. + + The string returned will be used to serialize the key. + If the return type is a list, this is considered hierarchical + result dict. + + See the three examples in this file: + + - attribute_transformer + - full_restapi_key_transformer + - last_restapi_key_transformer + + If you want XML serialization, you can pass the kwargs is_xml=True. + + :param function key_transformer: A key transformer function. + :returns: A dict JSON compatible object + :rtype: dict + """ + serializer = Serializer(self._infer_class_models()) + return serializer._serialize(self, key_transformer=key_transformer, keep_readonly=keep_readonly, **kwargs) # type: ignore + + @classmethod + def _infer_class_models(cls): + try: + str_models = cls.__module__.rsplit(".", 1)[0] + models = sys.modules[str_models] + client_models = {k: v for k, v in models.__dict__.items() if isinstance(v, type)} + if cls.__name__ not in client_models: + raise ValueError("Not Autorest generated code") + except Exception: + # Assume it's not Autorest generated (tests?). Add ourselves as dependencies. + client_models = {cls.__name__: cls} + return client_models + + @classmethod + def deserialize(cls: Type[ModelType], data: Any, content_type: Optional[str] = None) -> ModelType: + """Parse a str using the RestAPI syntax and return a model. + + :param str data: A str using RestAPI structure. JSON by default. + :param str content_type: JSON by default, set application/xml if XML. + :returns: An instance of this model + :raises: DeserializationError if something went wrong + """ + deserializer = Deserializer(cls._infer_class_models()) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore + + @classmethod + def from_dict( + cls: Type[ModelType], + data: Any, + key_extractors: Optional[Callable[[str, Dict[str, Any], Any], Any]] = None, + content_type: Optional[str] = None, + ) -> ModelType: + """Parse a dict using given key extractor return a model. + + By default consider key + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + and last_rest_key_case_insensitive_extractor) + + :param dict data: A dict using RestAPI structure + :param str content_type: JSON by default, set application/xml if XML. + :returns: An instance of this model + :raises: DeserializationError if something went wrong + """ + deserializer = Deserializer(cls._infer_class_models()) + deserializer.key_extractors = ( # type: ignore + [ # type: ignore + attribute_key_case_insensitive_extractor, + rest_key_case_insensitive_extractor, + last_rest_key_case_insensitive_extractor, + ] + if key_extractors is None + else key_extractors + ) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore + + @classmethod + def _flatten_subtype(cls, key, objects): + if "_subtype_map" not in cls.__dict__: + return {} + result = dict(cls._subtype_map[key]) + for valuetype in cls._subtype_map[key].values(): + result.update(objects[valuetype]._flatten_subtype(key, objects)) + return result + + @classmethod + def _classify(cls, response, objects): + """Check the class _subtype_map for any child classes. + We want to ignore any inherited _subtype_maps. + Remove the polymorphic key from the initial data. + """ + for subtype_key in cls.__dict__.get("_subtype_map", {}).keys(): + subtype_value = None + + if not isinstance(response, ET.Element): + rest_api_response_key = cls._get_rest_key_parts(subtype_key)[-1] + subtype_value = response.pop(rest_api_response_key, None) or response.pop(subtype_key, None) + else: + subtype_value = xml_key_extractor(subtype_key, cls._attribute_map[subtype_key], response) + if subtype_value: + # Try to match base class. Can be class name only + # (bug to fix in Autorest to support x-ms-discriminator-name) + if cls.__name__ == subtype_value: + return cls + flatten_mapping_type = cls._flatten_subtype(subtype_key, objects) + try: + return objects[flatten_mapping_type[subtype_value]] # type: ignore + except KeyError: + _LOGGER.warning( + "Subtype value %s has no mapping, use base class %s.", + subtype_value, + cls.__name__, + ) + break + else: + _LOGGER.warning("Discriminator %s is absent or null, use base class %s.", subtype_key, cls.__name__) + break + return cls + + @classmethod + def _get_rest_key_parts(cls, attr_key): + """Get the RestAPI key of this attr, split it and decode part + :param str attr_key: Attribute key must be in attribute_map. + :returns: A list of RestAPI part + :rtype: list + """ + rest_split_key = _FLATTEN.split(cls._attribute_map[attr_key]["key"]) + return [_decode_attribute_map_key(key_part) for key_part in rest_split_key] + + +def _decode_attribute_map_key(key): + """This decode a key in an _attribute_map to the actual key we want to look at + inside the received data. + + :param str key: A key string from the generated code + """ + return key.replace("\\.", ".") + + +class Serializer(object): + """Request object model serializer.""" + + basic_types = {str: "str", int: "int", bool: "bool", float: "float"} + + _xml_basic_types_serializers = {"bool": lambda x: str(x).lower()} + days = {0: "Mon", 1: "Tue", 2: "Wed", 3: "Thu", 4: "Fri", 5: "Sat", 6: "Sun"} + months = { + 1: "Jan", + 2: "Feb", + 3: "Mar", + 4: "Apr", + 5: "May", + 6: "Jun", + 7: "Jul", + 8: "Aug", + 9: "Sep", + 10: "Oct", + 11: "Nov", + 12: "Dec", + } + validation = { + "min_length": lambda x, y: len(x) < y, + "max_length": lambda x, y: len(x) > y, + "minimum": lambda x, y: x < y, + "maximum": lambda x, y: x > y, + "minimum_ex": lambda x, y: x <= y, + "maximum_ex": lambda x, y: x >= y, + "min_items": lambda x, y: len(x) < y, + "max_items": lambda x, y: len(x) > y, + "pattern": lambda x, y: not re.match(y, x, re.UNICODE), + "unique": lambda x, y: len(x) != len(set(x)), + "multiple": lambda x, y: x % y != 0, + } + + def __init__(self, classes: Optional[Mapping[str, type]] = None): + self.serialize_type = { + "iso-8601": Serializer.serialize_iso, + "rfc-1123": Serializer.serialize_rfc, + "unix-time": Serializer.serialize_unix, + "duration": Serializer.serialize_duration, + "date": Serializer.serialize_date, + "time": Serializer.serialize_time, + "decimal": Serializer.serialize_decimal, + "long": Serializer.serialize_long, + "bytearray": Serializer.serialize_bytearray, + "base64": Serializer.serialize_base64, + "object": self.serialize_object, + "[]": self.serialize_iter, + "{}": self.serialize_dict, + } + self.dependencies: Dict[str, type] = dict(classes) if classes else {} + self.key_transformer = full_restapi_key_transformer + self.client_side_validation = True + + def _serialize(self, target_obj, data_type=None, **kwargs): + """Serialize data into a string according to type. + + :param target_obj: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str, dict + :raises: SerializationError if serialization fails. + """ + key_transformer = kwargs.get("key_transformer", self.key_transformer) + keep_readonly = kwargs.get("keep_readonly", False) + if target_obj is None: + return None + + attr_name = None + class_name = target_obj.__class__.__name__ + + if data_type: + return self.serialize_data(target_obj, data_type, **kwargs) + + if not hasattr(target_obj, "_attribute_map"): + data_type = type(target_obj).__name__ + if data_type in self.basic_types.values(): + return self.serialize_data(target_obj, data_type, **kwargs) + + # Force "is_xml" kwargs if we detect a XML model + try: + is_xml_model_serialization = kwargs["is_xml"] + except KeyError: + is_xml_model_serialization = kwargs.setdefault("is_xml", target_obj.is_xml_model()) + + serialized = {} + if is_xml_model_serialization: + serialized = target_obj._create_xml_node() + try: + attributes = target_obj._attribute_map + for attr, attr_desc in attributes.items(): + attr_name = attr + if not keep_readonly and target_obj._validation.get(attr_name, {}).get("readonly", False): + continue + + if attr_name == "additional_properties" and attr_desc["key"] == "": + if target_obj.additional_properties is not None: + serialized.update(target_obj.additional_properties) + continue + try: + + orig_attr = getattr(target_obj, attr) + if is_xml_model_serialization: + pass # Don't provide "transformer" for XML for now. Keep "orig_attr" + else: # JSON + keys, orig_attr = key_transformer(attr, attr_desc.copy(), orig_attr) + keys = keys if isinstance(keys, list) else [keys] + + kwargs["serialization_ctxt"] = attr_desc + new_attr = self.serialize_data(orig_attr, attr_desc["type"], **kwargs) + + if is_xml_model_serialization: + xml_desc = attr_desc.get("xml", {}) + xml_name = xml_desc.get("name", attr_desc["key"]) + xml_prefix = xml_desc.get("prefix", None) + xml_ns = xml_desc.get("ns", None) + if xml_desc.get("attr", False): + if xml_ns: + ET.register_namespace(xml_prefix, xml_ns) + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + serialized.set(xml_name, new_attr) # type: ignore + continue + if xml_desc.get("text", False): + serialized.text = new_attr # type: ignore + continue + if isinstance(new_attr, list): + serialized.extend(new_attr) # type: ignore + elif isinstance(new_attr, ET.Element): + # If the down XML has no XML/Name, we MUST replace the tag with the local tag. But keeping the namespaces. + if "name" not in getattr(orig_attr, "_xml_map", {}): + splitted_tag = new_attr.tag.split("}") + if len(splitted_tag) == 2: # Namespace + new_attr.tag = "}".join([splitted_tag[0], xml_name]) + else: + new_attr.tag = xml_name + serialized.append(new_attr) # type: ignore + else: # That's a basic type + # Integrate namespace if necessary + local_node = _create_xml_node(xml_name, xml_prefix, xml_ns) + local_node.text = str(new_attr) + serialized.append(local_node) # type: ignore + else: # JSON + for k in reversed(keys): # type: ignore + new_attr = {k: new_attr} + + _new_attr = new_attr + _serialized = serialized + for k in keys: # type: ignore + if k not in _serialized: + _serialized.update(_new_attr) # type: ignore + _new_attr = _new_attr[k] # type: ignore + _serialized = _serialized[k] + except ValueError as err: + if isinstance(err, SerializationError): + raise + + except (AttributeError, KeyError, TypeError) as err: + msg = "Attribute {} in object {} cannot be serialized.\n{}".format(attr_name, class_name, str(target_obj)) + raise SerializationError(msg) from err + else: + return serialized + + def body(self, data, data_type, **kwargs): + """Serialize data intended for a request body. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: dict + :raises: SerializationError if serialization fails. + :raises: ValueError if data is None + """ + + # Just in case this is a dict + internal_data_type_str = data_type.strip("[]{}") + internal_data_type = self.dependencies.get(internal_data_type_str, None) + try: + is_xml_model_serialization = kwargs["is_xml"] + except KeyError: + if internal_data_type and issubclass(internal_data_type, Model): + is_xml_model_serialization = kwargs.setdefault("is_xml", internal_data_type.is_xml_model()) + else: + is_xml_model_serialization = False + if internal_data_type and not isinstance(internal_data_type, Enum): + try: + deserializer = Deserializer(self.dependencies) + # Since it's on serialization, it's almost sure that format is not JSON REST + # We're not able to deal with additional properties for now. + deserializer.additional_properties_detection = False + if is_xml_model_serialization: + deserializer.key_extractors = [ # type: ignore + attribute_key_case_insensitive_extractor, + ] + else: + deserializer.key_extractors = [ + rest_key_case_insensitive_extractor, + attribute_key_case_insensitive_extractor, + last_rest_key_case_insensitive_extractor, + ] + data = deserializer._deserialize(data_type, data) + except DeserializationError as err: + raise SerializationError("Unable to build a model: " + str(err)) from err + + return self._serialize(data, data_type, **kwargs) + + def url(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL path. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str + :raises: TypeError if serialization fails. + :raises: ValueError if data is None + """ + try: + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + + if kwargs.get("skip_quote") is True: + output = str(output) + output = output.replace("{", quote("{")).replace("}", quote("}")) + else: + output = quote(str(output), safe="") + except SerializationError: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return output + + def query(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL query. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :keyword bool skip_quote: Whether to skip quote the serialized result. + Defaults to False. + :rtype: str, list + :raises: TypeError if serialization fails. + :raises: ValueError if data is None + """ + try: + # Treat the list aside, since we don't want to encode the div separator + if data_type.startswith("["): + internal_data_type = data_type[1:-1] + do_quote = not kwargs.get("skip_quote", False) + return self.serialize_iter(data, internal_data_type, do_quote=do_quote, **kwargs) + + # Not a list, regular serialization + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + if kwargs.get("skip_quote") is True: + output = str(output) + else: + output = quote(str(output), safe="") + except SerializationError: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return str(output) + + def header(self, name, data, data_type, **kwargs): + """Serialize data intended for a request header. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str + :raises: TypeError if serialization fails. + :raises: ValueError if data is None + """ + try: + if data_type in ["[str]"]: + data = ["" if d is None else d for d in data] + + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + except SerializationError: + raise TypeError("{} must be type {}.".format(name, data_type)) + else: + return str(output) + + def serialize_data(self, data, data_type, **kwargs): + """Serialize generic data according to supplied data type. + + :param data: The data to be serialized. + :param str data_type: The type to be serialized from. + :param bool required: Whether it's essential that the data not be + empty or None + :raises: AttributeError if required data is None. + :raises: ValueError if data is None + :raises: SerializationError if serialization fails. + """ + if data is None: + raise ValueError("No value for given attribute") + + try: + if data is CoreNull: + return None + if data_type in self.basic_types.values(): + return self.serialize_basic(data, data_type, **kwargs) + + elif data_type in self.serialize_type: + return self.serialize_type[data_type](data, **kwargs) + + # If dependencies is empty, try with current data class + # It has to be a subclass of Enum anyway + enum_type = self.dependencies.get(data_type, data.__class__) + if issubclass(enum_type, Enum): + return Serializer.serialize_enum(data, enum_obj=enum_type) + + iter_type = data_type[0] + data_type[-1] + if iter_type in self.serialize_type: + return self.serialize_type[iter_type](data, data_type[1:-1], **kwargs) + + except (ValueError, TypeError) as err: + msg = "Unable to serialize value: {!r} as type: {!r}." + raise SerializationError(msg.format(data, data_type)) from err + else: + return self._serialize(data, **kwargs) + + @classmethod + def _get_custom_serializers(cls, data_type, **kwargs): + custom_serializer = kwargs.get("basic_types_serializers", {}).get(data_type) + if custom_serializer: + return custom_serializer + if kwargs.get("is_xml", False): + return cls._xml_basic_types_serializers.get(data_type) + + @classmethod + def serialize_basic(cls, data, data_type, **kwargs): + """Serialize basic builting data type. + Serializes objects to str, int, float or bool. + + Possible kwargs: + - basic_types_serializers dict[str, callable] : If set, use the callable as serializer + - is_xml bool : If set, use xml_basic_types_serializers + + :param data: Object to be serialized. + :param str data_type: Type of object in the iterable. + """ + custom_serializer = cls._get_custom_serializers(data_type, **kwargs) + if custom_serializer: + return custom_serializer(data) + if data_type == "str": + return cls.serialize_unicode(data) + return eval(data_type)(data) # nosec + + @classmethod + def serialize_unicode(cls, data): + """Special handling for serializing unicode strings in Py2. + Encode to UTF-8 if unicode, otherwise handle as a str. + + :param data: Object to be serialized. + :rtype: str + """ + try: # If I received an enum, return its value + return data.value + except AttributeError: + pass + + try: + if isinstance(data, unicode): # type: ignore + # Don't change it, JSON and XML ElementTree are totally able + # to serialize correctly u'' strings + return data + except NameError: + return str(data) + else: + return str(data) + + def serialize_iter(self, data, iter_type, div=None, **kwargs): + """Serialize iterable. + + Supported kwargs: + - serialization_ctxt dict : The current entry of _attribute_map, or same format. + serialization_ctxt['type'] should be same as data_type. + - is_xml bool : If set, serialize as XML + + :param list attr: Object to be serialized. + :param str iter_type: Type of object in the iterable. + :param bool required: Whether the objects in the iterable must + not be None or empty. + :param str div: If set, this str will be used to combine the elements + in the iterable into a combined string. Default is 'None'. + :keyword bool do_quote: Whether to quote the serialized result of each iterable element. + Defaults to False. + :rtype: list, str + """ + if isinstance(data, str): + raise SerializationError("Refuse str type as a valid iter type.") + + serialization_ctxt = kwargs.get("serialization_ctxt", {}) + is_xml = kwargs.get("is_xml", False) + + serialized = [] + for d in data: + try: + serialized.append(self.serialize_data(d, iter_type, **kwargs)) + except ValueError as err: + if isinstance(err, SerializationError): + raise + serialized.append(None) + + if kwargs.get("do_quote", False): + serialized = ["" if s is None else quote(str(s), safe="") for s in serialized] + + if div: + serialized = ["" if s is None else str(s) for s in serialized] + serialized = div.join(serialized) + + if "xml" in serialization_ctxt or is_xml: + # XML serialization is more complicated + xml_desc = serialization_ctxt.get("xml", {}) + xml_name = xml_desc.get("name") + if not xml_name: + xml_name = serialization_ctxt["key"] + + # Create a wrap node if necessary (use the fact that Element and list have "append") + is_wrapped = xml_desc.get("wrapped", False) + node_name = xml_desc.get("itemsName", xml_name) + if is_wrapped: + final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + else: + final_result = [] + # All list elements to "local_node" + for el in serialized: + if isinstance(el, ET.Element): + el_node = el + else: + el_node = _create_xml_node(node_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + if el is not None: # Otherwise it writes "None" :-p + el_node.text = str(el) + final_result.append(el_node) + return final_result + return serialized + + def serialize_dict(self, attr, dict_type, **kwargs): + """Serialize a dictionary of objects. + + :param dict attr: Object to be serialized. + :param str dict_type: Type of object in the dictionary. + :param bool required: Whether the objects in the dictionary must + not be None or empty. + :rtype: dict + """ + serialization_ctxt = kwargs.get("serialization_ctxt", {}) + serialized = {} + for key, value in attr.items(): + try: + serialized[self.serialize_unicode(key)] = self.serialize_data(value, dict_type, **kwargs) + except ValueError as err: + if isinstance(err, SerializationError): + raise + serialized[self.serialize_unicode(key)] = None + + if "xml" in serialization_ctxt: + # XML serialization is more complicated + xml_desc = serialization_ctxt["xml"] + xml_name = xml_desc["name"] + + final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + for key, value in serialized.items(): + ET.SubElement(final_result, key).text = value + return final_result + + return serialized + + def serialize_object(self, attr, **kwargs): + """Serialize a generic object. + This will be handled as a dictionary. If object passed in is not + a basic type (str, int, float, dict, list) it will simply be + cast to str. + + :param dict attr: Object to be serialized. + :rtype: dict or str + """ + if attr is None: + return None + if isinstance(attr, ET.Element): + return attr + obj_type = type(attr) + if obj_type in self.basic_types: + return self.serialize_basic(attr, self.basic_types[obj_type], **kwargs) + if obj_type is _long_type: + return self.serialize_long(attr) + if obj_type is str: + return self.serialize_unicode(attr) + if obj_type is datetime.datetime: + return self.serialize_iso(attr) + if obj_type is datetime.date: + return self.serialize_date(attr) + if obj_type is datetime.time: + return self.serialize_time(attr) + if obj_type is datetime.timedelta: + return self.serialize_duration(attr) + if obj_type is decimal.Decimal: + return self.serialize_decimal(attr) + + # If it's a model or I know this dependency, serialize as a Model + elif obj_type in self.dependencies.values() or isinstance(attr, Model): + return self._serialize(attr) + + if obj_type == dict: + serialized = {} + for key, value in attr.items(): + try: + serialized[self.serialize_unicode(key)] = self.serialize_object(value, **kwargs) + except ValueError: + serialized[self.serialize_unicode(key)] = None + return serialized + + if obj_type == list: + serialized = [] + for obj in attr: + try: + serialized.append(self.serialize_object(obj, **kwargs)) + except ValueError: + pass + return serialized + return str(attr) + + @staticmethod + def serialize_enum(attr, enum_obj=None): + try: + result = attr.value + except AttributeError: + result = attr + try: + enum_obj(result) # type: ignore + return result + except ValueError: + for enum_value in enum_obj: # type: ignore + if enum_value.value.lower() == str(attr).lower(): + return enum_value.value + error = "{!r} is not valid value for enum {!r}" + raise SerializationError(error.format(attr, enum_obj)) + + @staticmethod + def serialize_bytearray(attr, **kwargs): + """Serialize bytearray into base-64 string. + + :param attr: Object to be serialized. + :rtype: str + """ + return b64encode(attr).decode() + + @staticmethod + def serialize_base64(attr, **kwargs): + """Serialize str into base-64 string. + + :param attr: Object to be serialized. + :rtype: str + """ + encoded = b64encode(attr).decode("ascii") + return encoded.strip("=").replace("+", "-").replace("/", "_") + + @staticmethod + def serialize_decimal(attr, **kwargs): + """Serialize Decimal object to float. + + :param attr: Object to be serialized. + :rtype: float + """ + return float(attr) + + @staticmethod + def serialize_long(attr, **kwargs): + """Serialize long (Py2) or int (Py3). + + :param attr: Object to be serialized. + :rtype: int/long + """ + return _long_type(attr) + + @staticmethod + def serialize_date(attr, **kwargs): + """Serialize Date object into ISO-8601 formatted string. + + :param Date attr: Object to be serialized. + :rtype: str + """ + if isinstance(attr, str): + attr = isodate.parse_date(attr) + t = "{:04}-{:02}-{:02}".format(attr.year, attr.month, attr.day) + return t + + @staticmethod + def serialize_time(attr, **kwargs): + """Serialize Time object into ISO-8601 formatted string. + + :param datetime.time attr: Object to be serialized. + :rtype: str + """ + if isinstance(attr, str): + attr = isodate.parse_time(attr) + t = "{:02}:{:02}:{:02}".format(attr.hour, attr.minute, attr.second) + if attr.microsecond: + t += ".{:02}".format(attr.microsecond) + return t + + @staticmethod + def serialize_duration(attr, **kwargs): + """Serialize TimeDelta object into ISO-8601 formatted string. + + :param TimeDelta attr: Object to be serialized. + :rtype: str + """ + if isinstance(attr, str): + attr = isodate.parse_duration(attr) + return isodate.duration_isoformat(attr) + + @staticmethod + def serialize_rfc(attr, **kwargs): + """Serialize Datetime object into RFC-1123 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises: TypeError if format invalid. + """ + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + except AttributeError: + raise TypeError("RFC1123 object must be valid Datetime object.") + + return "{}, {:02} {} {:04} {:02}:{:02}:{:02} GMT".format( + Serializer.days[utc.tm_wday], + utc.tm_mday, + Serializer.months[utc.tm_mon], + utc.tm_year, + utc.tm_hour, + utc.tm_min, + utc.tm_sec, + ) + + @staticmethod + def serialize_iso(attr, **kwargs): + """Serialize Datetime object into ISO-8601 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises: SerializationError if format invalid. + """ + if isinstance(attr, str): + attr = isodate.parse_datetime(attr) + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + if utc.tm_year > 9999 or utc.tm_year < 1: + raise OverflowError("Hit max or min date") + + microseconds = str(attr.microsecond).rjust(6, "0").rstrip("0").ljust(3, "0") + if microseconds: + microseconds = "." + microseconds + date = "{:04}-{:02}-{:02}T{:02}:{:02}:{:02}".format( + utc.tm_year, utc.tm_mon, utc.tm_mday, utc.tm_hour, utc.tm_min, utc.tm_sec + ) + return date + microseconds + "Z" + except (ValueError, OverflowError) as err: + msg = "Unable to serialize datetime object." + raise SerializationError(msg) from err + except AttributeError as err: + msg = "ISO-8601 object must be valid Datetime object." + raise TypeError(msg) from err + + @staticmethod + def serialize_unix(attr, **kwargs): + """Serialize Datetime object into IntTime format. + This is represented as seconds. + + :param Datetime attr: Object to be serialized. + :rtype: int + :raises: SerializationError if format invalid + """ + if isinstance(attr, int): + return attr + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + return int(calendar.timegm(attr.utctimetuple())) + except AttributeError: + raise TypeError("Unix time object must be valid Datetime object.") + + +def rest_key_extractor(attr, attr_desc, data): + key = attr_desc["key"] + working_data = data + + while "." in key: + # Need the cast, as for some reasons "split" is typed as list[str | Any] + dict_keys = cast(List[str], _FLATTEN.split(key)) + if len(dict_keys) == 1: + key = _decode_attribute_map_key(dict_keys[0]) + break + working_key = _decode_attribute_map_key(dict_keys[0]) + working_data = working_data.get(working_key, data) + if working_data is None: + # If at any point while following flatten JSON path see None, it means + # that all properties under are None as well + return None + key = ".".join(dict_keys[1:]) + + return working_data.get(key) + + +def rest_key_case_insensitive_extractor(attr, attr_desc, data): + key = attr_desc["key"] + working_data = data + + while "." in key: + dict_keys = _FLATTEN.split(key) + if len(dict_keys) == 1: + key = _decode_attribute_map_key(dict_keys[0]) + break + working_key = _decode_attribute_map_key(dict_keys[0]) + working_data = attribute_key_case_insensitive_extractor(working_key, None, working_data) + if working_data is None: + # If at any point while following flatten JSON path see None, it means + # that all properties under are None as well + return None + key = ".".join(dict_keys[1:]) + + if working_data: + return attribute_key_case_insensitive_extractor(key, None, working_data) + + +def last_rest_key_extractor(attr, attr_desc, data): + """Extract the attribute in "data" based on the last part of the JSON path key.""" + key = attr_desc["key"] + dict_keys = _FLATTEN.split(key) + return attribute_key_extractor(dict_keys[-1], None, data) + + +def last_rest_key_case_insensitive_extractor(attr, attr_desc, data): + """Extract the attribute in "data" based on the last part of the JSON path key. + + This is the case insensitive version of "last_rest_key_extractor" + """ + key = attr_desc["key"] + dict_keys = _FLATTEN.split(key) + return attribute_key_case_insensitive_extractor(dict_keys[-1], None, data) + + +def attribute_key_extractor(attr, _, data): + return data.get(attr) + + +def attribute_key_case_insensitive_extractor(attr, _, data): + found_key = None + lower_attr = attr.lower() + for key in data: + if lower_attr == key.lower(): + found_key = key + break + + return data.get(found_key) + + +def _extract_name_from_internal_type(internal_type): + """Given an internal type XML description, extract correct XML name with namespace. + + :param dict internal_type: An model type + :rtype: tuple + :returns: A tuple XML name + namespace dict + """ + internal_type_xml_map = getattr(internal_type, "_xml_map", {}) + xml_name = internal_type_xml_map.get("name", internal_type.__name__) + xml_ns = internal_type_xml_map.get("ns", None) + if xml_ns: + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + return xml_name + + +def xml_key_extractor(attr, attr_desc, data): + if isinstance(data, dict): + return None + + # Test if this model is XML ready first + if not isinstance(data, ET.Element): + return None + + xml_desc = attr_desc.get("xml", {}) + xml_name = xml_desc.get("name", attr_desc["key"]) + + # Look for a children + is_iter_type = attr_desc["type"].startswith("[") + is_wrapped = xml_desc.get("wrapped", False) + internal_type = attr_desc.get("internalType", None) + internal_type_xml_map = getattr(internal_type, "_xml_map", {}) + + # Integrate namespace if necessary + xml_ns = xml_desc.get("ns", internal_type_xml_map.get("ns", None)) + if xml_ns: + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + + # If it's an attribute, that's simple + if xml_desc.get("attr", False): + return data.get(xml_name) + + # If it's x-ms-text, that's simple too + if xml_desc.get("text", False): + return data.text + + # Scenario where I take the local name: + # - Wrapped node + # - Internal type is an enum (considered basic types) + # - Internal type has no XML/Name node + if is_wrapped or (internal_type and (issubclass(internal_type, Enum) or "name" not in internal_type_xml_map)): + children = data.findall(xml_name) + # If internal type has a local name and it's not a list, I use that name + elif not is_iter_type and internal_type and "name" in internal_type_xml_map: + xml_name = _extract_name_from_internal_type(internal_type) + children = data.findall(xml_name) + # That's an array + else: + if internal_type: # Complex type, ignore itemsName and use the complex type name + items_name = _extract_name_from_internal_type(internal_type) + else: + items_name = xml_desc.get("itemsName", xml_name) + children = data.findall(items_name) + + if len(children) == 0: + if is_iter_type: + if is_wrapped: + return None # is_wrapped no node, we want None + else: + return [] # not wrapped, assume empty list + return None # Assume it's not there, maybe an optional node. + + # If is_iter_type and not wrapped, return all found children + if is_iter_type: + if not is_wrapped: + return children + else: # Iter and wrapped, should have found one node only (the wrap one) + if len(children) != 1: + raise DeserializationError( + "Tried to deserialize an array not wrapped, and found several nodes '{}'. Maybe you should declare this array as wrapped?".format( + xml_name + ) + ) + return list(children[0]) # Might be empty list and that's ok. + + # Here it's not a itertype, we should have found one element only or empty + if len(children) > 1: + raise DeserializationError("Find several XML '{}' where it was not expected".format(xml_name)) + return children[0] + + +class Deserializer(object): + """Response object model deserializer. + + :param dict classes: Class type dictionary for deserializing complex types. + :ivar list key_extractors: Ordered list of extractors to be used by this deserializer. + """ + + basic_types = {str: "str", int: "int", bool: "bool", float: "float"} + + valid_date = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") + + def __init__(self, classes: Optional[Mapping[str, type]] = None): + self.deserialize_type = { + "iso-8601": Deserializer.deserialize_iso, + "rfc-1123": Deserializer.deserialize_rfc, + "unix-time": Deserializer.deserialize_unix, + "duration": Deserializer.deserialize_duration, + "date": Deserializer.deserialize_date, + "time": Deserializer.deserialize_time, + "decimal": Deserializer.deserialize_decimal, + "long": Deserializer.deserialize_long, + "bytearray": Deserializer.deserialize_bytearray, + "base64": Deserializer.deserialize_base64, + "object": self.deserialize_object, + "[]": self.deserialize_iter, + "{}": self.deserialize_dict, + } + self.deserialize_expected_types = { + "duration": (isodate.Duration, datetime.timedelta), + "iso-8601": (datetime.datetime), + } + self.dependencies: Dict[str, type] = dict(classes) if classes else {} + self.key_extractors = [rest_key_extractor, xml_key_extractor] + # Additional properties only works if the "rest_key_extractor" is used to + # extract the keys. Making it to work whatever the key extractor is too much + # complicated, with no real scenario for now. + # So adding a flag to disable additional properties detection. This flag should be + # used if your expect the deserialization to NOT come from a JSON REST syntax. + # Otherwise, result are unexpected + self.additional_properties_detection = True + + def __call__(self, target_obj, response_data, content_type=None): + """Call the deserializer to process a REST response. + + :param str target_obj: Target data type to deserialize to. + :param requests.Response response_data: REST response object. + :param str content_type: Swagger "produces" if available. + :raises: DeserializationError if deserialization fails. + :return: Deserialized object. + """ + data = self._unpack_content(response_data, content_type) + return self._deserialize(target_obj, data) + + def _deserialize(self, target_obj, data): + """Call the deserializer on a model. + + Data needs to be already deserialized as JSON or XML ElementTree + + :param str target_obj: Target data type to deserialize to. + :param object data: Object to deserialize. + :raises: DeserializationError if deserialization fails. + :return: Deserialized object. + """ + # This is already a model, go recursive just in case + if hasattr(data, "_attribute_map"): + constants = [name for name, config in getattr(data, "_validation", {}).items() if config.get("constant")] + try: + for attr, mapconfig in data._attribute_map.items(): + if attr in constants: + continue + value = getattr(data, attr) + if value is None: + continue + local_type = mapconfig["type"] + internal_data_type = local_type.strip("[]{}") + if internal_data_type not in self.dependencies or isinstance(internal_data_type, Enum): + continue + setattr(data, attr, self._deserialize(local_type, value)) + return data + except AttributeError: + return + + response, class_name = self._classify_target(target_obj, data) + + if isinstance(response, str): + return self.deserialize_data(data, response) + elif isinstance(response, type) and issubclass(response, Enum): + return self.deserialize_enum(data, response) + + if data is None: + return data + try: + attributes = response._attribute_map # type: ignore + d_attrs = {} + for attr, attr_desc in attributes.items(): + # Check empty string. If it's not empty, someone has a real "additionalProperties"... + if attr == "additional_properties" and attr_desc["key"] == "": + continue + raw_value = None + # Enhance attr_desc with some dynamic data + attr_desc = attr_desc.copy() # Do a copy, do not change the real one + internal_data_type = attr_desc["type"].strip("[]{}") + if internal_data_type in self.dependencies: + attr_desc["internalType"] = self.dependencies[internal_data_type] + + for key_extractor in self.key_extractors: + found_value = key_extractor(attr, attr_desc, data) + if found_value is not None: + if raw_value is not None and raw_value != found_value: + msg = ( + "Ignoring extracted value '%s' from %s for key '%s'" + " (duplicate extraction, follow extractors order)" + ) + _LOGGER.warning(msg, found_value, key_extractor, attr) + continue + raw_value = found_value + + value = self.deserialize_data(raw_value, attr_desc["type"]) + d_attrs[attr] = value + except (AttributeError, TypeError, KeyError) as err: + msg = "Unable to deserialize to object: " + class_name # type: ignore + raise DeserializationError(msg) from err + else: + additional_properties = self._build_additional_properties(attributes, data) + return self._instantiate_model(response, d_attrs, additional_properties) + + def _build_additional_properties(self, attribute_map, data): + if not self.additional_properties_detection: + return None + if "additional_properties" in attribute_map and attribute_map.get("additional_properties", {}).get("key") != "": + # Check empty string. If it's not empty, someone has a real "additionalProperties" + return None + if isinstance(data, ET.Element): + data = {el.tag: el.text for el in data} + + known_keys = { + _decode_attribute_map_key(_FLATTEN.split(desc["key"])[0]) + for desc in attribute_map.values() + if desc["key"] != "" + } + present_keys = set(data.keys()) + missing_keys = present_keys - known_keys + return {key: data[key] for key in missing_keys} + + def _classify_target(self, target, data): + """Check to see whether the deserialization target object can + be classified into a subclass. + Once classification has been determined, initialize object. + + :param str target: The target object type to deserialize to. + :param str/dict data: The response data to deserialize. + """ + if target is None: + return None, None + + if isinstance(target, str): + try: + target = self.dependencies[target] + except KeyError: + return target, target + + try: + target = target._classify(data, self.dependencies) # type: ignore + except AttributeError: + pass # Target is not a Model, no classify + return target, target.__class__.__name__ # type: ignore + + def failsafe_deserialize(self, target_obj, data, content_type=None): + """Ignores any errors encountered in deserialization, + and falls back to not deserializing the object. Recommended + for use in error deserialization, as we want to return the + HttpResponseError to users, and not have them deal with + a deserialization error. + + :param str target_obj: The target object type to deserialize to. + :param str/dict data: The response data to deserialize. + :param str content_type: Swagger "produces" if available. + """ + try: + return self(target_obj, data, content_type=content_type) + except: + _LOGGER.debug( + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + ) + return None + + @staticmethod + def _unpack_content(raw_data, content_type=None): + """Extract the correct structure for deserialization. + + If raw_data is a PipelineResponse, try to extract the result of RawDeserializer. + if we can't, raise. Your Pipeline should have a RawDeserializer. + + If not a pipeline response and raw_data is bytes or string, use content-type + to decode it. If no content-type, try JSON. + + If raw_data is something else, bypass all logic and return it directly. + + :param raw_data: Data to be processed. + :param content_type: How to parse if raw_data is a string/bytes. + :raises JSONDecodeError: If JSON is requested and parsing is impossible. + :raises UnicodeDecodeError: If bytes is not UTF8 + """ + # Assume this is enough to detect a Pipeline Response without importing it + context = getattr(raw_data, "context", {}) + if context: + if RawDeserializer.CONTEXT_NAME in context: + return context[RawDeserializer.CONTEXT_NAME] + raise ValueError("This pipeline didn't have the RawDeserializer policy; can't deserialize") + + # Assume this is enough to recognize universal_http.ClientResponse without importing it + if hasattr(raw_data, "body"): + return RawDeserializer.deserialize_from_http_generics(raw_data.text(), raw_data.headers) + + # Assume this enough to recognize requests.Response without importing it. + if hasattr(raw_data, "_content_consumed"): + return RawDeserializer.deserialize_from_http_generics(raw_data.text, raw_data.headers) + + if isinstance(raw_data, (str, bytes)) or hasattr(raw_data, "read"): + return RawDeserializer.deserialize_from_text(raw_data, content_type) # type: ignore + return raw_data + + def _instantiate_model(self, response, attrs, additional_properties=None): + """Instantiate a response model passing in deserialized args. + + :param response: The response model class. + :param d_attrs: The deserialized response attributes. + """ + if callable(response): + subtype = getattr(response, "_subtype_map", {}) + try: + readonly = [k for k, v in response._validation.items() if v.get("readonly")] + const = [k for k, v in response._validation.items() if v.get("constant")] + kwargs = {k: v for k, v in attrs.items() if k not in subtype and k not in readonly + const} + response_obj = response(**kwargs) + for attr in readonly: + setattr(response_obj, attr, attrs.get(attr)) + if additional_properties: + response_obj.additional_properties = additional_properties + return response_obj + except TypeError as err: + msg = "Unable to deserialize {} into model {}. ".format(kwargs, response) # type: ignore + raise DeserializationError(msg + str(err)) + else: + try: + for attr, value in attrs.items(): + setattr(response, attr, value) + return response + except Exception as exp: + msg = "Unable to populate response model. " + msg += "Type: {}, Error: {}".format(type(response), exp) + raise DeserializationError(msg) + + def deserialize_data(self, data, data_type): + """Process data for deserialization according to data type. + + :param str data: The response string to be deserialized. + :param str data_type: The type to deserialize to. + :raises: DeserializationError if deserialization fails. + :return: Deserialized object. + """ + if data is None: + return data + + try: + if not data_type: + return data + if data_type in self.basic_types.values(): + return self.deserialize_basic(data, data_type) + if data_type in self.deserialize_type: + if isinstance(data, self.deserialize_expected_types.get(data_type, tuple())): + return data + + is_a_text_parsing_type = lambda x: x not in ["object", "[]", r"{}"] + if isinstance(data, ET.Element) and is_a_text_parsing_type(data_type) and not data.text: + return None + data_val = self.deserialize_type[data_type](data) + return data_val + + iter_type = data_type[0] + data_type[-1] + if iter_type in self.deserialize_type: + return self.deserialize_type[iter_type](data, data_type[1:-1]) + + obj_type = self.dependencies[data_type] + if issubclass(obj_type, Enum): + if isinstance(data, ET.Element): + data = data.text + return self.deserialize_enum(data, obj_type) + + except (ValueError, TypeError, AttributeError) as err: + msg = "Unable to deserialize response data." + msg += " Data: {}, {}".format(data, data_type) + raise DeserializationError(msg) from err + else: + return self._deserialize(obj_type, data) + + def deserialize_iter(self, attr, iter_type): + """Deserialize an iterable. + + :param list attr: Iterable to be deserialized. + :param str iter_type: The type of object in the iterable. + :rtype: list + """ + if attr is None: + return None + if isinstance(attr, ET.Element): # If I receive an element here, get the children + attr = list(attr) + if not isinstance(attr, (list, set)): + raise DeserializationError("Cannot deserialize as [{}] an object of type {}".format(iter_type, type(attr))) + return [self.deserialize_data(a, iter_type) for a in attr] + + def deserialize_dict(self, attr, dict_type): + """Deserialize a dictionary. + + :param dict/list attr: Dictionary to be deserialized. Also accepts + a list of key, value pairs. + :param str dict_type: The object type of the items in the dictionary. + :rtype: dict + """ + if isinstance(attr, list): + return {x["key"]: self.deserialize_data(x["value"], dict_type) for x in attr} + + if isinstance(attr, ET.Element): + # Transform value into {"Key": "value"} + attr = {el.tag: el.text for el in attr} + return {k: self.deserialize_data(v, dict_type) for k, v in attr.items()} + + def deserialize_object(self, attr, **kwargs): + """Deserialize a generic object. + This will be handled as a dictionary. + + :param dict attr: Dictionary to be deserialized. + :rtype: dict + :raises: TypeError if non-builtin datatype encountered. + """ + if attr is None: + return None + if isinstance(attr, ET.Element): + # Do no recurse on XML, just return the tree as-is + return attr + if isinstance(attr, str): + return self.deserialize_basic(attr, "str") + obj_type = type(attr) + if obj_type in self.basic_types: + return self.deserialize_basic(attr, self.basic_types[obj_type]) + if obj_type is _long_type: + return self.deserialize_long(attr) + + if obj_type == dict: + deserialized = {} + for key, value in attr.items(): + try: + deserialized[key] = self.deserialize_object(value, **kwargs) + except ValueError: + deserialized[key] = None + return deserialized + + if obj_type == list: + deserialized = [] + for obj in attr: + try: + deserialized.append(self.deserialize_object(obj, **kwargs)) + except ValueError: + pass + return deserialized + + else: + error = "Cannot deserialize generic object with type: " + raise TypeError(error + str(obj_type)) + + def deserialize_basic(self, attr, data_type): + """Deserialize basic builtin data type from string. + Will attempt to convert to str, int, float and bool. + This function will also accept '1', '0', 'true' and 'false' as + valid bool values. + + :param str attr: response string to be deserialized. + :param str data_type: deserialization data type. + :rtype: str, int, float or bool + :raises: TypeError if string format is not valid. + """ + # If we're here, data is supposed to be a basic type. + # If it's still an XML node, take the text + if isinstance(attr, ET.Element): + attr = attr.text + if not attr: + if data_type == "str": + # None or '', node is empty string. + return "" + else: + # None or '', node with a strong type is None. + # Don't try to model "empty bool" or "empty int" + return None + + if data_type == "bool": + if attr in [True, False, 1, 0]: + return bool(attr) + elif isinstance(attr, str): + if attr.lower() in ["true", "1"]: + return True + elif attr.lower() in ["false", "0"]: + return False + raise TypeError("Invalid boolean value: {}".format(attr)) + + if data_type == "str": + return self.deserialize_unicode(attr) + return eval(data_type)(attr) # nosec + + @staticmethod + def deserialize_unicode(data): + """Preserve unicode objects in Python 2, otherwise return data + as a string. + + :param str data: response string to be deserialized. + :rtype: str or unicode + """ + # We might be here because we have an enum modeled as string, + # and we try to deserialize a partial dict with enum inside + if isinstance(data, Enum): + return data + + # Consider this is real string + try: + if isinstance(data, unicode): # type: ignore + return data + except NameError: + return str(data) + else: + return str(data) + + @staticmethod + def deserialize_enum(data, enum_obj): + """Deserialize string into enum object. + + If the string is not a valid enum value it will be returned as-is + and a warning will be logged. + + :param str data: Response string to be deserialized. If this value is + None or invalid it will be returned as-is. + :param Enum enum_obj: Enum object to deserialize to. + :rtype: Enum + """ + if isinstance(data, enum_obj) or data is None: + return data + if isinstance(data, Enum): + data = data.value + if isinstance(data, int): + # Workaround. We might consider remove it in the future. + try: + return list(enum_obj.__members__.values())[data] + except IndexError: + error = "{!r} is not a valid index for enum {!r}" + raise DeserializationError(error.format(data, enum_obj)) + try: + return enum_obj(str(data)) + except ValueError: + for enum_value in enum_obj: + if enum_value.value.lower() == str(data).lower(): + return enum_value + # We don't fail anymore for unknown value, we deserialize as a string + _LOGGER.warning("Deserializer is not able to find %s as valid enum in %s", data, enum_obj) + return Deserializer.deserialize_unicode(data) + + @staticmethod + def deserialize_bytearray(attr): + """Deserialize string into bytearray. + + :param str attr: response string to be deserialized. + :rtype: bytearray + :raises: TypeError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return bytearray(b64decode(attr)) # type: ignore + + @staticmethod + def deserialize_base64(attr): + """Deserialize base64 encoded string into string. + + :param str attr: response string to be deserialized. + :rtype: bytearray + :raises: TypeError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return b64decode(encoded) + + @staticmethod + def deserialize_decimal(attr): + """Deserialize string into Decimal object. + + :param str attr: response string to be deserialized. + :rtype: Decimal + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + return decimal.Decimal(str(attr)) # type: ignore + except decimal.DecimalException as err: + msg = "Invalid decimal {}".format(attr) + raise DeserializationError(msg) from err + + @staticmethod + def deserialize_long(attr): + """Deserialize string into long (Py2) or int (Py3). + + :param str attr: response string to be deserialized. + :rtype: long or int + :raises: ValueError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return _long_type(attr) # type: ignore + + @staticmethod + def deserialize_duration(attr): + """Deserialize ISO-8601 formatted string into TimeDelta object. + + :param str attr: response string to be deserialized. + :rtype: TimeDelta + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + duration = isodate.parse_duration(attr) + except (ValueError, OverflowError, AttributeError) as err: + msg = "Cannot deserialize duration object." + raise DeserializationError(msg) from err + else: + return duration + + @staticmethod + def deserialize_date(attr): + """Deserialize ISO-8601 formatted string into Date object. + + :param str attr: response string to be deserialized. + :rtype: Date + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore + raise DeserializationError("Date must have only digits and -. Received: %s" % attr) + # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. + return isodate.parse_date(attr, defaultmonth=0, defaultday=0) + + @staticmethod + def deserialize_time(attr): + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :rtype: datetime.time + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore + raise DeserializationError("Date must have only digits and -. Received: %s" % attr) + return isodate.parse_time(attr) + + @staticmethod + def deserialize_rfc(attr): + """Deserialize RFC-1123 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: Datetime + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + parsed_date = email.utils.parsedate_tz(attr) # type: ignore + date_obj = datetime.datetime( + *parsed_date[:6], tzinfo=_FixedOffset(datetime.timedelta(minutes=(parsed_date[9] or 0) / 60)) + ) + if not date_obj.tzinfo: + date_obj = date_obj.astimezone(tz=TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to rfc datetime object." + raise DeserializationError(msg) from err + else: + return date_obj + + @staticmethod + def deserialize_iso(attr): + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: Datetime + :raises: DeserializationError if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + attr = attr.upper() # type: ignore + match = Deserializer.valid_date.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + check_decimal = attr.split(".") + if len(check_decimal) > 1: + decimal_str = "" + for digit in check_decimal[1]: + if digit.isdigit(): + decimal_str += digit + else: + break + if len(decimal_str) > 6: + attr = attr.replace(decimal_str, decimal_str[0:6]) + + date_obj = isodate.parse_datetime(attr) + test_utc = date_obj.utctimetuple() + if test_utc.tm_year > 9999 or test_utc.tm_year < 1: + raise OverflowError("Hit max or min date") + except (ValueError, OverflowError, AttributeError) as err: + msg = "Cannot deserialize datetime object." + raise DeserializationError(msg) from err + else: + return date_obj + + @staticmethod + def deserialize_unix(attr): + """Serialize Datetime object into IntTime format. + This is represented as seconds. + + :param int attr: Object to be serialized. + :rtype: Datetime + :raises: DeserializationError if format invalid + """ + if isinstance(attr, ET.Element): + attr = int(attr.text) # type: ignore + try: + attr = int(attr) + date_obj = datetime.datetime.fromtimestamp(attr, TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to unix datetime object." + raise DeserializationError(msg) from err + else: + return date_obj diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_vendor.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_vendor.py new file mode 100644 index 000000000000..1487cc18a180 --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_vendor.py @@ -0,0 +1,35 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from abc import ABC +from typing import TYPE_CHECKING + +from ._configuration import LoadTestAdministrationClientConfiguration, LoadTestRunClientConfiguration + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core import PipelineClient + + from ._serialization import Deserializer, Serializer + + +class LoadTestAdministrationClientMixinABC(ABC): + """DO NOT use this class. It is for internal typing use only.""" + + _client: "PipelineClient" + _config: LoadTestAdministrationClientConfiguration + _serialize: "Serializer" + _deserialize: "Deserializer" + + +class LoadTestRunClientMixinABC(ABC): + """DO NOT use this class. It is for internal typing use only.""" + + _client: "PipelineClient" + _config: LoadTestRunClientConfiguration + _serialize: "Serializer" + _deserialize: "Deserializer" diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_version.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_version.py index 010063f9dd93..be71c81bd282 100644 --- a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_version.py +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/_version.py @@ -1,6 +1,9 @@ -# ------------------------------------ -# Copyright (c) Microsoft Corporation. -# Licensed under the MIT License. -# ------------------------------------ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- -VERSION = "1.0.1" +VERSION = "1.0.0b1" diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/__init__.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/__init__.py index e055e16c9f6a..162a880336d4 100644 --- a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/__init__.py +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/__init__.py @@ -1,9 +1,25 @@ - -# ------------------------------------------------------------------------- +# coding=utf-8 +# -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. -# Licensed under the MIT License. See License.txt in the project root for -# license information. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -from ._client import LoadTestRunClient, LoadTestAdministrationClient -__all__ = ["LoadTestAdministrationClient", "LoadTestRunClient"] +from ._client import LoadTestAdministrationClient +from ._client import LoadTestRunClient + +try: + from ._patch import __all__ as _patch_all + from ._patch import * # pylint: disable=unused-wildcard-import +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "LoadTestAdministrationClient", + "LoadTestRunClient", +] +__all__.extend([p for p in _patch_all if p not in __all__]) + +_patch_sdk() diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_client.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_client.py index e3ed061bb413..e153219f4f65 100644 --- a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_client.py +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_client.py @@ -1,47 +1,71 @@ -# ------------------------------------------------------------------------- +# coding=utf-8 +# -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. -# Licensed under the MIT License. See License.txt in the project root for -# license information. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- from copy import deepcopy -from typing import Any, Awaitable +from typing import Any, Awaitable, TYPE_CHECKING -from azure.core.credentials_async import AsyncTokenCredential from azure.core import AsyncPipelineClient -from azure.core.rest import HttpRequest, AsyncHttpResponse +from azure.core.pipeline import policies +from azure.core.rest import AsyncHttpResponse, HttpRequest + +from .._serialization import Deserializer, Serializer +from ._configuration import LoadTestAdministrationClientConfiguration, LoadTestRunClientConfiguration +from ._operations import LoadTestAdministrationClientOperationsMixin, LoadTestRunClientOperationsMixin + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core.credentials_async import AsyncTokenCredential -from .._generated.aio._configuration import LoadTestingClientConfiguration -from .._generated._serialization import Deserializer, Serializer -from .._generated.aio.operations import AdministrationOperations, TestRunOperations -class _BaseClient: # pylint: disable=client-accepts-api-version-keyword - """These APIs allow end users to create, view and run load tests using Azure Load Test Service. +class LoadTestAdministrationClient( + LoadTestAdministrationClientOperationsMixin +): # pylint: disable=client-accepts-api-version-keyword + """LoadTestAdministrationClient. - :ivar administration: AdministrationOperations operations - :vartype administration: azure.developer.loadtesting.aio.operations.AdministrationOperations - :ivar test_run: TestRunOperations operations - :vartype test_run: azure.developer.loadtesting.aio.operations.TestRunOperations - :param endpoint: URL to perform data plane API operations on the resource. Required. + :param endpoint: Required. :type endpoint: str :param credential: Credential needed for the client to connect to Azure. Required. :type credential: ~azure.core.credentials_async.AsyncTokenCredential - :keyword api_version: Api Version. Default value is "2022-11-01". Note that overriding this - default value may result in unsupported behavior. + :keyword api_version: The API version to use for this operation. Default value is + "2023-04-01-preview". Note that overriding this default value may result in unsupported + behavior. :paramtype api_version: str """ def __init__(self, endpoint: str, credential: "AsyncTokenCredential", **kwargs: Any) -> None: - _endpoint = "https://{Endpoint}" - self._config = LoadTestingClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) - self._client = AsyncPipelineClient(base_url=_endpoint, config=self._config, **kwargs) + _endpoint = "https://{endpoint}" + self._config = LoadTestAdministrationClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: AsyncPipelineClient = AsyncPipelineClient(base_url=_endpoint, policies=_policies, **kwargs) self._serialize = Serializer() self._deserialize = Deserializer() self._serialize.client_side_validation = False - super().__init__(self._client, self._config, self._serialize, self._deserialize) - def send_request(self, request: HttpRequest, **kwargs: Any) -> Awaitable[AsyncHttpResponse]: + def send_request( + self, request: HttpRequest, *, stream: bool = False, **kwargs: Any + ) -> Awaitable[AsyncHttpResponse]: """Runs the network request through the client's chained policies. >>> from azure.core.rest import HttpRequest @@ -61,47 +85,96 @@ def send_request(self, request: HttpRequest, **kwargs: Any) -> Awaitable[AsyncHt request_copy = deepcopy(request) path_format_arguments = { - "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) - return self._client.send_request(request_copy, **kwargs) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore async def close(self) -> None: await self._client.close() - async def __aexit__(self, *exc_details) -> None: + async def __aenter__(self) -> "LoadTestAdministrationClient": + await self._client.__aenter__() + return self + + async def __aexit__(self, *exc_details: Any) -> None: await self._client.__aexit__(*exc_details) -class LoadTestAdministrationClient(_BaseClient, AdministrationOperations): # pylint: disable=client-accepts-api-version-keyword - """These APIs allow end users to create, view and run load tests using Azure Load Test Service. +class LoadTestRunClient(LoadTestRunClientOperationsMixin): # pylint: disable=client-accepts-api-version-keyword + """LoadTestRunClient. - :param endpoint: URL to perform data plane API operations on the resource. Required. + :param endpoint: Required. :type endpoint: str :param credential: Credential needed for the client to connect to Azure. Required. :type credential: ~azure.core.credentials_async.AsyncTokenCredential - :keyword api_version: Api Version. Default value is "2022-11-01". Note that overriding this - default value may result in unsupported behavior. + :keyword api_version: The API version to use for this operation. Default value is + "2023-04-01-preview". Note that overriding this default value may result in unsupported + behavior. :paramtype api_version: str """ - async def __aenter__(self) -> "LoadTestAdministrationClient": - await self._client.__aenter__() - return self + def __init__(self, endpoint: str, credential: "AsyncTokenCredential", **kwargs: Any) -> None: + _endpoint = "https://{endpoint}" + self._config = LoadTestRunClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: AsyncPipelineClient = AsyncPipelineClient(base_url=_endpoint, policies=_policies, **kwargs) -class LoadTestRunClient(_BaseClient, TestRunOperations): # pylint: disable=client-accepts-api-version-keyword - """These APIs allow end users to create, view and run load tests using Azure Load Test Service. + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False - :param endpoint: URL to perform data plane API operations on the resource. Required. - :type endpoint: str - :param credential: Credential needed for the client to connect to Azure. Required. - :type credential: ~azure.core.credentials_async.AsyncTokenCredential - :keyword api_version: Api Version. Default value is "2022-11-01". Note that overriding this - default value may result in unsupported behavior. - :paramtype api_version: str - """ + def send_request( + self, request: HttpRequest, *, stream: bool = False, **kwargs: Any + ) -> Awaitable[AsyncHttpResponse]: + """Runs the network request through the client's chained policies. + + >>> from azure.core.rest import HttpRequest + >>> request = HttpRequest("GET", "https://www.example.org/") + + >>> response = await client.send_request(request) + + + For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request + + :param request: The network request you want to make. Required. + :type request: ~azure.core.rest.HttpRequest + :keyword bool stream: Whether the response payload will be streamed. Defaults to False. + :return: The response of your network call. Does not do error handling on your response. + :rtype: ~azure.core.rest.AsyncHttpResponse + """ + + request_copy = deepcopy(request) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + + request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore + + async def close(self) -> None: + await self._client.close() async def __aenter__(self) -> "LoadTestRunClient": await self._client.__aenter__() return self + + async def __aexit__(self, *exc_details: Any) -> None: + await self._client.__aexit__(*exc_details) diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_configuration.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_configuration.py new file mode 100644 index 000000000000..087bdb95ca0d --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_configuration.py @@ -0,0 +1,113 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from typing import Any, TYPE_CHECKING + +from azure.core.pipeline import policies + +from .._version import VERSION + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core.credentials_async import AsyncTokenCredential + + +class LoadTestAdministrationClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long + """Configuration for LoadTestAdministrationClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param endpoint: Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials_async.AsyncTokenCredential + :keyword api_version: The API version to use for this operation. Default value is + "2023-04-01-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: "AsyncTokenCredential", **kwargs: Any) -> None: + api_version: str = kwargs.pop("api_version", "2023-04-01-preview") + + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.endpoint = endpoint + self.credential = credential + self.api_version = api_version + self.credential_scopes = kwargs.pop("credential_scopes", ["https://cnt-prod.loadtesting.azure.com/.default"]) + kwargs.setdefault("sdk_moniker", "developer-loadtesting/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get("redirect_policy") or policies.AsyncRedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.AsyncRetryPolicy(**kwargs) + self.authentication_policy = kwargs.get("authentication_policy") + if self.credential and not self.authentication_policy: + self.authentication_policy = policies.AsyncBearerTokenCredentialPolicy( + self.credential, *self.credential_scopes, **kwargs + ) + + +class LoadTestRunClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long + """Configuration for LoadTestRunClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :param endpoint: Required. + :type endpoint: str + :param credential: Credential needed for the client to connect to Azure. Required. + :type credential: ~azure.core.credentials_async.AsyncTokenCredential + :keyword api_version: The API version to use for this operation. Default value is + "2023-04-01-preview". Note that overriding this default value may result in unsupported + behavior. + :paramtype api_version: str + """ + + def __init__(self, endpoint: str, credential: "AsyncTokenCredential", **kwargs: Any) -> None: + api_version: str = kwargs.pop("api_version", "2023-04-01-preview") + + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") + if credential is None: + raise ValueError("Parameter 'credential' must not be None.") + + self.endpoint = endpoint + self.credential = credential + self.api_version = api_version + self.credential_scopes = kwargs.pop("credential_scopes", ["https://cnt-prod.loadtesting.azure.com/.default"]) + kwargs.setdefault("sdk_moniker", "developer-loadtesting/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) + self._configure(**kwargs) + + def _configure(self, **kwargs: Any) -> None: + self.user_agent_policy = kwargs.get("user_agent_policy") or policies.UserAgentPolicy(**kwargs) + self.headers_policy = kwargs.get("headers_policy") or policies.HeadersPolicy(**kwargs) + self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) + self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) + self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) + self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) + self.redirect_policy = kwargs.get("redirect_policy") or policies.AsyncRedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.AsyncRetryPolicy(**kwargs) + self.authentication_policy = kwargs.get("authentication_policy") + if self.credential and not self.authentication_policy: + self.authentication_policy = policies.AsyncBearerTokenCredentialPolicy( + self.credential, *self.credential_scopes, **kwargs + ) diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_operations/__init__.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_operations/__init__.py new file mode 100644 index 000000000000..c433bf33381f --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_operations/__init__.py @@ -0,0 +1,21 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._operations import LoadTestAdministrationClientOperationsMixin +from ._operations import LoadTestRunClientOperationsMixin + +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "LoadTestAdministrationClientOperationsMixin", + "LoadTestRunClientOperationsMixin", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_operations/_operations.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_operations/_operations.py new file mode 100644 index 000000000000..670942d5ed67 --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_operations/_operations.py @@ -0,0 +1,7948 @@ +# pylint: disable=too-many-lines,too-many-statements +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import datetime +from io import IOBase +import json +import sys +from typing import Any, AsyncIterable, Callable, Dict, IO, List, Optional, TypeVar, Union, overload +import urllib.parse + +from azure.core.async_paging import AsyncItemPaged, AsyncList +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + ResourceNotModifiedError, + map_error, +) +from azure.core.pipeline import PipelineResponse +from azure.core.rest import AsyncHttpResponse, HttpRequest +from azure.core.tracing.decorator import distributed_trace +from azure.core.tracing.decorator_async import distributed_trace_async +from azure.core.utils import case_insensitive_dict + +from ... import models as _models +from ..._model_base import SdkJSONEncoder, _deserialize +from ..._operations._operations import ( + build_load_test_administration_begin_upload_test_file_request, + build_load_test_administration_create_or_update_app_components_request, + build_load_test_administration_create_or_update_server_metrics_config_request, + build_load_test_administration_create_or_update_test_request, + build_load_test_administration_delete_test_file_request, + build_load_test_administration_delete_test_request, + build_load_test_administration_get_app_components_request, + build_load_test_administration_get_server_metrics_config_request, + build_load_test_administration_get_test_file_request, + build_load_test_administration_get_test_request, + build_load_test_administration_list_test_files_request, + build_load_test_administration_list_tests_request, + build_load_test_run_begin_test_run_request, + build_load_test_run_create_or_update_app_components_request, + build_load_test_run_create_or_update_server_metrics_config_request, + build_load_test_run_delete_test_run_request, + build_load_test_run_get_app_components_request, + build_load_test_run_get_metric_definitions_request, + build_load_test_run_get_metric_namespaces_request, + build_load_test_run_get_server_metrics_config_request, + build_load_test_run_get_test_run_file_request, + build_load_test_run_get_test_run_request, + build_load_test_run_list_metric_dimension_values_request, + build_load_test_run_list_metrics_request, + build_load_test_run_list_test_runs_request, + build_load_test_run_stop_test_run_request, +) +from .._vendor import LoadTestAdministrationClientMixinABC, LoadTestRunClientMixinABC + +if sys.version_info >= (3, 9): + from collections.abc import MutableMapping +else: + from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports +JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object +T = TypeVar("T") +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, Dict[str, Any]], Any]] + + +class LoadTestAdministrationClientOperationsMixin( # pylint: disable=name-too-long + LoadTestAdministrationClientMixinABC +): + @overload + async def create_or_update_test( + self, test_id: str, body: _models.Test, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.Test: + # pylint: disable=line-too-long + """Create a new test or update an existing test by providing the test Id. + + Create a new test or update an existing test by providing the test Id. + + :param test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: The resource instance. Required. + :type body: ~azure.developer.loadtesting.models.Test + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: Test. The Test is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.Test + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "testId": "str", # Unique test identifier for the load test, must contain + only lower-case alphabetic, numeric, underscore or hyphen characters. Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "baselineTestRunId": "str", # Optional. Id of the test run to be marked as + baseline to view trends of client-side metrics from recent test runs. + "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(RFC 3339 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 pairs. + }, + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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. + "kind": "str", # Optional. Kind of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. 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": "str", # Optional. 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. + } + } + }, + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "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. + } + + # response body for status code(s): 201, 200 + response == { + "testId": "str", # Unique test identifier for the load test, must contain + only lower-case alphabetic, numeric, underscore or hyphen characters. Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "baselineTestRunId": "str", # Optional. Id of the test run to be marked as + baseline to view trends of client-side metrics from recent test runs. + "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(RFC 3339 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 pairs. + }, + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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. + "kind": "str", # Optional. Kind of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. 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": "str", # Optional. 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. + } + } + }, + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "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. + } + """ + + @overload + async def create_or_update_test( + self, test_id: str, body: JSON, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.Test: + # pylint: disable=line-too-long + """Create a new test or update an existing test by providing the test Id. + + Create a new test or update an existing test by providing the test Id. + + :param test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: The resource instance. Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: Test. The Test is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.Test + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "testId": "str", # Unique test identifier for the load test, must contain + only lower-case alphabetic, numeric, underscore or hyphen characters. Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "baselineTestRunId": "str", # Optional. Id of the test run to be marked as + baseline to view trends of client-side metrics from recent test runs. + "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(RFC 3339 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 pairs. + }, + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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. + "kind": "str", # Optional. Kind of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. 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": "str", # Optional. 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. + } + } + }, + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "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. + } + """ + + @overload + async def create_or_update_test( + self, test_id: str, body: IO[bytes], *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.Test: + # pylint: disable=line-too-long + """Create a new test or update an existing test by providing the test Id. + + Create a new test or update an existing test by providing the test Id. + + :param test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: The resource instance. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: Test. The Test is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.Test + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "testId": "str", # Unique test identifier for the load test, must contain + only lower-case alphabetic, numeric, underscore or hyphen characters. Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "baselineTestRunId": "str", # Optional. Id of the test run to be marked as + baseline to view trends of client-side metrics from recent test runs. + "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(RFC 3339 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 pairs. + }, + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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. + "kind": "str", # Optional. Kind of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. 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": "str", # Optional. 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. + } + } + }, + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "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. + } + """ + + @distributed_trace_async + async def create_or_update_test( + self, test_id: str, body: Union[_models.Test, JSON, IO[bytes]], **kwargs: Any + ) -> _models.Test: + # pylint: disable=line-too-long + """Create a new test or update an existing test by providing the test Id. + + Create a new test or update an existing test by providing the test Id. + + :param test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: The resource instance. Is one of the following types: Test, JSON, IO[bytes] + Required. + :type body: ~azure.developer.loadtesting.models.Test or JSON or IO[bytes] + :return: Test. The Test is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.Test + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "testId": "str", # Unique test identifier for the load test, must contain + only lower-case alphabetic, numeric, underscore or hyphen characters. Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "baselineTestRunId": "str", # Optional. Id of the test run to be marked as + baseline to view trends of client-side metrics from recent test runs. + "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(RFC 3339 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 pairs. + }, + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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. + "kind": "str", # Optional. Kind of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. 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": "str", # Optional. 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. + } + } + }, + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "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. + } + + # response body for status code(s): 201, 200 + response == { + "testId": "str", # Unique test identifier for the load test, must contain + only lower-case alphabetic, numeric, underscore or hyphen characters. Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "baselineTestRunId": "str", # Optional. Id of the test run to be marked as + baseline to view trends of client-side metrics from recent test runs. + "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(RFC 3339 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 pairs. + }, + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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. + "kind": "str", # Optional. Kind of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. 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": "str", # Optional. 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. + } + } + }, + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "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. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.Test] = kwargs.pop("cls", None) + + content_type = content_type or "application/merge-patch+json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_load_test_administration_create_or_update_test_request( + test_id=test_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.status_code == 200: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.Test, response.json()) + + if response.status_code == 201: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.Test, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def create_or_update_app_components( + self, + test_id: str, + body: _models.TestAppComponents, + *, + content_type: str = "application/merge-patch+json", + **kwargs: Any + ) -> _models.TestAppComponents: + # pylint: disable=line-too-long + """Add an app component to a test. + + Add an app component to a test by providing the resource Id, name and type. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: App Component model. Required. + :type body: ~azure.developer.loadtesting.models.TestAppComponents + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestAppComponents. The TestAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "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. + "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(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + + # response body for status code(s): 201, 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "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. + "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(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + + @overload + async def create_or_update_app_components( + self, test_id: str, body: JSON, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.TestAppComponents: + # pylint: disable=line-too-long + """Add an app component to a test. + + Add an app component to a test by providing the resource Id, name and type. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: App Component model. Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestAppComponents. The TestAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "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. + "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(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + + @overload + async def create_or_update_app_components( + self, test_id: str, body: IO[bytes], *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.TestAppComponents: + # pylint: disable=line-too-long + """Add an app component to a test. + + Add an app component to a test by providing the resource Id, name and type. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: App Component model. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestAppComponents. The TestAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "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. + "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(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + + @distributed_trace_async + async def create_or_update_app_components( + self, test_id: str, body: Union[_models.TestAppComponents, JSON, IO[bytes]], **kwargs: Any + ) -> _models.TestAppComponents: + # pylint: disable=line-too-long + """Add an app component to a test. + + Add an app component to a test by providing the resource Id, name and type. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: App Component model. Is one of the following types: TestAppComponents, JSON, + IO[bytes] Required. + :type body: ~azure.developer.loadtesting.models.TestAppComponents or JSON or IO[bytes] + :return: TestAppComponents. The TestAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "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. + "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(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + + # response body for status code(s): 201, 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "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. + "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(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("content-type", None)) + cls: ClsType[_models.TestAppComponents] = kwargs.pop("cls", None) + + content_type = content_type or "application/merge-patch+json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_load_test_administration_create_or_update_app_components_request( + test_id=test_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.status_code == 200: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestAppComponents, response.json()) + + if response.status_code == 201: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestAppComponents, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def create_or_update_server_metrics_config( + self, + test_id: str, + body: _models.TestServerMetricConfig, + *, + content_type: str = "application/merge-patch+json", + **kwargs: Any + ) -> _models.TestServerMetricConfig: + """Configure server metrics for a test. + + Configure server metrics for a test. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: Server metric configuration model. Required. + :type body: ~azure.developer.loadtesting.models.TestServerMetricConfig + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestServerMetricConfig. The TestServerMetricConfig is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "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. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + + # response body for status code(s): 201, 200 + response == { + "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. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + + @overload + async def create_or_update_server_metrics_config( + self, test_id: str, body: JSON, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.TestServerMetricConfig: + """Configure server metrics for a test. + + Configure server metrics for a test. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: Server metric configuration model. Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestServerMetricConfig. The TestServerMetricConfig is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "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. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + + @overload + async def create_or_update_server_metrics_config( + self, test_id: str, body: IO[bytes], *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.TestServerMetricConfig: + """Configure server metrics for a test. + + Configure server metrics for a test. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: Server metric configuration model. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestServerMetricConfig. The TestServerMetricConfig is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "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. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + + @distributed_trace_async + async def create_or_update_server_metrics_config( + self, test_id: str, body: Union[_models.TestServerMetricConfig, JSON, IO[bytes]], **kwargs: Any + ) -> _models.TestServerMetricConfig: + """Configure server metrics for a test. + + Configure server metrics for a test. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :param body: Server metric configuration model. Is one of the following types: + TestServerMetricConfig, JSON, IO[bytes] Required. + :type body: ~azure.developer.loadtesting.models.TestServerMetricConfig or JSON or IO[bytes] + :return: TestServerMetricConfig. The TestServerMetricConfig is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "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. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + + # response body for status code(s): 201, 200 + response == { + "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. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("content-type", None)) + cls: ClsType[_models.TestServerMetricConfig] = kwargs.pop("cls", None) + + content_type = content_type or "application/merge-patch+json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_load_test_administration_create_or_update_server_metrics_config_request( + test_id=test_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.status_code == 200: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestServerMetricConfig, response.json()) + + if response.status_code == 201: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestServerMetricConfig, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_app_components(self, test_id: str, **kwargs: Any) -> _models.TestAppComponents: + # pylint: disable=line-too-long + """Get associated app component (collection of azure resources) for the given test. + + Get associated app component (collection of azure resources) for the given test. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :return: TestAppComponents. The TestAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "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. + "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(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TestAppComponents] = kwargs.pop("cls", None) + + _request = build_load_test_administration_get_app_components_request( + test_id=test_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestAppComponents, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_server_metrics_config(self, test_id: str, **kwargs: Any) -> _models.TestServerMetricConfig: + """List server metrics configuration for the given test. + + List server metrics configuration for the given test. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :return: TestServerMetricConfig. The TestServerMetricConfig is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "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. + } + }, + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testId": "str" # Optional. Test identifier. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TestServerMetricConfig] = kwargs.pop("cls", None) + + _request = build_load_test_administration_get_server_metrics_config_request( + test_id=test_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestServerMetricConfig, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_test(self, test_id: str, **kwargs: Any) -> _models.Test: + # pylint: disable=line-too-long + """Get load test details by test Id. + + Get load test details by test Id. + + :param test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :type test_id: str + :return: Test. The Test is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.Test + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "testId": "str", # Unique test identifier for the load test, must contain + only lower-case alphabetic, numeric, underscore or hyphen characters. Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "baselineTestRunId": "str", # Optional. Id of the test run to be marked as + baseline to view trends of client-side metrics from recent test runs. + "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(RFC 3339 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 pairs. + }, + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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. + "kind": "str", # Optional. Kind of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. 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": "str", # Optional. 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. + } + } + }, + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "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. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.Test] = kwargs.pop("cls", None) + + _request = build_load_test_administration_get_test_request( + test_id=test_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.Test, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_test_file(self, test_id: str, file_name: str, **kwargs: Any) -> _models.TestFileInfo: + # pylint: disable=line-too-long + """Get all the files that are associated with a test. + + Get all the files that are associated with a test. + + :param test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :type test_id: str + :param file_name: Name of the file. Required. + :type file_name: str + :return: TestFileInfo. The TestFileInfo is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestFileInfo + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry time of the file + (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: "JMX_FILE", + "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "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". + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TestFileInfo] = kwargs.pop("cls", None) + + _request = build_load_test_administration_get_test_file_request( + test_id=test_id, + file_name=file_name, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestFileInfo, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def list_test_files(self, test_id: str, **kwargs: Any) -> AsyncIterable["_models.TestFileInfo"]: + # pylint: disable=line-too-long + """Get all test files. + + Get all test files. + + :param test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :type test_id: str + :return: An iterator like instance of TestFileInfo + :rtype: + ~azure.core.async_paging.AsyncItemPaged[~azure.developer.loadtesting.models.TestFileInfo] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry time of the file + (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: "JMX_FILE", + "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "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". + } + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[List[_models.TestFileInfo]] = kwargs.pop("cls", None) + + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_load_test_administration_list_test_files_request( + test_id=test_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + return _request + + async def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize(List[_models.TestFileInfo], deserialized["value"]) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") or None, AsyncList(list_of_elem) + + async def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + return pipeline_response + + return AsyncItemPaged(get_next, extract_data) + + @distributed_trace + def list_tests( + self, + *, + orderby: Optional[str] = None, + search: Optional[str] = None, + last_modified_start_time: Optional[datetime.datetime] = None, + last_modified_end_time: Optional[datetime.datetime] = None, + **kwargs: Any + ) -> AsyncIterable["_models.Test"]: + # pylint: disable=line-too-long + """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}. + + :keyword orderby: Sort on the supported fields in (field asc/desc) format. eg: + lastModifiedDateTime asc. Supported fields - lastModifiedDateTime. Default value is None. + :paramtype orderby: str + :keyword search: 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. + :paramtype search: str + :keyword last_modified_start_time: Start DateTime(RFC 3339 literal format) of the last updated + time range to filter tests. Default value is None. + :paramtype last_modified_start_time: ~datetime.datetime + :keyword last_modified_end_time: End DateTime(RFC 3339 literal format) of the last updated time + range to filter tests. Default value is None. + :paramtype last_modified_end_time: ~datetime.datetime + :return: An iterator like instance of Test + :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.developer.loadtesting.models.Test] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "testId": "str", # Unique test identifier for the load test, must contain + only lower-case alphabetic, numeric, underscore or hyphen characters. Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "baselineTestRunId": "str", # Optional. Id of the test run to be marked as + baseline to view trends of client-side metrics from recent test runs. + "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(RFC 3339 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 pairs. + }, + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry + time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: + "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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. + "kind": "str", # Optional. Kind of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. 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": "str", # Optional. 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. + } + } + }, + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "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. + } + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + maxpagesize = kwargs.pop("maxpagesize", None) + cls: ClsType[List[_models.Test]] = kwargs.pop("cls", None) + + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_load_test_administration_list_tests_request( + orderby=orderby, + search=search, + last_modified_start_time=last_modified_start_time, + last_modified_end_time=last_modified_end_time, + maxpagesize=maxpagesize, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + return _request + + async def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize(List[_models.Test], deserialized["value"]) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") or None, AsyncList(list_of_elem) + + async def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + return pipeline_response + + return AsyncItemPaged(get_next, extract_data) + + @distributed_trace_async + async def begin_upload_test_file( + self, + test_id: str, + file_name: str, + body: bytes, + *, + file_type: Optional[Union[str, _models.FileType]] = None, + **kwargs: Any + ) -> _models.TestFileInfo: + # pylint: disable=line-too-long + """Upload input file for a given test Id. File size can't be more than 50 MB. + Existing file with same name for the given test will be overwritten. File + should be provided in the request body as application/octet-stream. + + Upload input file for a given test Id. File size can't be more than 50 MB. + Existing file with same name for the given test will be overwritten. File + should be provided in the request body as application/octet-stream. + + :param test_id: Unique name for the load test, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_id: str + :param file_name: Unique name for test file with file extension like : App.jmx. Required. + :type file_name: str + :param body: The file content as application/octet-stream. Required. + :type body: bytes + :keyword file_type: File type. Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". Default value is None. + :paramtype file_type: str or ~azure.developer.loadtesting.models.FileType + :return: TestFileInfo. The TestFileInfo is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestFileInfo + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201 + response == { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry time of the file + (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: "JMX_FILE", + "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "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". + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: str = kwargs.pop("content_type", _headers.pop("content-type", "application/octet-stream")) + cls: ClsType[_models.TestFileInfo] = kwargs.pop("cls", None) + + _content = body + + _request = build_load_test_administration_begin_upload_test_file_request( + test_id=test_id, + file_name=file_name, + file_type=file_type, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [201]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestFileInfo, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def delete_test_file( # pylint: disable=inconsistent-return-statements + self, test_id: str, file_name: str, **kwargs: Any + ) -> None: + """Delete file by the file name for a test. + + Delete file by the file name for a test. + + :param test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :type test_id: str + :param file_name: Name of the file. Required. + :type file_name: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_load_test_administration_delete_test_file_request( + test_id=test_id, + file_name=file_name, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @distributed_trace_async + async def delete_test(self, test_id: str, **kwargs: Any) -> None: # pylint: disable=inconsistent-return-statements + """Delete a test by its test Id. + + Delete a test by its test Id. + + :param test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :type test_id: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_load_test_administration_delete_test_request( + test_id=test_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + +class LoadTestRunClientOperationsMixin(LoadTestRunClientMixinABC): + @overload + async def begin_test_run( + self, + test_run_id: str, + body: _models.TestRun, + *, + content_type: str = "application/merge-patch+json", + old_test_run_id: Optional[str] = None, + **kwargs: Any + ) -> _models.TestRun: + # pylint: disable=line-too-long + """Create and start a new test run with the given test run Id. + + Create and start a new test run with the given test run Id. + + :param test_run_id: Unique test run identifier for the load test run, must contain only + lower-case alphabetic, numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: The resource instance. Required. + :type body: ~azure.developer.loadtesting.models.TestRun + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :keyword old_test_run_id: Existing test run identifier that should be rerun, if this is + provided, the + test will run with the JMX file, configuration and app components from the + existing test run. You can override the configuration values for new test run + in the request body. Default value is None. + :paramtype old_test_run_id: str + :return: TestRun. The TestRun is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRun + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "testRunId": "str", # Unique test run identifier for the load test run, must + contain only lower-case alphabetic, numeric, underscore or hyphen characters. + Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "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(RFC 3339 literal format). + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a testRun. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(RFC 3339 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "errorDetails": [ + { + "message": "str" # Optional. Error details in case test run + was not successfully run. + } + ], + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "kind": "str", # Optional. Type of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. 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": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(RFC 3339 literal format). + "status": "str", # Optional. The test run status. Known values are: + "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", + "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", + "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. + Required. + "expireDateTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. + Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + }, + "outputArtifacts": { + "artifactsContainerInfo": { + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the container (RFC 3339 literal format). + "url": "str" # Optional. This is a SAS URI to an + Azure Storage Container that contains the test run artifacts. + }, + "logsFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "resultFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED". + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Send network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "virtualUsers": 0 # Optional. Number of virtual users, for which test has + been run. + } + + # response body for status code(s): 201, 200 + response == { + "testRunId": "str", # Unique test run identifier for the load test run, must + contain only lower-case alphabetic, numeric, underscore or hyphen characters. + Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "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(RFC 3339 literal format). + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a testRun. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(RFC 3339 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "errorDetails": [ + { + "message": "str" # Optional. Error details in case test run + was not successfully run. + } + ], + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "kind": "str", # Optional. Type of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. 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": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(RFC 3339 literal format). + "status": "str", # Optional. The test run status. Known values are: + "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", + "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", + "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. + Required. + "expireDateTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. + Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + }, + "outputArtifacts": { + "artifactsContainerInfo": { + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the container (RFC 3339 literal format). + "url": "str" # Optional. This is a SAS URI to an + Azure Storage Container that contains the test run artifacts. + }, + "logsFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "resultFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED". + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Send network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "virtualUsers": 0 # Optional. Number of virtual users, for which test has + been run. + } + """ + + @overload + async def begin_test_run( + self, + test_run_id: str, + body: JSON, + *, + content_type: str = "application/merge-patch+json", + old_test_run_id: Optional[str] = None, + **kwargs: Any + ) -> _models.TestRun: + # pylint: disable=line-too-long + """Create and start a new test run with the given test run Id. + + Create and start a new test run with the given test run Id. + + :param test_run_id: Unique test run identifier for the load test run, must contain only + lower-case alphabetic, numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: The resource instance. Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :keyword old_test_run_id: Existing test run identifier that should be rerun, if this is + provided, the + test will run with the JMX file, configuration and app components from the + existing test run. You can override the configuration values for new test run + in the request body. Default value is None. + :paramtype old_test_run_id: str + :return: TestRun. The TestRun is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRun + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "testRunId": "str", # Unique test run identifier for the load test run, must + contain only lower-case alphabetic, numeric, underscore or hyphen characters. + Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "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(RFC 3339 literal format). + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a testRun. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(RFC 3339 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "errorDetails": [ + { + "message": "str" # Optional. Error details in case test run + was not successfully run. + } + ], + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "kind": "str", # Optional. Type of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. 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": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(RFC 3339 literal format). + "status": "str", # Optional. The test run status. Known values are: + "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", + "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", + "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. + Required. + "expireDateTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. + Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + }, + "outputArtifacts": { + "artifactsContainerInfo": { + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the container (RFC 3339 literal format). + "url": "str" # Optional. This is a SAS URI to an + Azure Storage Container that contains the test run artifacts. + }, + "logsFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "resultFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED". + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Send network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "virtualUsers": 0 # Optional. Number of virtual users, for which test has + been run. + } + """ + + @overload + async def begin_test_run( + self, + test_run_id: str, + body: IO[bytes], + *, + content_type: str = "application/merge-patch+json", + old_test_run_id: Optional[str] = None, + **kwargs: Any + ) -> _models.TestRun: + # pylint: disable=line-too-long + """Create and start a new test run with the given test run Id. + + Create and start a new test run with the given test run Id. + + :param test_run_id: Unique test run identifier for the load test run, must contain only + lower-case alphabetic, numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: The resource instance. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :keyword old_test_run_id: Existing test run identifier that should be rerun, if this is + provided, the + test will run with the JMX file, configuration and app components from the + existing test run. You can override the configuration values for new test run + in the request body. Default value is None. + :paramtype old_test_run_id: str + :return: TestRun. The TestRun is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRun + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "testRunId": "str", # Unique test run identifier for the load test run, must + contain only lower-case alphabetic, numeric, underscore or hyphen characters. + Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "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(RFC 3339 literal format). + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a testRun. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(RFC 3339 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "errorDetails": [ + { + "message": "str" # Optional. Error details in case test run + was not successfully run. + } + ], + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "kind": "str", # Optional. Type of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. 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": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(RFC 3339 literal format). + "status": "str", # Optional. The test run status. Known values are: + "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", + "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", + "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. + Required. + "expireDateTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. + Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + }, + "outputArtifacts": { + "artifactsContainerInfo": { + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the container (RFC 3339 literal format). + "url": "str" # Optional. This is a SAS URI to an + Azure Storage Container that contains the test run artifacts. + }, + "logsFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "resultFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED". + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Send network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "virtualUsers": 0 # Optional. Number of virtual users, for which test has + been run. + } + """ + + @distributed_trace_async + async def begin_test_run( + self, + test_run_id: str, + body: Union[_models.TestRun, JSON, IO[bytes]], + *, + old_test_run_id: Optional[str] = None, + **kwargs: Any + ) -> _models.TestRun: + # pylint: disable=line-too-long + """Create and start a new test run with the given test run Id. + + Create and start a new test run with the given test run Id. + + :param test_run_id: Unique test run identifier for the load test run, must contain only + lower-case alphabetic, numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: The resource instance. Is one of the following types: TestRun, JSON, IO[bytes] + Required. + :type body: ~azure.developer.loadtesting.models.TestRun or JSON or IO[bytes] + :keyword old_test_run_id: Existing test run identifier that should be rerun, if this is + provided, the + test will run with the JMX file, configuration and app components from the + existing test run. You can override the configuration values for new test run + in the request body. Default value is None. + :paramtype old_test_run_id: str + :return: TestRun. The TestRun is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRun + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "testRunId": "str", # Unique test run identifier for the load test run, must + contain only lower-case alphabetic, numeric, underscore or hyphen characters. + Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "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(RFC 3339 literal format). + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a testRun. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(RFC 3339 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "errorDetails": [ + { + "message": "str" # Optional. Error details in case test run + was not successfully run. + } + ], + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "kind": "str", # Optional. Type of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. 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": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(RFC 3339 literal format). + "status": "str", # Optional. The test run status. Known values are: + "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", + "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", + "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. + Required. + "expireDateTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. + Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + }, + "outputArtifacts": { + "artifactsContainerInfo": { + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the container (RFC 3339 literal format). + "url": "str" # Optional. This is a SAS URI to an + Azure Storage Container that contains the test run artifacts. + }, + "logsFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "resultFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED". + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Send network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "virtualUsers": 0 # Optional. Number of virtual users, for which test has + been run. + } + + # response body for status code(s): 201, 200 + response == { + "testRunId": "str", # Unique test run identifier for the load test run, must + contain only lower-case alphabetic, numeric, underscore or hyphen characters. + Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "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(RFC 3339 literal format). + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a testRun. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(RFC 3339 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "errorDetails": [ + { + "message": "str" # Optional. Error details in case test run + was not successfully run. + } + ], + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "kind": "str", # Optional. Type of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. 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": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(RFC 3339 literal format). + "status": "str", # Optional. The test run status. Known values are: + "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", + "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", + "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. + Required. + "expireDateTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. + Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + }, + "outputArtifacts": { + "artifactsContainerInfo": { + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the container (RFC 3339 literal format). + "url": "str" # Optional. This is a SAS URI to an + Azure Storage Container that contains the test run artifacts. + }, + "logsFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "resultFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED". + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Send network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "virtualUsers": 0 # Optional. Number of virtual users, for which test has + been run. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[_models.TestRun] = kwargs.pop("cls", None) + + content_type = content_type or "application/merge-patch+json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_load_test_run_begin_test_run_request( + test_run_id=test_run_id, + old_test_run_id=old_test_run_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.status_code == 200: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRun, response.json()) + + if response.status_code == 201: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRun, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def create_or_update_app_components( + self, + test_run_id: str, + body: _models.TestRunAppComponents, + *, + content_type: str = "application/merge-patch+json", + **kwargs: Any + ) -> _models.TestRunAppComponents: + # pylint: disable=line-too-long + """Add an app component to a test run. + + Add an app component to a test run by providing the resource Id, name and type. + + :param test_run_id: Unique Id for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: App Component model. Required. + :type body: ~azure.developer.loadtesting.models.TestRunAppComponents + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestRunAppComponents. The TestRunAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "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. + "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(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testRunId": "str" # Optional. Test run identifier. + } + + # response body for status code(s): 201, 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "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. + "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(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testRunId": "str" # Optional. Test run identifier. + } + """ + + @overload + async def create_or_update_app_components( + self, test_run_id: str, body: JSON, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.TestRunAppComponents: + # pylint: disable=line-too-long + """Add an app component to a test run. + + Add an app component to a test run by providing the resource Id, name and type. + + :param test_run_id: Unique Id for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: App Component model. Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestRunAppComponents. The TestRunAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "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. + "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(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testRunId": "str" # Optional. Test run identifier. + } + """ + + @overload + async def create_or_update_app_components( + self, test_run_id: str, body: IO[bytes], *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.TestRunAppComponents: + # pylint: disable=line-too-long + """Add an app component to a test run. + + Add an app component to a test run by providing the resource Id, name and type. + + :param test_run_id: Unique Id for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: App Component model. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestRunAppComponents. The TestRunAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "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. + "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(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testRunId": "str" # Optional. Test run identifier. + } + """ + + @distributed_trace_async + async def create_or_update_app_components( + self, test_run_id: str, body: Union[_models.TestRunAppComponents, JSON, IO[bytes]], **kwargs: Any + ) -> _models.TestRunAppComponents: + # pylint: disable=line-too-long + """Add an app component to a test run. + + Add an app component to a test run by providing the resource Id, name and type. + + :param test_run_id: Unique Id for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: App Component model. Is one of the following types: TestRunAppComponents, JSON, + IO[bytes] Required. + :type body: ~azure.developer.loadtesting.models.TestRunAppComponents or JSON or IO[bytes] + :return: TestRunAppComponents. The TestRunAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "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. + "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(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testRunId": "str" # Optional. Test run identifier. + } + + # response body for status code(s): 201, 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "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. + "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(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testRunId": "str" # Optional. Test run identifier. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("content-type", None)) + cls: ClsType[_models.TestRunAppComponents] = kwargs.pop("cls", None) + + content_type = content_type or "application/merge-patch+json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_load_test_run_create_or_update_app_components_request( + test_run_id=test_run_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.status_code == 200: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRunAppComponents, response.json()) + + if response.status_code == 201: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRunAppComponents, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def create_or_update_server_metrics_config( + self, + test_run_id: str, + body: _models.TestRunServerMetricConfig, + *, + content_type: str = "application/merge-patch+json", + **kwargs: Any + ) -> _models.TestRunServerMetricConfig: + """Configure server metrics for a test run. + + Configure server metrics for a test run. + + :param test_run_id: Unique Id for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: Server metric configuration model. Required. + :type body: ~azure.developer.loadtesting.models.TestRunServerMetricConfig + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestRunServerMetricConfig. The TestRunServerMetricConfig is compatible with + MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # 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(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "testRunId": "str" # Optional. Test run identifier. + } + + # response body for status code(s): 201, 200 + response == { + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "testRunId": "str" # Optional. Test run identifier. + } + """ + + @overload + async def create_or_update_server_metrics_config( + self, test_run_id: str, body: JSON, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.TestRunServerMetricConfig: + """Configure server metrics for a test run. + + Configure server metrics for a test run. + + :param test_run_id: Unique Id for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: Server metric configuration model. Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestRunServerMetricConfig. The TestRunServerMetricConfig is compatible with + MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "testRunId": "str" # Optional. Test run identifier. + } + """ + + @overload + async def create_or_update_server_metrics_config( + self, test_run_id: str, body: IO[bytes], *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> _models.TestRunServerMetricConfig: + """Configure server metrics for a test run. + + Configure server metrics for a test run. + + :param test_run_id: Unique Id for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: Server metric configuration model. Required. + :type body: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/merge-patch+json". + :paramtype content_type: str + :return: TestRunServerMetricConfig. The TestRunServerMetricConfig is compatible with + MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 201, 200 + response == { + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "testRunId": "str" # Optional. Test run identifier. + } + """ + + @distributed_trace_async + async def create_or_update_server_metrics_config( + self, test_run_id: str, body: Union[_models.TestRunServerMetricConfig, JSON, IO[bytes]], **kwargs: Any + ) -> _models.TestRunServerMetricConfig: + """Configure server metrics for a test run. + + Configure server metrics for a test run. + + :param test_run_id: Unique Id for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: Server metric configuration model. Is one of the following types: + TestRunServerMetricConfig, JSON, IO[bytes] Required. + :type body: ~azure.developer.loadtesting.models.TestRunServerMetricConfig or JSON or IO[bytes] + :return: TestRunServerMetricConfig. The TestRunServerMetricConfig is compatible with + MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # 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(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "testRunId": "str" # Optional. Test run identifier. + } + + # response body for status code(s): 201, 200 + response == { + "createdBy": "str", # Optional. The user that created. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The creation + datetime(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "testRunId": "str" # Optional. Test run identifier. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("content-type", None)) + cls: ClsType[_models.TestRunServerMetricConfig] = kwargs.pop("cls", None) + + content_type = content_type or "application/merge-patch+json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + + _request = build_load_test_run_create_or_update_server_metrics_config_request( + test_run_id=test_run_id, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.status_code == 200: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRunServerMetricConfig, response.json()) + + if response.status_code == 201: + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRunServerMetricConfig, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def delete_test_run( # pylint: disable=inconsistent-return-statements + self, test_run_id: str, **kwargs: Any + ) -> None: + """Delete an existing load test run. + + Delete an existing load test run by providing the testRunId. + + :param test_run_id: Unique test run identifier for the load test run, must contain only + lower-case alphabetic, numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[None] = kwargs.pop("cls", None) + + _request = build_load_test_run_delete_test_run_request( + test_run_id=test_run_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if cls: + return cls(pipeline_response, None, {}) # type: ignore + + @distributed_trace_async + async def get_app_components(self, test_run_id: str, **kwargs: Any) -> _models.TestRunAppComponents: + # pylint: disable=line-too-long + """Get associated app component (collection of azure resources) for the given test + run. + + Get associated app component (collection of azure resources) for the given test + run. + + :param test_run_id: Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :return: TestRunAppComponents. The TestRunAppComponents is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunAppComponents + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "components": { + "str": { + "resourceId": "str", # fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name, required while + creating the app component. Required. + "resourceType": "str", # Azure resource type, required while + creating the app component. Required. + "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. + "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(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "testRunId": "str" # Optional. Test run identifier. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TestRunAppComponents] = kwargs.pop("cls", None) + + _request = build_load_test_run_get_app_components_request( + test_run_id=test_run_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRunAppComponents, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_server_metrics_config(self, test_run_id: str, **kwargs: Any) -> _models.TestRunServerMetricConfig: + """Get associated server metrics configuration for the given test run. + + Get associated server metrics configuration for the given test run. + + :param test_run_id: Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :return: TestRunServerMetricConfig. The TestRunServerMetricConfig is compatible with + MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunServerMetricConfig + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # 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(RFC 3339 literal format). + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricNamespace": "str", # Metric name space. Required. + "name": "str", # The invariant value of metric name. + Required. + "resourceId": "str", # Azure resource id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique name for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "testRunId": "str" # Optional. Test run identifier. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TestRunServerMetricConfig] = kwargs.pop("cls", None) + + _request = build_load_test_run_get_server_metrics_config_request( + test_run_id=test_run_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRunServerMetricConfig, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_test_run(self, test_run_id: str, **kwargs: Any) -> _models.TestRun: + # pylint: disable=line-too-long + """Get test run details by test run Id. + + Get test run details by test run Id. + + :param test_run_id: Unique test run identifier for the load test run, must contain only + lower-case alphabetic, numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :return: TestRun. The TestRun is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRun + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "testRunId": "str", # Unique test run identifier for the load test run, must + contain only lower-case alphabetic, numeric, underscore or hyphen characters. + Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "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(RFC 3339 literal format). + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a testRun. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(RFC 3339 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "errorDetails": [ + { + "message": "str" # Optional. Error details in case test run + was not successfully run. + } + ], + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "kind": "str", # Optional. Type of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. 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": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(RFC 3339 literal format). + "status": "str", # Optional. The test run status. Known values are: + "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", + "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", + "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. + Required. + "expireDateTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. + Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + }, + "outputArtifacts": { + "artifactsContainerInfo": { + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the container (RFC 3339 literal format). + "url": "str" # Optional. This is a SAS URI to an + Azure Storage Container that contains the test run artifacts. + }, + "logsFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "resultFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED". + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Send network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "virtualUsers": 0 # Optional. Number of virtual users, for which test has + been run. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TestRun] = kwargs.pop("cls", None) + + _request = build_load_test_run_get_test_run_request( + test_run_id=test_run_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRun, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_test_run_file(self, test_run_id: str, file_name: str, **kwargs: Any) -> _models.TestRunFileInfo: + # pylint: disable=line-too-long + """Get test run file by file name. + + Get test run file by file name. + + :param test_run_id: Unique test run identifier for the load test run, must contain only + lower-case alphabetic, numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param file_name: Name of the file. Required. + :type file_name: str + :return: TestRunFileInfo. The TestRunFileInfo is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRunFileInfo + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. Expiry time of the file + (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known values are: "JMX_FILE", + "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "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". + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TestRunFileInfo] = kwargs.pop("cls", None) + + _request = build_load_test_run_get_test_run_file_request( + test_run_id=test_run_id, + file_name=file_name, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRunFileInfo, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def list_metric_dimension_values( + self, + test_run_id: str, + name: str, + *, + metricname: str, + metric_namespace: str, + time_interval: str, + interval: Optional[Union[str, _models.TimeGrain]] = None, + **kwargs: Any + ) -> _models.DimensionValueList: + """List the dimension values for the given metric dimension name. + + List the dimension values for the given metric dimension name. + + :param test_run_id: Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param name: Dimension name. Required. + :type name: str + :keyword metricname: Metric name. Required. + :paramtype metricname: str + :keyword metric_namespace: Metric namespace to query metric definitions for. Required. + :paramtype metric_namespace: str + :keyword time_interval: The timespan of the query. It is a string with the following format + 'startDateTime_ISO/endDateTime_ISO'. Required. + :paramtype time_interval: str + :keyword interval: The interval (i.e. timegrain) of the query. Known values are: "PT5S", + "PT10S", "PT1M", "PT5M", and "PT1H". Default value is None. + :paramtype interval: str or ~azure.developer.loadtesting.models.TimeGrain + :return: DimensionValueList. The DimensionValueList is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.DimensionValueList + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "name": "str", # Optional. The dimension name. + "nextLink": "str", # Optional. Link for the next set of values in case of + paginated results, if applicable. + "value": [ + "str" # Optional. The dimension value. + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.DimensionValueList] = kwargs.pop("cls", None) + + _request = build_load_test_run_list_metric_dimension_values_request( + test_run_id=test_run_id, + name=name, + metricname=metricname, + metric_namespace=metric_namespace, + time_interval=time_interval, + interval=interval, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.DimensionValueList, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_metric_definitions( + self, test_run_id: str, *, metric_namespace: str, **kwargs: Any + ) -> _models.MetricDefinitionCollection: + # pylint: disable=line-too-long + """List the metric definitions for a load test run. + + List the metric definitions for a load test run. + + :param test_run_id: Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :keyword metric_namespace: Metric namespace to query metric definitions for. Required. + :paramtype metric_namespace: str + :return: MetricDefinitionCollection. The MetricDefinitionCollection is compatible with + MutableMapping + :rtype: ~azure.developer.loadtesting.models.MetricDefinitionCollection + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "value": [ + { + "description": "str", # Optional. The metric description. + "dimensions": [ + { + "description": "str", # Optional. The + description. + "name": "str" # Optional. The name. + } + ], + "metricAvailabilities": [ + { + "timeGrain": "str" # Optional. The time + grain specifies the aggregation interval for the metric. + Expressed as a duration 'PT1M', 'PT1H', etc. Known values are: + "PT5S", "PT10S", "PT1M", "PT5M", and "PT1H". + } + ], + "name": "str", # Optional. The metric name. + "namespace": "str", # Optional. The namespace the metric + belongs to. + "primaryAggregationType": "str", # Optional. The primary + aggregation type value defining how to use the values for display. Known + values are: "Average", "Count", "None", "Total", "Percentile90", + "Percentile95", and "Percentile99". + "supportedAggregationTypes": [ + "str" # Optional. The collection of what all + aggregation types are supported. + ], + "unit": "str" # Optional. The unit of the metric. Known + values are: "NotSpecified", "Percent", "Count", "Seconds", + "Milliseconds", "Bytes", "BytesPerSecond", and "CountPerSecond". + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.MetricDefinitionCollection] = kwargs.pop("cls", None) + + _request = build_load_test_run_get_metric_definitions_request( + test_run_id=test_run_id, + metric_namespace=metric_namespace, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.MetricDefinitionCollection, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_metric_namespaces(self, test_run_id: str, **kwargs: Any) -> _models.MetricNamespaceCollection: + """List the metric namespaces for a load test run. + + List the metric namespaces for a load test run. + + :param test_run_id: Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :return: MetricNamespaceCollection. The MetricNamespaceCollection is compatible with + MutableMapping + :rtype: ~azure.developer.loadtesting.models.MetricNamespaceCollection + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "value": [ + { + "description": "str", # Optional. The namespace description. + "name": "str" # Optional. The metric namespace name. + } + ] + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.MetricNamespaceCollection] = kwargs.pop("cls", None) + + _request = build_load_test_run_get_metric_namespaces_request( + test_run_id=test_run_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.MetricNamespaceCollection, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def list_metrics( + self, + test_run_id: str, + body: Optional[_models.MetricRequestPayload] = None, + *, + metricname: str, + metric_namespace: str, + time_interval: str, + aggregation: Optional[str] = None, + interval: Optional[Union[str, _models.TimeGrain]] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncIterable["_models.TimeSeriesElement"]: + """List the metric values for a load test run. + + List the metric values for a load test run. + + :param test_run_id: Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: Metric dimension filter. Default value is None. + :type body: ~azure.developer.loadtesting.models.MetricRequestPayload + :keyword metricname: Metric name. Required. + :paramtype metricname: str + :keyword metric_namespace: Metric namespace to query metric definitions for. Required. + :paramtype metric_namespace: str + :keyword time_interval: The timespan of the query. It is a string with the following format + 'startDateTime_ISO/endDateTime_ISO'. Required. + :paramtype time_interval: str + :keyword aggregation: The aggregation. Default value is None. + :paramtype aggregation: str + :keyword interval: The interval (i.e. timegrain) of the query. Known values are: "PT5S", + "PT10S", "PT1M", "PT5M", and "PT1H". Default value is None. + :paramtype interval: str or ~azure.developer.loadtesting.models.TimeGrain + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An iterator like instance of TimeSeriesElement + :rtype: + ~azure.core.async_paging.AsyncItemPaged[~azure.developer.loadtesting.models.TimeSeriesElement] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "filters": [ + { + "name": "str", # Optional. The dimension name. + "values": [ + "str" # Optional. The dimension values. Maximum + values can be 20. + ] + } + ] + } + + # response body for status code(s): 200 + response == { + "data": [ + { + "timestamp": "2020-02-20 00:00:00", # Optional. The + timestamp for the metric value in RFC 3339 format. + "value": 0.0 # Optional. The metric value. + } + ], + "dimensionValues": [ + { + "name": "str", # Optional. The name of the dimension. + "value": "str" # Optional. The value of the dimension. + } + ] + } + """ + + @overload + def list_metrics( + self, + test_run_id: str, + body: Optional[JSON] = None, + *, + metricname: str, + metric_namespace: str, + time_interval: str, + aggregation: Optional[str] = None, + interval: Optional[Union[str, _models.TimeGrain]] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncIterable["_models.TimeSeriesElement"]: + """List the metric values for a load test run. + + List the metric values for a load test run. + + :param test_run_id: Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: Metric dimension filter. Default value is None. + :type body: JSON + :keyword metricname: Metric name. Required. + :paramtype metricname: str + :keyword metric_namespace: Metric namespace to query metric definitions for. Required. + :paramtype metric_namespace: str + :keyword time_interval: The timespan of the query. It is a string with the following format + 'startDateTime_ISO/endDateTime_ISO'. Required. + :paramtype time_interval: str + :keyword aggregation: The aggregation. Default value is None. + :paramtype aggregation: str + :keyword interval: The interval (i.e. timegrain) of the query. Known values are: "PT5S", + "PT10S", "PT1M", "PT5M", and "PT1H". Default value is None. + :paramtype interval: str or ~azure.developer.loadtesting.models.TimeGrain + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: An iterator like instance of TimeSeriesElement + :rtype: + ~azure.core.async_paging.AsyncItemPaged[~azure.developer.loadtesting.models.TimeSeriesElement] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "data": [ + { + "timestamp": "2020-02-20 00:00:00", # Optional. The + timestamp for the metric value in RFC 3339 format. + "value": 0.0 # Optional. The metric value. + } + ], + "dimensionValues": [ + { + "name": "str", # Optional. The name of the dimension. + "value": "str" # Optional. The value of the dimension. + } + ] + } + """ + + @overload + def list_metrics( + self, + test_run_id: str, + body: Optional[IO[bytes]] = None, + *, + metricname: str, + metric_namespace: str, + time_interval: str, + aggregation: Optional[str] = None, + interval: Optional[Union[str, _models.TimeGrain]] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> AsyncIterable["_models.TimeSeriesElement"]: + """List the metric values for a load test run. + + List the metric values for a load test run. + + :param test_run_id: Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: Metric dimension filter. Default value is None. + :type body: IO[bytes] + :keyword metricname: Metric name. Required. + :paramtype metricname: str + :keyword metric_namespace: Metric namespace to query metric definitions for. Required. + :paramtype metric_namespace: str + :keyword time_interval: The timespan of the query. It is a string with the following format + 'startDateTime_ISO/endDateTime_ISO'. Required. + :paramtype time_interval: str + :keyword aggregation: The aggregation. Default value is None. + :paramtype aggregation: str + :keyword interval: The interval (i.e. timegrain) of the query. Known values are: "PT5S", + "PT10S", "PT1M", "PT5M", and "PT1H". Default value is None. + :paramtype interval: str or ~azure.developer.loadtesting.models.TimeGrain + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: An iterator like instance of TimeSeriesElement + :rtype: + ~azure.core.async_paging.AsyncItemPaged[~azure.developer.loadtesting.models.TimeSeriesElement] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "data": [ + { + "timestamp": "2020-02-20 00:00:00", # Optional. The + timestamp for the metric value in RFC 3339 format. + "value": 0.0 # Optional. The metric value. + } + ], + "dimensionValues": [ + { + "name": "str", # Optional. The name of the dimension. + "value": "str" # Optional. The value of the dimension. + } + ] + } + """ + + @distributed_trace + def list_metrics( + self, + test_run_id: str, + body: Optional[Union[_models.MetricRequestPayload, JSON, IO[bytes]]] = None, + *, + metricname: str, + metric_namespace: str, + time_interval: str, + aggregation: Optional[str] = None, + interval: Optional[Union[str, _models.TimeGrain]] = None, + **kwargs: Any + ) -> AsyncIterable["_models.TimeSeriesElement"]: + """List the metric values for a load test run. + + List the metric values for a load test run. + + :param test_run_id: Unique name for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :param body: Metric dimension filter. Is one of the following types: MetricRequestPayload, + JSON, IO[bytes] Default value is None. + :type body: ~azure.developer.loadtesting.models.MetricRequestPayload or JSON or IO[bytes] + :keyword metricname: Metric name. Required. + :paramtype metricname: str + :keyword metric_namespace: Metric namespace to query metric definitions for. Required. + :paramtype metric_namespace: str + :keyword time_interval: The timespan of the query. It is a string with the following format + 'startDateTime_ISO/endDateTime_ISO'. Required. + :paramtype time_interval: str + :keyword aggregation: The aggregation. Default value is None. + :paramtype aggregation: str + :keyword interval: The interval (i.e. timegrain) of the query. Known values are: "PT5S", + "PT10S", "PT1M", "PT5M", and "PT1H". Default value is None. + :paramtype interval: str or ~azure.developer.loadtesting.models.TimeGrain + :return: An iterator like instance of TimeSeriesElement + :rtype: + ~azure.core.async_paging.AsyncItemPaged[~azure.developer.loadtesting.models.TimeSeriesElement] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "filters": [ + { + "name": "str", # Optional. The dimension name. + "values": [ + "str" # Optional. The dimension values. Maximum + values can be 20. + ] + } + ] + } + + # response body for status code(s): 200 + response == { + "data": [ + { + "timestamp": "2020-02-20 00:00:00", # Optional. The + timestamp for the metric value in RFC 3339 format. + "value": 0.0 # Optional. The metric value. + } + ], + "dimensionValues": [ + { + "name": "str", # Optional. The name of the dimension. + "value": "str" # Optional. The value of the dimension. + } + ] + } + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[List[_models.TimeSeriesElement]] = kwargs.pop("cls", None) + + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + content_type = content_type or "application/json" + _content = None + if isinstance(body, (IOBase, bytes)): + _content = body + else: + if body is not None: + _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore + else: + _content = None + + def prepare_request(next_link=None): + if not next_link: + + _request = build_load_test_run_list_metrics_request( + test_run_id=test_run_id, + metricname=metricname, + metric_namespace=metric_namespace, + time_interval=time_interval, + aggregation=aggregation, + interval=interval, + content_type=content_type, + api_version=self._config.api_version, + content=_content, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + return _request + + async def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize(List[_models.TimeSeriesElement], deserialized["value"]) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") or None, AsyncList(list_of_elem) + + async def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + return pipeline_response + + return AsyncItemPaged(get_next, extract_data) + + @distributed_trace + def list_test_runs( + self, + *, + orderby: Optional[str] = None, + search: Optional[str] = None, + test_id: Optional[str] = None, + execution_from: Optional[datetime.datetime] = None, + execution_to: Optional[datetime.datetime] = None, + status: Optional[str] = None, + **kwargs: Any + ) -> AsyncIterable["_models.TestRun"]: + # pylint: disable=line-too-long + """Get all test runs for the given filters. + + Get all test runs for the given filters. + + :keyword orderby: Sort on the supported fields in (field asc/desc) format. eg: executedDateTime + asc. Supported fields - executedDateTime. Default value is None. + :paramtype orderby: str + :keyword search: Prefix based, case sensitive search on searchable fields - description, + executedUser. For example, to search for a test run, with description 500 VUs, + the search parameter can be 500. Default value is None. + :paramtype search: str + :keyword test_id: Unique name of an existing load test. Default value is None. + :paramtype test_id: str + :keyword execution_from: Start DateTime(RFC 3339 literal format) of test-run execution time + filter range. Default value is None. + :paramtype execution_from: ~datetime.datetime + :keyword execution_to: End DateTime(RFC 3339 literal format) of test-run execution time filter + range. Default value is None. + :paramtype execution_to: ~datetime.datetime + :keyword status: Comma separated list of test run status. Default value is None. + :paramtype status: str + :return: An iterator like instance of TestRun + :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.developer.loadtesting.models.TestRun] + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "testRunId": "str", # Unique test run identifier for the load test run, must + contain only lower-case alphabetic, numeric, underscore or hyphen characters. + Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "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(RFC 3339 literal format). + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a testRun. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(RFC 3339 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "errorDetails": [ + { + "message": "str" # Optional. Error details in case test run + was not successfully run. + } + ], + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "kind": "str", # Optional. Type of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. 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": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(RFC 3339 literal format). + "status": "str", # Optional. The test run status. Known values are: + "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", + "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", + "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. + Required. + "expireDateTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. + Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + }, + "outputArtifacts": { + "artifactsContainerInfo": { + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the container (RFC 3339 literal format). + "url": "str" # Optional. This is a SAS URI to an + Azure Storage Container that contains the test run artifacts. + }, + "logsFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "resultFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED". + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Send network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "virtualUsers": 0 # Optional. Number of virtual users, for which test has + been run. + } + """ + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + maxpagesize = kwargs.pop("maxpagesize", None) + cls: ClsType[List[_models.TestRun]] = kwargs.pop("cls", None) + + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + def prepare_request(next_link=None): + if not next_link: + + _request = build_load_test_run_list_test_runs_request( + orderby=orderby, + search=search, + test_id=test_id, + execution_from=execution_from, + execution_to=execution_to, + status=status, + maxpagesize=maxpagesize, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + else: + # make call to next link with the client's api-version + _parsed_next_link = urllib.parse.urlparse(next_link) + _next_request_params = case_insensitive_dict( + { + key: [urllib.parse.quote(v) for v in value] + for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() + } + ) + _next_request_params["api-version"] = self._config.api_version + _request = HttpRequest( + "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params + ) + path_format_arguments = { + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + return _request + + async def extract_data(pipeline_response): + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize(List[_models.TestRun], deserialized["value"]) + if cls: + list_of_elem = cls(list_of_elem) # type: ignore + return deserialized.get("nextLink") or None, AsyncList(list_of_elem) + + async def get_next(next_link=None): + _request = prepare_request(next_link) + + _stream = False + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + return pipeline_response + + return AsyncItemPaged(get_next, extract_data) + + @distributed_trace_async + async def stop_test_run(self, test_run_id: str, **kwargs: Any) -> _models.TestRun: + # pylint: disable=line-too-long + """Stop test run by test run Id. + + Stop test run by test run Id. + + :param test_run_id: Unique test run identifier for the load test run, must contain only + lower-case alphabetic, numeric, underscore or hyphen characters. Required. + :type test_run_id: str + :return: TestRun. The TestRun is compatible with MutableMapping + :rtype: ~azure.developer.loadtesting.models.TestRun + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "testRunId": "str", # Unique test run identifier for the load test run, must + contain only lower-case alphabetic, numeric, underscore or hyphen characters. + Required. + "autoStopCriteria": { + "autoStopDisabled": bool, # Optional. Whether auto-stop should be + disabled. The default value is false. + "errorRate": 0.0, # Optional. Threshold percentage of errors on + which test run should be automatically stopped. Allowed values are in range + of 0.0-100.0. + "errorRateTimeWindowInSeconds": 0 # Optional. Time window during + which the error percentage should be evaluated in seconds. + }, + "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(RFC 3339 literal format). + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a testRun. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(RFC 3339 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "errorDetails": [ + { + "message": "str" # Optional. Error details in case test run + was not successfully run. + } + ], + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "kind": "str", # Optional. Type of test. Known values are: "URL" and "JMX". + "lastModifiedBy": "str", # Optional. The user that last modified. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + datetime(RFC 3339 literal format). + "loadTestConfiguration": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-400. Required for + creating a new test. + "optionalLoadTestConfig": { + "duration": 0, # Optional. Test run duration in seconds. + "endpointUrl": "str", # Optional. Test URL. Provide the + complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + "maxResponseTimeInMs": 0, # Optional. Maximum response time + in milliseconds of the API/endpoint. + "rampUpTime": 0, # Optional. Ramp up time in seconds. + "requestsPerSecond": 0, # Optional. Target throughput + (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling + it. + "virtualUsers": 0 # Optional. No of concurrent virtual + users. + }, + "quickStartTest": bool, # Optional. If true, optionalLoadTestConfig + is required and JMX script for the load test is not required to upload. + "splitAllCSVs": bool # Optional. 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": "str", # Optional. Action taken after the + threshold is met. Default is "u2018continue"u2019. Known values are: + "continue" and "stop". + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions * + "u2018percentage"u2019 - for error metric , "u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. Known values are: "count", "percentage", "avg", "p50", + "p90", "p95", "p99", "min", and "max". + "clientMetric": "str", # Optional. The client metric + on which the criteria should be applied. Known values are: + "response_time_ms", "latency", "error", "requests", and + "requests_per_sec". + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019, "u2018<"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. Known values are: "passed", "undetermined", and "failed". + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "publicIPDisabled": bool, # Optional. Inject load test engines without + deploying public IP for outbound access. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. Known values are: + "AKV_SECRET_URI" and "SECRET_VALUE". + "value": "str" # Optional. The value of the secret for the + respective type. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(RFC 3339 literal format). + "status": "str", # Optional. The test run status. Known values are: + "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", + "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", + "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalFileInfo": [ + { + "fileName": "str", # Name of the file. + Required. + "expireDateTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. + Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and + "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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". + }, + "urlTestConfigFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "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": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + }, + "outputArtifacts": { + "artifactsContainerInfo": { + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the container (RFC 3339 literal format). + "url": "str" # Optional. This is a SAS URI to an + Azure Storage Container that contains the test run artifacts. + }, + "logsFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + }, + "resultFileInfo": { + "fileName": "str", # Name of the file. Required. + "expireDateTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file (RFC 3339 literal format). + "fileType": "str", # Optional. File type. Known + values are: "JMX_FILE", "USER_PROPERTIES", "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + "url": "str", # Optional. File URL. + "validationFailureDetails": "str", # Optional. + Validation failure error details. + "validationStatus": "str" # Optional. Validation + status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", + and "VALIDATION_NOT_REQUIRED". + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. Known values are: "PASSED", "NOT_APPLICABLE", and "FAILED". + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Send network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "virtualUsers": 0 # Optional. Number of virtual users, for which test has + been run. + } + """ + error_map = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.TestRun] = kwargs.pop("cls", None) + + _request = build_load_test_run_stop_test_run_request( + test_run_id=test_run_id, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + await response.read() # Load the body in memory and close the socket + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TestRun, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_operations/_patch.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_operations/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_operations/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_patch.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_vendor.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_vendor.py new file mode 100644 index 000000000000..c6ab7b500913 --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/aio/_vendor.py @@ -0,0 +1,35 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from abc import ABC +from typing import TYPE_CHECKING + +from ._configuration import LoadTestAdministrationClientConfiguration, LoadTestRunClientConfiguration + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from azure.core import AsyncPipelineClient + + from .._serialization import Deserializer, Serializer + + +class LoadTestAdministrationClientMixinABC(ABC): + """DO NOT use this class. It is for internal typing use only.""" + + _client: "AsyncPipelineClient" + _config: LoadTestAdministrationClientConfiguration + _serialize: "Serializer" + _deserialize: "Deserializer" + + +class LoadTestRunClientMixinABC(ABC): + """DO NOT use this class. It is for internal typing use only.""" + + _client: "AsyncPipelineClient" + _config: LoadTestRunClientConfiguration + _serialize: "Serializer" + _deserialize: "Deserializer" diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/models/__init__.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/models/__init__.py new file mode 100644 index 000000000000..9edc44c39961 --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/models/__init__.py @@ -0,0 +1,117 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._models import AppComponent +from ._models import ArtifactsContainerInfo +from ._models import AutoStopCriteria +from ._models import CertificateMetadata +from ._models import DimensionFilter +from ._models import DimensionValue +from ._models import DimensionValueList +from ._models import ErrorDetails +from ._models import LoadTestConfiguration +from ._models import MetricAvailability +from ._models import MetricDefinition +from ._models import MetricDefinitionCollection +from ._models import MetricNamespace +from ._models import MetricNamespaceCollection +from ._models import MetricRequestPayload +from ._models import MetricValue +from ._models import NameAndDesc +from ._models import OptionalLoadTestConfig +from ._models import PassFailCriteria +from ._models import PassFailMetric +from ._models import ResourceMetric +from ._models import Secret +from ._models import Test +from ._models import TestAppComponents +from ._models import TestFileInfo +from ._models import TestInputArtifacts +from ._models import TestRun +from ._models import TestRunAppComponents +from ._models import TestRunArtifacts +from ._models import TestRunFileInfo +from ._models import TestRunInputArtifacts +from ._models import TestRunOutputArtifacts +from ._models import TestRunServerMetricConfig +from ._models import TestRunStatistics +from ._models import TestServerMetricConfig +from ._models import TimeSeriesElement + +from ._enums import AggregationType +from ._enums import CertificateType +from ._enums import FileStatus +from ._enums import FileType +from ._enums import MetricUnit +from ._enums import PFAction +from ._enums import PFAgFunc +from ._enums import PFMetrics +from ._enums import PFResult +from ._enums import PFTestResult +from ._enums import SecretType +from ._enums import Status +from ._enums import TestKind +from ._enums import TimeGrain +from ._patch import __all__ as _patch_all +from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "AppComponent", + "ArtifactsContainerInfo", + "AutoStopCriteria", + "CertificateMetadata", + "DimensionFilter", + "DimensionValue", + "DimensionValueList", + "ErrorDetails", + "LoadTestConfiguration", + "MetricAvailability", + "MetricDefinition", + "MetricDefinitionCollection", + "MetricNamespace", + "MetricNamespaceCollection", + "MetricRequestPayload", + "MetricValue", + "NameAndDesc", + "OptionalLoadTestConfig", + "PassFailCriteria", + "PassFailMetric", + "ResourceMetric", + "Secret", + "Test", + "TestAppComponents", + "TestFileInfo", + "TestInputArtifacts", + "TestRun", + "TestRunAppComponents", + "TestRunArtifacts", + "TestRunFileInfo", + "TestRunInputArtifacts", + "TestRunOutputArtifacts", + "TestRunServerMetricConfig", + "TestRunStatistics", + "TestServerMetricConfig", + "TimeSeriesElement", + "AggregationType", + "CertificateType", + "FileStatus", + "FileType", + "MetricUnit", + "PFAction", + "PFAgFunc", + "PFMetrics", + "PFResult", + "PFTestResult", + "SecretType", + "Status", + "TestKind", + "TimeGrain", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/models/_enums.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/models/_enums.py new file mode 100644 index 000000000000..3a5ffef039e2 --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/models/_enums.py @@ -0,0 +1,226 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from enum import Enum +from azure.core import CaseInsensitiveEnumMeta + + +class AggregationType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Aggregation type.""" + + AVERAGE = "Average" + """Average value.""" + COUNT = "Count" + """Total count.""" + NONE = "None" + """Aggregation will be average in this case.""" + TOTAL = "Total" + """Total sum.""" + PERCENTILE90 = "Percentile90" + """90th percentile.""" + PERCENTILE95 = "Percentile95" + """95th percentile.""" + PERCENTILE99 = "Percentile99" + """99th percentile.""" + + +class CertificateType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Types of certificates supported.""" + + AKV_CERT_URI = "AKV_CERT_URI" + """If the certificate is stored in an Azure Key Vault.""" + + +class FileStatus(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """File status.""" + + NOT_VALIDATED = "NOT_VALIDATED" + """File is not validated.""" + VALIDATION_SUCCESS = "VALIDATION_SUCCESS" + """File is validated.""" + VALIDATION_FAILURE = "VALIDATION_FAILURE" + """File validation is failed.""" + VALIDATION_INITIATED = "VALIDATION_INITIATED" + """File validation is in progress.""" + VALIDATION_NOT_REQUIRED = "VALIDATION_NOT_REQUIRED" + """Validation is not required.""" + + +class FileType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Types of file supported.""" + + JMX_FILE = "JMX_FILE" + """If the file is a JMX script.""" + USER_PROPERTIES = "USER_PROPERTIES" + """If the file is a user properties file.""" + ADDITIONAL_ARTIFACTS = "ADDITIONAL_ARTIFACTS" + """If the file is not among any of the other supported file types.""" + ZIPPED_ARTIFACTS = "ZIPPED_ARTIFACTS" + """If the file is a compressed archive containing a collection of various artifacts or resources.""" + URL_TEST_CONFIG_JSON = "URL_TEST_CONFIG_JSON" + """If the file is a JSON config file to define the requests for a URL test.""" + + +class MetricUnit(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Metric unit.""" + + NOT_SPECIFIED = "NotSpecified" + """No unit specified.""" + PERCENT = "Percent" + """Percentage.""" + COUNT = "Count" + """Value count.""" + SECONDS = "Seconds" + """Seconds.""" + MILLISECONDS = "Milliseconds" + """Milliseconds""" + BYTES = "Bytes" + """Bytes""" + BYTES_PER_SECOND = "BytesPerSecond" + """Bytes per second""" + COUNT_PER_SECOND = "CountPerSecond" + """Count per second""" + + +class PFAction(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Action to take on failure of pass/fail criteria.""" + + CONTINUE = "continue" + """Test will continue to run even if pass fail metric criteria metric gets failed.""" + STOP = "stop" + """Test run will stop if pass fail criteria metric is not passed.""" + + +class PFAgFunc(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Aggregation functions for pass/fail criteria.""" + + COUNT = "count" + """Criteria applies for count value.""" + PERCENTAGE = "percentage" + """Criteria applies for given percentage value.""" + AVG = "avg" + """Criteria applies for avg value.""" + P50 = "p50" + """Criteria applies for 50th percentile value.""" + P90 = "p90" + """Criteria applies for 90th percentile value.""" + P95 = "p95" + """Criteria applies for 95th percentile value.""" + P99 = "p99" + """Criteria applies for 99th percentile value.""" + MIN = "min" + """Criteria applies for minimum value.""" + MAX = "max" + """Criteria applies for maximum value.""" + + +class PFMetrics(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Metrics for pass/fail criteria.""" + + RESPONSE_TIME_MS = "response_time_ms" + """Pass fail criteria for response time metric in milliseconds.""" + LATENCY = "latency" + """Pass fail criteria for latency metric in milliseconds.""" + ERROR = "error" + """Pass fail criteria for error metric.""" + REQUESTS = "requests" + """Pass fail criteria for total requests.""" + REQUESTS_PER_SEC = "requests_per_sec" + """Pass fail criteria for request per second.""" + + +class PFResult(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Pass/fail criteria result.""" + + PASSED = "passed" + """Given pass fail criteria metric has passed.""" + UNDETERMINED = "undetermined" + """Given pass fail criteria metric couldn't determine.""" + FAILED = "failed" + """Given pass fail criteria metric has failed.""" + + +class PFTestResult(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Test result based on pass/fail criteria.""" + + PASSED = "PASSED" + """Pass/fail criteria has passed.""" + NOT_APPLICABLE = "NOT_APPLICABLE" + """Pass/fail criteria is not applicable.""" + FAILED = "FAILED" + """Pass/fail criteria has failed.""" + + +class SecretType(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Types of secrets supported.""" + + AKV_SECRET_URI = "AKV_SECRET_URI" + """If the secret is stored in an Azure Key Vault.""" + SECRET_VALUE = "SECRET_VALUE" + """If the secret value provided as plain text.""" + + +class Status(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Test run status.""" + + ACCEPTED = "ACCEPTED" + """Test run request is accepted.""" + NOTSTARTED = "NOTSTARTED" + """Test run is not yet started.""" + PROVISIONING = "PROVISIONING" + """Test run is provisioning.""" + PROVISIONED = "PROVISIONED" + """Test run is provisioned.""" + CONFIGURING = "CONFIGURING" + """Test run is getting configured.""" + CONFIGURED = "CONFIGURED" + """Test run configuration is done.""" + EXECUTING = "EXECUTING" + """Test run has started executing.""" + EXECUTED = "EXECUTED" + """Test run execution is completed.""" + DEPROVISIONING = "DEPROVISIONING" + """Test run is getting deprovisioned.""" + DEPROVISIONED = "DEPROVISIONED" + """Test run is deprovisioned.""" + DONE = "DONE" + """Test run is completed.""" + CANCELLING = "CANCELLING" + """Test run is being cancelled.""" + CANCELLED = "CANCELLED" + """Test run request is cancelled.""" + FAILED = "FAILED" + """Test run request is failed.""" + VALIDATION_SUCCESS = "VALIDATION_SUCCESS" + """Test run JMX file is validated.""" + VALIDATION_FAILURE = "VALIDATION_FAILURE" + """Test run JMX file validation is failed.""" + + +class TestKind(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Test kind.""" + + URL = "URL" + """URL Test""" + JMX = "JMX" + """JMX Test""" + + +class TimeGrain(str, Enum, metaclass=CaseInsensitiveEnumMeta): + """Time Grain.""" + + PT5S = "PT5S" + """5 seconds, available only if test run duration is less than 10 minutes.""" + PT10S = "PT10S" + """10 seconds, available only if test run duration is less than 10 minutes.""" + PT1M = "PT1M" + """1 minute""" + PT5M = "PT5M" + """5 minutes, available only if test run duration is greater than 1 minute.""" + PT1H = "PT1H" + """1 hour, available only if test run duration is greater than 1 minute.""" diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/models/_models.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/models/_models.py new file mode 100644 index 000000000000..1a7f6ae55f60 --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/models/_models.py @@ -0,0 +1,1934 @@ +# coding=utf-8 +# pylint: disable=too-many-lines +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +import datetime +from typing import Any, Dict, List, Mapping, Optional, TYPE_CHECKING, Union, overload + +from .. import _model_base +from .._model_base import rest_field + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from .. import models as _models + + +class AppComponent(_model_base.Model): + """An Azure resource object (Refer azure generic resource model + :https://docs.microsoft.com/en-us/rest/api/resources/resources/get-by-id#genericresource). + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + All required parameters must be populated in order to send to server. + + :ivar resource_id: fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + :vartype resource_id: str + :ivar resource_name: Azure resource name, required while creating the app component. Required. + :vartype resource_name: str + :ivar resource_type: Azure resource type, required while creating the app component. Required. + :vartype resource_type: str + :ivar display_name: Azure resource display name. + :vartype display_name: str + :ivar resource_group: Resource group name of the Azure resource. + :vartype resource_group: str + :ivar subscription_id: Subscription Id of the Azure resource. + :vartype subscription_id: str + :ivar kind: Kind of Azure resource type. + :vartype kind: str + """ + + resource_id: str = rest_field(name="resourceId", visibility=["read"]) + """fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required.""" + resource_name: str = rest_field(name="resourceName") + """Azure resource name, required while creating the app component. Required.""" + resource_type: str = rest_field(name="resourceType") + """Azure resource type, required while creating the app component. Required.""" + display_name: Optional[str] = rest_field(name="displayName") + """Azure resource display name.""" + resource_group: Optional[str] = rest_field(name="resourceGroup", visibility=["read"]) + """Resource group name of the Azure resource.""" + subscription_id: Optional[str] = rest_field(name="subscriptionId", visibility=["read"]) + """Subscription Id of the Azure resource.""" + kind: Optional[str] = rest_field() + """Kind of Azure resource type.""" + + @overload + def __init__( + self, + *, + resource_name: str, + resource_type: str, + display_name: Optional[str] = None, + kind: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ArtifactsContainerInfo(_model_base.Model): + """Artifacts container info. + + :ivar url: This is a SAS URI to an Azure Storage Container that contains the test run + artifacts. + :vartype url: str + :ivar expire_date_time: Expiry time of the container (RFC 3339 literal format). + :vartype expire_date_time: ~datetime.datetime + """ + + url: Optional[str] = rest_field() + """This is a SAS URI to an Azure Storage Container that contains the test run artifacts.""" + expire_date_time: Optional[datetime.datetime] = rest_field(name="expireDateTime", format="rfc3339") + """Expiry time of the container (RFC 3339 literal format).""" + + @overload + def __init__( + self, + *, + url: Optional[str] = None, + expire_date_time: Optional[datetime.datetime] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class AutoStopCriteria(_model_base.Model): + """Auto stop criteria for a test. This will automatically stop a load test if the error percentage + is high for a certain time window. + + :ivar auto_stop_disabled: Whether auto-stop should be disabled. The default value is false. + :vartype auto_stop_disabled: bool + :ivar error_rate: Threshold percentage of errors on which test run should be automatically + stopped. Allowed values are in range of 0.0-100.0. + :vartype error_rate: float + :ivar error_rate_time_window_in_seconds: Time window during which the error percentage should + be evaluated in seconds. + :vartype error_rate_time_window_in_seconds: int + """ + + auto_stop_disabled: Optional[bool] = rest_field(name="autoStopDisabled") + """Whether auto-stop should be disabled. The default value is false.""" + error_rate: Optional[float] = rest_field(name="errorRate") + """Threshold percentage of errors on which test run should be automatically stopped. Allowed + values are in range of 0.0-100.0.""" + error_rate_time_window_in_seconds: Optional[int] = rest_field(name="errorRateTimeWindowInSeconds") + """Time window during which the error percentage should be evaluated in seconds.""" + + @overload + def __init__( + self, + *, + auto_stop_disabled: Optional[bool] = None, + error_rate: Optional[float] = None, + error_rate_time_window_in_seconds: Optional[int] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class CertificateMetadata(_model_base.Model): + """Certificates metadata. + + :ivar value: The value of the certificate for respective type. + :vartype value: str + :ivar type: Type of certificate. "AKV_CERT_URI" + :vartype type: str or ~azure.developer.loadtesting.models.CertificateType + :ivar name: Name of the certificate. + :vartype name: str + """ + + value: Optional[str] = rest_field() + """The value of the certificate for respective type.""" + type: Optional[Union[str, "_models.CertificateType"]] = rest_field() + """Type of certificate. \"AKV_CERT_URI\"""" + name: Optional[str] = rest_field() + """Name of the certificate.""" + + @overload + def __init__( + self, + *, + value: Optional[str] = None, + type: Optional[Union[str, "_models.CertificateType"]] = None, + name: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class DimensionFilter(_model_base.Model): + """Dimension name and values to filter. + + :ivar name: The dimension name. + :vartype name: str + :ivar values_property: The dimension values. Maximum values can be 20. + :vartype values_property: list[str] + """ + + name: Optional[str] = rest_field() + """The dimension name.""" + values_property: Optional[List[str]] = rest_field(name="values") + """The dimension values. Maximum values can be 20.""" + + @overload + def __init__( + self, + *, + name: Optional[str] = None, + values_property: Optional[List[str]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class DimensionValue(_model_base.Model): + """Represents a metric dimension value. + + :ivar name: The name of the dimension. + :vartype name: str + :ivar value: The value of the dimension. + :vartype value: str + """ + + name: Optional[str] = rest_field() + """The name of the dimension.""" + value: Optional[str] = rest_field() + """The value of the dimension.""" + + @overload + def __init__( + self, + *, + name: Optional[str] = None, + value: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class DimensionValueList(_model_base.Model): + """Metrics dimension values. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + :ivar name: The dimension name. + :vartype name: str + :ivar value: The dimension value. + :vartype value: list[str] + :ivar next_link: Link for the next set of values in case of paginated results, if applicable. + :vartype next_link: str + """ + + name: Optional[str] = rest_field(visibility=["read"]) + """The dimension name.""" + value: Optional[List[str]] = rest_field() + """The dimension value.""" + next_link: Optional[str] = rest_field(name="nextLink") + """Link for the next set of values in case of paginated results, if applicable.""" + + @overload + def __init__( + self, + *, + value: Optional[List[str]] = None, + next_link: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ErrorDetails(_model_base.Model): + """Error details if there is any failure in load test run. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + :ivar message: Error details in case test run was not successfully run. + :vartype message: str + """ + + message: Optional[str] = rest_field(visibility=["read"]) + """Error details in case test run was not successfully run.""" + + +class LoadTestConfiguration(_model_base.Model): + """Configurations for the load test. + + :ivar engine_instances: The number of engine instances to execute load test. Supported values + are in range of 1-400. Required for creating a new test. + :vartype engine_instances: int + :ivar split_all_c_s_vs: 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. + :vartype split_all_c_s_vs: bool + :ivar quick_start_test: If true, optionalLoadTestConfig is required and JMX script for the load + test is + not required to upload. + :vartype quick_start_test: bool + :ivar optional_load_test_config: Configuration for quick load test. + :vartype optional_load_test_config: ~azure.developer.loadtesting.models.OptionalLoadTestConfig + """ + + engine_instances: Optional[int] = rest_field(name="engineInstances") + """The number of engine instances to execute load test. Supported values are in range of 1-400. + Required for creating a new test.""" + split_all_c_s_vs: Optional[bool] = rest_field(name="splitAllCSVs") + """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.""" + quick_start_test: Optional[bool] = rest_field(name="quickStartTest") + """If true, optionalLoadTestConfig is required and JMX script for the load test is + not required to upload.""" + optional_load_test_config: Optional["_models.OptionalLoadTestConfig"] = rest_field(name="optionalLoadTestConfig") + """Configuration for quick load test.""" + + @overload + def __init__( + self, + *, + engine_instances: Optional[int] = None, + split_all_c_s_vs: Optional[bool] = None, + quick_start_test: Optional[bool] = None, + optional_load_test_config: Optional["_models.OptionalLoadTestConfig"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class MetricAvailability(_model_base.Model): + """Metric availability specifies the time grain (aggregation interval or frequency). + + :ivar time_grain: The time grain specifies the aggregation interval for the metric. Expressed + as + a duration 'PT1M', 'PT1H', etc. Known values are: "PT5S", "PT10S", "PT1M", "PT5M", and "PT1H". + :vartype time_grain: str or ~azure.developer.loadtesting.models.TimeGrain + """ + + time_grain: Optional[Union[str, "_models.TimeGrain"]] = rest_field(name="timeGrain") + """The time grain specifies the aggregation interval for the metric. Expressed as + a duration 'PT1M', 'PT1H', etc. Known values are: \"PT5S\", \"PT10S\", \"PT1M\", \"PT5M\", and + \"PT1H\".""" + + @overload + def __init__( + self, + *, + time_grain: Optional[Union[str, "_models.TimeGrain"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class MetricDefinition(_model_base.Model): + """Metric definition. + + :ivar dimensions: List of dimensions. + :vartype dimensions: list[~azure.developer.loadtesting.models.NameAndDesc] + :ivar description: The metric description. + :vartype description: str + :ivar name: The metric name. + :vartype name: str + :ivar namespace: The namespace the metric belongs to. + :vartype namespace: str + :ivar primary_aggregation_type: The primary aggregation type value defining how to use the + values for display. Known values are: "Average", "Count", "None", "Total", "Percentile90", + "Percentile95", and "Percentile99". + :vartype primary_aggregation_type: str or ~azure.developer.loadtesting.models.AggregationType + :ivar supported_aggregation_types: The collection of what all aggregation types are supported. + :vartype supported_aggregation_types: list[str] + :ivar unit: The unit of the metric. Known values are: "NotSpecified", "Percent", "Count", + "Seconds", "Milliseconds", "Bytes", "BytesPerSecond", and "CountPerSecond". + :vartype unit: str or ~azure.developer.loadtesting.models.MetricUnit + :ivar metric_availabilities: Metric availability specifies the time grain (aggregation interval + or + frequency). + :vartype metric_availabilities: list[~azure.developer.loadtesting.models.MetricAvailability] + """ + + dimensions: Optional[List["_models.NameAndDesc"]] = rest_field() + """List of dimensions.""" + description: Optional[str] = rest_field() + """The metric description.""" + name: Optional[str] = rest_field() + """The metric name.""" + namespace: Optional[str] = rest_field() + """The namespace the metric belongs to.""" + primary_aggregation_type: Optional[Union[str, "_models.AggregationType"]] = rest_field( + name="primaryAggregationType" + ) + """The primary aggregation type value defining how to use the values for display. Known values + are: \"Average\", \"Count\", \"None\", \"Total\", \"Percentile90\", \"Percentile95\", and + \"Percentile99\".""" + supported_aggregation_types: Optional[List[str]] = rest_field(name="supportedAggregationTypes") + """The collection of what all aggregation types are supported.""" + unit: Optional[Union[str, "_models.MetricUnit"]] = rest_field() + """The unit of the metric. Known values are: \"NotSpecified\", \"Percent\", \"Count\", + \"Seconds\", \"Milliseconds\", \"Bytes\", \"BytesPerSecond\", and \"CountPerSecond\".""" + metric_availabilities: Optional[List["_models.MetricAvailability"]] = rest_field(name="metricAvailabilities") + """Metric availability specifies the time grain (aggregation interval or + frequency).""" + + @overload + def __init__( + self, + *, + dimensions: Optional[List["_models.NameAndDesc"]] = None, + description: Optional[str] = None, + name: Optional[str] = None, + namespace: Optional[str] = None, + primary_aggregation_type: Optional[Union[str, "_models.AggregationType"]] = None, + supported_aggregation_types: Optional[List[str]] = None, + unit: Optional[Union[str, "_models.MetricUnit"]] = None, + metric_availabilities: Optional[List["_models.MetricAvailability"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class MetricDefinitionCollection(_model_base.Model): + """Represents collection of metric definitions. + + All required parameters must be populated in order to send to server. + + :ivar value: the values for the metric definitions. Required. + :vartype value: list[~azure.developer.loadtesting.models.MetricDefinition] + """ + + value: List["_models.MetricDefinition"] = rest_field() + """the values for the metric definitions. Required.""" + + @overload + def __init__( + self, + *, + value: List["_models.MetricDefinition"], + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class MetricNamespace(_model_base.Model): + """Metric namespace class specifies the metadata for a metric namespace. + + :ivar description: The namespace description. + :vartype description: str + :ivar name: The metric namespace name. + :vartype name: str + """ + + description: Optional[str] = rest_field() + """The namespace description.""" + name: Optional[str] = rest_field() + """The metric namespace name.""" + + @overload + def __init__( + self, + *, + description: Optional[str] = None, + name: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class MetricNamespaceCollection(_model_base.Model): + """Represents collection of metric namespaces. + + All required parameters must be populated in order to send to server. + + :ivar value: The values for the metric namespaces. Required. + :vartype value: list[~azure.developer.loadtesting.models.MetricNamespace] + """ + + value: List["_models.MetricNamespace"] = rest_field() + """The values for the metric namespaces. Required.""" + + @overload + def __init__( + self, + *, + value: List["_models.MetricNamespace"], + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class MetricRequestPayload(_model_base.Model): + """Filters to fetch the set of metric. + + :ivar filters: Get metrics for specific dimension values. Example: Metric contains dimension + like SamplerName, Error. To retrieve all the time series data where SamplerName + is equals to HTTPRequest1 or HTTPRequest2, the DimensionFilter value will be + {"SamplerName", ["HTTPRequest1", "HTTPRequest2"}. + :vartype filters: list[~azure.developer.loadtesting.models.DimensionFilter] + """ + + filters: Optional[List["_models.DimensionFilter"]] = rest_field() + """Get metrics for specific dimension values. Example: Metric contains dimension + like SamplerName, Error. To retrieve all the time series data where SamplerName + is equals to HTTPRequest1 or HTTPRequest2, the DimensionFilter value will be + {\"SamplerName\", [\"HTTPRequest1\", \"HTTPRequest2\"}.""" + + @overload + def __init__( + self, + *, + filters: Optional[List["_models.DimensionFilter"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class MetricValue(_model_base.Model): + """Represents a metric value. + + :ivar timestamp: The timestamp for the metric value in RFC 3339 format. + :vartype timestamp: ~datetime.datetime + :ivar value: The metric value. + :vartype value: float + """ + + timestamp: Optional[datetime.datetime] = rest_field(format="rfc3339") + """The timestamp for the metric value in RFC 3339 format.""" + value: Optional[float] = rest_field() + """The metric value.""" + + @overload + def __init__( + self, + *, + timestamp: Optional[datetime.datetime] = None, + value: Optional[float] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class NameAndDesc(_model_base.Model): + """The name and description. + + :ivar description: The description. + :vartype description: str + :ivar name: The name. + :vartype name: str + """ + + description: Optional[str] = rest_field() + """The description.""" + name: Optional[str] = rest_field() + """The name.""" + + @overload + def __init__( + self, + *, + description: Optional[str] = None, + name: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class OptionalLoadTestConfig(_model_base.Model): + """Configuration for quick load test. + + :ivar endpoint_url: Test URL. Provide the complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login. + :vartype endpoint_url: str + :ivar requests_per_second: Target throughput (requests per second). This may not be necessarily + achieved. The actual throughput will be lower if the application is not capable of handling it. + :vartype requests_per_second: int + :ivar max_response_time_in_ms: Maximum response time in milliseconds of the API/endpoint. + :vartype max_response_time_in_ms: int + :ivar virtual_users: No of concurrent virtual users. + :vartype virtual_users: int + :ivar ramp_up_time: Ramp up time in seconds. + :vartype ramp_up_time: int + :ivar duration: Test run duration in seconds. + :vartype duration: int + """ + + endpoint_url: Optional[str] = rest_field(name="endpointUrl") + """Test URL. Provide the complete HTTP URL. For example, + https://contoso-app.azurewebsites.net/login.""" + requests_per_second: Optional[int] = rest_field(name="requestsPerSecond") + """Target throughput (requests per second). This may not be necessarily achieved. The actual + throughput will be lower if the application is not capable of handling it.""" + max_response_time_in_ms: Optional[int] = rest_field(name="maxResponseTimeInMs") + """Maximum response time in milliseconds of the API/endpoint.""" + virtual_users: Optional[int] = rest_field(name="virtualUsers") + """No of concurrent virtual users.""" + ramp_up_time: Optional[int] = rest_field(name="rampUpTime") + """Ramp up time in seconds.""" + duration: Optional[int] = rest_field() + """Test run duration in seconds.""" + + @overload + def __init__( + self, + *, + endpoint_url: Optional[str] = None, + requests_per_second: Optional[int] = None, + max_response_time_in_ms: Optional[int] = None, + virtual_users: Optional[int] = None, + ramp_up_time: Optional[int] = None, + duration: Optional[int] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PassFailCriteria(_model_base.Model): + """Pass fail criteria for a test. + + :ivar pass_fail_metrics: Map of id and pass fail metrics { id : pass fail metrics }. + :vartype pass_fail_metrics: dict[str, ~azure.developer.loadtesting.models.PassFailMetric] + """ + + pass_fail_metrics: Optional[Dict[str, "_models.PassFailMetric"]] = rest_field(name="passFailMetrics") + """Map of id and pass fail metrics { id : pass fail metrics }.""" + + @overload + def __init__( + self, + *, + pass_fail_metrics: Optional[Dict[str, "_models.PassFailMetric"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class PassFailMetric(_model_base.Model): + """Pass fail metric. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + :ivar client_metric: The client metric on which the criteria should be applied. Known values + are: "response_time_ms", "latency", "error", "requests", and "requests_per_sec". + :vartype client_metric: str or ~azure.developer.loadtesting.models.PFMetrics + :ivar aggregate: The aggregation function to be applied on the client metric. Allowed functions + + + * ‘percentage’ - for error metric , ‘avg’, ‘p50’, ‘p90’, ‘p95’, ‘p99’, ‘min’, + ‘max’ - for response_time_ms and latency metric, ‘avg’ - for requests_per_sec, + ‘count’ - for requests. Known values are: "count", "percentage", "avg", "p50", "p90", "p95", + "p99", "min", and "max". + :vartype aggregate: str or ~azure.developer.loadtesting.models.PFAgFunc + :ivar condition: The comparison operator. Supported types ‘>’, ‘<’. + :vartype condition: str + :ivar request_name: Request name for which the Pass fail criteria has to be applied. + :vartype request_name: str + :ivar value: The value to compare with the client metric. Allowed values - ‘error : [0.0 , + 100.0] unit- % ’, response_time_ms and latency : any integer value unit- ms. + :vartype value: float + :ivar action: Action taken after the threshold is met. Default is ‘continue’. Known values are: + "continue" and "stop". + :vartype action: str or ~azure.developer.loadtesting.models.PFAction + :ivar actual_value: The actual value of the client metric for the test run. + :vartype actual_value: float + :ivar result: Outcome of the test run. Known values are: "passed", "undetermined", and + "failed". + :vartype result: str or ~azure.developer.loadtesting.models.PFResult + """ + + client_metric: Optional[Union[str, "_models.PFMetrics"]] = rest_field(name="clientMetric") + """The client metric on which the criteria should be applied. Known values are: + \"response_time_ms\", \"latency\", \"error\", \"requests\", and \"requests_per_sec\".""" + aggregate: Optional[Union[str, "_models.PFAgFunc"]] = rest_field() + """The aggregation function to be applied on the client metric. Allowed functions + + + * ‘percentage’ - for error metric , ‘avg’, ‘p50’, ‘p90’, ‘p95’, ‘p99’, ‘min’, + ‘max’ - for response_time_ms and latency metric, ‘avg’ - for requests_per_sec, + ‘count’ - for requests. Known values are: \"count\", \"percentage\", \"avg\", \"p50\", + \"p90\", \"p95\", \"p99\", \"min\", and \"max\".""" + condition: Optional[str] = rest_field() + """The comparison operator. Supported types ‘>’, ‘<’.""" + request_name: Optional[str] = rest_field(name="requestName") + """Request name for which the Pass fail criteria has to be applied.""" + value: Optional[float] = rest_field() + """The value to compare with the client metric. Allowed values - ‘error : [0.0 , + 100.0] unit- % ’, response_time_ms and latency : any integer value unit- ms.""" + action: Optional[Union[str, "_models.PFAction"]] = rest_field() + """Action taken after the threshold is met. Default is ‘continue’. Known values are: \"continue\" + and \"stop\".""" + actual_value: Optional[float] = rest_field(name="actualValue", visibility=["read"]) + """The actual value of the client metric for the test run.""" + result: Optional[Union[str, "_models.PFResult"]] = rest_field(visibility=["read"]) + """Outcome of the test run. Known values are: \"passed\", \"undetermined\", and \"failed\".""" + + @overload + def __init__( + self, + *, + client_metric: Optional[Union[str, "_models.PFMetrics"]] = None, + aggregate: Optional[Union[str, "_models.PFAgFunc"]] = None, + condition: Optional[str] = None, + request_name: Optional[str] = None, + value: Optional[float] = None, + action: Optional[Union[str, "_models.PFAction"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class ResourceMetric(_model_base.Model): + """Associated metric definition for particular metrics of the azure resource ( + Refer : + https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition). + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + All required parameters must be populated in order to send to server. + + :ivar id: Unique name for metric. + :vartype id: str + :ivar resource_id: Azure resource id. Required. + :vartype resource_id: str + :ivar metric_namespace: Metric name space. Required. + :vartype metric_namespace: str + :ivar display_description: Metric description. + :vartype display_description: str + :ivar name: The invariant value of metric name. Required. + :vartype name: str + :ivar aggregation: Metric aggregation. Required. + :vartype aggregation: str + :ivar unit: Metric unit. + :vartype unit: str + :ivar resource_type: Azure resource type. Required. + :vartype resource_type: str + """ + + id: Optional[str] = rest_field(visibility=["read"]) + """Unique name for metric.""" + resource_id: str = rest_field(name="resourceId") + """Azure resource id. Required.""" + metric_namespace: str = rest_field(name="metricNamespace") + """Metric name space. Required.""" + display_description: Optional[str] = rest_field(name="displayDescription") + """Metric description.""" + name: str = rest_field() + """The invariant value of metric name. Required.""" + aggregation: str = rest_field() + """Metric aggregation. Required.""" + unit: Optional[str] = rest_field() + """Metric unit.""" + resource_type: str = rest_field(name="resourceType") + """Azure resource type. Required.""" + + @overload + def __init__( + self, + *, + resource_id: str, + metric_namespace: str, + name: str, + aggregation: str, + resource_type: str, + display_description: Optional[str] = None, + unit: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Secret(_model_base.Model): + """Secret. + + :ivar value: The value of the secret for the respective type. + :vartype value: str + :ivar type: Type of secret. Known values are: "AKV_SECRET_URI" and "SECRET_VALUE". + :vartype type: str or ~azure.developer.loadtesting.models.SecretType + """ + + value: Optional[str] = rest_field() + """The value of the secret for the respective type.""" + type: Optional[Union[str, "_models.SecretType"]] = rest_field() + """Type of secret. Known values are: \"AKV_SECRET_URI\" and \"SECRET_VALUE\".""" + + @overload + def __init__( + self, + *, + value: Optional[str] = None, + type: Optional[Union[str, "_models.SecretType"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class Test(_model_base.Model): # pylint: disable=too-many-instance-attributes + """Load test model. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + All required parameters must be populated in order to send to server. + + :ivar pass_fail_criteria: Pass fail criteria for a test. + :vartype pass_fail_criteria: ~azure.developer.loadtesting.models.PassFailCriteria + :ivar auto_stop_criteria: Auto stop criteria for a test. This will automatically stop a load + test if the error percentage is high for a certain time window. + :vartype auto_stop_criteria: ~azure.developer.loadtesting.models.AutoStopCriteria + :ivar secrets: Secrets can be stored in an Azure Key Vault or any other secret store. If the + secret is stored in an Azure Key Vault, the value should be the secret + identifier and the type should be AKV_SECRET_URI. If the secret is stored + elsewhere, the secret value should be provided directly and the type should be + SECRET_VALUE. + :vartype secrets: dict[str, ~azure.developer.loadtesting.models.Secret] + :ivar certificate: Certificates metadata. + :vartype certificate: ~azure.developer.loadtesting.models.CertificateMetadata + :ivar environment_variables: Environment variables which are defined as a set of + pairs. + :vartype environment_variables: dict[str, str] + :ivar load_test_configuration: The load test configuration. + :vartype load_test_configuration: ~azure.developer.loadtesting.models.LoadTestConfiguration + :ivar baseline_test_run_id: Id of the test run to be marked as baseline to view trends of + client-side metrics from recent test runs. + :vartype baseline_test_run_id: str + :ivar input_artifacts: The input artifacts for the test. + :vartype input_artifacts: ~azure.developer.loadtesting.models.TestInputArtifacts + :ivar test_id: Unique test identifier for the load test, must contain only lower-case + alphabetic, numeric, underscore or hyphen characters. Required. + :vartype test_id: str + :ivar description: The test description. + :vartype description: str + :ivar display_name: Display name of a test. + :vartype display_name: str + :ivar subnet_id: Subnet ID on which the load test instances should run. + :vartype subnet_id: str + :ivar kind: Kind of test. Known values are: "URL" and "JMX". + :vartype kind: str or ~azure.developer.loadtesting.models.TestKind + :ivar public_i_p_disabled: Inject load test engines without deploying public IP for outbound + access. + :vartype public_i_p_disabled: bool + :ivar keyvault_reference_identity_type: Type of the managed identity referencing the Key vault. + :vartype keyvault_reference_identity_type: str + :ivar keyvault_reference_identity_id: Resource Id of the managed identity referencing the Key + vault. + :vartype keyvault_reference_identity_id: str + :ivar created_date_time: The creation datetime(RFC 3339 literal format). + :vartype created_date_time: ~datetime.datetime + :ivar created_by: The user that created. + :vartype created_by: str + :ivar last_modified_date_time: The last Modified datetime(RFC 3339 literal format). + :vartype last_modified_date_time: ~datetime.datetime + :ivar last_modified_by: The user that last modified. + :vartype last_modified_by: str + """ + + pass_fail_criteria: Optional["_models.PassFailCriteria"] = rest_field(name="passFailCriteria") + """Pass fail criteria for a test.""" + auto_stop_criteria: Optional["_models.AutoStopCriteria"] = rest_field(name="autoStopCriteria") + """Auto stop criteria for a test. This will automatically stop a load test if the error percentage + is high for a certain time window.""" + secrets: Optional[Dict[str, "_models.Secret"]] = rest_field() + """Secrets can be stored in an Azure Key Vault or any other secret store. If the + secret is stored in an Azure Key Vault, the value should be the secret + identifier and the type should be AKV_SECRET_URI. If the secret is stored + elsewhere, the secret value should be provided directly and the type should be + SECRET_VALUE.""" + certificate: Optional["_models.CertificateMetadata"] = rest_field() + """Certificates metadata.""" + environment_variables: Optional[Dict[str, str]] = rest_field(name="environmentVariables") + """Environment variables which are defined as a set of pairs.""" + load_test_configuration: Optional["_models.LoadTestConfiguration"] = rest_field(name="loadTestConfiguration") + """The load test configuration.""" + baseline_test_run_id: Optional[str] = rest_field(name="baselineTestRunId") + """Id of the test run to be marked as baseline to view trends of client-side metrics from recent + test runs.""" + input_artifacts: Optional["_models.TestInputArtifacts"] = rest_field(name="inputArtifacts", visibility=["read"]) + """The input artifacts for the test.""" + test_id: str = rest_field(name="testId", visibility=["read"]) + """Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, + underscore or hyphen characters. Required.""" + description: Optional[str] = rest_field() + """The test description.""" + display_name: Optional[str] = rest_field(name="displayName") + """Display name of a test.""" + subnet_id: Optional[str] = rest_field(name="subnetId") + """Subnet ID on which the load test instances should run.""" + kind: Optional[Union[str, "_models.TestKind"]] = rest_field() + """Kind of test. Known values are: \"URL\" and \"JMX\".""" + public_i_p_disabled: Optional[bool] = rest_field(name="publicIPDisabled") + """Inject load test engines without deploying public IP for outbound access.""" + keyvault_reference_identity_type: Optional[str] = rest_field(name="keyvaultReferenceIdentityType") + """Type of the managed identity referencing the Key vault.""" + keyvault_reference_identity_id: Optional[str] = rest_field(name="keyvaultReferenceIdentityId") + """Resource Id of the managed identity referencing the Key vault.""" + created_date_time: Optional[datetime.datetime] = rest_field( + name="createdDateTime", visibility=["read"], format="rfc3339" + ) + """The creation datetime(RFC 3339 literal format).""" + created_by: Optional[str] = rest_field(name="createdBy", visibility=["read"]) + """The user that created.""" + last_modified_date_time: Optional[datetime.datetime] = rest_field( + name="lastModifiedDateTime", visibility=["read"], format="rfc3339" + ) + """The last Modified datetime(RFC 3339 literal format).""" + last_modified_by: Optional[str] = rest_field(name="lastModifiedBy", visibility=["read"]) + """The user that last modified.""" + + @overload + def __init__( + self, + *, + pass_fail_criteria: Optional["_models.PassFailCriteria"] = None, + auto_stop_criteria: Optional["_models.AutoStopCriteria"] = None, + secrets: Optional[Dict[str, "_models.Secret"]] = None, + certificate: Optional["_models.CertificateMetadata"] = None, + environment_variables: Optional[Dict[str, str]] = None, + load_test_configuration: Optional["_models.LoadTestConfiguration"] = None, + baseline_test_run_id: Optional[str] = None, + description: Optional[str] = None, + display_name: Optional[str] = None, + subnet_id: Optional[str] = None, + kind: Optional[Union[str, "_models.TestKind"]] = None, + public_i_p_disabled: Optional[bool] = None, + keyvault_reference_identity_type: Optional[str] = None, + keyvault_reference_identity_id: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class TestAppComponents(_model_base.Model): + """Test app components. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + All required parameters must be populated in order to send to server. + + :ivar components: Azure resource collection { resource id (fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}) + : resource object }. Required. + :vartype components: dict[str, ~azure.developer.loadtesting.models.AppComponent] + :ivar test_id: Test identifier. + :vartype test_id: str + :ivar created_date_time: The creation datetime(RFC 3339 literal format). + :vartype created_date_time: ~datetime.datetime + :ivar created_by: The user that created. + :vartype created_by: str + :ivar last_modified_date_time: The last Modified datetime(RFC 3339 literal format). + :vartype last_modified_date_time: ~datetime.datetime + :ivar last_modified_by: The user that last modified. + :vartype last_modified_by: str + """ + + components: Dict[str, "_models.AppComponent"] = rest_field() + """Azure resource collection { resource id (fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}) + : resource object }. Required.""" + test_id: Optional[str] = rest_field(name="testId", visibility=["read"]) + """Test identifier.""" + created_date_time: Optional[datetime.datetime] = rest_field( + name="createdDateTime", visibility=["read"], format="rfc3339" + ) + """The creation datetime(RFC 3339 literal format).""" + created_by: Optional[str] = rest_field(name="createdBy", visibility=["read"]) + """The user that created.""" + last_modified_date_time: Optional[datetime.datetime] = rest_field( + name="lastModifiedDateTime", visibility=["read"], format="rfc3339" + ) + """The last Modified datetime(RFC 3339 literal format).""" + last_modified_by: Optional[str] = rest_field(name="lastModifiedBy", visibility=["read"]) + """The user that last modified.""" + + @overload + def __init__( + self, + *, + components: Dict[str, "_models.AppComponent"], + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class TestFileInfo(_model_base.Model): + """Test file info. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + All required parameters must be populated in order to send to server. + + :ivar file_name: Name of the file. Required. + :vartype file_name: str + :ivar url: File URL. + :vartype url: str + :ivar file_type: File type. Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + :vartype file_type: str or ~azure.developer.loadtesting.models.FileType + :ivar expire_date_time: Expiry time of the file (RFC 3339 literal format). + :vartype expire_date_time: ~datetime.datetime + :ivar validation_status: Validation status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + :vartype validation_status: str or ~azure.developer.loadtesting.models.FileStatus + :ivar validation_failure_details: Validation failure error details. + :vartype validation_failure_details: str + """ + + file_name: str = rest_field(name="fileName") + """Name of the file. Required.""" + url: Optional[str] = rest_field(visibility=["read"]) + """File URL.""" + file_type: Optional[Union[str, "_models.FileType"]] = rest_field(name="fileType", visibility=["read"]) + """File type. Known values are: \"JMX_FILE\", \"USER_PROPERTIES\", \"ADDITIONAL_ARTIFACTS\", + \"ZIPPED_ARTIFACTS\", and \"URL_TEST_CONFIG_JSON\".""" + expire_date_time: Optional[datetime.datetime] = rest_field( + name="expireDateTime", visibility=["read"], format="rfc3339" + ) + """Expiry time of the file (RFC 3339 literal format).""" + validation_status: Optional[Union[str, "_models.FileStatus"]] = rest_field( + name="validationStatus", visibility=["read"] + ) + """Validation status of the file. Known values are: \"NOT_VALIDATED\", \"VALIDATION_SUCCESS\", + \"VALIDATION_FAILURE\", \"VALIDATION_INITIATED\", and \"VALIDATION_NOT_REQUIRED\".""" + validation_failure_details: Optional[str] = rest_field(name="validationFailureDetails", visibility=["read"]) + """Validation failure error details.""" + + @overload + def __init__( + self, + *, + file_name: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class TestInputArtifacts(_model_base.Model): + """The input artifacts for the test. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + :ivar config_file_info: File info. + :vartype config_file_info: ~azure.developer.loadtesting.models.TestFileInfo + :ivar test_script_file_info: File info. + :vartype test_script_file_info: ~azure.developer.loadtesting.models.TestFileInfo + :ivar user_prop_file_info: File info. + :vartype user_prop_file_info: ~azure.developer.loadtesting.models.TestFileInfo + :ivar input_artifacts_zip_file_info: File info. + :vartype input_artifacts_zip_file_info: ~azure.developer.loadtesting.models.TestFileInfo + :ivar url_test_config_file_info: The config json file for url based test. + :vartype url_test_config_file_info: ~azure.developer.loadtesting.models.TestFileInfo + :ivar additional_file_info: Additional supported files for the test run. + :vartype additional_file_info: list[~azure.developer.loadtesting.models.TestFileInfo] + """ + + config_file_info: Optional["_models.TestFileInfo"] = rest_field(name="configFileInfo") + """File info.""" + test_script_file_info: Optional["_models.TestFileInfo"] = rest_field(name="testScriptFileInfo") + """File info.""" + user_prop_file_info: Optional["_models.TestFileInfo"] = rest_field(name="userPropFileInfo") + """File info.""" + input_artifacts_zip_file_info: Optional["_models.TestFileInfo"] = rest_field(name="inputArtifactsZipFileInfo") + """File info.""" + url_test_config_file_info: Optional["_models.TestFileInfo"] = rest_field(name="urlTestConfigFileInfo") + """The config json file for url based test.""" + additional_file_info: Optional[List["_models.TestFileInfo"]] = rest_field( + name="additionalFileInfo", visibility=["read"] + ) + """Additional supported files for the test run.""" + + @overload + def __init__( + self, + *, + config_file_info: Optional["_models.TestFileInfo"] = None, + test_script_file_info: Optional["_models.TestFileInfo"] = None, + user_prop_file_info: Optional["_models.TestFileInfo"] = None, + input_artifacts_zip_file_info: Optional["_models.TestFileInfo"] = None, + url_test_config_file_info: Optional["_models.TestFileInfo"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class TestRun(_model_base.Model): # pylint: disable=too-many-instance-attributes + """Load test run model. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + All required parameters must be populated in order to send to server. + + :ivar test_run_id: Unique test run identifier for the load test run, must contain only + lower-case alphabetic, numeric, underscore or hyphen characters. Required. + :vartype test_run_id: str + :ivar pass_fail_criteria: Pass fail criteria for a test. + :vartype pass_fail_criteria: ~azure.developer.loadtesting.models.PassFailCriteria + :ivar auto_stop_criteria: Auto stop criteria for a test. This will automatically stop a load + test if the error percentage is high for a certain time window. + :vartype auto_stop_criteria: ~azure.developer.loadtesting.models.AutoStopCriteria + :ivar secrets: Secrets can be stored in an Azure Key Vault or any other secret store. If the + secret is stored in an Azure Key Vault, the value should be the secret + identifier and the type should be AKV_SECRET_URI. If the secret is stored + elsewhere, the secret value should be provided directly and the type should be + SECRET_VALUE. + :vartype secrets: dict[str, ~azure.developer.loadtesting.models.Secret] + :ivar certificate: Certificates metadata. + :vartype certificate: ~azure.developer.loadtesting.models.CertificateMetadata + :ivar environment_variables: Environment variables which are defined as a set of + pairs. + :vartype environment_variables: dict[str, str] + :ivar error_details: Error details if there is any failure in load test run. + :vartype error_details: list[~azure.developer.loadtesting.models.ErrorDetails] + :ivar test_run_statistics: Test run statistics. + :vartype test_run_statistics: dict[str, ~azure.developer.loadtesting.models.TestRunStatistics] + :ivar load_test_configuration: The load test configuration. + :vartype load_test_configuration: ~azure.developer.loadtesting.models.LoadTestConfiguration + :ivar test_artifacts: Collection of test run artifacts. + :vartype test_artifacts: ~azure.developer.loadtesting.models.TestRunArtifacts + :ivar test_result: Test result for pass/Fail criteria used during the test run. Known values + are: "PASSED", "NOT_APPLICABLE", and "FAILED". + :vartype test_result: str or ~azure.developer.loadtesting.models.PFTestResult + :ivar virtual_users: Number of virtual users, for which test has been run. + :vartype virtual_users: int + :ivar display_name: Display name of a testRun. + :vartype display_name: str + :ivar test_id: Associated test Id. + :vartype test_id: str + :ivar description: The test run description. + :vartype description: str + :ivar status: The test run status. Known values are: "ACCEPTED", "NOTSTARTED", "PROVISIONING", + "PROVISIONED", "CONFIGURING", "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", + "DEPROVISIONED", "DONE", "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", and + "VALIDATION_FAILURE". + :vartype status: str or ~azure.developer.loadtesting.models.Status + :ivar start_date_time: The test run start DateTime(RFC 3339 literal format). + :vartype start_date_time: ~datetime.datetime + :ivar end_date_time: The test run end DateTime(RFC 3339 literal format). + :vartype end_date_time: ~datetime.datetime + :ivar executed_date_time: Test run initiated time. + :vartype executed_date_time: ~datetime.datetime + :ivar portal_url: Portal url. + :vartype portal_url: str + :ivar duration: Test run duration in milliseconds. + :vartype duration: int + :ivar subnet_id: Subnet ID on which the load test instances should run. + :vartype subnet_id: str + :ivar kind: Type of test. Known values are: "URL" and "JMX". + :vartype kind: str or ~azure.developer.loadtesting.models.TestKind + :ivar public_i_p_disabled: Inject load test engines without deploying public IP for outbound + access. + :vartype public_i_p_disabled: bool + :ivar created_date_time: The creation datetime(RFC 3339 literal format). + :vartype created_date_time: ~datetime.datetime + :ivar created_by: The user that created. + :vartype created_by: str + :ivar last_modified_date_time: The last Modified datetime(RFC 3339 literal format). + :vartype last_modified_date_time: ~datetime.datetime + :ivar last_modified_by: The user that last modified. + :vartype last_modified_by: str + """ + + test_run_id: str = rest_field(name="testRunId", visibility=["read"]) + """Unique test run identifier for the load test run, must contain only lower-case alphabetic, + numeric, underscore or hyphen characters. Required.""" + pass_fail_criteria: Optional["_models.PassFailCriteria"] = rest_field(name="passFailCriteria") + """Pass fail criteria for a test.""" + auto_stop_criteria: Optional["_models.AutoStopCriteria"] = rest_field(name="autoStopCriteria") + """Auto stop criteria for a test. This will automatically stop a load test if the error percentage + is high for a certain time window.""" + secrets: Optional[Dict[str, "_models.Secret"]] = rest_field() + """Secrets can be stored in an Azure Key Vault or any other secret store. If the + secret is stored in an Azure Key Vault, the value should be the secret + identifier and the type should be AKV_SECRET_URI. If the secret is stored + elsewhere, the secret value should be provided directly and the type should be + SECRET_VALUE.""" + certificate: Optional["_models.CertificateMetadata"] = rest_field() + """Certificates metadata.""" + environment_variables: Optional[Dict[str, str]] = rest_field(name="environmentVariables") + """Environment variables which are defined as a set of pairs.""" + error_details: Optional[List["_models.ErrorDetails"]] = rest_field(name="errorDetails", visibility=["read"]) + """Error details if there is any failure in load test run.""" + test_run_statistics: Optional[Dict[str, "_models.TestRunStatistics"]] = rest_field( + name="testRunStatistics", visibility=["read"] + ) + """Test run statistics.""" + load_test_configuration: Optional["_models.LoadTestConfiguration"] = rest_field(name="loadTestConfiguration") + """The load test configuration.""" + test_artifacts: Optional["_models.TestRunArtifacts"] = rest_field(name="testArtifacts", visibility=["read"]) + """Collection of test run artifacts.""" + test_result: Optional[Union[str, "_models.PFTestResult"]] = rest_field(name="testResult", visibility=["read"]) + """Test result for pass/Fail criteria used during the test run. Known values are: \"PASSED\", + \"NOT_APPLICABLE\", and \"FAILED\".""" + virtual_users: Optional[int] = rest_field(name="virtualUsers", visibility=["read"]) + """Number of virtual users, for which test has been run.""" + display_name: Optional[str] = rest_field(name="displayName") + """Display name of a testRun.""" + test_id: Optional[str] = rest_field(name="testId") + """Associated test Id.""" + description: Optional[str] = rest_field() + """The test run description.""" + status: Optional[Union[str, "_models.Status"]] = rest_field(visibility=["read"]) + """The test run status. Known values are: \"ACCEPTED\", \"NOTSTARTED\", \"PROVISIONING\", + \"PROVISIONED\", \"CONFIGURING\", \"CONFIGURED\", \"EXECUTING\", \"EXECUTED\", + \"DEPROVISIONING\", \"DEPROVISIONED\", \"DONE\", \"CANCELLING\", \"CANCELLED\", \"FAILED\", + \"VALIDATION_SUCCESS\", and \"VALIDATION_FAILURE\".""" + start_date_time: Optional[datetime.datetime] = rest_field( + name="startDateTime", visibility=["read"], format="rfc3339" + ) + """The test run start DateTime(RFC 3339 literal format).""" + end_date_time: Optional[datetime.datetime] = rest_field(name="endDateTime", visibility=["read"], format="rfc3339") + """The test run end DateTime(RFC 3339 literal format).""" + executed_date_time: Optional[datetime.datetime] = rest_field( + name="executedDateTime", visibility=["read"], format="rfc3339" + ) + """Test run initiated time.""" + portal_url: Optional[str] = rest_field(name="portalUrl", visibility=["read"]) + """Portal url.""" + duration: Optional[int] = rest_field(visibility=["read"]) + """Test run duration in milliseconds.""" + subnet_id: Optional[str] = rest_field(name="subnetId", visibility=["read"]) + """Subnet ID on which the load test instances should run.""" + kind: Optional[Union[str, "_models.TestKind"]] = rest_field(visibility=["read"]) + """Type of test. Known values are: \"URL\" and \"JMX\".""" + public_i_p_disabled: Optional[bool] = rest_field(name="publicIPDisabled", visibility=["read"]) + """Inject load test engines without deploying public IP for outbound access.""" + created_date_time: Optional[datetime.datetime] = rest_field( + name="createdDateTime", visibility=["read"], format="rfc3339" + ) + """The creation datetime(RFC 3339 literal format).""" + created_by: Optional[str] = rest_field(name="createdBy", visibility=["read"]) + """The user that created.""" + last_modified_date_time: Optional[datetime.datetime] = rest_field( + name="lastModifiedDateTime", visibility=["read"], format="rfc3339" + ) + """The last Modified datetime(RFC 3339 literal format).""" + last_modified_by: Optional[str] = rest_field(name="lastModifiedBy", visibility=["read"]) + """The user that last modified.""" + + @overload + def __init__( + self, + *, + pass_fail_criteria: Optional["_models.PassFailCriteria"] = None, + auto_stop_criteria: Optional["_models.AutoStopCriteria"] = None, + secrets: Optional[Dict[str, "_models.Secret"]] = None, + certificate: Optional["_models.CertificateMetadata"] = None, + environment_variables: Optional[Dict[str, str]] = None, + load_test_configuration: Optional["_models.LoadTestConfiguration"] = None, + display_name: Optional[str] = None, + test_id: Optional[str] = None, + description: Optional[str] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class TestRunAppComponents(_model_base.Model): + """Test run app component. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + All required parameters must be populated in order to send to server. + + :ivar components: Azure resource collection { resource id (fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}) + : resource object }. Required. + :vartype components: dict[str, ~azure.developer.loadtesting.models.AppComponent] + :ivar test_run_id: Test run identifier. + :vartype test_run_id: str + :ivar created_date_time: The creation datetime(RFC 3339 literal format). + :vartype created_date_time: ~datetime.datetime + :ivar created_by: The user that created. + :vartype created_by: str + :ivar last_modified_date_time: The last Modified datetime(RFC 3339 literal format). + :vartype last_modified_date_time: ~datetime.datetime + :ivar last_modified_by: The user that last modified. + :vartype last_modified_by: str + """ + + components: Dict[str, "_models.AppComponent"] = rest_field() + """Azure resource collection { resource id (fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}) + : resource object }. Required.""" + test_run_id: Optional[str] = rest_field(name="testRunId", visibility=["read"]) + """Test run identifier.""" + created_date_time: Optional[datetime.datetime] = rest_field( + name="createdDateTime", visibility=["read"], format="rfc3339" + ) + """The creation datetime(RFC 3339 literal format).""" + created_by: Optional[str] = rest_field(name="createdBy", visibility=["read"]) + """The user that created.""" + last_modified_date_time: Optional[datetime.datetime] = rest_field( + name="lastModifiedDateTime", visibility=["read"], format="rfc3339" + ) + """The last Modified datetime(RFC 3339 literal format).""" + last_modified_by: Optional[str] = rest_field(name="lastModifiedBy", visibility=["read"]) + """The user that last modified.""" + + @overload + def __init__( + self, + *, + components: Dict[str, "_models.AppComponent"], + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class TestRunArtifacts(_model_base.Model): + """Collection of test run artifacts. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + :ivar input_artifacts: The input artifacts for the test run. + :vartype input_artifacts: ~azure.developer.loadtesting.models.TestRunInputArtifacts + :ivar output_artifacts: The output artifacts for the test run. + :vartype output_artifacts: ~azure.developer.loadtesting.models.TestRunOutputArtifacts + """ + + input_artifacts: Optional["_models.TestRunInputArtifacts"] = rest_field(name="inputArtifacts", visibility=["read"]) + """The input artifacts for the test run.""" + output_artifacts: Optional["_models.TestRunOutputArtifacts"] = rest_field(name="outputArtifacts") + """The output artifacts for the test run.""" + + @overload + def __init__( + self, + *, + output_artifacts: Optional["_models.TestRunOutputArtifacts"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class TestRunFileInfo(_model_base.Model): + """Test run file info. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + All required parameters must be populated in order to send to server. + + :ivar file_name: Name of the file. Required. + :vartype file_name: str + :ivar url: File URL. + :vartype url: str + :ivar file_type: File type. Known values are: "JMX_FILE", "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", "ZIPPED_ARTIFACTS", and "URL_TEST_CONFIG_JSON". + :vartype file_type: str or ~azure.developer.loadtesting.models.FileType + :ivar expire_date_time: Expiry time of the file (RFC 3339 literal format). + :vartype expire_date_time: ~datetime.datetime + :ivar validation_status: Validation status of the file. Known values are: "NOT_VALIDATED", + "VALIDATION_SUCCESS", "VALIDATION_FAILURE", "VALIDATION_INITIATED", and + "VALIDATION_NOT_REQUIRED". + :vartype validation_status: str or ~azure.developer.loadtesting.models.FileStatus + :ivar validation_failure_details: Validation failure error details. + :vartype validation_failure_details: str + """ + + file_name: str = rest_field(name="fileName") + """Name of the file. Required.""" + url: Optional[str] = rest_field(visibility=["read"]) + """File URL.""" + file_type: Optional[Union[str, "_models.FileType"]] = rest_field(name="fileType", visibility=["read"]) + """File type. Known values are: \"JMX_FILE\", \"USER_PROPERTIES\", \"ADDITIONAL_ARTIFACTS\", + \"ZIPPED_ARTIFACTS\", and \"URL_TEST_CONFIG_JSON\".""" + expire_date_time: Optional[datetime.datetime] = rest_field( + name="expireDateTime", visibility=["read"], format="rfc3339" + ) + """Expiry time of the file (RFC 3339 literal format).""" + validation_status: Optional[Union[str, "_models.FileStatus"]] = rest_field( + name="validationStatus", visibility=["read"] + ) + """Validation status of the file. Known values are: \"NOT_VALIDATED\", \"VALIDATION_SUCCESS\", + \"VALIDATION_FAILURE\", \"VALIDATION_INITIATED\", and \"VALIDATION_NOT_REQUIRED\".""" + validation_failure_details: Optional[str] = rest_field(name="validationFailureDetails", visibility=["read"]) + """Validation failure error details.""" + + @overload + def __init__( + self, + *, + file_name: str, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class TestRunInputArtifacts(_model_base.Model): + """The input artifacts for the test run. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + :ivar config_file_info: File info. + :vartype config_file_info: ~azure.developer.loadtesting.models.TestRunFileInfo + :ivar test_script_file_info: File info. + :vartype test_script_file_info: ~azure.developer.loadtesting.models.TestRunFileInfo + :ivar user_prop_file_info: File info. + :vartype user_prop_file_info: ~azure.developer.loadtesting.models.TestRunFileInfo + :ivar input_artifacts_zip_file_info: File info. + :vartype input_artifacts_zip_file_info: ~azure.developer.loadtesting.models.TestRunFileInfo + :ivar url_test_config_file_info: The config json file for url based test. + :vartype url_test_config_file_info: ~azure.developer.loadtesting.models.TestRunFileInfo + :ivar additional_file_info: Additional supported files for the test run. + :vartype additional_file_info: list[~azure.developer.loadtesting.models.TestRunFileInfo] + """ + + config_file_info: Optional["_models.TestRunFileInfo"] = rest_field(name="configFileInfo") + """File info.""" + test_script_file_info: Optional["_models.TestRunFileInfo"] = rest_field(name="testScriptFileInfo") + """File info.""" + user_prop_file_info: Optional["_models.TestRunFileInfo"] = rest_field(name="userPropFileInfo") + """File info.""" + input_artifacts_zip_file_info: Optional["_models.TestRunFileInfo"] = rest_field(name="inputArtifactsZipFileInfo") + """File info.""" + url_test_config_file_info: Optional["_models.TestRunFileInfo"] = rest_field(name="urlTestConfigFileInfo") + """The config json file for url based test.""" + additional_file_info: Optional[List["_models.TestRunFileInfo"]] = rest_field( + name="additionalFileInfo", visibility=["read"] + ) + """Additional supported files for the test run.""" + + @overload + def __init__( + self, + *, + config_file_info: Optional["_models.TestRunFileInfo"] = None, + test_script_file_info: Optional["_models.TestRunFileInfo"] = None, + user_prop_file_info: Optional["_models.TestRunFileInfo"] = None, + input_artifacts_zip_file_info: Optional["_models.TestRunFileInfo"] = None, + url_test_config_file_info: Optional["_models.TestRunFileInfo"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class TestRunOutputArtifacts(_model_base.Model): + """The output artifacts for the test run. + + :ivar result_file_info: File info. + :vartype result_file_info: ~azure.developer.loadtesting.models.TestRunFileInfo + :ivar logs_file_info: File info. + :vartype logs_file_info: ~azure.developer.loadtesting.models.TestRunFileInfo + :ivar artifacts_container_info: The container for test run artifacts. + :vartype artifacts_container_info: ~azure.developer.loadtesting.models.ArtifactsContainerInfo + """ + + result_file_info: Optional["_models.TestRunFileInfo"] = rest_field(name="resultFileInfo") + """File info.""" + logs_file_info: Optional["_models.TestRunFileInfo"] = rest_field(name="logsFileInfo") + """File info.""" + artifacts_container_info: Optional["_models.ArtifactsContainerInfo"] = rest_field(name="artifactsContainerInfo") + """The container for test run artifacts.""" + + @overload + def __init__( + self, + *, + result_file_info: Optional["_models.TestRunFileInfo"] = None, + logs_file_info: Optional["_models.TestRunFileInfo"] = None, + artifacts_container_info: Optional["_models.ArtifactsContainerInfo"] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class TestRunServerMetricConfig(_model_base.Model): + """Test run server metrics configuration. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + :ivar test_run_id: Test run identifier. + :vartype test_run_id: str + :ivar metrics: Azure resource metrics collection {metric id : metrics object} (Refer : + https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition + for metric id). + :vartype metrics: dict[str, ~azure.developer.loadtesting.models.ResourceMetric] + :ivar created_date_time: The creation datetime(RFC 3339 literal format). + :vartype created_date_time: ~datetime.datetime + :ivar created_by: The user that created. + :vartype created_by: str + :ivar last_modified_date_time: The last Modified datetime(RFC 3339 literal format). + :vartype last_modified_date_time: ~datetime.datetime + :ivar last_modified_by: The user that last modified. + :vartype last_modified_by: str + """ + + test_run_id: Optional[str] = rest_field(name="testRunId", visibility=["read"]) + """Test run identifier.""" + metrics: Optional[Dict[str, "_models.ResourceMetric"]] = rest_field() + """Azure resource metrics collection {metric id : metrics object} (Refer : + https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition + for metric id).""" + created_date_time: Optional[datetime.datetime] = rest_field( + name="createdDateTime", visibility=["read"], format="rfc3339" + ) + """The creation datetime(RFC 3339 literal format).""" + created_by: Optional[str] = rest_field(name="createdBy", visibility=["read"]) + """The user that created.""" + last_modified_date_time: Optional[datetime.datetime] = rest_field( + name="lastModifiedDateTime", visibility=["read"], format="rfc3339" + ) + """The last Modified datetime(RFC 3339 literal format).""" + last_modified_by: Optional[str] = rest_field(name="lastModifiedBy", visibility=["read"]) + """The user that last modified.""" + + @overload + def __init__( + self, + *, + metrics: Optional[Dict[str, "_models.ResourceMetric"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class TestRunStatistics(_model_base.Model): # pylint: disable=too-many-instance-attributes + """Test run statistics. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + :ivar transaction: Transaction name. + :vartype transaction: str + :ivar sample_count: Sampler count. + :vartype sample_count: float + :ivar error_count: Error count. + :vartype error_count: float + :ivar error_pct: Error percentage. + :vartype error_pct: float + :ivar mean_res_time: Mean response time. + :vartype mean_res_time: float + :ivar median_res_time: Median response time. + :vartype median_res_time: float + :ivar max_res_time: Max response time. + :vartype max_res_time: float + :ivar min_res_time: Minimum response time. + :vartype min_res_time: float + :ivar pct1_res_time: 90 percentile response time. + :vartype pct1_res_time: float + :ivar pct2_res_time: 95 percentile response time. + :vartype pct2_res_time: float + :ivar pct3_res_time: 99 percentile response time. + :vartype pct3_res_time: float + :ivar throughput: Throughput. + :vartype throughput: float + :ivar received_k_bytes_per_sec: Received network bytes. + :vartype received_k_bytes_per_sec: float + :ivar sent_k_bytes_per_sec: Send network bytes. + :vartype sent_k_bytes_per_sec: float + """ + + transaction: Optional[str] = rest_field(visibility=["read"]) + """Transaction name.""" + sample_count: Optional[float] = rest_field(name="sampleCount", visibility=["read"]) + """Sampler count.""" + error_count: Optional[float] = rest_field(name="errorCount", visibility=["read"]) + """Error count.""" + error_pct: Optional[float] = rest_field(name="errorPct", visibility=["read"]) + """Error percentage.""" + mean_res_time: Optional[float] = rest_field(name="meanResTime", visibility=["read"]) + """Mean response time.""" + median_res_time: Optional[float] = rest_field(name="medianResTime", visibility=["read"]) + """Median response time.""" + max_res_time: Optional[float] = rest_field(name="maxResTime", visibility=["read"]) + """Max response time.""" + min_res_time: Optional[float] = rest_field(name="minResTime", visibility=["read"]) + """Minimum response time.""" + pct1_res_time: Optional[float] = rest_field(name="pct1ResTime", visibility=["read"]) + """90 percentile response time.""" + pct2_res_time: Optional[float] = rest_field(name="pct2ResTime", visibility=["read"]) + """95 percentile response time.""" + pct3_res_time: Optional[float] = rest_field(name="pct3ResTime", visibility=["read"]) + """99 percentile response time.""" + throughput: Optional[float] = rest_field(visibility=["read"]) + """Throughput.""" + received_k_bytes_per_sec: Optional[float] = rest_field(name="receivedKBytesPerSec", visibility=["read"]) + """Received network bytes.""" + sent_k_bytes_per_sec: Optional[float] = rest_field(name="sentKBytesPerSec", visibility=["read"]) + """Send network bytes.""" + + +class TestServerMetricConfig(_model_base.Model): + """Test server metrics configuration. + + Readonly variables are only populated by the server, and will be ignored when sending a request. + + All required parameters must be populated in order to send to server. + + :ivar test_id: Test identifier. + :vartype test_id: str + :ivar metrics: Azure resource metrics collection {metric id : metrics object} (Refer : + https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition + for metric id). Required. + :vartype metrics: dict[str, ~azure.developer.loadtesting.models.ResourceMetric] + :ivar created_date_time: The creation datetime(RFC 3339 literal format). + :vartype created_date_time: ~datetime.datetime + :ivar created_by: The user that created. + :vartype created_by: str + :ivar last_modified_date_time: The last Modified datetime(RFC 3339 literal format). + :vartype last_modified_date_time: ~datetime.datetime + :ivar last_modified_by: The user that last modified. + :vartype last_modified_by: str + """ + + test_id: Optional[str] = rest_field(name="testId", visibility=["read"]) + """Test identifier.""" + metrics: Dict[str, "_models.ResourceMetric"] = rest_field() + """Azure resource metrics collection {metric id : metrics object} (Refer : + https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition + for metric id). Required.""" + created_date_time: Optional[datetime.datetime] = rest_field( + name="createdDateTime", visibility=["read"], format="rfc3339" + ) + """The creation datetime(RFC 3339 literal format).""" + created_by: Optional[str] = rest_field(name="createdBy", visibility=["read"]) + """The user that created.""" + last_modified_date_time: Optional[datetime.datetime] = rest_field( + name="lastModifiedDateTime", visibility=["read"], format="rfc3339" + ) + """The last Modified datetime(RFC 3339 literal format).""" + last_modified_by: Optional[str] = rest_field(name="lastModifiedBy", visibility=["read"]) + """The user that last modified.""" + + @overload + def __init__( + self, + *, + metrics: Dict[str, "_models.ResourceMetric"], + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) + + +class TimeSeriesElement(_model_base.Model): + """The time series returned when a data query is performed. + + :ivar data: An array of data points representing the metric values. + :vartype data: list[~azure.developer.loadtesting.models.MetricValue] + :ivar dimension_values: The dimension values. + :vartype dimension_values: list[~azure.developer.loadtesting.models.DimensionValue] + """ + + data: Optional[List["_models.MetricValue"]] = rest_field() + """An array of data points representing the metric values.""" + dimension_values: Optional[List["_models.DimensionValue"]] = rest_field(name="dimensionValues") + """The dimension values.""" + + @overload + def __init__( + self, + *, + data: Optional[List["_models.MetricValue"]] = None, + dimension_values: Optional[List["_models.DimensionValue"]] = None, + ): + ... + + @overload + def __init__(self, mapping: Mapping[str, Any]): + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + super().__init__(*args, **kwargs) diff --git a/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/models/_patch.py b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/models/_patch.py new file mode 100644 index 000000000000..f7dd32510333 --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/azure/developer/loadtesting/models/_patch.py @@ -0,0 +1,20 @@ +# ------------------------------------ +# Copyright (c) Microsoft Corporation. +# Licensed under the MIT License. +# ------------------------------------ +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" +from typing import List + +__all__: List[str] = [] # Add all objects you want publicly available to users at this package level + + +def patch_sdk(): + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/loadtesting/azure-developer-loadtesting/samples/begin_test_run.py b/sdk/loadtesting/azure-developer-loadtesting/samples/begin_test_run.py index f1a34f455b4e..516c22a682b8 100644 --- a/sdk/loadtesting/azure-developer-loadtesting/samples/begin_test_run.py +++ b/sdk/loadtesting/azure-developer-loadtesting/samples/begin_test_run.py @@ -42,10 +42,10 @@ { "testId": TEST_ID, "displayName": "My New Load Test Run", - } + }, ) -#waiting for test run status to be completed with timeout = 3600 seconds +# waiting for test run status to be completed with timeout = 3600 seconds result = testRunPoller.result(3600) print(result["status"]) diff --git a/sdk/loadtesting/azure-developer-loadtesting/samples/create_or_update_test_function.py b/sdk/loadtesting/azure-developer-loadtesting/samples/create_or_update_test_function.py index 968373f5e794..231899a5e9d5 100644 --- a/sdk/loadtesting/azure-developer-loadtesting/samples/create_or_update_test_function.py +++ b/sdk/loadtesting/azure-developer-loadtesting/samples/create_or_update_test_function.py @@ -48,37 +48,25 @@ }, "passFailCriteria": { "passFailMetrics": { - "condition1": { - "clientmetric": "response_time_ms", - "aggregate": "avg", - "condition": ">", - "value": 300 - }, - "condition2": { - "clientmetric": "error", - "aggregate": "percentage", - "condition": ">", - "value": 50 - }, + "condition1": {"clientmetric": "response_time_ms", "aggregate": "avg", "condition": ">", "value": 300}, + "condition2": {"clientmetric": "error", "aggregate": "percentage", "condition": ">", "value": 50}, "condition3": { "clientmetric": "latency", "aggregate": "avg", "condition": ">", "value": 200, - "requestName": "GetCustomerDetails" - } + "requestName": "GetCustomerDetails", + }, } }, "secrets": { "secret1": { "value": "https://sdk-testing-keyvault.vault.azure.net/secrets/sdk-secret", - "type": "AKV_SECRET_URI" + "type": "AKV_SECRET_URI", } }, - "environmentVariables": { - "my-varaible": "value" - } - } + "environmentVariables": {"my-varaible": "value"}, + }, ) print(result) diff --git a/sdk/loadtesting/azure-developer-loadtesting/samples/get_metrics.py b/sdk/loadtesting/azure-developer-loadtesting/samples/get_metrics.py index 0a6fb452426e..69f781d231fb 100644 --- a/sdk/loadtesting/azure-developer-loadtesting/samples/get_metrics.py +++ b/sdk/loadtesting/azure-developer-loadtesting/samples/get_metrics.py @@ -56,7 +56,7 @@ TEST_RUN_ID, metric_name=metric_definitions["value"][0]["name"], metric_namespace=metric_namespaces["value"][0]["name"], - time_interval=test_run_response["startDateTime"]+"/"+test_run_response["endDateTime"] + time_interval=test_run_response["startDateTime"] + "/" + test_run_response["endDateTime"], ) for page in metrics.by_page(): diff --git a/sdk/loadtesting/azure-developer-loadtesting/setup.py b/sdk/loadtesting/azure-developer-loadtesting/setup.py index efe061bdca5c..3867393c7083 100644 --- a/sdk/loadtesting/azure-developer-loadtesting/setup.py +++ b/sdk/loadtesting/azure-developer-loadtesting/setup.py @@ -2,7 +2,7 @@ # -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. See License.txt in the project root for license information. -# Code generated by Microsoft (R) AutoRest Code Generator. +# Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- # coding: utf-8 @@ -13,7 +13,7 @@ PACKAGE_NAME = "azure-developer-loadtesting" -PACKAGE_PPRINT_NAME = "Azure Developer LoadTesting" +PACKAGE_PPRINT_NAME = "Azure Developer Loadtesting" # a-b-c => a/b/c package_folder_path = PACKAGE_NAME.replace("-", "/") @@ -29,7 +29,7 @@ setup( name=PACKAGE_NAME, version=version, - description="Microsoft Azure Developer LoadTesting Client Library for Python", + description="Microsoft {} Client Library for Python".format(PACKAGE_PPRINT_NAME), long_description=open("README.md", "r").read(), long_description_content_type="text/markdown", license="MIT License", @@ -38,15 +38,15 @@ url="https://github.com/Azure/azure-sdk-for-python/tree/main/sdk", keywords="azure, azure sdk", classifiers=[ - "Development Status :: 5 - Production/Stable", + "Development Status :: 4 - Beta", "Programming Language :: Python", "Programming Language :: Python :: 3 :: Only", "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", "License :: OSI Approved :: MIT License", ], zip_safe=False, @@ -60,12 +60,12 @@ ), include_package_data=True, package_data={ - "pytyped": ["py.typed"], + "azure.developer.loadtesting": ["py.typed"], }, install_requires=[ "isodate<1.0.0,>=0.6.1", - "azure-core<2.0.0,>=1.24.0", - "typing-extensions>=4.3.0; python_version<'3.8.0'", + "azure-core<2.0.0,>=1.30.0", + "typing-extensions>=4.6.0", ], - python_requires=">=3.7", + python_requires=">=3.8", ) diff --git a/sdk/loadtesting/azure-developer-loadtesting/tests/conftest.py b/sdk/loadtesting/azure-developer-loadtesting/tests/conftest.py index b8c81835777c..65b0a4c7af53 100644 --- a/sdk/loadtesting/azure-developer-loadtesting/tests/conftest.py +++ b/sdk/loadtesting/azure-developer-loadtesting/tests/conftest.py @@ -30,10 +30,16 @@ from dotenv import load_dotenv -from devtools_testutils import test_proxy, add_general_regex_sanitizer, add_body_key_sanitizer, add_header_regex_sanitizer +from devtools_testutils import ( + test_proxy, + add_general_regex_sanitizer, + add_body_key_sanitizer, + add_header_regex_sanitizer, +) load_dotenv() + @pytest.fixture(scope="session", autouse=True) def add_sanitizers(test_proxy): subscription_id = os.environ.get("LOADTESTING_SUBSCRIPTION_ID", "00000000-0000-0000-0000-000000000000") diff --git a/sdk/loadtesting/azure-developer-loadtesting/tests/test_admin_ops.py b/sdk/loadtesting/azure-developer-loadtesting/tests/test_admin_ops.py index b79e97d3be18..0020073881e2 100644 --- a/sdk/loadtesting/azure-developer-loadtesting/tests/test_admin_ops.py +++ b/sdk/loadtesting/azure-developer-loadtesting/tests/test_admin_ops.py @@ -15,8 +15,9 @@ DISPLAY_NAME = "TestingResourcePyTest" NON_EXISTING_RESOURCE = "nonexistingresource" -class TestLoadTestAdministrationClient(LoadtestingTest): + +class TestLoadTestAdministrationClient(LoadtestingTest): def setup_create_load_test(self, endpoint): self.setup_load_test_id = "pytest_setup_load_test_id" client = self.create_administration_client(endpoint) @@ -36,13 +37,17 @@ def setup_create_load_test(self, endpoint): "passFailCriteria": {"passFailMetrics": {}}, "keyvaultReferenceIdentityType": "SystemAssigned", "keyvaultReferenceIdentityId": None, - } + }, ) def setup_upload_test_file(self, endpoint): client = self.create_administration_client(endpoint) self.setup_file_name = "sample.jmx" - client.begin_upload_test_file(self.setup_load_test_id, "sample.jmx", open(os.path.join(Path(__file__).resolve().parent, "sample.jmx"), "rb")) + client.begin_upload_test_file( + self.setup_load_test_id, + "sample.jmx", + open(os.path.join(Path(__file__).resolve().parent, "sample.jmx"), "rb"), + ) def setup_app_components(self, endpoint, resource_id): client = self.create_administration_client(endpoint) @@ -60,6 +65,7 @@ def setup_app_components(self, endpoint, resource_id): }, }, ) + @LoadtestingPowerShellPreparer() @recorded_by_proxy def test_create_or_update_load_test(self, loadtesting_endpoint, loadtesting_test_id): @@ -140,7 +146,6 @@ def test_list_load_tests(self, loadtesting_endpoint): result = client.list_tests() assert result is not None - @LoadtestingPowerShellPreparer() @recorded_by_proxy def test_get_test_file(self, loadtesting_endpoint): @@ -169,7 +174,6 @@ def test_delete_test_file(self, loadtesting_endpoint): with pytest.raises(ResourceNotFoundError): client.delete_test_file(self.setup_load_test_id, "nonexistent.jmx") - @LoadtestingPowerShellPreparer() @recorded_by_proxy def list_test_files(self, loadtesting_endpoint): @@ -193,17 +197,15 @@ def test_create_or_update_app_components(self, loadtesting_endpoint, loadtesting result = client.create_or_update_app_components( loadtesting_test_id, { - "components": - { - loadtesting_resource_id: - { + "components": { + loadtesting_resource_id: { "resourceId": loadtesting_resource_id, "resourceName": "App-Service-Sample-Demo", "resourceType": "Microsoft.Web/sites", - "kind": "web" + "kind": "web", } } - } + }, ) assert result is not None @@ -219,7 +221,7 @@ def test_create_or_update_app_components(self, loadtesting_endpoint, loadtesting "kind": "web", } } - } + }, ) @LoadtestingPowerShellPreparer() @@ -243,8 +245,11 @@ def test_file_upload_poller(self, loadtesting_endpoint): self.setup_create_load_test(loadtesting_endpoint) client = self.create_administration_client(loadtesting_endpoint) - poller = client.begin_upload_test_file(self.setup_load_test_id, "sample.jmx", - open(os.path.join(Path(__file__).resolve().parent, "sample.jmx"), "rb")) + poller = client.begin_upload_test_file( + self.setup_load_test_id, + "sample.jmx", + open(os.path.join(Path(__file__).resolve().parent, "sample.jmx"), "rb"), + ) result = poller.result(1000) assert poller.status() is not None @@ -253,7 +258,9 @@ def test_file_upload_poller(self, loadtesting_endpoint): @LoadtestingPowerShellPreparer() @recorded_by_proxy - def test_create_or_update_server_metrics_config(self, loadtesting_endpoint, loadtesting_resource_id, loadtesting_test_id): + def test_create_or_update_server_metrics_config( + self, loadtesting_endpoint, loadtesting_resource_id, loadtesting_test_id + ): set_bodiless_matcher() client = self.create_administration_client(loadtesting_endpoint) @@ -268,10 +275,10 @@ def test_create_or_update_server_metrics_config(self, loadtesting_endpoint, load "name": "requests/duration", "aggregation": "Average", "unit": None, - "resourceType": "microsoft.insights/components" + "resourceType": "microsoft.insights/components", } } - } + }, ) assert result is not None diff --git a/sdk/loadtesting/azure-developer-loadtesting/tests/test_async_admin_ops.py b/sdk/loadtesting/azure-developer-loadtesting/tests/test_async_admin_ops.py index 53f564567b6d..569955c0dab2 100644 --- a/sdk/loadtesting/azure-developer-loadtesting/tests/test_async_admin_ops.py +++ b/sdk/loadtesting/azure-developer-loadtesting/tests/test_async_admin_ops.py @@ -17,8 +17,9 @@ DISPLAY_NAME = "TestingResourcePyTest" NON_EXISTING_RESOURCE = "nonexistingresource" -class TestLoadTestAdministrationClient(LoadtestingAsyncTest): + +class TestLoadTestAdministrationClient(LoadtestingAsyncTest): async def setup_create_load_test(self, endpoint): self.setup_load_test_id = "pytest_setup_load_test_id" client = self.create_administration_client(endpoint) @@ -38,13 +39,17 @@ async def setup_create_load_test(self, endpoint): "passFailCriteria": {"passFailMetrics": {}}, "keyvaultReferenceIdentityType": "SystemAssigned", "keyvaultReferenceIdentityId": None, - } + }, ) async def setup_upload_test_file(self, endpoint): client = self.create_administration_client(endpoint) self.setup_file_name = "sample.jmx" - await client.begin_upload_test_file(self.setup_load_test_id, "sample.jmx", open(os.path.join(Path(__file__).resolve().parent, "sample.jmx"), "rb")) + await client.begin_upload_test_file( + self.setup_load_test_id, + "sample.jmx", + open(os.path.join(Path(__file__).resolve().parent, "sample.jmx"), "rb"), + ) async def setup_app_components(self, endpoint, resource_id): client = self.create_administration_client(endpoint) @@ -62,6 +67,7 @@ async def setup_app_components(self, endpoint, resource_id): }, }, ) + @LoadtestingPowerShellPreparer() @recorded_by_proxy_async async def test_create_or_update_load_test(self, loadtesting_endpoint, loadtesting_test_id): @@ -142,7 +148,6 @@ async def test_list_load_tests(self, loadtesting_endpoint): result = client.list_tests() assert result is not None - @LoadtestingPowerShellPreparer() @recorded_by_proxy_async async def test_get_test_file(self, loadtesting_endpoint): @@ -171,7 +176,6 @@ async def test_delete_test_file(self, loadtesting_endpoint): with pytest.raises(ResourceNotFoundError): await client.delete_test_file(self.setup_load_test_id, "nonexistent.jmx") - @LoadtestingPowerShellPreparer() @recorded_by_proxy_async async def list_test_files(self, loadtesting_endpoint): @@ -188,24 +192,24 @@ async def list_test_files(self, loadtesting_endpoint): @LoadtestingPowerShellPreparer() @recorded_by_proxy_async - async def test_create_or_update_app_components(self, loadtesting_endpoint, loadtesting_test_id, loadtesting_resource_id): + async def test_create_or_update_app_components( + self, loadtesting_endpoint, loadtesting_test_id, loadtesting_resource_id + ): set_bodiless_matcher() client = self.create_administration_client(loadtesting_endpoint) result = await client.create_or_update_app_components( loadtesting_test_id, { - "components": - { - loadtesting_resource_id: - { + "components": { + loadtesting_resource_id: { "resourceId": loadtesting_resource_id, "resourceName": "App-Service-Sample-Demo", "resourceType": "Microsoft.Web/sites", - "kind": "web" + "kind": "web", } } - } + }, ) assert result is not None @@ -221,7 +225,7 @@ async def test_create_or_update_app_components(self, loadtesting_endpoint, loadt "kind": "web", } } - } + }, ) @LoadtestingPowerShellPreparer() @@ -245,8 +249,11 @@ async def test_file_upload_poller(self, loadtesting_endpoint): await self.setup_create_load_test(loadtesting_endpoint) client = self.create_administration_client(loadtesting_endpoint) - poller = await client.begin_upload_test_file(self.setup_load_test_id, "sample.jmx", - open(os.path.join(Path(__file__).resolve().parent, "sample.jmx"), "rb")) + poller = await client.begin_upload_test_file( + self.setup_load_test_id, + "sample.jmx", + open(os.path.join(Path(__file__).resolve().parent, "sample.jmx"), "rb"), + ) result = await poller.result() assert poller.status() is not None @@ -255,7 +262,9 @@ async def test_file_upload_poller(self, loadtesting_endpoint): @LoadtestingPowerShellPreparer() @recorded_by_proxy_async - async def test_create_or_update_server_metrics_config(self, loadtesting_endpoint, loadtesting_resource_id, loadtesting_test_id): + async def test_create_or_update_server_metrics_config( + self, loadtesting_endpoint, loadtesting_resource_id, loadtesting_test_id + ): set_bodiless_matcher() client = self.create_administration_client(loadtesting_endpoint) @@ -270,10 +279,10 @@ async def test_create_or_update_server_metrics_config(self, loadtesting_endpoint "name": "requests/duration", "aggregation": "Average", "unit": None, - "resourceType": "microsoft.insights/components" + "resourceType": "microsoft.insights/components", } } - } + }, ) assert result is not None diff --git a/sdk/loadtesting/azure-developer-loadtesting/tests/test_async_run_ops.py b/sdk/loadtesting/azure-developer-loadtesting/tests/test_async_run_ops.py index 6265141f4b6e..4bee7fc804c6 100644 --- a/sdk/loadtesting/azure-developer-loadtesting/tests/test_async_run_ops.py +++ b/sdk/loadtesting/azure-developer-loadtesting/tests/test_async_run_ops.py @@ -17,8 +17,9 @@ DISPLAY_NAME = "TestingResourcePyTest" NON_EXISTING_RESOURCE = "nonexistingresource" -class TestRunOps(LoadtestingAsyncTest): + +class TestRunOps(LoadtestingAsyncTest): async def setup_loadtest(self, endpoint, test_id): admin_client = self.create_administration_client(endpoint) @@ -37,7 +38,7 @@ async def setup_loadtest(self, endpoint, test_id): "passFailCriteria": {"passFailMetrics": {}}, "keyvaultReferenceIdentityType": "SystemAssigned", "keyvaultReferenceIdentityId": None, - } + }, ) validation_poller = await admin_client.begin_upload_test_file( @@ -56,7 +57,7 @@ async def setup_test_run(self, endpoint, test_id, test_run_id): { "testId": test_id, "displayName": "My New Load Test Run from PyTest", - } + }, ) await run_poller.result() @@ -74,7 +75,7 @@ async def test_test_run_poller(self, loadtesting_endpoint, loadtesting_test_id, { "testId": loadtesting_test_id, "displayName": "My New Load Test Run from PyTest", - } + }, ) result = await run_poller.result() @@ -111,7 +112,6 @@ async def test_delete_test_run(self, loadtesting_endpoint, loadtesting_test_id, with pytest.raises(ResourceNotFoundError): await run_client.delete_test_run(NON_EXISTING_RESOURCE) - @LoadtestingPowerShellPreparer() @recorded_by_proxy_async async def test_get_test_run_file(self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id): @@ -130,7 +130,6 @@ async def test_get_test_run_file(self, loadtesting_endpoint, loadtesting_test_id with pytest.raises(HttpResponseError): await run_client.get_test_run_file(loadtesting_test_run_id, NON_EXISTING_RESOURCE) - @LoadtestingPowerShellPreparer() @recorded_by_proxy_async async def test_list_test_runs(self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id): @@ -143,7 +142,6 @@ async def test_list_test_runs(self, loadtesting_endpoint, loadtesting_test_id, l result = run_client.list_test_runs() assert result is not None - @LoadtestingPowerShellPreparer() @recorded_by_proxy_async async def test_stop_test_run(self, loadtesting_endpoint): @@ -162,7 +160,7 @@ async def test_stop_test_run(self, loadtesting_endpoint): { "testId": "new-load-test-from-pytest-aio-abc", "displayName": "My New Load Test Run from PyTest", - } + }, ) result = await run_client.stop_test_run("my-new-test-run-from-pytest-aio-abc") @@ -182,21 +180,24 @@ async def test_get_metrics(self, loadtesting_endpoint, loadtesting_test_id, load metric_namespaces = await run_client.get_metric_namespaces(loadtesting_test_run_id) assert metric_namespaces is not None - metric_definitions = await run_client.get_metric_definitions(loadtesting_test_run_id, - metric_namespace=metric_namespaces["value"][0]["name"]) + metric_definitions = await run_client.get_metric_definitions( + loadtesting_test_run_id, metric_namespace=metric_namespaces["value"][0]["name"] + ) assert metric_definitions is not None metrics = run_client.list_metrics( test_run_id=loadtesting_test_run_id, metric_name=metric_definitions["value"][0]["name"], metric_namespace=metric_namespaces["value"][0]["name"], - time_interval=test_run_response["startDateTime"] + "/" + test_run_response["endDateTime"] + time_interval=test_run_response["startDateTime"] + "/" + test_run_response["endDateTime"], ) assert metrics is not None @LoadtestingPowerShellPreparer() @recorded_by_proxy_async - async def test_create_or_update_app_component(self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id, loadtesting_resource_id): + async def test_create_or_update_app_component( + self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id, loadtesting_resource_id + ): set_bodiless_matcher() await self.setup_test_run(loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id) @@ -206,17 +207,15 @@ async def test_create_or_update_app_component(self, loadtesting_endpoint, loadte result = await run_client.create_or_update_app_components( loadtesting_test_run_id, { - "components": - { - loadtesting_resource_id: - { - "resourceId": loadtesting_resource_id, - "resourceName": "App-Service-Sample-Demo", - "resourceType": "Microsoft.Web/sites", - "kind": "web" - } + "components": { + loadtesting_resource_id: { + "resourceId": loadtesting_resource_id, + "resourceName": "App-Service-Sample-Demo", + "resourceType": "Microsoft.Web/sites", + "kind": "web", } - } + } + }, ) assert result is not None @@ -224,22 +223,22 @@ async def test_create_or_update_app_component(self, loadtesting_endpoint, loadte await run_client.create_or_update_app_components( NON_EXISTING_RESOURCE, { - "components": - { - loadtesting_resource_id: - { - "resourceId": loadtesting_resource_id, - "resourceName": "App-Service-Sample-Demo", - "resourceType": "Microsoft.Web/sites", - "kind": "web" - } + "components": { + loadtesting_resource_id: { + "resourceId": loadtesting_resource_id, + "resourceName": "App-Service-Sample-Demo", + "resourceType": "Microsoft.Web/sites", + "kind": "web", } - } + } + }, ) @LoadtestingPowerShellPreparer() @recorded_by_proxy_async - async def test_get_app_component(self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id, loadtesting_resource_id): + async def test_get_app_component( + self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id, loadtesting_resource_id + ): set_bodiless_matcher() await self.setup_test_run(loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id) @@ -250,7 +249,9 @@ async def test_get_app_component(self, loadtesting_endpoint, loadtesting_test_id @LoadtestingPowerShellPreparer() @recorded_by_proxy_async - async def test_create_or_update_server_metrics_config(self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id, loadtesting_resource_id): + async def test_create_or_update_server_metrics_config( + self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id, loadtesting_resource_id + ): set_bodiless_matcher() await self.setup_test_run(loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id) @@ -267,20 +268,22 @@ async def test_create_or_update_server_metrics_config(self, loadtesting_endpoint "name": "requests/duration", "aggregation": "Average", "unit": None, - "resourceType": "microsoft.insights/components" + "resourceType": "microsoft.insights/components", } } - } + }, ) assert result is not None @LoadtestingPowerShellPreparer() @recorded_by_proxy_async - async def test_get_server_metrics_config(self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id, loadtesting_resource_id): + async def test_get_server_metrics_config( + self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id, loadtesting_resource_id + ): set_bodiless_matcher() await self.setup_test_run(loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id) run_client = self.create_run_client(loadtesting_endpoint) result = await run_client.get_server_metrics_config(loadtesting_test_run_id) - assert result is not None \ No newline at end of file + assert result is not None diff --git a/sdk/loadtesting/azure-developer-loadtesting/tests/test_run_ops.py b/sdk/loadtesting/azure-developer-loadtesting/tests/test_run_ops.py index 23781caa0436..7a87dc0e59fe 100644 --- a/sdk/loadtesting/azure-developer-loadtesting/tests/test_run_ops.py +++ b/sdk/loadtesting/azure-developer-loadtesting/tests/test_run_ops.py @@ -16,8 +16,8 @@ DISPLAY_NAME = "TestingResourcePyTest" NON_EXISTING_RESOURCE = "nonexistingresource" -class TestRunOps(LoadtestingTest): +class TestRunOps(LoadtestingTest): def setup_loadtest(self, endpoint, test_id): admin_client = self.create_administration_client(endpoint) @@ -36,7 +36,7 @@ def setup_loadtest(self, endpoint, test_id): "passFailCriteria": {"passFailMetrics": {}}, "keyvaultReferenceIdentityType": "SystemAssigned", "keyvaultReferenceIdentityId": None, - } + }, ) validation_poller = admin_client.begin_upload_test_file( @@ -55,7 +55,7 @@ def setup_test_run(self, endpoint, test_id, test_run_id): { "testId": test_id, "displayName": "My New Load Test Run from PyTest", - } + }, ) run_poller.result(10800) @@ -110,7 +110,6 @@ def test_delete_test_run(self, loadtesting_endpoint, loadtesting_test_id, loadte with pytest.raises(ResourceNotFoundError): run_client.delete_test_run(NON_EXISTING_RESOURCE) - @LoadtestingPowerShellPreparer() @recorded_by_proxy def test_get_test_run_file(self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id): @@ -129,7 +128,6 @@ def test_get_test_run_file(self, loadtesting_endpoint, loadtesting_test_id, load with pytest.raises(HttpResponseError): run_client.get_test_run_file(loadtesting_test_run_id, NON_EXISTING_RESOURCE) - @LoadtestingPowerShellPreparer() @recorded_by_proxy def test_list_test_runs(self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id): @@ -142,7 +140,6 @@ def test_list_test_runs(self, loadtesting_endpoint, loadtesting_test_id, loadtes result = run_client.list_test_runs() assert result is not None - @LoadtestingPowerShellPreparer() @recorded_by_proxy def test_stop_test_run(self, loadtesting_endpoint): @@ -161,7 +158,7 @@ def test_stop_test_run(self, loadtesting_endpoint): { "testId": "new-load-test-from-pytest-abc", "displayName": "My New Load Test Run from PyTest", - } + }, ) result = run_client.stop_test_run("my-new-test-run-from-pytest") @@ -170,7 +167,6 @@ def test_stop_test_run(self, loadtesting_endpoint): with pytest.raises(ResourceNotFoundError): run_client.stop_test_run(NON_EXISTING_RESOURCE) - @LoadtestingPowerShellPreparer() @recorded_by_proxy def test_get_metrics(self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id): @@ -185,21 +181,24 @@ def test_get_metrics(self, loadtesting_endpoint, loadtesting_test_id, loadtestin metric_namespaces = run_client.get_metric_namespaces(loadtesting_test_run_id) assert metric_namespaces is not None - metric_definitions = run_client.get_metric_definitions(loadtesting_test_run_id, - metric_namespace=metric_namespaces["value"][0]["name"]) + metric_definitions = run_client.get_metric_definitions( + loadtesting_test_run_id, metric_namespace=metric_namespaces["value"][0]["name"] + ) assert metric_definitions is not None metrics = run_client.list_metrics( test_run_id=loadtesting_test_run_id, metric_name=metric_definitions["value"][0]["name"], metric_namespace=metric_namespaces["value"][0]["name"], - time_interval=test_run_response["startDateTime"] + "/" + test_run_response["endDateTime"] + time_interval=test_run_response["startDateTime"] + "/" + test_run_response["endDateTime"], ) assert metrics is not None @LoadtestingPowerShellPreparer() @recorded_by_proxy - def test_create_or_update_app_component(self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id, loadtesting_resource_id): + def test_create_or_update_app_component( + self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id, loadtesting_resource_id + ): set_bodiless_matcher() self.setup_test_run(loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id) @@ -209,17 +208,15 @@ def test_create_or_update_app_component(self, loadtesting_endpoint, loadtesting_ result = run_client.create_or_update_app_components( loadtesting_test_run_id, { - "components": - { - loadtesting_resource_id: - { - "resourceId": loadtesting_resource_id, - "resourceName": "App-Service-Sample-Demo", - "resourceType": "Microsoft.Web/sites", - "kind": "web" - } + "components": { + loadtesting_resource_id: { + "resourceId": loadtesting_resource_id, + "resourceName": "App-Service-Sample-Demo", + "resourceType": "Microsoft.Web/sites", + "kind": "web", } - } + } + }, ) assert result is not None @@ -227,22 +224,22 @@ def test_create_or_update_app_component(self, loadtesting_endpoint, loadtesting_ run_client.create_or_update_app_components( NON_EXISTING_RESOURCE, { - "components": - { - loadtesting_resource_id: - { - "resourceId": loadtesting_resource_id, - "resourceName": "App-Service-Sample-Demo", - "resourceType": "Microsoft.Web/sites", - "kind": "web" - } + "components": { + loadtesting_resource_id: { + "resourceId": loadtesting_resource_id, + "resourceName": "App-Service-Sample-Demo", + "resourceType": "Microsoft.Web/sites", + "kind": "web", } - } + } + }, ) @LoadtestingPowerShellPreparer() @recorded_by_proxy - def test_get_app_component(self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id, loadtesting_resource_id): + def test_get_app_component( + self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id, loadtesting_resource_id + ): set_bodiless_matcher() self.setup_test_run(loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id) @@ -253,7 +250,9 @@ def test_get_app_component(self, loadtesting_endpoint, loadtesting_test_id, load @LoadtestingPowerShellPreparer() @recorded_by_proxy - def test_create_or_update_server_metrics_config(self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id, loadtesting_resource_id): + def test_create_or_update_server_metrics_config( + self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id, loadtesting_resource_id + ): set_bodiless_matcher() self.setup_test_run(loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id) @@ -270,20 +269,22 @@ def test_create_or_update_server_metrics_config(self, loadtesting_endpoint, load "name": "requests/duration", "aggregation": "Average", "unit": None, - "resourceType": "microsoft.insights/components" + "resourceType": "microsoft.insights/components", } } - } + }, ) assert result is not None @LoadtestingPowerShellPreparer() @recorded_by_proxy - def test_get_server_metrics_config(self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id, loadtesting_resource_id): + def test_get_server_metrics_config( + self, loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id, loadtesting_resource_id + ): set_bodiless_matcher() self.setup_test_run(loadtesting_endpoint, loadtesting_test_id, loadtesting_test_run_id) run_client = self.create_run_client(loadtesting_endpoint) result = run_client.get_server_metrics_config(loadtesting_test_run_id) - assert result is not None \ No newline at end of file + assert result is not None diff --git a/sdk/loadtesting/azure-developer-loadtesting/tests/testcase.py b/sdk/loadtesting/azure-developer-loadtesting/tests/testcase.py index 4c662118b11c..cad9fb27d10b 100644 --- a/sdk/loadtesting/azure-developer-loadtesting/tests/testcase.py +++ b/sdk/loadtesting/azure-developer-loadtesting/tests/testcase.py @@ -9,8 +9,8 @@ from devtools_testutils import AzureRecordedTestCase, PowerShellPreparer from azure.developer.loadtesting import LoadTestAdministrationClient, LoadTestRunClient -class LoadtestingTest(AzureRecordedTestCase): +class LoadtestingTest(AzureRecordedTestCase): def create_administration_client(self, endpoint): credential = self.get_credential(LoadTestAdministrationClient) return self.create_client_from_credential( diff --git a/sdk/loadtesting/azure-developer-loadtesting/tsp-location.yaml b/sdk/loadtesting/azure-developer-loadtesting/tsp-location.yaml new file mode 100644 index 000000000000..b2dde86a3c14 --- /dev/null +++ b/sdk/loadtesting/azure-developer-loadtesting/tsp-location.yaml @@ -0,0 +1,5 @@ +directory: specification/loadtestservice/LoadTestService +commit: a718913e51a489e2ed6fa6a5966e5291b8018435 +additionalDirectories: [] +repo: Azure/azure-rest-api-specs + diff --git a/sdk/vision/azure-ai-vision-imageanalysis/MANIFEST.in b/sdk/vision/azure-ai-vision-imageanalysis/MANIFEST.in index 0239ba4fd05b..19b8f97e43b7 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/MANIFEST.in +++ b/sdk/vision/azure-ai-vision-imageanalysis/MANIFEST.in @@ -1,8 +1,8 @@ include *.md include LICENSE include azure/ai/vision/imageanalysis/py.typed -recursive-include tests *.py *.md sample.jpg -recursive-include samples *.py *.md sample.jpg run_all_samples.cmd run_all_samples.ps1 +recursive-include tests *.py +recursive-include samples *.py *.md include azure/__init__.py include azure/ai/__init__.py include azure/ai/vision/__init__.py \ No newline at end of file diff --git a/sdk/vision/azure-ai-vision-imageanalysis/_meta.json b/sdk/vision/azure-ai-vision-imageanalysis/_meta.json index e63fcb6c8802..cfc576632704 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/_meta.json +++ b/sdk/vision/azure-ai-vision-imageanalysis/_meta.json @@ -1,6 +1,6 @@ { - "commit": "bef35d01d2572ba131d7f2d4cd8d6313ec649525", + "commit": "a718913e51a489e2ed6fa6a5966e5291b8018435", "repository_url": "https://github.com/Azure/azure-rest-api-specs", - "typespec_src": "specification/cognitiveservices/Vision.ImageAnalysis", - "@azure-tools/typespec-python": "0.15.0" + "typespec_src": "specification/ai/ImageAnalysis", + "@azure-tools/typespec-python": "0.21.0" } \ No newline at end of file diff --git a/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/__init__.py b/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/__init__.py index f7462abd47f7..b08513e7f1ab 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/__init__.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/__init__.py @@ -6,17 +6,21 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -from ._patch import ImageAnalysisClient +from ._client import ImageAnalysisClient from ._version import VERSION __version__ = VERSION - +try: + from ._patch import __all__ as _patch_all + from ._patch import * # pylint: disable=unused-wildcard-import +except ImportError: + _patch_all = [] from ._patch import patch_sdk as _patch_sdk __all__ = [ "ImageAnalysisClient", ] - +__all__.extend([p for p in _patch_all if p not in __all__]) _patch_sdk() diff --git a/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/_model_base.py b/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/_model_base.py index bd51cdeb4465..1ddc071517d6 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/_model_base.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/_model_base.py @@ -5,7 +5,6 @@ # license information. # -------------------------------------------------------------------------- # pylint: disable=protected-access, arguments-differ, signature-differs, broad-except -# pyright: reportGeneralTypeIssues=false import calendar import decimal @@ -16,9 +15,11 @@ import re import copy import typing +import enum import email.utils from datetime import datetime, date, time, timedelta, timezone from json import JSONEncoder +from typing_extensions import Self import isodate from azure.core.exceptions import DeserializationError from azure.core import CaseInsensitiveEnumMeta @@ -35,6 +36,7 @@ __all__ = ["SdkJSONEncoder", "Model", "rest_field", "rest_discriminator"] TZ_UTC = timezone.utc +_T = typing.TypeVar("_T") def _timedelta_as_isostr(td: timedelta) -> str: @@ -242,7 +244,7 @@ def _deserialize_date(attr: typing.Union[str, date]) -> date: # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. if isinstance(attr, date): return attr - return isodate.parse_date(attr, defaultmonth=None, defaultday=None) + return isodate.parse_date(attr, defaultmonth=None, defaultday=None) # type: ignore def _deserialize_time(attr: typing.Union[str, time]) -> time: @@ -375,8 +377,12 @@ def get(self, key: str, default: typing.Any = None) -> typing.Any: except KeyError: return default - @typing.overload # type: ignore - def pop(self, key: str) -> typing.Any: # pylint: disable=no-member + @typing.overload + def pop(self, key: str) -> typing.Any: + ... + + @typing.overload + def pop(self, key: str, default: _T) -> _T: ... @typing.overload @@ -397,8 +403,8 @@ def clear(self) -> None: def update(self, *args: typing.Any, **kwargs: typing.Any) -> None: self._data.update(*args, **kwargs) - @typing.overload # type: ignore - def setdefault(self, key: str) -> typing.Any: + @typing.overload + def setdefault(self, key: str, default: None = None) -> None: ... @typing.overload @@ -438,6 +444,8 @@ def _serialize(o, format: typing.Optional[str] = None): # pylint: disable=too-m return _serialize_bytes(o, format) if isinstance(o, decimal.Decimal): return float(o) + if isinstance(o, enum.Enum): + return o.value try: # First try datetime.datetime return _serialize_datetime(o, format) @@ -504,7 +512,7 @@ def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None: def copy(self) -> "Model": return Model(self.__dict__) - def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> "Model": # pylint: disable=unused-argument + def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self: # pylint: disable=unused-argument # we know the last three classes in mro are going to be 'Model', 'dict', and 'object' mros = cls.__mro__[:-3][::-1] # ignore model, dict, and object parents, and reverse the mro order attr_to_rest_field: typing.Dict[str, _RestField] = { # map attribute name to rest_field property @@ -546,7 +554,7 @@ def _deserialize(cls, data, exist_discriminators): return cls(data) discriminator = cls._get_discriminator(exist_discriminators) exist_discriminators.append(discriminator) - mapped_cls = cls.__mapping__.get(data.get(discriminator), cls) # pylint: disable=no-member + mapped_cls = cls.__mapping__.get(data.get(discriminator), cls) # pyright: ignore # pylint: disable=no-member if mapped_cls == cls: return cls(data) return mapped_cls._deserialize(data, exist_discriminators) # pylint: disable=protected-access @@ -563,7 +571,7 @@ def as_dict(self, *, exclude_readonly: bool = False) -> typing.Dict[str, typing. if exclude_readonly: readonly_props = [p._rest_name for p in self._attr_to_rest_field.values() if _is_readonly(p)] for k, v in self.items(): - if exclude_readonly and k in readonly_props: # pyright: ignore[reportUnboundVariable] + if exclude_readonly and k in readonly_props: # pyright: ignore continue is_multipart_file_input = False try: @@ -618,22 +626,22 @@ def _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj return obj return _deserialize(model_deserializer, obj) - return functools.partial(_deserialize_model, annotation) + return functools.partial(_deserialize_model, annotation) # pyright: ignore except Exception: pass # is it a literal? try: - if annotation.__origin__ is typing.Literal: + if annotation.__origin__ is typing.Literal: # pyright: ignore return None except AttributeError: pass # is it optional? try: - if any(a for a in annotation.__args__ if a == type(None)): + if any(a for a in annotation.__args__ if a == type(None)): # pyright: ignore if_obj_deserializer = _get_deserialize_callable_from_annotation( - next(a for a in annotation.__args__ if a != type(None)), module, rf + next(a for a in annotation.__args__ if a != type(None)), module, rf # pyright: ignore ) def _deserialize_with_optional(if_obj_deserializer: typing.Optional[typing.Callable], obj): @@ -646,7 +654,13 @@ def _deserialize_with_optional(if_obj_deserializer: typing.Optional[typing.Calla pass if getattr(annotation, "__origin__", None) is typing.Union: - deserializers = [_get_deserialize_callable_from_annotation(arg, module, rf) for arg in annotation.__args__] + # initial ordering is we make `string` the last deserialization option, because it is often them most generic + deserializers = [ + _get_deserialize_callable_from_annotation(arg, module, rf) + for arg in sorted( + annotation.__args__, key=lambda x: hasattr(x, "__name__") and x.__name__ == "str" # pyright: ignore + ) + ] def _deserialize_with_union(deserializers, obj): for deserializer in deserializers: @@ -659,8 +673,10 @@ def _deserialize_with_union(deserializers, obj): return functools.partial(_deserialize_with_union, deserializers) try: - if annotation._name == "Dict": - value_deserializer = _get_deserialize_callable_from_annotation(annotation.__args__[1], module, rf) + if annotation._name == "Dict": # pyright: ignore + value_deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[1], module, rf # pyright: ignore + ) def _deserialize_dict( value_deserializer: typing.Optional[typing.Callable], @@ -677,8 +693,8 @@ def _deserialize_dict( except (AttributeError, IndexError): pass try: - if annotation._name in ["List", "Set", "Tuple", "Sequence"]: - if len(annotation.__args__) > 1: + if annotation._name in ["List", "Set", "Tuple", "Sequence"]: # pyright: ignore + if len(annotation.__args__) > 1: # pyright: ignore def _deserialize_multiple_sequence( entry_deserializers: typing.List[typing.Optional[typing.Callable]], @@ -692,10 +708,13 @@ def _deserialize_multiple_sequence( ) entry_deserializers = [ - _get_deserialize_callable_from_annotation(dt, module, rf) for dt in annotation.__args__ + _get_deserialize_callable_from_annotation(dt, module, rf) + for dt in annotation.__args__ # pyright: ignore ] return functools.partial(_deserialize_multiple_sequence, entry_deserializers) - deserializer = _get_deserialize_callable_from_annotation(annotation.__args__[0], module, rf) + deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[0], module, rf # pyright: ignore + ) def _deserialize_sequence( deserializer: typing.Optional[typing.Callable], @@ -787,6 +806,10 @@ def __init__( self._format = format self._is_multipart_file_input = is_multipart_file_input + @property + def _class_type(self) -> typing.Any: + return getattr(self._type, "args", [None])[0] + @property def _rest_name(self) -> str: if self._rest_name_input is None: diff --git a/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/_patch.py b/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/_patch.py index 4a4ed79b677c..1801f044097b 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/_patch.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/_patch.py @@ -87,7 +87,6 @@ def analyze_from_url( **kwargs ) - @distributed_trace def analyze( self, diff --git a/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/_serialization.py b/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/_serialization.py index baa661cb82d2..2f781d740827 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/_serialization.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/_serialization.py @@ -170,13 +170,6 @@ def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], return None -try: - basestring # type: ignore - unicode_str = unicode # type: ignore -except NameError: - basestring = str - unicode_str = str - _LOGGER = logging.getLogger(__name__) try: @@ -545,7 +538,7 @@ class Serializer(object): "multiple": lambda x, y: x % y != 0, } - def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): + def __init__(self, classes: Optional[Mapping[str, type]] = None): self.serialize_type = { "iso-8601": Serializer.serialize_iso, "rfc-1123": Serializer.serialize_rfc, @@ -561,7 +554,7 @@ def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): "[]": self.serialize_iter, "{}": self.serialize_dict, } - self.dependencies: Dict[str, Type[ModelType]] = dict(classes) if classes else {} + self.dependencies: Dict[str, type] = dict(classes) if classes else {} self.key_transformer = full_restapi_key_transformer self.client_side_validation = True @@ -649,7 +642,7 @@ def _serialize(self, target_obj, data_type=None, **kwargs): else: # That's a basic type # Integrate namespace if necessary local_node = _create_xml_node(xml_name, xml_prefix, xml_ns) - local_node.text = unicode_str(new_attr) + local_node.text = str(new_attr) serialized.append(local_node) # type: ignore else: # JSON for k in reversed(keys): # type: ignore @@ -994,7 +987,7 @@ def serialize_object(self, attr, **kwargs): return self.serialize_basic(attr, self.basic_types[obj_type], **kwargs) if obj_type is _long_type: return self.serialize_long(attr) - if obj_type is unicode_str: + if obj_type is str: return self.serialize_unicode(attr) if obj_type is datetime.datetime: return self.serialize_iso(attr) @@ -1370,7 +1363,7 @@ class Deserializer(object): valid_date = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") - def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): + def __init__(self, classes: Optional[Mapping[str, type]] = None): self.deserialize_type = { "iso-8601": Deserializer.deserialize_iso, "rfc-1123": Deserializer.deserialize_rfc, @@ -1390,7 +1383,7 @@ def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): "duration": (isodate.Duration, datetime.timedelta), "iso-8601": (datetime.datetime), } - self.dependencies: Dict[str, Type[ModelType]] = dict(classes) if classes else {} + self.dependencies: Dict[str, type] = dict(classes) if classes else {} self.key_extractors = [rest_key_extractor, xml_key_extractor] # Additional properties only works if the "rest_key_extractor" is used to # extract the keys. Making it to work whatever the key extractor is too much @@ -1443,7 +1436,7 @@ def _deserialize(self, target_obj, data): response, class_name = self._classify_target(target_obj, data) - if isinstance(response, basestring): + if isinstance(response, str): return self.deserialize_data(data, response) elif isinstance(response, type) and issubclass(response, Enum): return self.deserialize_enum(data, response) @@ -1514,14 +1507,14 @@ def _classify_target(self, target, data): if target is None: return None, None - if isinstance(target, basestring): + if isinstance(target, str): try: target = self.dependencies[target] except KeyError: return target, target try: - target = target._classify(data, self.dependencies) + target = target._classify(data, self.dependencies) # type: ignore except AttributeError: pass # Target is not a Model, no classify return target, target.__class__.__name__ # type: ignore @@ -1577,7 +1570,7 @@ def _unpack_content(raw_data, content_type=None): if hasattr(raw_data, "_content_consumed"): return RawDeserializer.deserialize_from_http_generics(raw_data.text, raw_data.headers) - if isinstance(raw_data, (basestring, bytes)) or hasattr(raw_data, "read"): + if isinstance(raw_data, (str, bytes)) or hasattr(raw_data, "read"): return RawDeserializer.deserialize_from_text(raw_data, content_type) # type: ignore return raw_data @@ -1699,7 +1692,7 @@ def deserialize_object(self, attr, **kwargs): if isinstance(attr, ET.Element): # Do no recurse on XML, just return the tree as-is return attr - if isinstance(attr, basestring): + if isinstance(attr, str): return self.deserialize_basic(attr, "str") obj_type = type(attr) if obj_type in self.basic_types: @@ -1756,7 +1749,7 @@ def deserialize_basic(self, attr, data_type): if data_type == "bool": if attr in [True, False, 1, 0]: return bool(attr) - elif isinstance(attr, basestring): + elif isinstance(attr, str): if attr.lower() in ["true", "1"]: return True elif attr.lower() in ["false", "0"]: diff --git a/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/_version.py b/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/_version.py index bbcd28b4aa67..be71c81bd282 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/_version.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/_version.py @@ -6,4 +6,4 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -VERSION = "1.0.0b2" +VERSION = "1.0.0b1" diff --git a/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/aio/__init__.py b/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/aio/__init__.py index 4e185770e8d5..4fed93494fc6 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/aio/__init__.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/aio/__init__.py @@ -6,14 +6,18 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -from ._patch import ImageAnalysisClient - +from ._client import ImageAnalysisClient +try: + from ._patch import __all__ as _patch_all + from ._patch import * # pylint: disable=unused-wildcard-import +except ImportError: + _patch_all = [] from ._patch import patch_sdk as _patch_sdk __all__ = [ "ImageAnalysisClient", ] - +__all__.extend([p for p in _patch_all if p not in __all__]) _patch_sdk() diff --git a/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/aio/_patch.py b/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/aio/_patch.py index 117a0e6c4ebb..68bfdb00fb21 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/aio/_patch.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/azure/ai/vision/imageanalysis/aio/_patch.py @@ -87,7 +87,6 @@ async def analyze_from_url( **kwargs ) - @distributed_trace_async async def analyze( self, diff --git a/sdk/vision/azure-ai-vision-imageanalysis/samples/async_samples/sample_caption_image_file_async.py b/sdk/vision/azure-ai-vision-imageanalysis/samples/async_samples/sample_caption_image_file_async.py index 35b3b001da4a..5f857c22d792 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/samples/async_samples/sample_caption_image_file_async.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/samples/async_samples/sample_caption_image_file_async.py @@ -48,16 +48,10 @@ async def sample_caption_image_file_async(): image_data = f.read() # Create an asynchronous Image Analysis client - client = ImageAnalysisClient( - endpoint=endpoint, - credential=AzureKeyCredential(key) - ) + client = ImageAnalysisClient(endpoint=endpoint, credential=AzureKeyCredential(key)) # Get a caption for the image, asynchronously. - result = await client.analyze( - image_data=image_data, - visual_features=[VisualFeatures.CAPTION] - ) + result = await client.analyze(image_data=image_data, visual_features=[VisualFeatures.CAPTION]) await client.close() diff --git a/sdk/vision/azure-ai-vision-imageanalysis/samples/async_samples/sample_ocr_image_url_async.py b/sdk/vision/azure-ai-vision-imageanalysis/samples/async_samples/sample_ocr_image_url_async.py index 502d05d4417d..2a3e1af4cfcf 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/samples/async_samples/sample_ocr_image_url_async.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/samples/async_samples/sample_ocr_image_url_async.py @@ -47,15 +47,11 @@ async def sample_ocr_image_file_async(): exit() # Create an asynchronous Image Analysis client - client = ImageAnalysisClient( - endpoint=endpoint, - credential=AzureKeyCredential(key) - ) + client = ImageAnalysisClient(endpoint=endpoint, credential=AzureKeyCredential(key)) # Extract text (OCR) from an image URL, asynchronously. result = await client.analyze_from_url( - image_url="https://aka.ms/azsdk/image-analysis/sample.jpg", - visual_features=[VisualFeatures.READ] + image_url="https://aka.ms/azsdk/image-analysis/sample.jpg", visual_features=[VisualFeatures.READ] ) await client.close() @@ -67,7 +63,9 @@ async def sample_ocr_image_file_async(): for line in result.read.blocks[0].lines: print(f" Line: '{line.text}', Bounding box {line.bounding_polygon}") for word in line.words: - print(f" Word: '{word.text}', Bounding polygon {word.bounding_polygon}, Confidence {word.confidence:.4f}") + print( + f" Word: '{word.text}', Bounding polygon {word.bounding_polygon}, Confidence {word.confidence:.4f}" + ) print(f" Image height: {result.metadata.height}") print(f" Image width: {result.metadata.width}") print(f" Model version: {result.model_version}") diff --git a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_analyze_all_image_file.py b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_analyze_all_image_file.py index 08ce7f3d584c..6a04a2faf266 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_analyze_all_image_file.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_analyze_all_image_file.py @@ -70,11 +70,7 @@ def sample_analyze_all_image_file(): # [START create_client_with_logging] # Create an Image Analysis client with none redacted log - client = ImageAnalysisClient( - endpoint=endpoint, - credential=AzureKeyCredential(key), - logging_enable=True - ) + client = ImageAnalysisClient(endpoint=endpoint, credential=AzureKeyCredential(key), logging_enable=True) # [END create_client_with_logging] # Analyze all visual features from an image stream. This will be a synchronously (blocking) call. @@ -112,7 +108,9 @@ def sample_analyze_all_image_file(): for line in result.read.blocks[0].lines: print(f" Line: '{line.text}', Bounding box {line.bounding_polygon}") for word in line.words: - print(f" Word: '{word.text}', Bounding polygon {word.bounding_polygon}, Confidence {word.confidence:.4f}") + print( + f" Word: '{word.text}', Bounding polygon {word.bounding_polygon}, Confidence {word.confidence:.4f}" + ) if result.tags is not None: print(" Tags:") diff --git a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_caption_image_file.py b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_caption_image_file.py index 5570b2b4996f..e060626cc6e9 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_caption_image_file.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_caption_image_file.py @@ -45,10 +45,7 @@ def sample_caption_image_file(): exit() # Create an Image Analysis client for synchronous operations - client = ImageAnalysisClient( - endpoint=endpoint, - credential=AzureKeyCredential(key) - ) + client = ImageAnalysisClient(endpoint=endpoint, credential=AzureKeyCredential(key)) # [END create_client] # [START caption] diff --git a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_caption_image_url.py b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_caption_image_url.py index fe9dad3aa4a1..c6d99f21b25e 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_caption_image_url.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_caption_image_url.py @@ -44,10 +44,7 @@ def sample_caption_image_url(): exit() # Create an Image Analysis client - client = ImageAnalysisClient( - endpoint=endpoint, - credential=AzureKeyCredential(key) - ) + client = ImageAnalysisClient(endpoint=endpoint, credential=AzureKeyCredential(key)) # [START caption] # Get a caption for the image. This will be a synchronously (blocking) call. diff --git a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_dense_captions_image_file.py b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_dense_captions_image_file.py index 8f268cb76ee0..5e062467ca67 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_dense_captions_image_file.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_dense_captions_image_file.py @@ -48,10 +48,7 @@ def sample_dense_captions_image_file(): exit() # Create an Image Analysis client. - client = ImageAnalysisClient( - endpoint=endpoint, - credential=AzureKeyCredential(key) - ) + client = ImageAnalysisClient(endpoint=endpoint, credential=AzureKeyCredential(key)) # Load image to analyze into a 'bytes' object. with open("sample.jpg", "rb") as f: diff --git a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_objects_image_file.py b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_objects_image_file.py index b3aec2ead684..0bf98d2d05a6 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_objects_image_file.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_objects_image_file.py @@ -41,20 +41,14 @@ def sample_objects_image_file(): exit() # Create an Image Analysis client - client = ImageAnalysisClient( - endpoint=endpoint, - credential=AzureKeyCredential(key) - ) + client = ImageAnalysisClient(endpoint=endpoint, credential=AzureKeyCredential(key)) # Load image to analyze into a 'bytes' object with open("sample.jpg", "rb") as f: image_data = f.read() # Detect objects in an image stream. This will be a synchronously (blocking) call. - result = client.analyze( - image_data=image_data, - visual_features=[VisualFeatures.OBJECTS] - ) + result = client.analyze(image_data=image_data, visual_features=[VisualFeatures.OBJECTS]) # Print Objects analysis results to the console print("Image analysis results:") diff --git a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_ocr_image_file.py b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_ocr_image_file.py index 3715bf4618a6..766e8122ec34 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_ocr_image_file.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_ocr_image_file.py @@ -47,10 +47,7 @@ def sample_ocr_image_file(): exit() # Create an Image Analysis client - client = ImageAnalysisClient( - endpoint=endpoint, - credential=AzureKeyCredential(key) - ) + client = ImageAnalysisClient(endpoint=endpoint, credential=AzureKeyCredential(key)) # [START read] # Load image to analyze into a 'bytes' object @@ -58,10 +55,7 @@ def sample_ocr_image_file(): image_data = f.read() # Extract text (OCR) from an image stream. This will be a synchronously (blocking) call. - result = client.analyze( - image_data=image_data, - visual_features=[VisualFeatures.READ] - ) + result = client.analyze(image_data=image_data, visual_features=[VisualFeatures.READ]) # Print text (OCR) analysis results to the console print("Image analysis results:") @@ -70,7 +64,9 @@ def sample_ocr_image_file(): for line in result.read.blocks[0].lines: print(f" Line: '{line.text}', Bounding box {line.bounding_polygon}") for word in line.words: - print(f" Word: '{word.text}', Bounding polygon {word.bounding_polygon}, Confidence {word.confidence:.4f}") + print( + f" Word: '{word.text}', Bounding polygon {word.bounding_polygon}, Confidence {word.confidence:.4f}" + ) # [END read] print(f" Image height: {result.metadata.height}") print(f" Image width: {result.metadata.width}") diff --git a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_ocr_image_url.py b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_ocr_image_url.py index 96a835bb9cb3..42118166b116 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_ocr_image_url.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_ocr_image_url.py @@ -47,16 +47,12 @@ def sample_ocr_image_url(): exit() # Create an Image Analysis client - client = ImageAnalysisClient( - endpoint=endpoint, - credential=AzureKeyCredential(key) - ) + client = ImageAnalysisClient(endpoint=endpoint, credential=AzureKeyCredential(key)) # [START read] # Extract text (OCR) from an image stream. This will be a synchronously (blocking) call. result = client.analyze_from_url( - image_url="https://aka.ms/azsdk/image-analysis/sample.jpg", - visual_features=[VisualFeatures.READ] + image_url="https://aka.ms/azsdk/image-analysis/sample.jpg", visual_features=[VisualFeatures.READ] ) # Print text (OCR) analysis results to the console @@ -66,7 +62,9 @@ def sample_ocr_image_url(): for line in result.read.blocks[0].lines: print(f" Line: '{line.text}', Bounding box {line.bounding_polygon}") for word in line.words: - print(f" Word: '{word.text}', Bounding polygon {word.bounding_polygon}, Confidence {word.confidence:.4f}") + print( + f" Word: '{word.text}', Bounding polygon {word.bounding_polygon}, Confidence {word.confidence:.4f}" + ) # [END read] print(f" Image height: {result.metadata.height}") print(f" Image width: {result.metadata.width}") diff --git a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_people_image_file.py b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_people_image_file.py index c540bcf0c897..c506ea91d19a 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_people_image_file.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_people_image_file.py @@ -40,20 +40,14 @@ def sample_people_image_file(): exit() # Create an Image Analysis client - client = ImageAnalysisClient( - endpoint=endpoint, - credential=AzureKeyCredential(key) - ) + client = ImageAnalysisClient(endpoint=endpoint, credential=AzureKeyCredential(key)) # Load image to analyze into a 'bytes' object with open("sample.jpg", "rb") as f: image_data = f.read() # Find people in an image stream. This will be a synchronously (blocking) call. - result = client.analyze( - image_data=image_data, - visual_features=[VisualFeatures.PEOPLE] - ) + result = client.analyze(image_data=image_data, visual_features=[VisualFeatures.PEOPLE]) # Print People analysis results to the console print("Image analysis results:") diff --git a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_smart_crops_image_file.py b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_smart_crops_image_file.py index c9d4cdeec8d2..b2aac22a02cb 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_smart_crops_image_file.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_smart_crops_image_file.py @@ -49,10 +49,7 @@ def sample_smart_crops_image_file(): exit() # Create an Image Analysis client - client = ImageAnalysisClient( - endpoint=endpoint, - credential=AzureKeyCredential(key) - ) + client = ImageAnalysisClient(endpoint=endpoint, credential=AzureKeyCredential(key)) # Load image to analyze into a 'bytes' object with open("sample.jpg", "rb") as f: diff --git a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_tags_image_file.py b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_tags_image_file.py index d2cc94f3f746..b32c783f961e 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_tags_image_file.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/samples/sample_tags_image_file.py @@ -42,10 +42,7 @@ def sample_tags_image_file(): exit() # Create an Image Analysis client - client = ImageAnalysisClient( - endpoint=endpoint, - credential=AzureKeyCredential(key) - ) + client = ImageAnalysisClient(endpoint=endpoint, credential=AzureKeyCredential(key)) # Load image to analyze into a 'bytes' object with open("sample.jpg", "rb") as f: diff --git a/sdk/vision/azure-ai-vision-imageanalysis/setup.py b/sdk/vision/azure-ai-vision-imageanalysis/setup.py index b8b29a5bb973..f250e17b33ad 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/setup.py +++ b/sdk/vision/azure-ai-vision-imageanalysis/setup.py @@ -66,6 +66,7 @@ install_requires=[ "isodate<1.0.0,>=0.6.1", "azure-core<2.0.0,>=1.30.0", + "typing-extensions>=4.6.0", ], python_requires=">=3.8", ) diff --git a/sdk/vision/azure-ai-vision-imageanalysis/tsp-location.yaml b/sdk/vision/azure-ai-vision-imageanalysis/tsp-location.yaml index f3498ff59bfe..a65f57ed5978 100644 --- a/sdk/vision/azure-ai-vision-imageanalysis/tsp-location.yaml +++ b/sdk/vision/azure-ai-vision-imageanalysis/tsp-location.yaml @@ -1,6 +1,5 @@ additionalDirectories: [] -repo: Azure/azure-rest-api-specs +commit: a718913e51a489e2ed6fa6a5966e5291b8018435 directory: specification/ai/ImageAnalysis -commit: 3cf7400ba3d65978bef86e9c4197a5e7f7bf5277 - +repo: Azure/azure-rest-api-specs