diff --git a/.vscode/cspell.json b/.vscode/cspell.json index 62cb12fbf2a1..5f2c9afc92a5 100644 --- a/.vscode/cspell.json +++ b/.vscode/cspell.json @@ -105,6 +105,7 @@ "sdk/ml/azure-ai-ml/azure/ai/ml/_restclient/**", "sdk/ml/azure-ai-ml/azure/ai/ml/entities/_job/job_name_generator.py", "sdk/ml/azure-ai-ml/tests/**", + "sdk/loadtestservice/azure-developer-loadtesting/**", "sdk/monitor/azure-monitor-ingestion/**", "eng/**/*.json", "eng/*.txt", @@ -463,6 +464,12 @@ "undoc" ] }, + { + "filename": "sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/**", + "words":[ + "vusers" + ] + }, { "filename": "sdk/ml/azure-ai-ml/**", "words": [ diff --git a/eng/tox/allowed_pylint_failures.py b/eng/tox/allowed_pylint_failures.py index a2421870ded3..a67e0bfd0f31 100644 --- a/eng/tox/allowed_pylint_failures.py +++ b/eng/tox/allowed_pylint_failures.py @@ -59,5 +59,6 @@ "azure-messaging-nspkg", "azure-agrifood-farming", "azure-ai-language-questionanswering", - "azure-ai-language-conversations" + "azure-ai-language-conversations", + "azure-developer-loadtesting" ] diff --git a/sdk/loadtestservice/azure-developer-loadtesting/CHANGELOG.md b/sdk/loadtestservice/azure-developer-loadtesting/CHANGELOG.md new file mode 100644 index 000000000000..d156e13ce654 --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/CHANGELOG.md @@ -0,0 +1,5 @@ +# Release History + +## 1.0.0b1 (2022-07-28) + +- Initial version diff --git a/sdk/loadtestservice/azure-developer-loadtesting/LICENSE b/sdk/loadtestservice/azure-developer-loadtesting/LICENSE new file mode 100644 index 000000000000..63447fd8bbbf --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/LICENSE @@ -0,0 +1,21 @@ +Copyright (c) Microsoft Corporation. + +MIT License + +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. \ No newline at end of file diff --git a/sdk/loadtestservice/azure-developer-loadtesting/MANIFEST.in b/sdk/loadtestservice/azure-developer-loadtesting/MANIFEST.in new file mode 100644 index 000000000000..6ebb7e55a108 --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/MANIFEST.in @@ -0,0 +1,7 @@ +include *.md +include LICENSE +include azure/developer/loadtesting/py.typed +recursive-include tests *.py +recursive-include samples *.py *.md +include azure/__init__.py +include azure/developer/__init__.py \ No newline at end of file diff --git a/sdk/loadtestservice/azure-developer-loadtesting/README.md b/sdk/loadtestservice/azure-developer-loadtesting/README.md new file mode 100644 index 000000000000..2b409ebfbb38 --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/README.md @@ -0,0 +1,182 @@ + +# Azure Developer LoadTesting client library for Python +Azure Developer LoadTesting provides client library in python to the user by which they can interact natively with Load Test Service.The service is for performing the load test to optimize application performance, scalability or capacity. The user can get the client-side and server-side metrices to see the details reported by the test engine and information about your Azure application components. + + +## Getting started + +### Installating the package + +```bash +python -m pip install azure-developer-loadtesting +``` + +#### Prequisites + +- Python 3.7 or later is required to use this package. +- You need an [Azure subscription][azure_sub] to use this package. +- An existing Azure Developer LoadTesting instance. +#### Create with an Azure Active Directory Credential +To use an [Azure Active Directory (AAD) token credential][authenticate_with_token], +provide an instance of the desired credential type obtained from the +[azure-identity][azure_identity_credentials] library. + +To authenticate with AAD, you must first [pip][pip] install [`azure-identity`][azure_identity_pip] + +After setup, you can choose which type of [credential][azure_identity_credentials] from azure.identity to use. +As an example, [DefaultAzureCredential][default_azure_credential] can be used to authenticate the client: + +Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables: +`AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET` + +Use the returned token credential to authenticate the client: + +```python +from azure.developer.loadtesting import LoadTestingClient +from azure.identity import DefaultAzureCredential +client = LoadTestingClient(endpoint='', credential=DefaultAzureCredential()) +``` + +## Examples + +### Creating a load test +```python +from azure.developer.loadtesting import LoadTestingClient +from azure.identity import DefaultAzureCredential +from azure.core.exceptions import HttpResponseError + +TEST_ID = "some-test-id" +DISPLAY_NAME = "new_namespace-new-namespace" +SUBSCRIPTION_ID = os.environ["SUBSCRIPTION_ID"] + +client = LoadTestingClient(endpoint='', credential=DefaultAzureCredential()) + +try: + result = client.load_test_administration.create_or_update_test( + TEST_ID, + { + "resourceId": f"/subscriptions/{SUBSCRIPTION_ID}/resourceGroups/yashika-rg/providers/Microsoft.LoadTestService/loadtests/loadtestsdk", + "description": "", + "displayName": DISPLAY_NAME, + "loadTestConfig": { + "engineSize": "m", + "engineInstances": 1, + "splitAllCSVs": False, + }, + "secrets": {}, + "environmentVariables": {}, + "passFailCriteria": {"passFailMetrics": {}}, + "keyvaultReferenceIdentityType": "SystemAssigned", + "keyvaultReferenceIdentityId": None, + }, + ) + print(result) +except HttpResponseError as e: + print('service responds error: {}'.format(e.response.json())) + +``` + +### Uploading .jmx file to a Test +```python +from azure.developer.loadtesting import LoadTestingClient +from azure.identity import DefaultAzureCredential +from azure.core.exceptions import HttpResponseError + +TEST_ID = "some-test-id" +FILE_ID = "some-file-id" + +client = LoadTestingClient(endpoint='', credential=DefaultAzureCredential()) + +try: + + result = client.load_test_administration.upload_test_file(TEST_ID, FILE_ID, open("sample.jmx", "rb")) + print(result) +except HttpResponseError as e: + print("Failed to send JSON message: {}".format(e.response.json())) +``` + +### Running a Test +```python +from azure.developer.loadtesting import LoadTestingClient +from azure.identity import DefaultAzureCredential +from azure.core.exceptions import HttpResponseError + +TEST_ID = "some-test-id" +TEST_RUN_ID = "some-testrun-id" +DISPLAY_NAME = "new_namespace-new-namespace" + +client = LoadTestingClient(endpoint='', credential=DefaultAzureCredential()) + +try: + result = client.load_test_runs.create_and_update_test( + TEST_RUN_ID, + { + "testId": TEST_ID, + "displayName": DISPLAY_NAME, + "requestSamplers": [], + "errors": [], + "percentiles": ["90"], + "groupByInterval": "5s", + }, + ) + print(result) +except HttpResponseError as e: + print("Failed to send JSON message: {}".format(e.response.json())) +``` +## Key concepts +The following components make up the Azure Load Testing Service. The Azure Load Test client library for Python allows you to interact with each of these components through the use of a dedicated client object. + +### Load testing resource +The Load testing resource is the top-level resource for your load-testing activities. This resource provides a centralized place to view and manage load tests, test results, and related artifacts. A load testing resource contains zero or more load tests. + +### Test +A test specifies the test script, and configuration settings for running a load test. You can create one or more tests in an Azure Load Testing resource. + +### Test Engine +A test engine is computing infrastructure that runs the Apache JMeter test script. You can scale out your load test by configuring the number of test engines. The test script runs in parallel across the specified number of test engines. + +### Test Run +A test run represents one execution of a load test. It collects the logs associated with running the Apache JMeter script, the load test YAML configuration, the list of app components to monitor, and the results of the test. + +### App Component +When you run a load test for an Azure-hosted application, you can monitor resource metrics for the different Azure application components (server-side metrics). While the load test runs, and after completion of the test, you can monitor and analyze the resource metrics in the Azure Load Testing dashboard. + +### Metrics +During a load test, Azure Load Testing collects metrics about the test execution. There are two types of metrics: + +1. Client-side metrics give you details reported by the test engine. These metrics include the number of virtual users, the request response time, the number of failed requests, or the number of requests per second. + +2. Server-side metrics are available for Azure-hosted applications and provide information about your Azure application components. Metrics can be for the number of database reads, the type of HTTP responses, or container resource consumption. + +## Troubleshooting +More about it is coming soon... + +## Next steps + +More examples are coming soon... + +## Contributing + +This project welcomes contributions and suggestions. Most contributions require +you to agree to a Contributor License Agreement (CLA) declaring that you have +the right to, and actually do, grant us the rights to use your contribution. +For details, visit https://cla.microsoft.com. + +When you submit a pull request, a CLA-bot will automatically determine whether +you need to provide a CLA and decorate the PR appropriately (e.g., label, +comment). Simply follow the instructions provided by the bot. You will only +need to do this once across all repos using our CLA. + +This project has adopted the +[Microsoft Open Source Code of Conduct][code_of_conduct]. For more information, +see the Code of Conduct FAQ or contact opencode@microsoft.com with any +additional questions or comments. + + +[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/ +[authenticate_with_token]: https://docs.microsoft.com/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-an-authentication-token +[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#credentials +[azure_identity_pip]: https://pypi.org/project/azure-identity/ +[default_azure_credential]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#defaultazurecredential +[pip]: https://pypi.org/project/pip/ +[azure_sub]: https://azure.microsoft.com/free/ diff --git a/sdk/loadtestservice/azure-developer-loadtesting/azure/__init__.py b/sdk/loadtestservice/azure-developer-loadtesting/azure/__init__.py new file mode 100644 index 000000000000..d55ccad1f573 --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/azure/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/__init__.py b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/__init__.py new file mode 100644 index 000000000000..d55ccad1f573 --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/__init__.py @@ -0,0 +1 @@ +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/__init__.py b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/__init__.py new file mode 100644 index 000000000000..e0e16e203296 --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/__init__.py @@ -0,0 +1,24 @@ +# 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) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._client import LoadTestingClient +from ._version import VERSION + +__version__ = VERSION + +try: + from ._patch import __all__ as _patch_all + from ._patch import * # type: ignore # pylint: disable=unused-wildcard-import +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk + +__all__ = ["LoadTestingClient"] +__all__.extend([p for p in _patch_all if p not in __all__]) + +_patch_sdk() diff --git a/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/_client.py b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/_client.py new file mode 100644 index 000000000000..676075e18dab --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/_client.py @@ -0,0 +1,98 @@ +# 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) AutoRest 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.rest import HttpRequest, HttpResponse + +from ._configuration import LoadTestingClientConfiguration +from ._serialization import Deserializer, Serializer +from .operations import AppComponentOperations, ServerMetricsOperations, TestOperations, TestRunOperations + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from typing import Dict + + from azure.core.credentials import TokenCredential + + +class LoadTestingClient: # pylint: disable=client-accepts-api-version-keyword + """These APIs allow end users to create, view and run load tests using Azure Load Test Service. + + :ivar app_component: AppComponentOperations operations + :vartype app_component: azure.developer.loadtesting.operations.AppComponentOperations + :ivar server_metrics: ServerMetricsOperations operations + :vartype server_metrics: azure.developer.loadtesting.operations.ServerMetricsOperations + :ivar test: TestOperations operations + :vartype test: azure.developer.loadtesting.operations.TestOperations + :ivar test_run: TestRunOperations operations + :vartype test_run: azure.developer.loadtesting.operations.TestRunOperations + :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-06-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) + + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False + self.app_component = AppComponentOperations(self._client, self._config, self._serialize, self._deserialize) + self.server_metrics = ServerMetricsOperations(self._client, self._config, self._serialize, self._deserialize) + self.test = TestOperations( # type: ignore # pylint: disable=abstract-class-instantiated + self._client, self._config, self._serialize, self._deserialize + ) + self.test_run = TestRunOperations(self._client, self._config, self._serialize, self._deserialize) + + def send_request(self, request: HttpRequest, **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, **kwargs) + + def close(self): + # type: () -> None + self._client.close() + + def __enter__(self): + # type: () -> LoadTestingClient + self._client.__enter__() + return self + + def __exit__(self, *exc_details): + # type: (Any) -> None + self._client.__exit__(*exc_details) diff --git a/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/_configuration.py b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/_configuration.py new file mode 100644 index 000000000000..b2f16c2f9d6a --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/_configuration.py @@ -0,0 +1,68 @@ +# 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) AutoRest 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.configuration import Configuration +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 LoadTestingClientConfiguration(Configuration): # pylint: disable=too-many-instance-attributes + """Configuration for LoadTestingClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :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-06-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: + super(LoadTestingClientConfiguration, self).__init__(**kwargs) + api_version = kwargs.pop("api_version", "2022-06-01-preview") # type: str + + 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://loadtest.azure-dev.com/.default"]) + kwargs.setdefault("sdk_moniker", "developer-loadtesting/{}".format(VERSION)) + self._configure(**kwargs) + + def _configure( + self, **kwargs # type: Any + ): + # type: (...) -> 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.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**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.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/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/_patch.py b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/_patch.py new file mode 100644 index 000000000000..0c71458bece6 --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/_patch.py @@ -0,0 +1,80 @@ +# ------------------------------------ +# 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, Any + +from azure.core import PipelineClient + +from ._client import LoadTestingClient as LoadTestingClientGenerated +from ._configuration import LoadTestingClientConfiguration +from ._serialization import Deserializer, Serializer +from .operations import AppComponentOperations, ServerMetricsOperations, TestOperations, TestRunOperations + + +class LoadTestingAdministration(AppComponentOperations, ServerMetricsOperations, TestOperations): + """ + class to hold LoadTestingAdministration + """ + + def __init__(self, client, config, serialize, deserialize): + self._client = client + self._config = config + + self._serialize = serialize + self._deserialize = deserialize + self._serialize.client_side_validation = False + + AppComponentOperations.__init__(self, self._client, self._config, self._serialize, self._deserialize) + ServerMetricsOperations.__init__(self, self._client, self._config, self._serialize, self._deserialize) + TestOperations.__init__(self, self._client, self._config, self._serialize, self._deserialize) + + +class LoadTestingClient(LoadTestingClientGenerated): # pylint: disable=client-accepts-api-version-keyword + """These APIs allow end users to create, view and run load tests using Azure Load Test Service. + + :ivar app_component: AppComponentOperations operations + :vartype app_component: azure.developer.loadtesting.operations.AppComponentOperations + :ivar server_metrics: ServerMetricsOperations operations + :vartype server_metrics: azure.developer.loadtesting.operations.ServerMetricsOperations + :ivar test: TestOperations operations + :vartype test: azure.developer.loadtesting.operations.TestOperations + :ivar test_run: TestRunOperations operations + :vartype test_run: azure.developer.loadtesting.operations.TestRunOperations + :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-06-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: + self._config = LoadTestingClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + self._client = PipelineClient(base_url=endpoint, config=self._config, **kwargs) + + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False + + self.load_test_runs = TestRunOperations(self._client, self._config, self._serialize, self._deserialize) + self.load_test_administration = LoadTestingAdministration( + self._client, self._config, self._serialize, self._deserialize + ) + + +__all__: List[str] = ["LoadTestingClient"] # 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/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/_serialization.py b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/_serialization.py new file mode 100644 index 000000000000..648f84cc4e65 --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/_serialization.py @@ -0,0 +1,1970 @@ +# -------------------------------------------------------------------------- +# +# 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 + +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 + +try: + from urllib import quote # type: ignore +except ImportError: + from urllib.parse import quote # type: ignore +import xml.etree.ElementTree as ET + +import isodate + +from typing import Dict, Any, cast, TYPE_CHECKING + +from azure.core.exceptions import DeserializationError, SerializationError, raise_with_traceback + +_BOM = codecs.BOM_UTF8.decode(encoding="utf-8") + +if TYPE_CHECKING: + from typing import Optional, Union, AnyStr, IO, Mapping + + +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, content_type=None): + # type: (Optional[Union[AnyStr, IO]], Optional[str]) -> 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: + # 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_with_traceback(DeserializationError, "XML is invalid") + raise DeserializationError("Cannot deserialize content-type: {}".format(content_type)) + + @classmethod + def deserialize_from_http_generics(cls, body_bytes, headers): + # type: (Optional[Union[AnyStr, IO]], 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 + + +try: + basestring # type: ignore + unicode_str = unicode # type: ignore +except NameError: + basestring = str # type: ignore + unicode_str = str # type: ignore + +_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 +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 # type: ignore +except ImportError: + TZ_UTC = UTC() # type: ignore + +_FLATTEN = re.compile(r"(? 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=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(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) + continue + if xml_desc.get("text", False): + serialized.text = new_attr + continue + if isinstance(new_attr, list): + serialized.extend(new_attr) + 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) + 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) + serialized.append(local_node) + else: # JSON + for k in reversed(keys): + unflattened = {k: new_attr} + new_attr = unflattened + + _new_attr = new_attr + _serialized = serialized + for k in keys: + if k not in _serialized: + _serialized.update(_new_attr) + _new_attr = _new_attr[k] + _serialized = _serialized[k] + except ValueError: + continue + + except (AttributeError, KeyError, TypeError) as err: + msg = "Attribute {} in object {} cannot be serialized.\n{}".format(attr_name, class_name, str(target_obj)) + raise_with_traceback(SerializationError, msg, 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 = data_type.strip("[]{}") + internal_data_type = self.dependencies.get(internal_data_type, 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 = [ + 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_with_traceback(SerializationError, "Unable to build a model: " + str(err), 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) + 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. + :rtype: str + :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] + data = [self.serialize_data(d, internal_data_type, **kwargs) if d is not None else "" for d in data] + if not kwargs.get("skip_quote", False): + data = [quote(str(d), safe="") for d in data] + return str(self.serialize_iter(data, internal_data_type, **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_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_with_traceback(SerializationError, msg.format(data, data_type), 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): + # 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'. + :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: + serialized.append(None) + + 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: + 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 unicode_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) + return result + except ValueError: + for enum_value in enum_obj: + 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_with_traceback(SerializationError, msg, err) + except AttributeError as err: + msg = "ISO-8601 object must be valid Datetime object." + raise_with_traceback(TypeError, msg, 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: + 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 = 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 + # https://github.com/Azure/msrest-for-python/issues/197 + 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 + # https://github.com/Azure/msrest-for-python/issues/197 + 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=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(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, basestring): + 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 + 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 + raise_with_traceback(DeserializationError, msg, 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 deseralize. + """ + if target is None: + return None, None + + if isinstance(target, basestring): + try: + target = self.dependencies[target] + except KeyError: + return target, target + + try: + target = target._classify(data, self.dependencies) + except AttributeError: + pass # Target is not a Model, no classify + return target, target.__class__.__name__ + + 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 deseralize. + :param str content_type: Swagger "produces" if available. + """ + try: + return self(target_obj, data, content_type=content_type) + except: + _LOGGER.warning( + "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, (basestring, bytes)) or hasattr(raw_data, "read"): + return RawDeserializer.deserialize_from_text(raw_data, content_type) + 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) + 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_with_traceback(DeserializationError, msg, 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, basestring): + 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, basestring): + 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): + 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. + # https://github.com/Azure/azure-rest-api-specs/issues/141 + 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)) + + @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) + attr = attr + padding + 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(attr) + except decimal.DecimalException as err: + msg = "Invalid decimal {}".format(attr) + raise_with_traceback(DeserializationError, msg, 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) + + @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_with_traceback(DeserializationError, msg, 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): + 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=None, defaultday=None) + + @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): + 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) + 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_with_traceback(DeserializationError, msg, 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() + 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_with_traceback(DeserializationError, msg, 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) + try: + date_obj = datetime.datetime.fromtimestamp(attr, TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to unix datetime object." + raise_with_traceback(DeserializationError, msg, err) + else: + return date_obj diff --git a/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/_vendor.py b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/_vendor.py new file mode 100644 index 000000000000..592346320442 --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/_vendor.py @@ -0,0 +1,28 @@ +# -------------------------------------------------------------------------- +# 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. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + + +def _format_url_section(template, **kwargs): + components = template.split("/") + while components: + try: + return template.format(**kwargs) + except KeyError as key: + formatted_components = template.split("/") + components = [c for c in formatted_components if "{}".format(key.args[0]) not in c] + template = "/".join(components) + + +def raise_if_not_implemented(cls, abstract_methods): + not_implemented = [f for f in abstract_methods if not callable(getattr(cls, f, None))] + if not_implemented: + raise NotImplementedError( + "The following methods on operation group '{}' are not implemented: '{}'." + " Please refer to https://aka.ms/azsdk/python/dpcodegen/python/customize to learn how to customize.".format( + cls.__name__, "', '".join(not_implemented) + ) + ) diff --git a/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/_version.py b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/_version.py new file mode 100644 index 000000000000..e5754a47ce68 --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/_version.py @@ -0,0 +1,9 @@ +# 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) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +VERSION = "1.0.0b1" diff --git a/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/aio/__init__.py b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/aio/__init__.py new file mode 100644 index 000000000000..d51222b7f92d --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/aio/__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) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._client import LoadTestingClient + +try: + from ._patch import __all__ as _patch_all + from ._patch import * # type: ignore # pylint: disable=unused-wildcard-import +except ImportError: + _patch_all = [] +from ._patch import patch_sdk as _patch_sdk + +__all__ = ["LoadTestingClient"] +__all__.extend([p for p in _patch_all if p not in __all__]) + +_patch_sdk() diff --git a/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/aio/_client.py b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/aio/_client.py new file mode 100644 index 000000000000..8f4d04365a6f --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/aio/_client.py @@ -0,0 +1,95 @@ +# 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) AutoRest 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, TYPE_CHECKING + +from azure.core import AsyncPipelineClient +from azure.core.rest import AsyncHttpResponse, HttpRequest + +from .._serialization import Deserializer, Serializer +from ._configuration import LoadTestingClientConfiguration +from .operations import AppComponentOperations, ServerMetricsOperations, TestOperations, TestRunOperations + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from typing import Dict + + from azure.core.credentials_async import AsyncTokenCredential + + +class LoadTestingClient: # pylint: disable=client-accepts-api-version-keyword + """These APIs allow end users to create, view and run load tests using Azure Load Test Service. + + :ivar app_component: AppComponentOperations operations + :vartype app_component: azure.developer.loadtesting.aio.operations.AppComponentOperations + :ivar server_metrics: ServerMetricsOperations operations + :vartype server_metrics: azure.developer.loadtesting.aio.operations.ServerMetricsOperations + :ivar test: TestOperations operations + :vartype test: azure.developer.loadtesting.aio.operations.TestOperations + :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. + :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-06-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) + + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False + self.app_component = AppComponentOperations(self._client, self._config, self._serialize, self._deserialize) + self.server_metrics = ServerMetricsOperations(self._client, self._config, self._serialize, self._deserialize) + self.test = TestOperations( # type: ignore # pylint: disable=abstract-class-instantiated + self._client, self._config, self._serialize, self._deserialize + ) + self.test_run = TestRunOperations(self._client, self._config, self._serialize, self._deserialize) + + def send_request(self, request: HttpRequest, **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, **kwargs) + + async def close(self) -> None: + await self._client.close() + + async def __aenter__(self) -> "LoadTestingClient": + await self._client.__aenter__() + return self + + async def __aexit__(self, *exc_details) -> None: + await self._client.__aexit__(*exc_details) diff --git a/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/aio/_configuration.py b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/aio/_configuration.py new file mode 100644 index 000000000000..dab13661a1c0 --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/aio/_configuration.py @@ -0,0 +1,65 @@ +# 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) AutoRest 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.configuration import Configuration +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 LoadTestingClientConfiguration(Configuration): # pylint: disable=too-many-instance-attributes + """Configuration for LoadTestingClient. + + Note that all parameters used to create this instance are saved as instance + attributes. + + :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-06-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: + super(LoadTestingClientConfiguration, self).__init__(**kwargs) + api_version = kwargs.pop("api_version", "2022-06-01-preview") # type: str + + 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://loadtest.azure-dev.com/.default"]) + kwargs.setdefault("sdk_moniker", "developer-loadtesting/{}".format(VERSION)) + 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.retry_policy = kwargs.get("retry_policy") or policies.AsyncRetryPolicy(**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.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/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/aio/_patch.py b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/aio/_patch.py new file mode 100644 index 000000000000..6d71aac0aed3 --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/aio/_patch.py @@ -0,0 +1,86 @@ +# ------------------------------------ +# 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, Any, TYPE_CHECKING + +from azure.core import AsyncPipelineClient + +from ._client import LoadTestingClient as LoadTestingClientGenerated +from ._configuration import LoadTestingClientConfiguration +from .operations import AppComponentOperations, ServerMetricsOperations, TestOperations, TestRunOperations +from .._serialization import Deserializer, Serializer + +if TYPE_CHECKING: + # pylint: disable=unused-import,ungrouped-imports + from typing import Dict + + from azure.core.credentials_async import AsyncTokenCredential + + +class LoadTestingAdministration(AppComponentOperations, ServerMetricsOperations, TestOperations): + """ + class to hold LoadTestAdministration + """ + + def __init__(self, client, config, serialize, deserialize): + self._client = client + self._config = config + + self._serialize = serialize + self._deserialize = deserialize + self._serialize.client_side_validation = False + + AppComponentOperations.__init__(self, self._client, self._config, self._serialize, self._deserialize) + ServerMetricsOperations.__init__(self, self._client, self._config, self._serialize, self._deserialize) + TestOperations.__init__(self, self._client, self._config, self._serialize, self._deserialize) + + +class LoadTestingClient(LoadTestingClientGenerated): # pylint: disable=client-accepts-api-version-keyword + """These APIs allow end users to create, view and run load tests using Azure Load Test Service. + + :ivar app_component: AppComponentOperations operations + :vartype app_component: azure.developer.loadtesting.aio.operations.AppComponentOperations + :ivar server_metrics: ServerMetricsOperations operations + :vartype server_metrics: azure.developer.loadtesting.aio.operations.ServerMetricsOperations + :ivar test: TestOperations operations + :vartype test: azure.developer.loadtesting.aio.operations.TestOperations + :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. + :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-06-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: + self._config = LoadTestingClientConfiguration(endpoint=endpoint, credential=credential, **kwargs) + self._client = AsyncPipelineClient(base_url=endpoint, config=self._config, **kwargs) + + self._serialize = Serializer() + self._deserialize = Deserializer() + self._serialize.client_side_validation = False + + self.load_test_runs = TestRunOperations(self._client, self._config, self._serialize, self._deserialize) + self.load_test_administration = LoadTestingAdministration( + self._client, self._config, self._serialize, self._deserialize + ) + + +__all__: List[str] = ["LoadTestingClient"] # 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/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/aio/_vendor.py b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/aio/_vendor.py new file mode 100644 index 000000000000..3e21ea6effcb --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/aio/_vendor.py @@ -0,0 +1,17 @@ +# -------------------------------------------------------------------------- +# 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. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + + +def raise_if_not_implemented(cls, abstract_methods): + not_implemented = [f for f in abstract_methods if not callable(getattr(cls, f, None))] + if not_implemented: + raise NotImplementedError( + "The following methods on operation group '{}' are not implemented: '{}'." + " Please refer to https://aka.ms/azsdk/python/dpcodegen/python/customize to learn how to customize.".format( + cls.__name__, "', '".join(not_implemented) + ) + ) diff --git a/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/aio/operations/__init__.py b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/aio/operations/__init__.py new file mode 100644 index 000000000000..b602fd14d336 --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/aio/operations/__init__.py @@ -0,0 +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. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._operations import AppComponentOperations +from ._operations import ServerMetricsOperations +from ._operations import TestOperations +from ._operations import TestRunOperations + +from ._patch import __all__ as _patch_all +from ._patch import * # type: ignore # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "AppComponentOperations", + "ServerMetricsOperations", + "TestOperations", + "TestRunOperations", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/aio/operations/_operations.py b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/aio/operations/_operations.py new file mode 100644 index 000000000000..8b45a4badcdf --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/aio/operations/_operations.py @@ -0,0 +1,4780 @@ +# pylint: disable=too-many-lines +# 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) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import datetime +import sys +from typing import Any, Callable, Dict, IO, Optional, TypeVar, Union, cast, overload + +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + map_error, +) +from azure.core.pipeline import PipelineResponse +from azure.core.pipeline.transport import AsyncHttpResponse +from azure.core.rest import HttpRequest +from azure.core.tracing.decorator_async import distributed_trace_async +from azure.core.utils import case_insensitive_dict + +from ...operations._operations import ( + build_app_component_create_or_update_app_components_request, + build_app_component_delete_app_components_request, + build_app_component_get_app_component_by_name_request, + build_app_component_get_app_component_request, + build_server_metrics_create_or_update_server_metrics_config_request, + build_server_metrics_delete_server_metrics_config_request, + build_server_metrics_get_server_default_metrics_config_request, + build_server_metrics_get_server_metrics_config_by_name_request, + build_server_metrics_get_server_metrics_config_request, + build_server_metrics_list_supported_resource_types_request, + build_test_create_or_update_test_request, + build_test_delete_load_test_request, + build_test_delete_test_file_request, + build_test_get_load_test_request, + build_test_get_test_file_request, + build_test_list_load_test_search_request, + build_test_list_test_files_request, + build_test_run_create_or_update_test_request, + build_test_run_delete_test_run_request, + build_test_run_get_test_run_client_metrics_filters_request, + build_test_run_get_test_run_client_metrics_request, + build_test_run_get_test_run_file_request, + build_test_run_get_test_run_request, + build_test_run_list_test_runs_request, + build_test_run_stop_test_run_request, +) +from .._vendor import raise_if_not_implemented + +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 AppComponentOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.developer.loadtesting.aio.LoadTestingClient`'s + :attr:`app_component` attribute. + """ + + def __init__(self, *args, **kwargs) -> None: + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @overload + async def create_or_update_app_components( + self, name: str, body: JSON, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> JSON: + """Associate an App Component (Azure resource) to a test or test run. + + Associate an App Component (Azure resource) to a test or test run. + + :param name: Unique name of the App Component, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type name: 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: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "value": { + "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. + "resourceType": "str", # Azure resource type. 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. + } + }, + "name": "str", # Optional. AppComponent name. + "resourceId": "str", # Optional. Azure Load Testing resource Id. + "testId": "str", # Optional. [Required, if testRunId is not given] Load test + unique identifier. + "testRunId": "str" # Optional. [Required if testId is not given] Load test + run unique identifier. + } + + # response body for status code(s): 200, 201 + response == { + "value": { + "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. + "resourceType": "str", # Azure resource type. 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. + } + }, + "name": "str", # Optional. AppComponent name. + "resourceId": "str", # Optional. Azure Load Testing resource Id. + "testId": "str", # Optional. [Required, if testRunId is not given] Load test + unique identifier. + "testRunId": "str" # Optional. [Required if testId is not given] Load test + run unique identifier. + } + """ + + @overload + async def create_or_update_app_components( + self, name: str, body: IO, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> JSON: + """Associate an App Component (Azure resource) to a test or test run. + + Associate an App Component (Azure resource) to a test or test run. + + :param name: Unique name of the App Component, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type name: str + :param body: App Component model. Required. + :type body: IO + :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: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200, 201 + response == { + "value": { + "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. + "resourceType": "str", # Azure resource type. 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. + } + }, + "name": "str", # Optional. AppComponent name. + "resourceId": "str", # Optional. Azure Load Testing resource Id. + "testId": "str", # Optional. [Required, if testRunId is not given] Load test + unique identifier. + "testRunId": "str" # Optional. [Required if testId is not given] Load test + run unique identifier. + } + """ + + @distributed_trace_async + async def create_or_update_app_components(self, name: str, body: Union[JSON, IO], **kwargs: Any) -> JSON: + """Associate an App Component (Azure resource) to a test or test run. + + Associate an App Component (Azure resource) to a test or test run. + + :param name: Unique name of the App Component, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type name: str + :param body: App Component model. Is either a model type or a IO type. Required. + :type body: JSON or IO + :keyword content_type: Body Parameter content-type. Known values are: + 'application/merge-patch+json'. Default value is None. + :paramtype content_type: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200, 201 + response == { + "value": { + "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. + "resourceType": "str", # Azure resource type. 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. + } + }, + "name": "str", # Optional. AppComponent name. + "resourceId": "str", # Optional. Azure Load Testing resource Id. + "testId": "str", # Optional. [Required, if testRunId is not given] Load test + unique identifier. + "testRunId": "str" # Optional. [Required if testId is not given] Load test + run unique identifier. + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str] + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + content_type = content_type or "application/merge-patch+json" + _json = None + _content = None + if isinstance(body, (IO, bytes)): + _content = body + else: + _json = body + + request = build_app_component_create_or_update_app_components_request( + name=name, + content_type=content_type, + api_version=self._config.api_version, + json=_json, + 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) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.status_code == 200: + if response.content: + deserialized = response.json() + else: + deserialized = None + + if response.status_code == 201: + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + @distributed_trace_async + async def delete_app_components( # pylint: disable=inconsistent-return-statements + self, name: str, **kwargs: Any + ) -> None: + """Delete an App Component. + + Delete an App Component. + + :param name: Unique name of the App Component, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type name: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[None] + + request = build_app_component_delete_app_components_request( + name=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) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if cls: + return cls(pipeline_response, None, {}) + + @distributed_trace_async + async def get_app_component_by_name(self, name: str, **kwargs: Any) -> JSON: + """Get App Component details by App Component name. + + Get App Component details by App Component name. + + :param name: Unique name of the App Component, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type name: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "value": { + "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. + "resourceType": "str", # Azure resource type. 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. + } + }, + "name": "str", # Optional. AppComponent name. + "resourceId": "str", # Optional. Azure Load Testing resource Id. + "testId": "str", # Optional. [Required, if testRunId is not given] Load test + unique identifier. + "testRunId": "str" # Optional. [Required if testId is not given] Load test + run unique identifier. + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + request = build_app_component_get_app_component_by_name_request( + name=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) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + @distributed_trace_async + async def get_app_component( + self, *, test_run_id: Optional[str] = None, test_id: Optional[str] = None, **kwargs: Any + ) -> JSON: + """Get App Components for a test or a test run by its name. + + Get App Components for a test or a test run by its name. + + :keyword test_run_id: [Required, if testId is not provided] Test run Id. Default value is None. + :paramtype test_run_id: str + :keyword test_id: Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. + Default value is None. + :paramtype test_id: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "value": { + "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. + "resourceType": "str", # Azure resource type. 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. + } + }, + "name": "str", # Optional. AppComponent name. + "resourceId": "str", # Optional. Azure Load Testing resource Id. + "testId": "str", # Optional. [Required, if testRunId is not given] Load test + unique identifier. + "testRunId": "str" # Optional. [Required if testId is not given] Load test + run unique identifier. + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + request = build_app_component_get_app_component_request( + test_run_id=test_run_id, + 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) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + +class ServerMetricsOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.developer.loadtesting.aio.LoadTestingClient`'s + :attr:`server_metrics` attribute. + """ + + def __init__(self, *args, **kwargs) -> None: + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @overload + async def create_or_update_server_metrics_config( + self, name: str, body: JSON, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> JSON: + """Configure server metrics for a test or test run. + + Configure server metrics for a test or test run. + + :param name: Unique name for server metrics, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type name: str + :param body: Server metrics 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: JSON object + :rtype: JSON + :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": { + "localizedValue": "str", # Metric localized name. + Required. + "value": "str" # Metric name value. Required. + }, + "resourceId": "str", # Azure resource Id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique identifier for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "name": "str", # Optional. Server metrics config name. + "testId": "str", # Optional. [Required, if testRunId is not given] Load test + unique identifier. + "testRunId": "str" # Optional. [Required, if testId is not given] Load test + run unique identifier. + } + + # response body for status code(s): 200, 201 + response == { + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricnamespace": "str", # Metric name space. Required. + "name": { + "localizedValue": "str", # Metric localized name. + Required. + "value": "str" # Metric name value. Required. + }, + "resourceId": "str", # Azure resource Id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique identifier for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "name": "str", # Optional. Server metrics config name. + "testId": "str", # Optional. [Required, if testRunId is not given] Load test + unique identifier. + "testRunId": "str" # Optional. [Required, if testId is not given] Load test + run unique identifier. + } + """ + + @overload + async def create_or_update_server_metrics_config( + self, name: str, body: IO, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> JSON: + """Configure server metrics for a test or test run. + + Configure server metrics for a test or test run. + + :param name: Unique name for server metrics, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type name: str + :param body: Server metrics configuration model. Required. + :type body: IO + :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: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200, 201 + response == { + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricnamespace": "str", # Metric name space. Required. + "name": { + "localizedValue": "str", # Metric localized name. + Required. + "value": "str" # Metric name value. Required. + }, + "resourceId": "str", # Azure resource Id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique identifier for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "name": "str", # Optional. Server metrics config name. + "testId": "str", # Optional. [Required, if testRunId is not given] Load test + unique identifier. + "testRunId": "str" # Optional. [Required, if testId is not given] Load test + run unique identifier. + } + """ + + @distributed_trace_async + async def create_or_update_server_metrics_config(self, name: str, body: Union[JSON, IO], **kwargs: Any) -> JSON: + """Configure server metrics for a test or test run. + + Configure server metrics for a test or test run. + + :param name: Unique name for server metrics, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type name: str + :param body: Server metrics configuration model. Is either a model type or a IO type. Required. + :type body: JSON or IO + :keyword content_type: Body Parameter content-type. Known values are: + 'application/merge-patch+json'. Default value is None. + :paramtype content_type: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200, 201 + response == { + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricnamespace": "str", # Metric name space. Required. + "name": { + "localizedValue": "str", # Metric localized name. + Required. + "value": "str" # Metric name value. Required. + }, + "resourceId": "str", # Azure resource Id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique identifier for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "name": "str", # Optional. Server metrics config name. + "testId": "str", # Optional. [Required, if testRunId is not given] Load test + unique identifier. + "testRunId": "str" # Optional. [Required, if testId is not given] Load test + run unique identifier. + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str] + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + content_type = content_type or "application/merge-patch+json" + _json = None + _content = None + if isinstance(body, (IO, bytes)): + _content = body + else: + _json = body + + request = build_server_metrics_create_or_update_server_metrics_config_request( + name=name, + content_type=content_type, + api_version=self._config.api_version, + json=_json, + 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) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.status_code == 200: + if response.content: + deserialized = response.json() + else: + deserialized = None + + if response.status_code == 201: + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + @distributed_trace_async + async def get_server_metrics_config_by_name(self, name: str, **kwargs: Any) -> JSON: + """Get server metrics configuration by its name. + + Get server metrics configuration by its name. + + :param name: Unique name for server metrics, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type name: str + :return: JSON object + :rtype: JSON + :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": { + "localizedValue": "str", # Metric localized name. + Required. + "value": "str" # Metric name value. Required. + }, + "resourceId": "str", # Azure resource Id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique identifier for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "name": "str", # Optional. Server metrics config name. + "testId": "str", # Optional. [Required, if testRunId is not given] Load test + unique identifier. + "testRunId": "str" # Optional. [Required, if testId is not given] Load test + run unique identifier. + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + request = build_server_metrics_get_server_metrics_config_by_name_request( + name=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) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + @distributed_trace_async + async def delete_server_metrics_config( # pylint: disable=inconsistent-return-statements + self, name: str, **kwargs: Any + ) -> None: + """Delete server metrics configuration by its name. + + Delete server metrics configuration by its name. + + :param name: Unique name for server metrics, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type name: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[None] + + request = build_server_metrics_delete_server_metrics_config_request( + name=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) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if cls: + return cls(pipeline_response, None, {}) + + @distributed_trace_async + async def get_server_metrics_config( + self, *, test_run_id: Optional[str] = None, test_id: Optional[str] = None, **kwargs: Any + ) -> JSON: + """Get server metrics configuration for a test or test run by its name. + + Get server metrics configuration for a test or test run by its name. + + :keyword test_run_id: [Required, if testId is not provided] Test run Id. Default value is None. + :paramtype test_run_id: str + :keyword test_id: Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. + Default value is None. + :paramtype test_id: str + :return: JSON object + :rtype: JSON + :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": { + "localizedValue": "str", # Metric localized name. + Required. + "value": "str" # Metric name value. Required. + }, + "resourceId": "str", # Azure resource Id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique identifier for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "name": "str", # Optional. Server metrics config name. + "testId": "str", # Optional. [Required, if testRunId is not given] Load test + unique identifier. + "testRunId": "str" # Optional. [Required, if testId is not given] Load test + run unique identifier. + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + request = build_server_metrics_get_server_metrics_config_request( + test_run_id=test_run_id, + 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) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + @distributed_trace_async + async def get_server_default_metrics_config(self, **kwargs: Any) -> JSON: + """Get all default server metrics configuration for supported resource types. + + Get all default server metrics configuration for supported resource types. + + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "defaultMetrics": { + "str": [ + { + "aggregation": "str", # Optional. Default metrics + map {resourceType : list of metrics config} (Refer for metrics + structure: + https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition). + "displayDescription": "str", # Optional. Default + metrics map {resourceType : list of metrics config} (Refer for + metrics structure: + https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition). + "metricnamespace": "str", # Optional. Default + metrics map {resourceType : list of metrics config} (Refer for + metrics structure: + https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition). + "name": { + "localizedValue": "str", # Optional. Default + metrics map {resourceType : list of metrics config} (Refer for + metrics structure: + https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition). + "value": "str" # Optional. Default metrics + map {resourceType : list of metrics config} (Refer for metrics + structure: + https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition). + }, + "unit": "str" # Optional. Default metrics map + {resourceType : list of metrics config} (Refer for metrics structure: + https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition). + } + ] + } + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + request = build_server_metrics_get_server_default_metrics_config_request( + 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) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + @distributed_trace_async + async def list_supported_resource_types(self, **kwargs: Any) -> JSON: + """Get all supported resource types for App Components(Azure resource types). + + Get all supported resource types for App Components(Azure resource types). + + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "value": [ + "str" # Optional. + ] + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + request = build_server_metrics_list_supported_resource_types_request( + 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) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + +class TestOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.developer.loadtesting.aio.LoadTestingClient`'s + :attr:`test` attribute. + """ + + def __init__(self, *args, **kwargs) -> None: + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + raise_if_not_implemented( + self.__class__, + [ + "upload_test_file", + ], + ) + + @overload + async def create_or_update_test( + self, test_id: str, body: JSON, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> JSON: + """Create a new test or Update an existing test. + + Create a new test or Update an existing test. + + :param test_id: Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type test_id: str + :param body: Load test 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: JSON object + :rtype: JSON + :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 the test model. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The created + DateTime(ISO 8601 literal format) of the test model. + "description": "str", # Optional. The test description. + "displayName": "str", # Optional. Display name of a test. + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "inputArtifacts": { + "additionalUrls": [ + { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + } + ], + "configUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + }, + "inputArtifactsZipFileurl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + }, + "testScriptUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + }, + "userPropUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + } + }, + "keyvaultReferenceIdentityId": "str", # Optional. Resource Id of the managed + identity referencing the Key vault. + "keyvaultReferenceIdentityType": "str", # Optional. Type of the managed + identity referencing the Key vault. + "lastModifiedBy": "str", # Optional. The user that last modified the test + model. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + DateTime(ISO 8601 literal format) of the test model. + "loadTestConfig": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-45. Required for + creating a new test. + "splitAllCSVs": bool # Optional. Whether all the input CSV files + should be split evenly across all engines. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Either "u2018stop"u2019 + or "u2018continue"u2019 after the threshold is met. Default is + "u2018continue"u2019. + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions - + "u2018percentage"u2019 - for error metric ,"u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. + "clientmetric": "str", # Optional. The client metric + on which the criteria should be applied. Allowed values - + "u2018response_time_ms"u2019 , "u2018latency"u2019, + "u2018error"u2019, "u2018requests"u2019, + "u2018requests_per_sec"u2019. + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. possible outcome - "u2018passed"u2019 , "u2018failed"u2019 , + "u2018undetermined"u2019. + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "resourceId": "str", # Optional. Fully qualified resource Id e.g + /subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. eg. + AKV_SECRET_URI/SECRET_VALUE. + "value": "str" # Optional. The value of the secret, of type + AKV_SECRET_URI or SECRET_VALUE. + } + }, + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testId": "str" # Optional. Unique test name as identifier. + } + + # response body for status code(s): 200, 201 + response == { + "createdBy": "str", # Optional. The user that created the test model. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The created + DateTime(ISO 8601 literal format) of the test model. + "description": "str", # Optional. The test description. + "displayName": "str", # Optional. Display name of a test. + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "inputArtifacts": { + "additionalUrls": [ + { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + } + ], + "configUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + }, + "inputArtifactsZipFileurl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + }, + "testScriptUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + }, + "userPropUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + } + }, + "keyvaultReferenceIdentityId": "str", # Optional. Resource Id of the managed + identity referencing the Key vault. + "keyvaultReferenceIdentityType": "str", # Optional. Type of the managed + identity referencing the Key vault. + "lastModifiedBy": "str", # Optional. The user that last modified the test + model. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + DateTime(ISO 8601 literal format) of the test model. + "loadTestConfig": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-45. Required for + creating a new test. + "splitAllCSVs": bool # Optional. Whether all the input CSV files + should be split evenly across all engines. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Either "u2018stop"u2019 + or "u2018continue"u2019 after the threshold is met. Default is + "u2018continue"u2019. + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions - + "u2018percentage"u2019 - for error metric ,"u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. + "clientmetric": "str", # Optional. The client metric + on which the criteria should be applied. Allowed values - + "u2018response_time_ms"u2019 , "u2018latency"u2019, + "u2018error"u2019, "u2018requests"u2019, + "u2018requests_per_sec"u2019. + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. possible outcome - "u2018passed"u2019 , "u2018failed"u2019 , + "u2018undetermined"u2019. + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "resourceId": "str", # Optional. Fully qualified resource Id e.g + /subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. eg. + AKV_SECRET_URI/SECRET_VALUE. + "value": "str" # Optional. The value of the secret, of type + AKV_SECRET_URI or SECRET_VALUE. + } + }, + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testId": "str" # Optional. Unique test name as identifier. + } + """ + + @overload + async def create_or_update_test( + self, test_id: str, body: IO, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> JSON: + """Create a new test or Update an existing test. + + Create a new test or Update an existing test. + + :param test_id: Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type test_id: str + :param body: Load test model. Required. + :type body: IO + :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: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200, 201 + response == { + "createdBy": "str", # Optional. The user that created the test model. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The created + DateTime(ISO 8601 literal format) of the test model. + "description": "str", # Optional. The test description. + "displayName": "str", # Optional. Display name of a test. + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "inputArtifacts": { + "additionalUrls": [ + { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + } + ], + "configUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + }, + "inputArtifactsZipFileurl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + }, + "testScriptUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + }, + "userPropUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + } + }, + "keyvaultReferenceIdentityId": "str", # Optional. Resource Id of the managed + identity referencing the Key vault. + "keyvaultReferenceIdentityType": "str", # Optional. Type of the managed + identity referencing the Key vault. + "lastModifiedBy": "str", # Optional. The user that last modified the test + model. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + DateTime(ISO 8601 literal format) of the test model. + "loadTestConfig": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-45. Required for + creating a new test. + "splitAllCSVs": bool # Optional. Whether all the input CSV files + should be split evenly across all engines. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Either "u2018stop"u2019 + or "u2018continue"u2019 after the threshold is met. Default is + "u2018continue"u2019. + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions - + "u2018percentage"u2019 - for error metric ,"u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. + "clientmetric": "str", # Optional. The client metric + on which the criteria should be applied. Allowed values - + "u2018response_time_ms"u2019 , "u2018latency"u2019, + "u2018error"u2019, "u2018requests"u2019, + "u2018requests_per_sec"u2019. + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. possible outcome - "u2018passed"u2019 , "u2018failed"u2019 , + "u2018undetermined"u2019. + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "resourceId": "str", # Optional. Fully qualified resource Id e.g + /subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. eg. + AKV_SECRET_URI/SECRET_VALUE. + "value": "str" # Optional. The value of the secret, of type + AKV_SECRET_URI or SECRET_VALUE. + } + }, + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testId": "str" # Optional. Unique test name as identifier. + } + """ + + @distributed_trace_async + async def create_or_update_test(self, test_id: str, body: Union[JSON, IO], **kwargs: Any) -> JSON: + """Create a new test or Update an existing test. + + Create a new test or Update an existing test. + + :param test_id: Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type test_id: str + :param body: Load test model. Is either a model type or a IO type. Required. + :type body: JSON or IO + :keyword content_type: Body Parameter content-type. Known values are: + 'application/merge-patch+json'. Default value is None. + :paramtype content_type: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200, 201 + response == { + "createdBy": "str", # Optional. The user that created the test model. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The created + DateTime(ISO 8601 literal format) of the test model. + "description": "str", # Optional. The test description. + "displayName": "str", # Optional. Display name of a test. + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "inputArtifacts": { + "additionalUrls": [ + { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + } + ], + "configUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + }, + "inputArtifactsZipFileurl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + }, + "testScriptUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + }, + "userPropUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + } + }, + "keyvaultReferenceIdentityId": "str", # Optional. Resource Id of the managed + identity referencing the Key vault. + "keyvaultReferenceIdentityType": "str", # Optional. Type of the managed + identity referencing the Key vault. + "lastModifiedBy": "str", # Optional. The user that last modified the test + model. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + DateTime(ISO 8601 literal format) of the test model. + "loadTestConfig": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-45. Required for + creating a new test. + "splitAllCSVs": bool # Optional. Whether all the input CSV files + should be split evenly across all engines. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Either "u2018stop"u2019 + or "u2018continue"u2019 after the threshold is met. Default is + "u2018continue"u2019. + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions - + "u2018percentage"u2019 - for error metric ,"u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. + "clientmetric": "str", # Optional. The client metric + on which the criteria should be applied. Allowed values - + "u2018response_time_ms"u2019 , "u2018latency"u2019, + "u2018error"u2019, "u2018requests"u2019, + "u2018requests_per_sec"u2019. + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. possible outcome - "u2018passed"u2019 , "u2018failed"u2019 , + "u2018undetermined"u2019. + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "resourceId": "str", # Optional. Fully qualified resource Id e.g + /subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. eg. + AKV_SECRET_URI/SECRET_VALUE. + "value": "str" # Optional. The value of the secret, of type + AKV_SECRET_URI or SECRET_VALUE. + } + }, + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testId": "str" # Optional. Unique test name as identifier. + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str] + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + content_type = content_type or "application/merge-patch+json" + _json = None + _content = None + if isinstance(body, (IO, bytes)): + _content = body + else: + _json = body + + request = build_test_create_or_update_test_request( + test_id=test_id, + content_type=content_type, + api_version=self._config.api_version, + json=_json, + 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) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.status_code == 200: + if response.content: + deserialized = response.json() + else: + deserialized = None + + if response.status_code == 201: + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + @distributed_trace_async + async def delete_load_test( # pylint: disable=inconsistent-return-statements + self, test_id: str, **kwargs: Any + ) -> None: + """Delete a test by its name. + + Delete a test by its name. + + :param test_id: Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type test_id: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[None] + + request = build_test_delete_load_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) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if cls: + return cls(pipeline_response, None, {}) + + @distributed_trace_async + async def get_load_test(self, test_id: str, **kwargs: Any) -> JSON: + """Get load test details by test name. + + Get load test details by test name. + + :param test_id: Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type test_id: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "createdBy": "str", # Optional. The user that created the test model. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The created + DateTime(ISO 8601 literal format) of the test model. + "description": "str", # Optional. The test description. + "displayName": "str", # Optional. Display name of a test. + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "inputArtifacts": { + "additionalUrls": [ + { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + } + ], + "configUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + }, + "inputArtifactsZipFileurl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + }, + "testScriptUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + }, + "userPropUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + } + }, + "keyvaultReferenceIdentityId": "str", # Optional. Resource Id of the managed + identity referencing the Key vault. + "keyvaultReferenceIdentityType": "str", # Optional. Type of the managed + identity referencing the Key vault. + "lastModifiedBy": "str", # Optional. The user that last modified the test + model. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + DateTime(ISO 8601 literal format) of the test model. + "loadTestConfig": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-45. Required for + creating a new test. + "splitAllCSVs": bool # Optional. Whether all the input CSV files + should be split evenly across all engines. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Either "u2018stop"u2019 + or "u2018continue"u2019 after the threshold is met. Default is + "u2018continue"u2019. + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions - + "u2018percentage"u2019 - for error metric ,"u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. + "clientmetric": "str", # Optional. The client metric + on which the criteria should be applied. Allowed values - + "u2018response_time_ms"u2019 , "u2018latency"u2019, + "u2018error"u2019, "u2018requests"u2019, + "u2018requests_per_sec"u2019. + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. possible outcome - "u2018passed"u2019 , "u2018failed"u2019 , + "u2018undetermined"u2019. + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "resourceId": "str", # Optional. Fully qualified resource Id e.g + /subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. eg. + AKV_SECRET_URI/SECRET_VALUE. + "value": "str" # Optional. The value of the secret, of type + AKV_SECRET_URI or SECRET_VALUE. + } + }, + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testId": "str" # Optional. Unique test name as identifier. + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + request = build_test_get_load_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) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + @distributed_trace_async + async def list_load_test_search( + self, + *, + order_by: Optional[str] = None, + search: Optional[str] = None, + last_updated_start_time: Optional[datetime.datetime] = None, + last_updated_end_time: Optional[datetime.datetime] = None, + continuation_token_parameter: Optional[str] = None, + max_page_size: int = 50, + **kwargs: Any + ) -> JSON: + """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 order_by: Sort on one of the field - lastModifiedDateTime, displayName, createdBy in + (field asc/desc) format. eg: displayName asc. Default value is None. + :paramtype order_by: str + :keyword search: Filter search based on searchable fields - testId, createdBy. Default value is + None. + :paramtype search: str + :keyword last_updated_start_time: Start DateTime(ISO 8601 literal format) of the last updated + time range to filter tests. Default value is None. + :paramtype last_updated_start_time: ~datetime.datetime + :keyword last_updated_end_time: End DateTime(ISO 8601 literal format) of the last updated time + range to filter tests. Default value is None. + :paramtype last_updated_end_time: ~datetime.datetime + :keyword continuation_token_parameter: Continuation token to get the next page of response. + Default value is None. + :paramtype continuation_token_parameter: str + :keyword max_page_size: Number of results in response. Default value is 50. + :paramtype max_page_size: int + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "value": [ + { + "createdBy": "str", # Optional. The user that created the + test model. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The + created DateTime(ISO 8601 literal format) of the test model. + "description": "str", # Optional. The test description. + "displayName": "str", # Optional. Display name of a test. + "environmentVariables": { + "str": "str" # Optional. Environment variables which + are defined as a set of pairs. + }, + "inputArtifacts": { + "additionalUrls": [ + { + "expireTime": "2020-02-20 00:00:00", + # Optional. Expiry time of the file. + "fileId": "str", # Optional. File + unique identifier. + "fileType": 0, # Optional. Integer + representation of the file type (0 = JMX_FILE, 1 = + USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: + 0, 1, and 2. + "filename": "str", # Optional. Name + of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # + Optional. Validation status of the file. + } + ], + "configUrl": { + "expireTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file. + "fileId": "str", # Optional. File unique + identifier. + "fileType": 0, # Optional. Integer + representation of the file type (0 = JMX_FILE, 1 = + USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: 0, + 1, and 2. + "filename": "str", # Optional. Name of the + file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. + Validation status of the file. + }, + "inputArtifactsZipFileurl": { + "expireTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file. + "fileId": "str", # Optional. File unique + identifier. + "fileType": 0, # Optional. Integer + representation of the file type (0 = JMX_FILE, 1 = + USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: 0, + 1, and 2. + "filename": "str", # Optional. Name of the + file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. + Validation status of the file. + }, + "testScriptUrl": { + "expireTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file. + "fileId": "str", # Optional. File unique + identifier. + "fileType": 0, # Optional. Integer + representation of the file type (0 = JMX_FILE, 1 = + USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: 0, + 1, and 2. + "filename": "str", # Optional. Name of the + file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. + Validation status of the file. + }, + "userPropUrl": { + "expireTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file. + "fileId": "str", # Optional. File unique + identifier. + "fileType": 0, # Optional. Integer + representation of the file type (0 = JMX_FILE, 1 = + USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: 0, + 1, and 2. + "filename": "str", # Optional. Name of the + file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. + Validation status of the file. + } + }, + "keyvaultReferenceIdentityId": "str", # Optional. Resource + Id of the managed identity referencing the Key vault. + "keyvaultReferenceIdentityType": "str", # Optional. Type of + the managed identity referencing the Key vault. + "lastModifiedBy": "str", # Optional. The user that last + modified the test model. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. + The last Modified DateTime(ISO 8601 literal format) of the test model. + "loadTestConfig": { + "engineInstances": 0, # Optional. The number of + engine instances to execute load test. Supported values are in range + of 1-45. Required for creating a new test. + "splitAllCSVs": bool # Optional. Whether all the + input CSV files should be split evenly across all engines. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Either + "u2018stop"u2019 or "u2018continue"u2019 after the threshold + is met. Default is "u2018continue"u2019. + "actualValue": 0.0, # Optional. The + actual value of the client metric for the test run. + "aggregate": "str", # Optional. The + aggregation function to be applied on the client metric. + Allowed functions - "u2018percentage"u2019 - for error metric + ,"u2018avg"u2019, "u2018p50"u2019, "u2018p90"u2019, + "u2018p95"u2019, "u2018p99"u2019, "u2018min"u2019, + "u2018max"u2019 - for response_time_ms and latency metric, + "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. + "clientmetric": "str", # Optional. + The client metric on which the criteria should be applied. + Allowed values - "u2018response_time_ms"u2019 , + "u2018latency"u2019, "u2018error"u2019, "u2018requests"u2019, + "u2018requests_per_sec"u2019. + "condition": "str", # Optional. The + comparison operator. Supported types "u2018>"u2019. + "requestName": "str", # Optional. + Request name for which the Pass fail criteria has to be + applied. + "result": "str", # Optional. Outcome + of the test run. possible outcome - "u2018passed"u2019 , + "u2018failed"u2019 , "u2018undetermined"u2019. + "value": 0.0 # Optional. The value + to compare with the client metric. Allowed values - + "u2018error : [0.0 , 100.0] unit- % "u2019, response_time_ms + and latency : any integer value unit- ms. + } + } + }, + "resourceId": "str", # Optional. Fully qualified resource Id + e.g + /subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. + eg. AKV_SECRET_URI/SECRET_VALUE. + "value": "str" # Optional. The value of the + secret, of type AKV_SECRET_URI or SECRET_VALUE. + } + }, + "subnetId": "str", # Optional. Subnet ID on which the load + test instances should run. + "testId": "str" # Optional. Unique test name as identifier. + } + ], + "nextLink": "str" # Optional. Link for the next list of resources in case of + paginated results, if applicable. + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + request = build_test_list_load_test_search_request( + order_by=order_by, + search=search, + last_updated_start_time=last_updated_start_time, + last_updated_end_time=last_updated_end_time, + continuation_token_parameter=continuation_token_parameter, + max_page_size=max_page_size, + 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) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + @distributed_trace_async + async def get_test_file(self, test_id: str, file_id: str, **kwargs: Any) -> JSON: + """Get test file by the file name. + + Get test file by the file name. + + :param test_id: Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type test_id: str + :param file_id: Unique identifier for test file, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type file_id: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the file type (0 = + JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: 0, 1, + and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of the file. + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + request = build_test_get_test_file_request( + test_id=test_id, + file_id=file_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) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + @distributed_trace_async + async def delete_test_file( # pylint: disable=inconsistent-return-statements + self, test_id: str, file_id: 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 name for load test, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type test_id: str + :param file_id: Unique identifier for test file, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type file_id: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[None] + + request = build_test_delete_test_file_request( + test_id=test_id, + file_id=file_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) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if cls: + return cls(pipeline_response, None, {}) + + @distributed_trace_async + async def list_test_files( + self, test_id: str, *, continuation_token_parameter: Optional[str] = None, **kwargs: Any + ) -> JSON: + """Get all test files. + + Get all test files. + + :param test_id: Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type test_id: str + :keyword continuation_token_parameter: Continuation token to get the next page of response. + Default value is None. + :paramtype continuation_token_parameter: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "value": [ + { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + } + ], + "nextLink": "str" # Optional. Link for the next list of file URLs, if + applicable. + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + request = build_test_list_test_files_request( + test_id=test_id, + continuation_token_parameter=continuation_token_parameter, + 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) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + +class TestRunOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.developer.loadtesting.aio.LoadTestingClient`'s + :attr:`test_run` attribute. + """ + + def __init__(self, *args, **kwargs) -> None: + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @distributed_trace_async + async def delete_test_run( # pylint: disable=inconsistent-return-statements + self, test_run_id: str, **kwargs: Any + ) -> None: + """Delete a test run by its name. + + Delete a test run by its name. + + :param test_run_id: Unique name of the load test run, must be a valid URL character + ^[a-z0-9_-]*$. Required. + :type test_run_id: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[None] + + request = build_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) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if cls: + return cls(pipeline_response, None, {}) + + @overload + async def create_or_update_test( + self, + test_run_id: str, + body: JSON, + *, + old_test_run_id: Optional[str] = None, + content_type: str = "application/merge-patch+json", + **kwargs: Any + ) -> JSON: + """Create and start a new test run with the given name. + + Create and start a new test run with the given name. + + :param test_run_id: Unique name of the load test run, must be a valid URL character + ^[a-z0-9_-]*$. Required. + :type test_run_id: str + :param body: Load test run model. Required. + :type body: JSON + :keyword old_test_run_id: Existing test run Id that should be rerun. Default value is None. + :paramtype old_test_run_id: str + :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: JSON object + :rtype: JSON + :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 the test run. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The created + DateTime(ISO 8601 literal format) of the test run. + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a test run. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(ISO 8601 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "lastModifiedBy": "str", # Optional. The user that updated the test run. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last updated + DateTime(ISO 8601 literal format) of the test run. + "loadTestConfig": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-45. Required for + creating a new test. + "splitAllCSVs": bool # Optional. Whether all the input CSV files + should be split evenly across all engines. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Either "u2018stop"u2019 + or "u2018continue"u2019 after the threshold is met. Default is + "u2018continue"u2019. + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions - + "u2018percentage"u2019 - for error metric ,"u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. + "clientmetric": "str", # Optional. The client metric + on which the criteria should be applied. Allowed values - + "u2018response_time_ms"u2019 , "u2018latency"u2019, + "u2018error"u2019, "u2018requests"u2019, + "u2018requests_per_sec"u2019. + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. possible outcome - "u2018passed"u2019 , "u2018failed"u2019 , + "u2018undetermined"u2019. + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "resourceId": "str", # Optional. Load test resource Id. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. eg. + AKV_SECRET_URI/SECRET_VALUE. + "value": "str" # Optional. The value of the secret, of type + AKV_SECRET_URI or SECRET_VALUE. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(ISO 8601 literal format). + "status": "str", # Optional. The test run status. + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalUrls": [ + { + "expireTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file. + "fileId": "str", # Optional. File unique + identifier. + "fileType": 0, # Optional. Integer + representation of the file type (0 = JMX_FILE, 1 = + USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: 0, + 1, and 2. + "filename": "str", # Optional. Name of the + file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. + Validation status of the file. + } + ], + "configUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "inputArtifactsZipFileurl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "testScriptUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "userPropUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + } + }, + "outputArtifacts": { + "logsUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "resultUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. possible outcome - "u2018Passed"u2019 , "u2018Failed"u2019 , + "u2018Not Applicable"u2019. + "testRunId": "str", # Optional. Unique test run name as identifier. + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Sent network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "vusers": 0 # Optional. Number of virtual users, for which test has been + run. + } + + # response body for status code(s): 200 + response == { + "createdBy": "str", # Optional. The user that created the test run. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The created + DateTime(ISO 8601 literal format) of the test run. + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a test run. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(ISO 8601 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "lastModifiedBy": "str", # Optional. The user that updated the test run. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last updated + DateTime(ISO 8601 literal format) of the test run. + "loadTestConfig": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-45. Required for + creating a new test. + "splitAllCSVs": bool # Optional. Whether all the input CSV files + should be split evenly across all engines. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Either "u2018stop"u2019 + or "u2018continue"u2019 after the threshold is met. Default is + "u2018continue"u2019. + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions - + "u2018percentage"u2019 - for error metric ,"u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. + "clientmetric": "str", # Optional. The client metric + on which the criteria should be applied. Allowed values - + "u2018response_time_ms"u2019 , "u2018latency"u2019, + "u2018error"u2019, "u2018requests"u2019, + "u2018requests_per_sec"u2019. + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. possible outcome - "u2018passed"u2019 , "u2018failed"u2019 , + "u2018undetermined"u2019. + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "resourceId": "str", # Optional. Load test resource Id. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. eg. + AKV_SECRET_URI/SECRET_VALUE. + "value": "str" # Optional. The value of the secret, of type + AKV_SECRET_URI or SECRET_VALUE. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(ISO 8601 literal format). + "status": "str", # Optional. The test run status. + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalUrls": [ + { + "expireTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file. + "fileId": "str", # Optional. File unique + identifier. + "fileType": 0, # Optional. Integer + representation of the file type (0 = JMX_FILE, 1 = + USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: 0, + 1, and 2. + "filename": "str", # Optional. Name of the + file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. + Validation status of the file. + } + ], + "configUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "inputArtifactsZipFileurl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "testScriptUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "userPropUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + } + }, + "outputArtifacts": { + "logsUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "resultUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. possible outcome - "u2018Passed"u2019 , "u2018Failed"u2019 , + "u2018Not Applicable"u2019. + "testRunId": "str", # Optional. Unique test run name as identifier. + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Sent network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "vusers": 0 # Optional. Number of virtual users, for which test has been + run. + } + """ + + @overload + async def create_or_update_test( + self, + test_run_id: str, + body: IO, + *, + old_test_run_id: Optional[str] = None, + content_type: str = "application/merge-patch+json", + **kwargs: Any + ) -> JSON: + """Create and start a new test run with the given name. + + Create and start a new test run with the given name. + + :param test_run_id: Unique name of the load test run, must be a valid URL character + ^[a-z0-9_-]*$. Required. + :type test_run_id: str + :param body: Load test run model. Required. + :type body: IO + :keyword old_test_run_id: Existing test run Id that should be rerun. Default value is None. + :paramtype old_test_run_id: str + :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: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "createdBy": "str", # Optional. The user that created the test run. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The created + DateTime(ISO 8601 literal format) of the test run. + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a test run. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(ISO 8601 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "lastModifiedBy": "str", # Optional. The user that updated the test run. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last updated + DateTime(ISO 8601 literal format) of the test run. + "loadTestConfig": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-45. Required for + creating a new test. + "splitAllCSVs": bool # Optional. Whether all the input CSV files + should be split evenly across all engines. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Either "u2018stop"u2019 + or "u2018continue"u2019 after the threshold is met. Default is + "u2018continue"u2019. + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions - + "u2018percentage"u2019 - for error metric ,"u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. + "clientmetric": "str", # Optional. The client metric + on which the criteria should be applied. Allowed values - + "u2018response_time_ms"u2019 , "u2018latency"u2019, + "u2018error"u2019, "u2018requests"u2019, + "u2018requests_per_sec"u2019. + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. possible outcome - "u2018passed"u2019 , "u2018failed"u2019 , + "u2018undetermined"u2019. + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "resourceId": "str", # Optional. Load test resource Id. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. eg. + AKV_SECRET_URI/SECRET_VALUE. + "value": "str" # Optional. The value of the secret, of type + AKV_SECRET_URI or SECRET_VALUE. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(ISO 8601 literal format). + "status": "str", # Optional. The test run status. + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalUrls": [ + { + "expireTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file. + "fileId": "str", # Optional. File unique + identifier. + "fileType": 0, # Optional. Integer + representation of the file type (0 = JMX_FILE, 1 = + USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: 0, + 1, and 2. + "filename": "str", # Optional. Name of the + file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. + Validation status of the file. + } + ], + "configUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "inputArtifactsZipFileurl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "testScriptUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "userPropUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + } + }, + "outputArtifacts": { + "logsUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "resultUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. possible outcome - "u2018Passed"u2019 , "u2018Failed"u2019 , + "u2018Not Applicable"u2019. + "testRunId": "str", # Optional. Unique test run name as identifier. + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Sent network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "vusers": 0 # Optional. Number of virtual users, for which test has been + run. + } + """ + + @distributed_trace_async + async def create_or_update_test( + self, test_run_id: str, body: Union[JSON, IO], *, old_test_run_id: Optional[str] = None, **kwargs: Any + ) -> JSON: + """Create and start a new test run with the given name. + + Create and start a new test run with the given name. + + :param test_run_id: Unique name of the load test run, must be a valid URL character + ^[a-z0-9_-]*$. Required. + :type test_run_id: str + :param body: Load test run model. Is either a model type or a IO type. Required. + :type body: JSON or IO + :keyword old_test_run_id: Existing test run Id that should be rerun. Default value is None. + :paramtype old_test_run_id: str + :keyword content_type: Body Parameter content-type. Known values are: + 'application/merge-patch+json'. Default value is None. + :paramtype content_type: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "createdBy": "str", # Optional. The user that created the test run. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The created + DateTime(ISO 8601 literal format) of the test run. + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a test run. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(ISO 8601 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "lastModifiedBy": "str", # Optional. The user that updated the test run. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last updated + DateTime(ISO 8601 literal format) of the test run. + "loadTestConfig": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-45. Required for + creating a new test. + "splitAllCSVs": bool # Optional. Whether all the input CSV files + should be split evenly across all engines. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Either "u2018stop"u2019 + or "u2018continue"u2019 after the threshold is met. Default is + "u2018continue"u2019. + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions - + "u2018percentage"u2019 - for error metric ,"u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. + "clientmetric": "str", # Optional. The client metric + on which the criteria should be applied. Allowed values - + "u2018response_time_ms"u2019 , "u2018latency"u2019, + "u2018error"u2019, "u2018requests"u2019, + "u2018requests_per_sec"u2019. + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. possible outcome - "u2018passed"u2019 , "u2018failed"u2019 , + "u2018undetermined"u2019. + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "resourceId": "str", # Optional. Load test resource Id. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. eg. + AKV_SECRET_URI/SECRET_VALUE. + "value": "str" # Optional. The value of the secret, of type + AKV_SECRET_URI or SECRET_VALUE. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(ISO 8601 literal format). + "status": "str", # Optional. The test run status. + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalUrls": [ + { + "expireTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file. + "fileId": "str", # Optional. File unique + identifier. + "fileType": 0, # Optional. Integer + representation of the file type (0 = JMX_FILE, 1 = + USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: 0, + 1, and 2. + "filename": "str", # Optional. Name of the + file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. + Validation status of the file. + } + ], + "configUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "inputArtifactsZipFileurl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "testScriptUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "userPropUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + } + }, + "outputArtifacts": { + "logsUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "resultUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. possible outcome - "u2018Passed"u2019 , "u2018Failed"u2019 , + "u2018Not Applicable"u2019. + "testRunId": "str", # Optional. Unique test run name as identifier. + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Sent network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "vusers": 0 # Optional. Number of virtual users, for which test has been + run. + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str] + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + content_type = content_type or "application/merge-patch+json" + _json = None + _content = None + if isinstance(body, (IO, bytes)): + _content = body + else: + _json = body + + request = build_test_run_create_or_update_test_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, + json=_json, + 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) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + @distributed_trace_async + async def get_test_run(self, test_run_id: str, **kwargs: Any) -> JSON: + """Get test run details by name. + + Get test run details by name. + + :param test_run_id: Unique name of load test run, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type test_run_id: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "createdBy": "str", # Optional. The user that created the test run. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The created + DateTime(ISO 8601 literal format) of the test run. + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a test run. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(ISO 8601 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "lastModifiedBy": "str", # Optional. The user that updated the test run. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last updated + DateTime(ISO 8601 literal format) of the test run. + "loadTestConfig": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-45. Required for + creating a new test. + "splitAllCSVs": bool # Optional. Whether all the input CSV files + should be split evenly across all engines. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Either "u2018stop"u2019 + or "u2018continue"u2019 after the threshold is met. Default is + "u2018continue"u2019. + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions - + "u2018percentage"u2019 - for error metric ,"u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. + "clientmetric": "str", # Optional. The client metric + on which the criteria should be applied. Allowed values - + "u2018response_time_ms"u2019 , "u2018latency"u2019, + "u2018error"u2019, "u2018requests"u2019, + "u2018requests_per_sec"u2019. + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. possible outcome - "u2018passed"u2019 , "u2018failed"u2019 , + "u2018undetermined"u2019. + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "resourceId": "str", # Optional. Load test resource Id. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. eg. + AKV_SECRET_URI/SECRET_VALUE. + "value": "str" # Optional. The value of the secret, of type + AKV_SECRET_URI or SECRET_VALUE. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(ISO 8601 literal format). + "status": "str", # Optional. The test run status. + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalUrls": [ + { + "expireTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file. + "fileId": "str", # Optional. File unique + identifier. + "fileType": 0, # Optional. Integer + representation of the file type (0 = JMX_FILE, 1 = + USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: 0, + 1, and 2. + "filename": "str", # Optional. Name of the + file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. + Validation status of the file. + } + ], + "configUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "inputArtifactsZipFileurl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "testScriptUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "userPropUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + } + }, + "outputArtifacts": { + "logsUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "resultUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. possible outcome - "u2018Passed"u2019 , "u2018Failed"u2019 , + "u2018Not Applicable"u2019. + "testRunId": "str", # Optional. Unique test run name as identifier. + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Sent network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "vusers": 0 # Optional. Number of virtual users, for which test has been + run. + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + request = build_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) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + @distributed_trace_async + async def get_test_run_file(self, test_run_id: str, file_id: str, **kwargs: Any) -> JSON: + """Get test run file by file name. + + Get test run file by file name. + + :param test_run_id: Unique name of load test run, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type test_run_id: str + :param file_id: Unique identifier for test run file, must be a valid URL character + ^[a-z0-9_-]*$. Required. + :type file_id: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the file type (0 = + JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: 0, 1, + and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of the file. + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + request = build_test_run_get_test_run_file_request( + test_run_id=test_run_id, + file_id=file_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) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + @distributed_trace_async + async def list_test_runs( + self, + *, + order_by: Optional[str] = None, + continuation_token_parameter: Optional[str] = None, + search: Optional[str] = None, + execution_from: Optional[datetime.datetime] = None, + execution_to: Optional[datetime.datetime] = None, + status: Optional[str] = None, + max_page_size: int = 50, + test_id: Optional[str] = None, + **kwargs: Any + ) -> JSON: + """Get all test runs with given filters. + + Get all test runs with given filters. + + :keyword order_by: Sort on one of the field - status, displayName, executedDateTime in (field + asc/desc) format. eg: displayName asc. Default value is None. + :paramtype order_by: str + :keyword continuation_token_parameter: Continuation token to get the next page of response. + Default value is None. + :paramtype continuation_token_parameter: str + :keyword search: Filter search based on searchable fields - description, executedUser. Default + value is None. + :paramtype search: str + :keyword execution_from: The end DateTime(ISO 8601 literal format) of test-run execution time + filter range. Default value is None. + :paramtype execution_from: ~datetime.datetime + :keyword execution_to: The start DateTime(ISO 8601 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, value can be - "ACCEPTED", + "NOTSTARTED","PROVISIONING","PROVISIONED","CONFIGURING", + "CONFIGURED","EXECUTING","EXECUTED","DEPROVISIONING","DEPROVISIONED","DONE","CANCELLED","FAILED". + Default value is None. + :paramtype status: str + :keyword max_page_size: Number of results in response. Default value is 50. + :paramtype max_page_size: int + :keyword test_id: Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. + Default value is None. + :paramtype test_id: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "value": [ + { + "createdBy": "str", # Optional. The user that created the + test run. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The + created DateTime(ISO 8601 literal format) of the test run. + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a test + run. + "duration": 0, # Optional. Test run duration in + milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test + run end DateTime(ISO 8601 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which + are defined as a set of pairs. + }, + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test + run initiated time. + "lastModifiedBy": "str", # Optional. The user that updated + the test run. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. + The last updated DateTime(ISO 8601 literal format) of the test run. + "loadTestConfig": { + "engineInstances": 0, # Optional. The number of + engine instances to execute load test. Supported values are in range + of 1-45. Required for creating a new test. + "splitAllCSVs": bool # Optional. Whether all the + input CSV files should be split evenly across all engines. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Either + "u2018stop"u2019 or "u2018continue"u2019 after the threshold + is met. Default is "u2018continue"u2019. + "actualValue": 0.0, # Optional. The + actual value of the client metric for the test run. + "aggregate": "str", # Optional. The + aggregation function to be applied on the client metric. + Allowed functions - "u2018percentage"u2019 - for error metric + ,"u2018avg"u2019, "u2018p50"u2019, "u2018p90"u2019, + "u2018p95"u2019, "u2018p99"u2019, "u2018min"u2019, + "u2018max"u2019 - for response_time_ms and latency metric, + "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. + "clientmetric": "str", # Optional. + The client metric on which the criteria should be applied. + Allowed values - "u2018response_time_ms"u2019 , + "u2018latency"u2019, "u2018error"u2019, "u2018requests"u2019, + "u2018requests_per_sec"u2019. + "condition": "str", # Optional. The + comparison operator. Supported types "u2018>"u2019. + "requestName": "str", # Optional. + Request name for which the Pass fail criteria has to be + applied. + "result": "str", # Optional. Outcome + of the test run. possible outcome - "u2018passed"u2019 , + "u2018failed"u2019 , "u2018undetermined"u2019. + "value": 0.0 # Optional. The value + to compare with the client metric. Allowed values - + "u2018error : [0.0 , 100.0] unit- % "u2019, response_time_ms + and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "resourceId": "str", # Optional. Load test resource Id. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. + eg. AKV_SECRET_URI/SECRET_VALUE. + "value": "str" # Optional. The value of the + secret, of type AKV_SECRET_URI or SECRET_VALUE. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test + run start DateTime(ISO 8601 literal format). + "status": "str", # Optional. The test run status. + "subnetId": "str", # Optional. Subnet ID on which the load + test instances should run. + "testArtifacts": { + "inputArtifacts": { + "additionalUrls": [ + { + "expireTime": "2020-02-20 + 00:00:00", # Optional. Expiry time of the file. + "fileId": "str", # Optional. + File unique identifier. + "fileType": 0, # Optional. + Integer representation of the file type (0 = JMX_FILE, 1 + = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known + values are: 0, 1, and 2. + "filename": "str", # + Optional. Name of the file. + "url": "str", # Optional. + File URL. + "validationStatus": "str" # + Optional. Validation status of the file. + } + ], + "configUrl": { + "expireTime": "2020-02-20 00:00:00", + # Optional. Expiry time of the file. + "fileId": "str", # Optional. File + unique identifier. + "fileType": 0, # Optional. Integer + representation of the file type (0 = JMX_FILE, 1 = + USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: + 0, 1, and 2. + "filename": "str", # Optional. Name + of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # + Optional. Validation status of the file. + }, + "inputArtifactsZipFileurl": { + "expireTime": "2020-02-20 00:00:00", + # Optional. Expiry time of the file. + "fileId": "str", # Optional. File + unique identifier. + "fileType": 0, # Optional. Integer + representation of the file type (0 = JMX_FILE, 1 = + USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: + 0, 1, and 2. + "filename": "str", # Optional. Name + of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # + Optional. Validation status of the file. + }, + "testScriptUrl": { + "expireTime": "2020-02-20 00:00:00", + # Optional. Expiry time of the file. + "fileId": "str", # Optional. File + unique identifier. + "fileType": 0, # Optional. Integer + representation of the file type (0 = JMX_FILE, 1 = + USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: + 0, 1, and 2. + "filename": "str", # Optional. Name + of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # + Optional. Validation status of the file. + }, + "userPropUrl": { + "expireTime": "2020-02-20 00:00:00", + # Optional. Expiry time of the file. + "fileId": "str", # Optional. File + unique identifier. + "fileType": 0, # Optional. Integer + representation of the file type (0 = JMX_FILE, 1 = + USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: + 0, 1, and 2. + "filename": "str", # Optional. Name + of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # + Optional. Validation status of the file. + } + }, + "outputArtifacts": { + "logsUrl": { + "expireTime": "2020-02-20 00:00:00", + # Optional. Expiry time of the file. + "fileId": "str", # Optional. File + unique identifier. + "fileType": 0, # Optional. Integer + representation of the file type (0 = JMX_FILE, 1 = + USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: + 0, 1, and 2. + "filename": "str", # Optional. Name + of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # + Optional. Validation status of the file. + }, + "resultUrl": { + "expireTime": "2020-02-20 00:00:00", + # Optional. Expiry time of the file. + "fileId": "str", # Optional. File + unique identifier. + "fileType": 0, # Optional. Integer + representation of the file type (0 = JMX_FILE, 1 = + USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: + 0, 1, and 2. + "filename": "str", # Optional. Name + of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # + Optional. Validation status of the file. + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail + criteria used during the test run. possible outcome - "u2018Passed"u2019 + , "u2018Failed"u2019 , "u2018Not Applicable"u2019. + "testRunId": "str", # Optional. Unique test run name as + identifier. + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error + percentage. + "maxResTime": 0.0, # Optional. Max response + time. + "meanResTime": 0.0, # Optional. Mean + response time. + "medianResTime": 0.0, # Optional. Median + response time. + "minResTime": 0.0, # Optional. Minimum + response time. + "pct1ResTime": 0.0, # Optional. 90 + percentile response time. + "pct2ResTime": 0.0, # Optional. 95 + percentile response time. + "pct3ResTime": 0.0, # Optional. 99 + percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. + Received network bytes. + "sampleCount": 0.0, # Optional. Sampler + count. + "sentKBytesPerSec": 0.0, # Optional. Sent + network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction + name. + } + }, + "vusers": 0 # Optional. Number of virtual users, for which + test has been run. + } + ], + "nextLink": "str" # Optional. Link for the next list of resources in case of + paginated results, if applicable. + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + request = build_test_run_list_test_runs_request( + order_by=order_by, + continuation_token_parameter=continuation_token_parameter, + search=search, + execution_from=execution_from, + execution_to=execution_to, + status=status, + max_page_size=max_page_size, + 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) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + @distributed_trace_async + async def stop_test_run(self, test_run_id: str, **kwargs: Any) -> JSON: + """Stop test run by name. + + Stop test run by name. + + :param test_run_id: Unique name of the load test run, must be a valid URL character + ^[a-z0-9_-]*$. Required. + :type test_run_id: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "createdBy": "str", # Optional. The user that created the test run. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The created + DateTime(ISO 8601 literal format) of the test run. + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a test run. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(ISO 8601 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "lastModifiedBy": "str", # Optional. The user that updated the test run. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last updated + DateTime(ISO 8601 literal format) of the test run. + "loadTestConfig": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-45. Required for + creating a new test. + "splitAllCSVs": bool # Optional. Whether all the input CSV files + should be split evenly across all engines. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Either "u2018stop"u2019 + or "u2018continue"u2019 after the threshold is met. Default is + "u2018continue"u2019. + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions - + "u2018percentage"u2019 - for error metric ,"u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. + "clientmetric": "str", # Optional. The client metric + on which the criteria should be applied. Allowed values - + "u2018response_time_ms"u2019 , "u2018latency"u2019, + "u2018error"u2019, "u2018requests"u2019, + "u2018requests_per_sec"u2019. + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. possible outcome - "u2018passed"u2019 , "u2018failed"u2019 , + "u2018undetermined"u2019. + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "resourceId": "str", # Optional. Load test resource Id. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. eg. + AKV_SECRET_URI/SECRET_VALUE. + "value": "str" # Optional. The value of the secret, of type + AKV_SECRET_URI or SECRET_VALUE. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(ISO 8601 literal format). + "status": "str", # Optional. The test run status. + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalUrls": [ + { + "expireTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file. + "fileId": "str", # Optional. File unique + identifier. + "fileType": 0, # Optional. Integer + representation of the file type (0 = JMX_FILE, 1 = + USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: 0, + 1, and 2. + "filename": "str", # Optional. Name of the + file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. + Validation status of the file. + } + ], + "configUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "inputArtifactsZipFileurl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "testScriptUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "userPropUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + } + }, + "outputArtifacts": { + "logsUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "resultUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. possible outcome - "u2018Passed"u2019 , "u2018Failed"u2019 , + "u2018Not Applicable"u2019. + "testRunId": "str", # Optional. Unique test run name as identifier. + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Sent network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "vusers": 0 # Optional. Number of virtual users, for which test has been + run. + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + request = build_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) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + @overload + async def get_test_run_client_metrics( + self, test_run_id: str, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> JSON: + """Get all client metrics for a load test run. + + Get all client metrics for a load test run. + + :param test_run_id: Unique name of the load test run, must be a valid URL character + ^[a-z0-9_-]*$. Required. + :type test_run_id: str + :param body: Client metrics request model. Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "endTime": "2020-02-20 00:00:00", # End time. Required. + "startTime": "2020-02-20 00:00:00", # Start time. Required. + "errors": [ + "str" # Optional. List of errors, maximum supported errors for + queries are 20. In case of empty, by default will return metrics for maximum + 20 errors. + ], + "groupByInterval": "str", # Optional. For test duration less than 10 minutes + group by time interval can be any one of 5s,10s,1m,5m.""n""nFor test duration + greater than 10 minutes, group by time interval can be any one of 1m,5m,1h. + Default value is 1m. + "percentiles": [ + "str" # Optional. List of percentiles values for response time, + supported values 50,90,99,95. Default value is 50th percentile. + ], + "requestSamplers": [ + "str" # Optional. List of request samplers, maximum supported + samplers for queries are 20. In case of empty, it will return metrics for + maximum 20 samplers. + ] + } + + # response body for status code(s): 200 + response == { + "testRunId": "str", # Optional. Test run name for which client metrics + results is required. + "timeSeries": { + "activeUsers": { + "str": [ + { + "timestamp": "2020-02-20 00:00:00", # + Optional. Timestamp(ISO 8601 literal format). + "value": 0.0 # Optional. Value at timestamp. + } + ] + }, + "errors": { + "str": [ + { + "timestamp": "2020-02-20 00:00:00", # + Optional. Timestamp(ISO 8601 literal format). + "value": 0.0 # Optional. Value at timestamp. + } + ] + }, + "responseTime": { + "str": [ + { + "timestamp": "2020-02-20 00:00:00", # + Optional. Timestamp(ISO 8601 literal format). + "value": 0.0 # Optional. Value at timestamp. + } + ] + }, + "throughput": { + "str": [ + { + "timestamp": "2020-02-20 00:00:00", # + Optional. Timestamp(ISO 8601 literal format). + "value": 0.0 # Optional. Value at timestamp. + } + ] + } + } + } + """ + + @overload + async def get_test_run_client_metrics( + self, test_run_id: str, body: IO, *, content_type: str = "application/json", **kwargs: Any + ) -> JSON: + """Get all client metrics for a load test run. + + Get all client metrics for a load test run. + + :param test_run_id: Unique name of the load test run, must be a valid URL character + ^[a-z0-9_-]*$. Required. + :type test_run_id: str + :param body: Client metrics request model. Required. + :type body: IO + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "testRunId": "str", # Optional. Test run name for which client metrics + results is required. + "timeSeries": { + "activeUsers": { + "str": [ + { + "timestamp": "2020-02-20 00:00:00", # + Optional. Timestamp(ISO 8601 literal format). + "value": 0.0 # Optional. Value at timestamp. + } + ] + }, + "errors": { + "str": [ + { + "timestamp": "2020-02-20 00:00:00", # + Optional. Timestamp(ISO 8601 literal format). + "value": 0.0 # Optional. Value at timestamp. + } + ] + }, + "responseTime": { + "str": [ + { + "timestamp": "2020-02-20 00:00:00", # + Optional. Timestamp(ISO 8601 literal format). + "value": 0.0 # Optional. Value at timestamp. + } + ] + }, + "throughput": { + "str": [ + { + "timestamp": "2020-02-20 00:00:00", # + Optional. Timestamp(ISO 8601 literal format). + "value": 0.0 # Optional. Value at timestamp. + } + ] + } + } + } + """ + + @distributed_trace_async + async def get_test_run_client_metrics(self, test_run_id: str, body: Union[JSON, IO], **kwargs: Any) -> JSON: + """Get all client metrics for a load test run. + + Get all client metrics for a load test run. + + :param test_run_id: Unique name of the load test run, must be a valid URL character + ^[a-z0-9_-]*$. Required. + :type test_run_id: str + :param body: Client metrics request model. Is either a model type or a IO type. Required. + :type body: JSON or IO + :keyword content_type: Body Parameter content-type. Known values are: 'application/json'. + Default value is None. + :paramtype content_type: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "testRunId": "str", # Optional. Test run name for which client metrics + results is required. + "timeSeries": { + "activeUsers": { + "str": [ + { + "timestamp": "2020-02-20 00:00:00", # + Optional. Timestamp(ISO 8601 literal format). + "value": 0.0 # Optional. Value at timestamp. + } + ] + }, + "errors": { + "str": [ + { + "timestamp": "2020-02-20 00:00:00", # + Optional. Timestamp(ISO 8601 literal format). + "value": 0.0 # Optional. Value at timestamp. + } + ] + }, + "responseTime": { + "str": [ + { + "timestamp": "2020-02-20 00:00:00", # + Optional. Timestamp(ISO 8601 literal format). + "value": 0.0 # Optional. Value at timestamp. + } + ] + }, + "throughput": { + "str": [ + { + "timestamp": "2020-02-20 00:00:00", # + Optional. Timestamp(ISO 8601 literal format). + "value": 0.0 # Optional. Value at timestamp. + } + ] + } + } + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str] + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + content_type = content_type or "application/json" + _json = None + _content = None + if isinstance(body, (IO, bytes)): + _content = body + else: + _json = body + + request = build_test_run_get_test_run_client_metrics_request( + test_run_id=test_run_id, + content_type=content_type, + api_version=self._config.api_version, + json=_json, + 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) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + @distributed_trace_async + async def get_test_run_client_metrics_filters(self, test_run_id: str, **kwargs: Any) -> JSON: + """Get all filters that are supported for client metrics for a given load test run. + + Get all filters that are supported for client metrics for a given load test run. + + :param test_run_id: Unique name for load test run, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type test_run_id: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "filters": { + "errorFiltersValues": [ + "str" # Optional. List of errors occurred for the test run, + for which client metrics can be filtered. + ], + "requestSamplerValues": [ + "str" # Optional. List of request sampler for the test run, + for which client metrics can be filtered. + ] + }, + "testRunId": "str", # Optional. Test run name for which client metrics + filters is required. + "timeRange": { + "endTime": "2020-02-20 00:00:00", # Optional. end DateTime(ISO 8601 + literal format) for the requested client metrics filter. + "startTime": "2020-02-20 00:00:00" # Optional. start DateTime(ISO + 8601 literal format) for the requested client metrics filter. + } + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + request = build_test_run_get_test_run_client_metrics_filters_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) # type: ignore + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) diff --git a/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/aio/operations/_patch.py b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/aio/operations/_patch.py new file mode 100644 index 000000000000..9526c4d4126a --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/aio/operations/_patch.py @@ -0,0 +1,365 @@ +# ------------------------------------ +# 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 Any, IO, Optional, Union, cast, overload, List, MutableMapping, Coroutine, BinaryIO + +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + map_error, +) +from azure.core.tracing.decorator import distributed_trace +from azure.core.utils import case_insensitive_dict + +from ._operations import AppComponentOperations as AppComponentOperationsGenerated +from ._operations import TestOperations as TestOperationsGenerated, JSON, ClsType +from ...operations._patch import build_upload_test_file_request + + +class TestOperations(TestOperationsGenerated): + """ + for performing the operations on test + """ + + def __init__(self, *args, **kwargs): + super(TestOperations, self).__init__(*args, **kwargs) + + async def upload_test_file(self, test_id: str, file_id: str, file: BinaryIO, **kwargs) -> JSON: + """Upload test file and link it to a test. + + Upload a test file to an existing test. + + :param test_id: Unique id for the test + :type test_id: str + :param file_id: Unique id for the file + :type file_id: str + :param file_content: dictionary containing file contet + :type file: BinaryIO (file opened in Binary read mode) + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + """ + + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + _content = file + + request = build_upload_test_file_request( + test_id=test_id, + file_id=file_id, + file=file, + 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) # type: ignore + + request.method = "PUT" + + pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [201]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + if response.content: + deserialized = response.json() + else: + deserialized = None + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + return cast(JSON, deserialized) + + +class AppComponentOperations: + def __init__(self, *args, **kwargs): + self.__app_component_operations_generated = AppComponentOperationsGenerated(*args, **kwargs) + + def get_app_components( + self, + *, + test_run_id: Optional[str] = None, + test_id: Optional[str] = None, + name: Optional[str] = None, + **kwargs: Any, + ) -> Coroutine[Any, Any, MutableMapping[str, Any]]: + """Get App Components for a test or a test run by its name. + + Get App Components for a test or a test run by its name. + + :keyword test_run_id: [Required, if testId is not provided] Test run Id. Default value is None. + :paramtype test_run_id: st + :keyword test_id: Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. + Default value is None. + :paramtype test_id: str + :keyword name: Unique name of the App Component, must be a valid URL character ^[a-z0-9_-]*$. + Default value is None. + :paramtype name: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "name": "str", # Optional. AppComponent name. + "resourceId": "str", # Optional. Azure Load Testing resource Id. + "testId": "str", # Optional. [Required, if testRunId is not given] Load test + unique identifier. + "testRunId": "str", # Optional. [Required if testId is not given] Load test + run unique identifier. + "value": { + "str": { + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "resourceId": "str", # Fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name. Required. + "resourceType": "str", # Azure resource type. Required. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + } + } + """ + + if name is not None: + return self.__app_component_operations_generated.get_app_component_by_name(name=name, **kwargs) + else: + return self.__app_component_operations_generated.get_app_component( + test_run_id=test_run_id, test_id=test_id, **kwargs + ) + + @overload + def create_or_update_app_components( + self, name: str, body: JSON, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> JSON: + """Associate an App Component (Azure resource) to a test or test run. + + Associate an App Component (Azure resource) to a test or test run. + + :param name: Unique name of the App Component, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type name: 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: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "name": "str", # Optional. AppComponent name. + "resourceId": "str", # Optional. Azure Load Testing resource Id. + "testId": "str", # Optional. [Required, if testRunId is not given] Load test + unique identifier. + "testRunId": "str", # Optional. [Required if testId is not given] Load test + run unique identifier. + "value": { + "str": { + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "resourceId": "str", # Fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name. Required. + "resourceType": "str", # Azure resource type. Required. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + } + } + + # response body for status code(s): 200, 201 + response == { + "name": "str", # Optional. AppComponent name. + "resourceId": "str", # Optional. Azure Load Testing resource Id. + "testId": "str", # Optional. [Required, if testRunId is not given] Load test + unique identifier. + "testRunId": "str", # Optional. [Required if testId is not given] Load test + run unique identifier. + "value": { + "str": { + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "resourceId": "str", # Fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name. Required. + "resourceType": "str", # Azure resource type. Required. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + } + } + """ + + @overload + def create_or_update_app_components( + self, name: str, body: IO, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> JSON: + """Associate an App Component (Azure resource) to a test or test run. + + Associate an App Component (Azure resource) to a test or test run. + + :param name: Unique name of the App Component, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type name: str + :param body: App Component model. Required. + :type body: IO + :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: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200, 201 + response == { + "name": "str", # Optional. AppComponent name. + "resourceId": "str", # Optional. Azure Load Testing resource Id. + "testId": "str", # Optional. [Required, if testRunId is not given] Load test + unique identifier. + "testRunId": "str", # Optional. [Required if testId is not given] Load test + run unique identifier. + "value": { + "str": { + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "resourceId": "str", # Fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name. Required. + "resourceType": "str", # Azure resource type. Required. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + } + } + """ + + @distributed_trace + def create_or_update_app_components(self, name: str, body: Union[JSON, IO], **kwargs: Any) -> JSON: + """Associate an App Component (Azure resource) to a test or test run. + + Associate an App Component (Azure resource) to a test or test run. + + :param name: Unique name of the App Component, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type name: str + :param body: App Component model. Is either a model type or a IO type. Required. + :type body: JSON or IO + :keyword content_type: Body Parameter content-type. Known values are: + 'application/merge-patch+json'. Default value is None. + :paramtype content_type: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200, 201 + response == { + "name": "str", # Optional. AppComponent name. + "resourceId": "str", # Optional. Azure Load Testing resource Id. + "testId": "str", # Optional. [Required, if testRunId is not given] Load test + unique identifier. + "testRunId": "str", # Optional. [Required if testId is not given] Load test + run unique identifier. + "value": { + "str": { + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "resourceId": "str", # Fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name. Required. + "resourceType": "str", # Azure resource type. Required. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + } + } + """ + return self.__app_component_operations_generated.create_or_update_app_components(name, body, **kwargs) + + @distributed_trace + def delete_app_components( # pylint: disable=inconsistent-return-statements + self, name: str, **kwargs: Any + ) -> None: + """Delete an App Component. + + Delete an App Component. + + :param name: Unique name of the App Component, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type name: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + return self.__app_component_operations_generated.delete_app_components(name, **kwargs) + + +__all__: List[str] = ["TestOperations", "AppComponentOperations"] + + +# 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/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/operations/__init__.py b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/operations/__init__.py new file mode 100644 index 000000000000..b602fd14d336 --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/operations/__init__.py @@ -0,0 +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. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +from ._operations import AppComponentOperations +from ._operations import ServerMetricsOperations +from ._operations import TestOperations +from ._operations import TestRunOperations + +from ._patch import __all__ as _patch_all +from ._patch import * # type: ignore # pylint: disable=unused-wildcard-import +from ._patch import patch_sdk as _patch_sdk + +__all__ = [ + "AppComponentOperations", + "ServerMetricsOperations", + "TestOperations", + "TestRunOperations", +] +__all__.extend([p for p in _patch_all if p not in __all__]) +_patch_sdk() diff --git a/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/operations/_operations.py b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/operations/_operations.py new file mode 100644 index 000000000000..4d642f3ebfec --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/operations/_operations.py @@ -0,0 +1,5440 @@ +# pylint: disable=too-many-lines +# 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) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +import datetime +import sys +from typing import Any, Callable, Dict, IO, Optional, TypeVar, Union, cast, overload + +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + map_error, +) +from azure.core.pipeline import PipelineResponse +from azure.core.pipeline.transport import HttpResponse +from azure.core.rest import HttpRequest +from azure.core.tracing.decorator import distributed_trace +from azure.core.utils import case_insensitive_dict + +from .._serialization import Serializer +from .._vendor import _format_url_section, raise_if_not_implemented + +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_app_component_create_or_update_app_components_request(name: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str] + api_version = kwargs.pop("api_version", _params.pop("api-version", "2022-06-01-preview")) # type: str + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/appcomponents/{name}" + path_format_arguments = { + "name": _SERIALIZER.url("name", name, "str", max_length=50, min_length=2, pattern=r"^[a-z0-9_-]*$"), + } + + _url = _format_url_section(_url, **path_format_arguments) + + # 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_app_component_delete_app_components_request(name: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version = kwargs.pop("api_version", _params.pop("api-version", "2022-06-01-preview")) # type: str + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/appcomponents/{name}" + path_format_arguments = { + "name": _SERIALIZER.url("name", name, "str", max_length=50, min_length=2, pattern=r"^[a-z0-9_-]*$"), + } + + _url = _format_url_section(_url, **path_format_arguments) + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="DELETE", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_app_component_get_app_component_by_name_request(name: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version = kwargs.pop("api_version", _params.pop("api-version", "2022-06-01-preview")) # type: str + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/appcomponents/{name}" + path_format_arguments = { + "name": _SERIALIZER.url("name", name, "str", max_length=50, min_length=2, pattern=r"^[a-z0-9_-]*$"), + } + + _url = _format_url_section(_url, **path_format_arguments) + + # 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_app_component_get_app_component_request( + *, test_run_id: Optional[str] = None, test_id: Optional[str] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version = kwargs.pop("api_version", _params.pop("api-version", "2022-06-01-preview")) # type: str + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/appcomponents" + + # Construct parameters + if test_run_id is not None: + _params["testRunId"] = _SERIALIZER.query( + "test_run_id", test_run_id, "str", max_length=50, min_length=2, pattern=r"^[a-z0-9_-]*$" + ) + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + if test_id is not None: + _params["testId"] = _SERIALIZER.query( + "test_id", test_id, "str", max_length=50, min_length=2, pattern=r"^[a-z0-9_-]*$" + ) + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_server_metrics_create_or_update_server_metrics_config_request(name: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str] + api_version = kwargs.pop("api_version", _params.pop("api-version", "2022-06-01-preview")) # type: str + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/serverMetricsConfig/{name}" + path_format_arguments = { + "name": _SERIALIZER.url("name", name, "str", max_length=50, min_length=2, pattern=r"^[a-z0-9_-]*$"), + } + + _url = _format_url_section(_url, **path_format_arguments) + + # 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_server_metrics_get_server_metrics_config_by_name_request(name: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version = kwargs.pop("api_version", _params.pop("api-version", "2022-06-01-preview")) # type: str + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/serverMetricsConfig/{name}" + path_format_arguments = { + "name": _SERIALIZER.url("name", name, "str", max_length=50, min_length=2, pattern=r"^[a-z0-9_-]*$"), + } + + _url = _format_url_section(_url, **path_format_arguments) + + # 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_server_metrics_delete_server_metrics_config_request(name: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version = kwargs.pop("api_version", _params.pop("api-version", "2022-06-01-preview")) # type: str + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/serverMetricsConfig/{name}" + path_format_arguments = { + "name": _SERIALIZER.url("name", name, "str", max_length=50, min_length=2, pattern=r"^[a-z0-9_-]*$"), + } + + _url = _format_url_section(_url, **path_format_arguments) + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="DELETE", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_server_metrics_get_server_metrics_config_request( + *, test_run_id: Optional[str] = None, test_id: Optional[str] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version = kwargs.pop("api_version", _params.pop("api-version", "2022-06-01-preview")) # type: str + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/serverMetricsConfig" + + # Construct parameters + if test_run_id is not None: + _params["testRunId"] = _SERIALIZER.query( + "test_run_id", test_run_id, "str", max_length=50, min_length=2, pattern=r"^[a-z0-9_-]*$" + ) + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + if test_id is not None: + _params["testId"] = _SERIALIZER.query( + "test_id", test_id, "str", max_length=50, min_length=2, pattern=r"^[a-z0-9_-]*$" + ) + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_server_metrics_get_server_default_metrics_config_request(**kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version = kwargs.pop("api_version", _params.pop("api-version", "2022-06-01-preview")) # type: str + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/serverMetricsConfig/default" + + # 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_server_metrics_list_supported_resource_types_request(**kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version = kwargs.pop("api_version", _params.pop("api-version", "2022-06-01-preview")) # type: str + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/serverMetricsConfig/supportedResourceTypes" + + # 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_test_create_or_update_test_request(test_id: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str] + api_version = kwargs.pop("api_version", _params.pop("api-version", "2022-06-01-preview")) # type: str + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/loadtests/{testId}" + path_format_arguments = { + "testId": _SERIALIZER.url("test_id", test_id, "str", max_length=50, min_length=2, pattern=r"^[a-z0-9_-]*$"), + } + + _url = _format_url_section(_url, **path_format_arguments) + + # 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_test_delete_load_test_request(test_id: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version = kwargs.pop("api_version", _params.pop("api-version", "2022-06-01-preview")) # type: str + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/loadtests/{testId}" + path_format_arguments = { + "testId": _SERIALIZER.url("test_id", test_id, "str", max_length=50, min_length=2, pattern=r"^[a-z0-9_-]*$"), + } + + _url = _format_url_section(_url, **path_format_arguments) + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="DELETE", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_test_get_load_test_request(test_id: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version = kwargs.pop("api_version", _params.pop("api-version", "2022-06-01-preview")) # type: str + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/loadtests/{testId}" + path_format_arguments = { + "testId": _SERIALIZER.url("test_id", test_id, "str", max_length=50, min_length=2, pattern=r"^[a-z0-9_-]*$"), + } + + _url = _format_url_section(_url, **path_format_arguments) + + # 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_test_list_load_test_search_request( + *, + order_by: Optional[str] = None, + search: Optional[str] = None, + last_updated_start_time: Optional[datetime.datetime] = None, + last_updated_end_time: Optional[datetime.datetime] = None, + continuation_token_parameter: Optional[str] = None, + max_page_size: int = 50, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version = kwargs.pop("api_version", _params.pop("api-version", "2022-06-01-preview")) # type: str + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/loadtests/sortAndFilter" + + # Construct parameters + if order_by is not None: + _params["orderBy"] = _SERIALIZER.query("order_by", order_by, "str") + if search is not None: + _params["search"] = _SERIALIZER.query("search", search, "str") + if last_updated_start_time is not None: + _params["lastUpdatedStartTime"] = _SERIALIZER.query( + "last_updated_start_time", last_updated_start_time, "iso-8601" + ) + if last_updated_end_time is not None: + _params["lastUpdatedEndTime"] = _SERIALIZER.query("last_updated_end_time", last_updated_end_time, "iso-8601") + if continuation_token_parameter is not None: + _params["continuationToken"] = _SERIALIZER.query( + "continuation_token_parameter", continuation_token_parameter, "str" + ) + if max_page_size is not None: + _params["maxPageSize"] = _SERIALIZER.query("max_page_size", max_page_size, "int") + _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_test_get_test_file_request(test_id: str, file_id: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version = kwargs.pop("api_version", _params.pop("api-version", "2022-06-01-preview")) # type: str + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/loadtests/{testId}/files/{fileId}" + path_format_arguments = { + "testId": _SERIALIZER.url("test_id", test_id, "str", max_length=50, min_length=2, pattern=r"^[a-z0-9_-]*$"), + "fileId": _SERIALIZER.url("file_id", file_id, "str", max_length=50, min_length=2, pattern=r"^[a-z0-9_-]*$"), + } + + _url = _format_url_section(_url, **path_format_arguments) + + # 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_test_delete_test_file_request(test_id: str, file_id: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version = kwargs.pop("api_version", _params.pop("api-version", "2022-06-01-preview")) # type: str + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/loadtests/{testId}/files/{fileId}" + path_format_arguments = { + "testId": _SERIALIZER.url("test_id", test_id, "str", max_length=50, min_length=2, pattern=r"^[a-z0-9_-]*$"), + "fileId": _SERIALIZER.url("file_id", file_id, "str", max_length=50, min_length=2, pattern=r"^[a-z0-9_-]*$"), + } + + _url = _format_url_section(_url, **path_format_arguments) + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="DELETE", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_test_list_test_files_request( + test_id: str, *, continuation_token_parameter: Optional[str] = None, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version = kwargs.pop("api_version", _params.pop("api-version", "2022-06-01-preview")) # type: str + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/loadtests/{testId}/files" + path_format_arguments = { + "testId": _SERIALIZER.url("test_id", test_id, "str", max_length=50, min_length=2, pattern=r"^[a-z0-9_-]*$"), + } + + _url = _format_url_section(_url, **path_format_arguments) + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + if continuation_token_parameter is not None: + _params["continuationToken"] = _SERIALIZER.query( + "continuation_token_parameter", continuation_token_parameter, "str" + ) + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_test_run_delete_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 = kwargs.pop("api_version", _params.pop("api-version", "2022-06-01-preview")) # type: str + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/testruns/{testRunId}" + path_format_arguments = { + "testRunId": _SERIALIZER.url( + "test_run_id", test_run_id, "str", max_length=50, min_length=2, pattern=r"^[a-z0-9_-]*$" + ), + } + + _url = _format_url_section(_url, **path_format_arguments) + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="DELETE", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_test_run_create_or_update_test_request(test_run_id: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + old_test_run_id = kwargs.pop("old_test_run_id", _params.pop("oldTestRunId", None)) # type: Optional[str] + content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str] + api_version = kwargs.pop("api_version", _params.pop("api-version", "2022-06-01-preview")) # type: str + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/testruns/{testRunId}" + path_format_arguments = { + "testRunId": _SERIALIZER.url( + "test_run_id", test_run_id, "str", max_length=50, min_length=2, pattern=r"^[a-z0-9_-]*$" + ), + } + + _url = _format_url_section(_url, **path_format_arguments) + + # Construct parameters + if old_test_run_id is not None: + _params["oldTestRunId"] = _SERIALIZER.query("old_test_run_id", old_test_run_id, "str") + _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_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 = kwargs.pop("api_version", _params.pop("api-version", "2022-06-01-preview")) # type: str + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/testruns/{testRunId}" + path_format_arguments = { + "testRunId": _SERIALIZER.url( + "test_run_id", test_run_id, "str", max_length=50, min_length=2, pattern=r"^[a-z0-9_-]*$" + ), + } + + _url = _format_url_section(_url, **path_format_arguments) + + # 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_test_run_get_test_run_file_request(test_run_id: str, file_id: str, **kwargs: Any) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version = kwargs.pop("api_version", _params.pop("api-version", "2022-06-01-preview")) # type: str + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/testruns/{testRunId}/files/{fileId}" + path_format_arguments = { + "testRunId": _SERIALIZER.url( + "test_run_id", test_run_id, "str", max_length=50, min_length=2, pattern=r"^[a-z0-9_-]*$" + ), + "fileId": _SERIALIZER.url("file_id", file_id, "str", max_length=50, min_length=2, pattern=r"^[a-z0-9_-]*$"), + } + + _url = _format_url_section(_url, **path_format_arguments) + + # 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_test_run_list_test_runs_request( + *, + order_by: Optional[str] = None, + continuation_token_parameter: Optional[str] = None, + search: Optional[str] = None, + execution_from: Optional[datetime.datetime] = None, + execution_to: Optional[datetime.datetime] = None, + status: Optional[str] = None, + max_page_size: int = 50, + test_id: Optional[str] = None, + **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version = kwargs.pop("api_version", _params.pop("api-version", "2022-06-01-preview")) # type: str + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/testruns/sortAndFilter" + + # Construct parameters + if order_by is not None: + _params["orderBy"] = _SERIALIZER.query("order_by", order_by, "str") + if continuation_token_parameter is not None: + _params["continuationToken"] = _SERIALIZER.query( + "continuation_token_parameter", continuation_token_parameter, "str" + ) + if search is not None: + _params["search"] = _SERIALIZER.query("search", search, "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 max_page_size is not None: + _params["maxPageSize"] = _SERIALIZER.query("max_page_size", max_page_size, "int") + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + if test_id is not None: + _params["testId"] = _SERIALIZER.query( + "test_id", test_id, "str", max_length=50, min_length=2, pattern=r"^[a-z0-9_-]*$" + ) + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_test_run_stop_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 = kwargs.pop("api_version", _params.pop("api-version", "2022-06-01-preview")) # type: str + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/testruns/{testRunId}:stop" + path_format_arguments = { + "testRunId": _SERIALIZER.url( + "test_run_id", test_run_id, "str", max_length=50, min_length=2, pattern=r"^[a-z0-9_-]*$" + ), + } + + _url = _format_url_section(_url, **path_format_arguments) + + # 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) + + +def build_test_run_get_test_run_client_metrics_request(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 = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str] + api_version = kwargs.pop("api_version", _params.pop("api-version", "2022-06-01-preview")) # type: str + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/testruns/{testRunId}/clientMetrics" + path_format_arguments = { + "testRunId": _SERIALIZER.url( + "test_run_id", test_run_id, "str", max_length=50, min_length=2, pattern=r"^[a-z0-9_-]*$" + ), + } + + _url = _format_url_section(_url, **path_format_arguments) + + # 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="POST", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_test_run_get_test_run_client_metrics_filters_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 = kwargs.pop("api_version", _params.pop("api-version", "2022-06-01-preview")) # type: str + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/testruns/{testRunId}/clientMetricsFilters" + path_format_arguments = { + "testRunId": _SERIALIZER.url( + "test_run_id", test_run_id, "str", max_length=50, min_length=2, pattern=r"^[a-z0-9_-]*$" + ), + } + + _url = _format_url_section(_url, **path_format_arguments) + + # 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) + + +class AppComponentOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.developer.loadtesting.LoadTestingClient`'s + :attr:`app_component` attribute. + """ + + def __init__(self, *args, **kwargs): + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @overload + def create_or_update_app_components( + self, name: str, body: JSON, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> JSON: + """Associate an App Component (Azure resource) to a test or test run. + + Associate an App Component (Azure resource) to a test or test run. + + :param name: Unique name of the App Component, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type name: 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: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "value": { + "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. + "resourceType": "str", # Azure resource type. 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. + } + }, + "name": "str", # Optional. AppComponent name. + "resourceId": "str", # Optional. Azure Load Testing resource Id. + "testId": "str", # Optional. [Required, if testRunId is not given] Load test + unique identifier. + "testRunId": "str" # Optional. [Required if testId is not given] Load test + run unique identifier. + } + + # response body for status code(s): 200, 201 + response == { + "value": { + "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. + "resourceType": "str", # Azure resource type. 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. + } + }, + "name": "str", # Optional. AppComponent name. + "resourceId": "str", # Optional. Azure Load Testing resource Id. + "testId": "str", # Optional. [Required, if testRunId is not given] Load test + unique identifier. + "testRunId": "str" # Optional. [Required if testId is not given] Load test + run unique identifier. + } + """ + + @overload + def create_or_update_app_components( + self, name: str, body: IO, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> JSON: + """Associate an App Component (Azure resource) to a test or test run. + + Associate an App Component (Azure resource) to a test or test run. + + :param name: Unique name of the App Component, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type name: str + :param body: App Component model. Required. + :type body: IO + :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: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200, 201 + response == { + "value": { + "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. + "resourceType": "str", # Azure resource type. 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. + } + }, + "name": "str", # Optional. AppComponent name. + "resourceId": "str", # Optional. Azure Load Testing resource Id. + "testId": "str", # Optional. [Required, if testRunId is not given] Load test + unique identifier. + "testRunId": "str" # Optional. [Required if testId is not given] Load test + run unique identifier. + } + """ + + @distributed_trace + def create_or_update_app_components(self, name: str, body: Union[JSON, IO], **kwargs: Any) -> JSON: + """Associate an App Component (Azure resource) to a test or test run. + + Associate an App Component (Azure resource) to a test or test run. + + :param name: Unique name of the App Component, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type name: str + :param body: App Component model. Is either a model type or a IO type. Required. + :type body: JSON or IO + :keyword content_type: Body Parameter content-type. Known values are: + 'application/merge-patch+json'. Default value is None. + :paramtype content_type: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200, 201 + response == { + "value": { + "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. + "resourceType": "str", # Azure resource type. 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. + } + }, + "name": "str", # Optional. AppComponent name. + "resourceId": "str", # Optional. Azure Load Testing resource Id. + "testId": "str", # Optional. [Required, if testRunId is not given] Load test + unique identifier. + "testRunId": "str" # Optional. [Required if testId is not given] Load test + run unique identifier. + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str] + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + content_type = content_type or "application/merge-patch+json" + _json = None + _content = None + if isinstance(body, (IO, bytes)): + _content = body + else: + _json = body + + request = build_app_component_create_or_update_app_components_request( + name=name, + content_type=content_type, + api_version=self._config.api_version, + json=_json, + 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) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.status_code == 200: + if response.content: + deserialized = response.json() + else: + deserialized = None + + if response.status_code == 201: + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + @distributed_trace + def delete_app_components(self, name: str, **kwargs: Any) -> None: # pylint: disable=inconsistent-return-statements + """Delete an App Component. + + Delete an App Component. + + :param name: Unique name of the App Component, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type name: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[None] + + request = build_app_component_delete_app_components_request( + name=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) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if cls: + return cls(pipeline_response, None, {}) + + @distributed_trace + def get_app_component_by_name(self, name: str, **kwargs: Any) -> JSON: + """Get App Component details by App Component name. + + Get App Component details by App Component name. + + :param name: Unique name of the App Component, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type name: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "value": { + "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. + "resourceType": "str", # Azure resource type. 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. + } + }, + "name": "str", # Optional. AppComponent name. + "resourceId": "str", # Optional. Azure Load Testing resource Id. + "testId": "str", # Optional. [Required, if testRunId is not given] Load test + unique identifier. + "testRunId": "str" # Optional. [Required if testId is not given] Load test + run unique identifier. + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + request = build_app_component_get_app_component_by_name_request( + name=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) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + @distributed_trace + def get_app_component( + self, *, test_run_id: Optional[str] = None, test_id: Optional[str] = None, **kwargs: Any + ) -> JSON: + """Get App Components for a test or a test run by its name. + + Get App Components for a test or a test run by its name. + + :keyword test_run_id: [Required, if testId is not provided] Test run Id. Default value is None. + :paramtype test_run_id: str + :keyword test_id: Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. + Default value is None. + :paramtype test_id: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "value": { + "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. + "resourceType": "str", # Azure resource type. 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. + } + }, + "name": "str", # Optional. AppComponent name. + "resourceId": "str", # Optional. Azure Load Testing resource Id. + "testId": "str", # Optional. [Required, if testRunId is not given] Load test + unique identifier. + "testRunId": "str" # Optional. [Required if testId is not given] Load test + run unique identifier. + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + request = build_app_component_get_app_component_request( + test_run_id=test_run_id, + 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) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + +class ServerMetricsOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.developer.loadtesting.LoadTestingClient`'s + :attr:`server_metrics` attribute. + """ + + def __init__(self, *args, **kwargs): + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @overload + def create_or_update_server_metrics_config( + self, name: str, body: JSON, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> JSON: + """Configure server metrics for a test or test run. + + Configure server metrics for a test or test run. + + :param name: Unique name for server metrics, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type name: str + :param body: Server metrics 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: JSON object + :rtype: JSON + :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": { + "localizedValue": "str", # Metric localized name. + Required. + "value": "str" # Metric name value. Required. + }, + "resourceId": "str", # Azure resource Id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique identifier for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "name": "str", # Optional. Server metrics config name. + "testId": "str", # Optional. [Required, if testRunId is not given] Load test + unique identifier. + "testRunId": "str" # Optional. [Required, if testId is not given] Load test + run unique identifier. + } + + # response body for status code(s): 200, 201 + response == { + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricnamespace": "str", # Metric name space. Required. + "name": { + "localizedValue": "str", # Metric localized name. + Required. + "value": "str" # Metric name value. Required. + }, + "resourceId": "str", # Azure resource Id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique identifier for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "name": "str", # Optional. Server metrics config name. + "testId": "str", # Optional. [Required, if testRunId is not given] Load test + unique identifier. + "testRunId": "str" # Optional. [Required, if testId is not given] Load test + run unique identifier. + } + """ + + @overload + def create_or_update_server_metrics_config( + self, name: str, body: IO, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> JSON: + """Configure server metrics for a test or test run. + + Configure server metrics for a test or test run. + + :param name: Unique name for server metrics, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type name: str + :param body: Server metrics configuration model. Required. + :type body: IO + :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: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200, 201 + response == { + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricnamespace": "str", # Metric name space. Required. + "name": { + "localizedValue": "str", # Metric localized name. + Required. + "value": "str" # Metric name value. Required. + }, + "resourceId": "str", # Azure resource Id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique identifier for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "name": "str", # Optional. Server metrics config name. + "testId": "str", # Optional. [Required, if testRunId is not given] Load test + unique identifier. + "testRunId": "str" # Optional. [Required, if testId is not given] Load test + run unique identifier. + } + """ + + @distributed_trace + def create_or_update_server_metrics_config(self, name: str, body: Union[JSON, IO], **kwargs: Any) -> JSON: + """Configure server metrics for a test or test run. + + Configure server metrics for a test or test run. + + :param name: Unique name for server metrics, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type name: str + :param body: Server metrics configuration model. Is either a model type or a IO type. Required. + :type body: JSON or IO + :keyword content_type: Body Parameter content-type. Known values are: + 'application/merge-patch+json'. Default value is None. + :paramtype content_type: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200, 201 + response == { + "metrics": { + "str": { + "aggregation": "str", # Metric aggregation. Required. + "metricnamespace": "str", # Metric name space. Required. + "name": { + "localizedValue": "str", # Metric localized name. + Required. + "value": "str" # Metric name value. Required. + }, + "resourceId": "str", # Azure resource Id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique identifier for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "name": "str", # Optional. Server metrics config name. + "testId": "str", # Optional. [Required, if testRunId is not given] Load test + unique identifier. + "testRunId": "str" # Optional. [Required, if testId is not given] Load test + run unique identifier. + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str] + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + content_type = content_type or "application/merge-patch+json" + _json = None + _content = None + if isinstance(body, (IO, bytes)): + _content = body + else: + _json = body + + request = build_server_metrics_create_or_update_server_metrics_config_request( + name=name, + content_type=content_type, + api_version=self._config.api_version, + json=_json, + 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) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.status_code == 200: + if response.content: + deserialized = response.json() + else: + deserialized = None + + if response.status_code == 201: + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + @distributed_trace + def get_server_metrics_config_by_name(self, name: str, **kwargs: Any) -> JSON: + """Get server metrics configuration by its name. + + Get server metrics configuration by its name. + + :param name: Unique name for server metrics, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type name: str + :return: JSON object + :rtype: JSON + :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": { + "localizedValue": "str", # Metric localized name. + Required. + "value": "str" # Metric name value. Required. + }, + "resourceId": "str", # Azure resource Id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique identifier for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "name": "str", # Optional. Server metrics config name. + "testId": "str", # Optional. [Required, if testRunId is not given] Load test + unique identifier. + "testRunId": "str" # Optional. [Required, if testId is not given] Load test + run unique identifier. + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + request = build_server_metrics_get_server_metrics_config_by_name_request( + name=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) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + @distributed_trace + def delete_server_metrics_config( # pylint: disable=inconsistent-return-statements + self, name: str, **kwargs: Any + ) -> None: + """Delete server metrics configuration by its name. + + Delete server metrics configuration by its name. + + :param name: Unique name for server metrics, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type name: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[None] + + request = build_server_metrics_delete_server_metrics_config_request( + name=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) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if cls: + return cls(pipeline_response, None, {}) + + @distributed_trace + def get_server_metrics_config( + self, *, test_run_id: Optional[str] = None, test_id: Optional[str] = None, **kwargs: Any + ) -> JSON: + """Get server metrics configuration for a test or test run by its name. + + Get server metrics configuration for a test or test run by its name. + + :keyword test_run_id: [Required, if testId is not provided] Test run Id. Default value is None. + :paramtype test_run_id: str + :keyword test_id: Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. + Default value is None. + :paramtype test_id: str + :return: JSON object + :rtype: JSON + :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": { + "localizedValue": "str", # Metric localized name. + Required. + "value": "str" # Metric name value. Required. + }, + "resourceId": "str", # Azure resource Id. Required. + "resourceType": "str", # Azure resource type. Required. + "displayDescription": "str", # Optional. Metric description. + "id": "str", # Optional. Unique identifier for metric. + "unit": "str" # Optional. Metric unit. + } + }, + "name": "str", # Optional. Server metrics config name. + "testId": "str", # Optional. [Required, if testRunId is not given] Load test + unique identifier. + "testRunId": "str" # Optional. [Required, if testId is not given] Load test + run unique identifier. + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + request = build_server_metrics_get_server_metrics_config_request( + test_run_id=test_run_id, + 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) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + @distributed_trace + def get_server_default_metrics_config(self, **kwargs: Any) -> JSON: + """Get all default server metrics configuration for supported resource types. + + Get all default server metrics configuration for supported resource types. + + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "defaultMetrics": { + "str": [ + { + "aggregation": "str", # Optional. Default metrics + map {resourceType : list of metrics config} (Refer for metrics + structure: + https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition). + "displayDescription": "str", # Optional. Default + metrics map {resourceType : list of metrics config} (Refer for + metrics structure: + https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition). + "metricnamespace": "str", # Optional. Default + metrics map {resourceType : list of metrics config} (Refer for + metrics structure: + https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition). + "name": { + "localizedValue": "str", # Optional. Default + metrics map {resourceType : list of metrics config} (Refer for + metrics structure: + https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition). + "value": "str" # Optional. Default metrics + map {resourceType : list of metrics config} (Refer for metrics + structure: + https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition). + }, + "unit": "str" # Optional. Default metrics map + {resourceType : list of metrics config} (Refer for metrics structure: + https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition). + } + ] + } + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + request = build_server_metrics_get_server_default_metrics_config_request( + 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) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + @distributed_trace + def list_supported_resource_types(self, **kwargs: Any) -> JSON: + """Get all supported resource types for App Components(Azure resource types). + + Get all supported resource types for App Components(Azure resource types). + + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "value": [ + "str" # Optional. + ] + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + request = build_server_metrics_list_supported_resource_types_request( + 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) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + +class TestOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.developer.loadtesting.LoadTestingClient`'s + :attr:`test` attribute. + """ + + def __init__(self, *args, **kwargs): + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + raise_if_not_implemented( + self.__class__, + [ + "upload_test_file", + ], + ) + + @overload + def create_or_update_test( + self, test_id: str, body: JSON, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> JSON: + """Create a new test or Update an existing test. + + Create a new test or Update an existing test. + + :param test_id: Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type test_id: str + :param body: Load test 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: JSON object + :rtype: JSON + :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 the test model. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The created + DateTime(ISO 8601 literal format) of the test model. + "description": "str", # Optional. The test description. + "displayName": "str", # Optional. Display name of a test. + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "inputArtifacts": { + "additionalUrls": [ + { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + } + ], + "configUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + }, + "inputArtifactsZipFileurl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + }, + "testScriptUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + }, + "userPropUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + } + }, + "keyvaultReferenceIdentityId": "str", # Optional. Resource Id of the managed + identity referencing the Key vault. + "keyvaultReferenceIdentityType": "str", # Optional. Type of the managed + identity referencing the Key vault. + "lastModifiedBy": "str", # Optional. The user that last modified the test + model. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + DateTime(ISO 8601 literal format) of the test model. + "loadTestConfig": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-45. Required for + creating a new test. + "splitAllCSVs": bool # Optional. Whether all the input CSV files + should be split evenly across all engines. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Either "u2018stop"u2019 + or "u2018continue"u2019 after the threshold is met. Default is + "u2018continue"u2019. + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions - + "u2018percentage"u2019 - for error metric ,"u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. + "clientmetric": "str", # Optional. The client metric + on which the criteria should be applied. Allowed values - + "u2018response_time_ms"u2019 , "u2018latency"u2019, + "u2018error"u2019, "u2018requests"u2019, + "u2018requests_per_sec"u2019. + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. possible outcome - "u2018passed"u2019 , "u2018failed"u2019 , + "u2018undetermined"u2019. + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "resourceId": "str", # Optional. Fully qualified resource Id e.g + /subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. eg. + AKV_SECRET_URI/SECRET_VALUE. + "value": "str" # Optional. The value of the secret, of type + AKV_SECRET_URI or SECRET_VALUE. + } + }, + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testId": "str" # Optional. Unique test name as identifier. + } + + # response body for status code(s): 200, 201 + response == { + "createdBy": "str", # Optional. The user that created the test model. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The created + DateTime(ISO 8601 literal format) of the test model. + "description": "str", # Optional. The test description. + "displayName": "str", # Optional. Display name of a test. + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "inputArtifacts": { + "additionalUrls": [ + { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + } + ], + "configUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + }, + "inputArtifactsZipFileurl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + }, + "testScriptUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + }, + "userPropUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + } + }, + "keyvaultReferenceIdentityId": "str", # Optional. Resource Id of the managed + identity referencing the Key vault. + "keyvaultReferenceIdentityType": "str", # Optional. Type of the managed + identity referencing the Key vault. + "lastModifiedBy": "str", # Optional. The user that last modified the test + model. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + DateTime(ISO 8601 literal format) of the test model. + "loadTestConfig": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-45. Required for + creating a new test. + "splitAllCSVs": bool # Optional. Whether all the input CSV files + should be split evenly across all engines. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Either "u2018stop"u2019 + or "u2018continue"u2019 after the threshold is met. Default is + "u2018continue"u2019. + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions - + "u2018percentage"u2019 - for error metric ,"u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. + "clientmetric": "str", # Optional. The client metric + on which the criteria should be applied. Allowed values - + "u2018response_time_ms"u2019 , "u2018latency"u2019, + "u2018error"u2019, "u2018requests"u2019, + "u2018requests_per_sec"u2019. + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. possible outcome - "u2018passed"u2019 , "u2018failed"u2019 , + "u2018undetermined"u2019. + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "resourceId": "str", # Optional. Fully qualified resource Id e.g + /subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. eg. + AKV_SECRET_URI/SECRET_VALUE. + "value": "str" # Optional. The value of the secret, of type + AKV_SECRET_URI or SECRET_VALUE. + } + }, + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testId": "str" # Optional. Unique test name as identifier. + } + """ + + @overload + def create_or_update_test( + self, test_id: str, body: IO, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> JSON: + """Create a new test or Update an existing test. + + Create a new test or Update an existing test. + + :param test_id: Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type test_id: str + :param body: Load test model. Required. + :type body: IO + :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: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200, 201 + response == { + "createdBy": "str", # Optional. The user that created the test model. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The created + DateTime(ISO 8601 literal format) of the test model. + "description": "str", # Optional. The test description. + "displayName": "str", # Optional. Display name of a test. + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "inputArtifacts": { + "additionalUrls": [ + { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + } + ], + "configUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + }, + "inputArtifactsZipFileurl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + }, + "testScriptUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + }, + "userPropUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + } + }, + "keyvaultReferenceIdentityId": "str", # Optional. Resource Id of the managed + identity referencing the Key vault. + "keyvaultReferenceIdentityType": "str", # Optional. Type of the managed + identity referencing the Key vault. + "lastModifiedBy": "str", # Optional. The user that last modified the test + model. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + DateTime(ISO 8601 literal format) of the test model. + "loadTestConfig": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-45. Required for + creating a new test. + "splitAllCSVs": bool # Optional. Whether all the input CSV files + should be split evenly across all engines. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Either "u2018stop"u2019 + or "u2018continue"u2019 after the threshold is met. Default is + "u2018continue"u2019. + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions - + "u2018percentage"u2019 - for error metric ,"u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. + "clientmetric": "str", # Optional. The client metric + on which the criteria should be applied. Allowed values - + "u2018response_time_ms"u2019 , "u2018latency"u2019, + "u2018error"u2019, "u2018requests"u2019, + "u2018requests_per_sec"u2019. + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. possible outcome - "u2018passed"u2019 , "u2018failed"u2019 , + "u2018undetermined"u2019. + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "resourceId": "str", # Optional. Fully qualified resource Id e.g + /subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. eg. + AKV_SECRET_URI/SECRET_VALUE. + "value": "str" # Optional. The value of the secret, of type + AKV_SECRET_URI or SECRET_VALUE. + } + }, + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testId": "str" # Optional. Unique test name as identifier. + } + """ + + @distributed_trace + def create_or_update_test(self, test_id: str, body: Union[JSON, IO], **kwargs: Any) -> JSON: + """Create a new test or Update an existing test. + + Create a new test or Update an existing test. + + :param test_id: Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type test_id: str + :param body: Load test model. Is either a model type or a IO type. Required. + :type body: JSON or IO + :keyword content_type: Body Parameter content-type. Known values are: + 'application/merge-patch+json'. Default value is None. + :paramtype content_type: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200, 201 + response == { + "createdBy": "str", # Optional. The user that created the test model. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The created + DateTime(ISO 8601 literal format) of the test model. + "description": "str", # Optional. The test description. + "displayName": "str", # Optional. Display name of a test. + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "inputArtifacts": { + "additionalUrls": [ + { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + } + ], + "configUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + }, + "inputArtifactsZipFileurl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + }, + "testScriptUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + }, + "userPropUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + } + }, + "keyvaultReferenceIdentityId": "str", # Optional. Resource Id of the managed + identity referencing the Key vault. + "keyvaultReferenceIdentityType": "str", # Optional. Type of the managed + identity referencing the Key vault. + "lastModifiedBy": "str", # Optional. The user that last modified the test + model. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + DateTime(ISO 8601 literal format) of the test model. + "loadTestConfig": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-45. Required for + creating a new test. + "splitAllCSVs": bool # Optional. Whether all the input CSV files + should be split evenly across all engines. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Either "u2018stop"u2019 + or "u2018continue"u2019 after the threshold is met. Default is + "u2018continue"u2019. + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions - + "u2018percentage"u2019 - for error metric ,"u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. + "clientmetric": "str", # Optional. The client metric + on which the criteria should be applied. Allowed values - + "u2018response_time_ms"u2019 , "u2018latency"u2019, + "u2018error"u2019, "u2018requests"u2019, + "u2018requests_per_sec"u2019. + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. possible outcome - "u2018passed"u2019 , "u2018failed"u2019 , + "u2018undetermined"u2019. + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "resourceId": "str", # Optional. Fully qualified resource Id e.g + /subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. eg. + AKV_SECRET_URI/SECRET_VALUE. + "value": "str" # Optional. The value of the secret, of type + AKV_SECRET_URI or SECRET_VALUE. + } + }, + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testId": "str" # Optional. Unique test name as identifier. + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str] + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + content_type = content_type or "application/merge-patch+json" + _json = None + _content = None + if isinstance(body, (IO, bytes)): + _content = body + else: + _json = body + + request = build_test_create_or_update_test_request( + test_id=test_id, + content_type=content_type, + api_version=self._config.api_version, + json=_json, + 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) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200, 201]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.status_code == 200: + if response.content: + deserialized = response.json() + else: + deserialized = None + + if response.status_code == 201: + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + @distributed_trace + def delete_load_test(self, test_id: str, **kwargs: Any) -> None: # pylint: disable=inconsistent-return-statements + """Delete a test by its name. + + Delete a test by its name. + + :param test_id: Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type test_id: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[None] + + request = build_test_delete_load_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) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if cls: + return cls(pipeline_response, None, {}) + + @distributed_trace + def get_load_test(self, test_id: str, **kwargs: Any) -> JSON: + """Get load test details by test name. + + Get load test details by test name. + + :param test_id: Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type test_id: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "createdBy": "str", # Optional. The user that created the test model. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The created + DateTime(ISO 8601 literal format) of the test model. + "description": "str", # Optional. The test description. + "displayName": "str", # Optional. Display name of a test. + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "inputArtifacts": { + "additionalUrls": [ + { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + } + ], + "configUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + }, + "inputArtifactsZipFileurl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + }, + "testScriptUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + }, + "userPropUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + } + }, + "keyvaultReferenceIdentityId": "str", # Optional. Resource Id of the managed + identity referencing the Key vault. + "keyvaultReferenceIdentityType": "str", # Optional. Type of the managed + identity referencing the Key vault. + "lastModifiedBy": "str", # Optional. The user that last modified the test + model. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last Modified + DateTime(ISO 8601 literal format) of the test model. + "loadTestConfig": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-45. Required for + creating a new test. + "splitAllCSVs": bool # Optional. Whether all the input CSV files + should be split evenly across all engines. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Either "u2018stop"u2019 + or "u2018continue"u2019 after the threshold is met. Default is + "u2018continue"u2019. + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions - + "u2018percentage"u2019 - for error metric ,"u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. + "clientmetric": "str", # Optional. The client metric + on which the criteria should be applied. Allowed values - + "u2018response_time_ms"u2019 , "u2018latency"u2019, + "u2018error"u2019, "u2018requests"u2019, + "u2018requests_per_sec"u2019. + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. possible outcome - "u2018passed"u2019 , "u2018failed"u2019 , + "u2018undetermined"u2019. + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "resourceId": "str", # Optional. Fully qualified resource Id e.g + /subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. eg. + AKV_SECRET_URI/SECRET_VALUE. + "value": "str" # Optional. The value of the secret, of type + AKV_SECRET_URI or SECRET_VALUE. + } + }, + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testId": "str" # Optional. Unique test name as identifier. + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + request = build_test_get_load_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) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + @distributed_trace + def list_load_test_search( + self, + *, + order_by: Optional[str] = None, + search: Optional[str] = None, + last_updated_start_time: Optional[datetime.datetime] = None, + last_updated_end_time: Optional[datetime.datetime] = None, + continuation_token_parameter: Optional[str] = None, + max_page_size: int = 50, + **kwargs: Any + ) -> JSON: + """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 order_by: Sort on one of the field - lastModifiedDateTime, displayName, createdBy in + (field asc/desc) format. eg: displayName asc. Default value is None. + :paramtype order_by: str + :keyword search: Filter search based on searchable fields - testId, createdBy. Default value is + None. + :paramtype search: str + :keyword last_updated_start_time: Start DateTime(ISO 8601 literal format) of the last updated + time range to filter tests. Default value is None. + :paramtype last_updated_start_time: ~datetime.datetime + :keyword last_updated_end_time: End DateTime(ISO 8601 literal format) of the last updated time + range to filter tests. Default value is None. + :paramtype last_updated_end_time: ~datetime.datetime + :keyword continuation_token_parameter: Continuation token to get the next page of response. + Default value is None. + :paramtype continuation_token_parameter: str + :keyword max_page_size: Number of results in response. Default value is 50. + :paramtype max_page_size: int + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "value": [ + { + "createdBy": "str", # Optional. The user that created the + test model. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The + created DateTime(ISO 8601 literal format) of the test model. + "description": "str", # Optional. The test description. + "displayName": "str", # Optional. Display name of a test. + "environmentVariables": { + "str": "str" # Optional. Environment variables which + are defined as a set of pairs. + }, + "inputArtifacts": { + "additionalUrls": [ + { + "expireTime": "2020-02-20 00:00:00", + # Optional. Expiry time of the file. + "fileId": "str", # Optional. File + unique identifier. + "fileType": 0, # Optional. Integer + representation of the file type (0 = JMX_FILE, 1 = + USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: + 0, 1, and 2. + "filename": "str", # Optional. Name + of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # + Optional. Validation status of the file. + } + ], + "configUrl": { + "expireTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file. + "fileId": "str", # Optional. File unique + identifier. + "fileType": 0, # Optional. Integer + representation of the file type (0 = JMX_FILE, 1 = + USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: 0, + 1, and 2. + "filename": "str", # Optional. Name of the + file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. + Validation status of the file. + }, + "inputArtifactsZipFileurl": { + "expireTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file. + "fileId": "str", # Optional. File unique + identifier. + "fileType": 0, # Optional. Integer + representation of the file type (0 = JMX_FILE, 1 = + USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: 0, + 1, and 2. + "filename": "str", # Optional. Name of the + file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. + Validation status of the file. + }, + "testScriptUrl": { + "expireTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file. + "fileId": "str", # Optional. File unique + identifier. + "fileType": 0, # Optional. Integer + representation of the file type (0 = JMX_FILE, 1 = + USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: 0, + 1, and 2. + "filename": "str", # Optional. Name of the + file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. + Validation status of the file. + }, + "userPropUrl": { + "expireTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file. + "fileId": "str", # Optional. File unique + identifier. + "fileType": 0, # Optional. Integer + representation of the file type (0 = JMX_FILE, 1 = + USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: 0, + 1, and 2. + "filename": "str", # Optional. Name of the + file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. + Validation status of the file. + } + }, + "keyvaultReferenceIdentityId": "str", # Optional. Resource + Id of the managed identity referencing the Key vault. + "keyvaultReferenceIdentityType": "str", # Optional. Type of + the managed identity referencing the Key vault. + "lastModifiedBy": "str", # Optional. The user that last + modified the test model. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. + The last Modified DateTime(ISO 8601 literal format) of the test model. + "loadTestConfig": { + "engineInstances": 0, # Optional. The number of + engine instances to execute load test. Supported values are in range + of 1-45. Required for creating a new test. + "splitAllCSVs": bool # Optional. Whether all the + input CSV files should be split evenly across all engines. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Either + "u2018stop"u2019 or "u2018continue"u2019 after the threshold + is met. Default is "u2018continue"u2019. + "actualValue": 0.0, # Optional. The + actual value of the client metric for the test run. + "aggregate": "str", # Optional. The + aggregation function to be applied on the client metric. + Allowed functions - "u2018percentage"u2019 - for error metric + ,"u2018avg"u2019, "u2018p50"u2019, "u2018p90"u2019, + "u2018p95"u2019, "u2018p99"u2019, "u2018min"u2019, + "u2018max"u2019 - for response_time_ms and latency metric, + "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. + "clientmetric": "str", # Optional. + The client metric on which the criteria should be applied. + Allowed values - "u2018response_time_ms"u2019 , + "u2018latency"u2019, "u2018error"u2019, "u2018requests"u2019, + "u2018requests_per_sec"u2019. + "condition": "str", # Optional. The + comparison operator. Supported types "u2018>"u2019. + "requestName": "str", # Optional. + Request name for which the Pass fail criteria has to be + applied. + "result": "str", # Optional. Outcome + of the test run. possible outcome - "u2018passed"u2019 , + "u2018failed"u2019 , "u2018undetermined"u2019. + "value": 0.0 # Optional. The value + to compare with the client metric. Allowed values - + "u2018error : [0.0 , 100.0] unit- % "u2019, response_time_ms + and latency : any integer value unit- ms. + } + } + }, + "resourceId": "str", # Optional. Fully qualified resource Id + e.g + /subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. + eg. AKV_SECRET_URI/SECRET_VALUE. + "value": "str" # Optional. The value of the + secret, of type AKV_SECRET_URI or SECRET_VALUE. + } + }, + "subnetId": "str", # Optional. Subnet ID on which the load + test instances should run. + "testId": "str" # Optional. Unique test name as identifier. + } + ], + "nextLink": "str" # Optional. Link for the next list of resources in case of + paginated results, if applicable. + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + request = build_test_list_load_test_search_request( + order_by=order_by, + search=search, + last_updated_start_time=last_updated_start_time, + last_updated_end_time=last_updated_end_time, + continuation_token_parameter=continuation_token_parameter, + max_page_size=max_page_size, + 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) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + @distributed_trace + def get_test_file(self, test_id: str, file_id: str, **kwargs: Any) -> JSON: + """Get test file by the file name. + + Get test file by the file name. + + :param test_id: Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type test_id: str + :param file_id: Unique identifier for test file, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type file_id: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the file type (0 = + JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: 0, 1, + and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of the file. + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + request = build_test_get_test_file_request( + test_id=test_id, + file_id=file_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) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + @distributed_trace + def delete_test_file( # pylint: disable=inconsistent-return-statements + self, test_id: str, file_id: 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 name for load test, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type test_id: str + :param file_id: Unique identifier for test file, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type file_id: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[None] + + request = build_test_delete_test_file_request( + test_id=test_id, + file_id=file_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) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if cls: + return cls(pipeline_response, None, {}) + + @distributed_trace + def list_test_files( + self, test_id: str, *, continuation_token_parameter: Optional[str] = None, **kwargs: Any + ) -> JSON: + """Get all test files. + + Get all test files. + + :param test_id: Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type test_id: str + :keyword continuation_token_parameter: Continuation token to get the next page of response. + Default value is None. + :paramtype continuation_token_parameter: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "value": [ + { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time + of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the + file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). + Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of + the file. + } + ], + "nextLink": "str" # Optional. Link for the next list of file URLs, if + applicable. + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + request = build_test_list_test_files_request( + test_id=test_id, + continuation_token_parameter=continuation_token_parameter, + 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) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + +class TestRunOperations: + """ + .. warning:: + **DO NOT** instantiate this class directly. + + Instead, you should access the following operations through + :class:`~azure.developer.loadtesting.LoadTestingClient`'s + :attr:`test_run` attribute. + """ + + def __init__(self, *args, **kwargs): + input_args = list(args) + self._client = input_args.pop(0) if input_args else kwargs.pop("client") + self._config = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @distributed_trace + def delete_test_run( # pylint: disable=inconsistent-return-statements + self, test_run_id: str, **kwargs: Any + ) -> None: + """Delete a test run by its name. + + Delete a test run by its name. + + :param test_run_id: Unique name of the load test run, must be a valid URL character + ^[a-z0-9_-]*$. Required. + :type test_run_id: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[None] + + request = build_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) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [204]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if cls: + return cls(pipeline_response, None, {}) + + @overload + def create_or_update_test( + self, + test_run_id: str, + body: JSON, + *, + old_test_run_id: Optional[str] = None, + content_type: str = "application/merge-patch+json", + **kwargs: Any + ) -> JSON: + """Create and start a new test run with the given name. + + Create and start a new test run with the given name. + + :param test_run_id: Unique name of the load test run, must be a valid URL character + ^[a-z0-9_-]*$. Required. + :type test_run_id: str + :param body: Load test run model. Required. + :type body: JSON + :keyword old_test_run_id: Existing test run Id that should be rerun. Default value is None. + :paramtype old_test_run_id: str + :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: JSON object + :rtype: JSON + :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 the test run. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The created + DateTime(ISO 8601 literal format) of the test run. + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a test run. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(ISO 8601 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "lastModifiedBy": "str", # Optional. The user that updated the test run. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last updated + DateTime(ISO 8601 literal format) of the test run. + "loadTestConfig": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-45. Required for + creating a new test. + "splitAllCSVs": bool # Optional. Whether all the input CSV files + should be split evenly across all engines. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Either "u2018stop"u2019 + or "u2018continue"u2019 after the threshold is met. Default is + "u2018continue"u2019. + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions - + "u2018percentage"u2019 - for error metric ,"u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. + "clientmetric": "str", # Optional. The client metric + on which the criteria should be applied. Allowed values - + "u2018response_time_ms"u2019 , "u2018latency"u2019, + "u2018error"u2019, "u2018requests"u2019, + "u2018requests_per_sec"u2019. + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. possible outcome - "u2018passed"u2019 , "u2018failed"u2019 , + "u2018undetermined"u2019. + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "resourceId": "str", # Optional. Load test resource Id. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. eg. + AKV_SECRET_URI/SECRET_VALUE. + "value": "str" # Optional. The value of the secret, of type + AKV_SECRET_URI or SECRET_VALUE. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(ISO 8601 literal format). + "status": "str", # Optional. The test run status. + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalUrls": [ + { + "expireTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file. + "fileId": "str", # Optional. File unique + identifier. + "fileType": 0, # Optional. Integer + representation of the file type (0 = JMX_FILE, 1 = + USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: 0, + 1, and 2. + "filename": "str", # Optional. Name of the + file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. + Validation status of the file. + } + ], + "configUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "inputArtifactsZipFileurl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "testScriptUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "userPropUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + } + }, + "outputArtifacts": { + "logsUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "resultUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. possible outcome - "u2018Passed"u2019 , "u2018Failed"u2019 , + "u2018Not Applicable"u2019. + "testRunId": "str", # Optional. Unique test run name as identifier. + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Sent network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "vusers": 0 # Optional. Number of virtual users, for which test has been + run. + } + + # response body for status code(s): 200 + response == { + "createdBy": "str", # Optional. The user that created the test run. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The created + DateTime(ISO 8601 literal format) of the test run. + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a test run. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(ISO 8601 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "lastModifiedBy": "str", # Optional. The user that updated the test run. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last updated + DateTime(ISO 8601 literal format) of the test run. + "loadTestConfig": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-45. Required for + creating a new test. + "splitAllCSVs": bool # Optional. Whether all the input CSV files + should be split evenly across all engines. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Either "u2018stop"u2019 + or "u2018continue"u2019 after the threshold is met. Default is + "u2018continue"u2019. + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions - + "u2018percentage"u2019 - for error metric ,"u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. + "clientmetric": "str", # Optional. The client metric + on which the criteria should be applied. Allowed values - + "u2018response_time_ms"u2019 , "u2018latency"u2019, + "u2018error"u2019, "u2018requests"u2019, + "u2018requests_per_sec"u2019. + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. possible outcome - "u2018passed"u2019 , "u2018failed"u2019 , + "u2018undetermined"u2019. + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "resourceId": "str", # Optional. Load test resource Id. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. eg. + AKV_SECRET_URI/SECRET_VALUE. + "value": "str" # Optional. The value of the secret, of type + AKV_SECRET_URI or SECRET_VALUE. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(ISO 8601 literal format). + "status": "str", # Optional. The test run status. + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalUrls": [ + { + "expireTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file. + "fileId": "str", # Optional. File unique + identifier. + "fileType": 0, # Optional. Integer + representation of the file type (0 = JMX_FILE, 1 = + USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: 0, + 1, and 2. + "filename": "str", # Optional. Name of the + file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. + Validation status of the file. + } + ], + "configUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "inputArtifactsZipFileurl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "testScriptUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "userPropUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + } + }, + "outputArtifacts": { + "logsUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "resultUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. possible outcome - "u2018Passed"u2019 , "u2018Failed"u2019 , + "u2018Not Applicable"u2019. + "testRunId": "str", # Optional. Unique test run name as identifier. + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Sent network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "vusers": 0 # Optional. Number of virtual users, for which test has been + run. + } + """ + + @overload + def create_or_update_test( + self, + test_run_id: str, + body: IO, + *, + old_test_run_id: Optional[str] = None, + content_type: str = "application/merge-patch+json", + **kwargs: Any + ) -> JSON: + """Create and start a new test run with the given name. + + Create and start a new test run with the given name. + + :param test_run_id: Unique name of the load test run, must be a valid URL character + ^[a-z0-9_-]*$. Required. + :type test_run_id: str + :param body: Load test run model. Required. + :type body: IO + :keyword old_test_run_id: Existing test run Id that should be rerun. Default value is None. + :paramtype old_test_run_id: str + :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: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "createdBy": "str", # Optional. The user that created the test run. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The created + DateTime(ISO 8601 literal format) of the test run. + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a test run. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(ISO 8601 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "lastModifiedBy": "str", # Optional. The user that updated the test run. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last updated + DateTime(ISO 8601 literal format) of the test run. + "loadTestConfig": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-45. Required for + creating a new test. + "splitAllCSVs": bool # Optional. Whether all the input CSV files + should be split evenly across all engines. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Either "u2018stop"u2019 + or "u2018continue"u2019 after the threshold is met. Default is + "u2018continue"u2019. + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions - + "u2018percentage"u2019 - for error metric ,"u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. + "clientmetric": "str", # Optional. The client metric + on which the criteria should be applied. Allowed values - + "u2018response_time_ms"u2019 , "u2018latency"u2019, + "u2018error"u2019, "u2018requests"u2019, + "u2018requests_per_sec"u2019. + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. possible outcome - "u2018passed"u2019 , "u2018failed"u2019 , + "u2018undetermined"u2019. + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "resourceId": "str", # Optional. Load test resource Id. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. eg. + AKV_SECRET_URI/SECRET_VALUE. + "value": "str" # Optional. The value of the secret, of type + AKV_SECRET_URI or SECRET_VALUE. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(ISO 8601 literal format). + "status": "str", # Optional. The test run status. + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalUrls": [ + { + "expireTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file. + "fileId": "str", # Optional. File unique + identifier. + "fileType": 0, # Optional. Integer + representation of the file type (0 = JMX_FILE, 1 = + USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: 0, + 1, and 2. + "filename": "str", # Optional. Name of the + file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. + Validation status of the file. + } + ], + "configUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "inputArtifactsZipFileurl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "testScriptUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "userPropUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + } + }, + "outputArtifacts": { + "logsUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "resultUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. possible outcome - "u2018Passed"u2019 , "u2018Failed"u2019 , + "u2018Not Applicable"u2019. + "testRunId": "str", # Optional. Unique test run name as identifier. + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Sent network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "vusers": 0 # Optional. Number of virtual users, for which test has been + run. + } + """ + + @distributed_trace + def create_or_update_test( + self, test_run_id: str, body: Union[JSON, IO], *, old_test_run_id: Optional[str] = None, **kwargs: Any + ) -> JSON: + """Create and start a new test run with the given name. + + Create and start a new test run with the given name. + + :param test_run_id: Unique name of the load test run, must be a valid URL character + ^[a-z0-9_-]*$. Required. + :type test_run_id: str + :param body: Load test run model. Is either a model type or a IO type. Required. + :type body: JSON or IO + :keyword old_test_run_id: Existing test run Id that should be rerun. Default value is None. + :paramtype old_test_run_id: str + :keyword content_type: Body Parameter content-type. Known values are: + 'application/merge-patch+json'. Default value is None. + :paramtype content_type: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "createdBy": "str", # Optional. The user that created the test run. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The created + DateTime(ISO 8601 literal format) of the test run. + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a test run. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(ISO 8601 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "lastModifiedBy": "str", # Optional. The user that updated the test run. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last updated + DateTime(ISO 8601 literal format) of the test run. + "loadTestConfig": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-45. Required for + creating a new test. + "splitAllCSVs": bool # Optional. Whether all the input CSV files + should be split evenly across all engines. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Either "u2018stop"u2019 + or "u2018continue"u2019 after the threshold is met. Default is + "u2018continue"u2019. + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions - + "u2018percentage"u2019 - for error metric ,"u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. + "clientmetric": "str", # Optional. The client metric + on which the criteria should be applied. Allowed values - + "u2018response_time_ms"u2019 , "u2018latency"u2019, + "u2018error"u2019, "u2018requests"u2019, + "u2018requests_per_sec"u2019. + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. possible outcome - "u2018passed"u2019 , "u2018failed"u2019 , + "u2018undetermined"u2019. + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "resourceId": "str", # Optional. Load test resource Id. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. eg. + AKV_SECRET_URI/SECRET_VALUE. + "value": "str" # Optional. The value of the secret, of type + AKV_SECRET_URI or SECRET_VALUE. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(ISO 8601 literal format). + "status": "str", # Optional. The test run status. + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalUrls": [ + { + "expireTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file. + "fileId": "str", # Optional. File unique + identifier. + "fileType": 0, # Optional. Integer + representation of the file type (0 = JMX_FILE, 1 = + USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: 0, + 1, and 2. + "filename": "str", # Optional. Name of the + file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. + Validation status of the file. + } + ], + "configUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "inputArtifactsZipFileurl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "testScriptUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "userPropUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + } + }, + "outputArtifacts": { + "logsUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "resultUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. possible outcome - "u2018Passed"u2019 , "u2018Failed"u2019 , + "u2018Not Applicable"u2019. + "testRunId": "str", # Optional. Unique test run name as identifier. + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Sent network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "vusers": 0 # Optional. Number of virtual users, for which test has been + run. + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str] + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + content_type = content_type or "application/merge-patch+json" + _json = None + _content = None + if isinstance(body, (IO, bytes)): + _content = body + else: + _json = body + + request = build_test_run_create_or_update_test_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, + json=_json, + 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) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + @distributed_trace + def get_test_run(self, test_run_id: str, **kwargs: Any) -> JSON: + """Get test run details by name. + + Get test run details by name. + + :param test_run_id: Unique name of load test run, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type test_run_id: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "createdBy": "str", # Optional. The user that created the test run. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The created + DateTime(ISO 8601 literal format) of the test run. + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a test run. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(ISO 8601 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "lastModifiedBy": "str", # Optional. The user that updated the test run. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last updated + DateTime(ISO 8601 literal format) of the test run. + "loadTestConfig": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-45. Required for + creating a new test. + "splitAllCSVs": bool # Optional. Whether all the input CSV files + should be split evenly across all engines. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Either "u2018stop"u2019 + or "u2018continue"u2019 after the threshold is met. Default is + "u2018continue"u2019. + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions - + "u2018percentage"u2019 - for error metric ,"u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. + "clientmetric": "str", # Optional. The client metric + on which the criteria should be applied. Allowed values - + "u2018response_time_ms"u2019 , "u2018latency"u2019, + "u2018error"u2019, "u2018requests"u2019, + "u2018requests_per_sec"u2019. + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. possible outcome - "u2018passed"u2019 , "u2018failed"u2019 , + "u2018undetermined"u2019. + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "resourceId": "str", # Optional. Load test resource Id. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. eg. + AKV_SECRET_URI/SECRET_VALUE. + "value": "str" # Optional. The value of the secret, of type + AKV_SECRET_URI or SECRET_VALUE. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(ISO 8601 literal format). + "status": "str", # Optional. The test run status. + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalUrls": [ + { + "expireTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file. + "fileId": "str", # Optional. File unique + identifier. + "fileType": 0, # Optional. Integer + representation of the file type (0 = JMX_FILE, 1 = + USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: 0, + 1, and 2. + "filename": "str", # Optional. Name of the + file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. + Validation status of the file. + } + ], + "configUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "inputArtifactsZipFileurl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "testScriptUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "userPropUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + } + }, + "outputArtifacts": { + "logsUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "resultUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. possible outcome - "u2018Passed"u2019 , "u2018Failed"u2019 , + "u2018Not Applicable"u2019. + "testRunId": "str", # Optional. Unique test run name as identifier. + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Sent network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "vusers": 0 # Optional. Number of virtual users, for which test has been + run. + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + request = build_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) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + @distributed_trace + def get_test_run_file(self, test_run_id: str, file_id: str, **kwargs: Any) -> JSON: + """Get test run file by file name. + + Get test run file by file name. + + :param test_run_id: Unique name of load test run, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type test_run_id: str + :param file_id: Unique identifier for test run file, must be a valid URL character + ^[a-z0-9_-]*$. Required. + :type file_id: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "expireTime": "2020-02-20 00:00:00", # Optional. Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of the file type (0 = + JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: 0, 1, + and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation status of the file. + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + request = build_test_run_get_test_run_file_request( + test_run_id=test_run_id, + file_id=file_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) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + @distributed_trace + def list_test_runs( + self, + *, + order_by: Optional[str] = None, + continuation_token_parameter: Optional[str] = None, + search: Optional[str] = None, + execution_from: Optional[datetime.datetime] = None, + execution_to: Optional[datetime.datetime] = None, + status: Optional[str] = None, + max_page_size: int = 50, + test_id: Optional[str] = None, + **kwargs: Any + ) -> JSON: + """Get all test runs with given filters. + + Get all test runs with given filters. + + :keyword order_by: Sort on one of the field - status, displayName, executedDateTime in (field + asc/desc) format. eg: displayName asc. Default value is None. + :paramtype order_by: str + :keyword continuation_token_parameter: Continuation token to get the next page of response. + Default value is None. + :paramtype continuation_token_parameter: str + :keyword search: Filter search based on searchable fields - description, executedUser. Default + value is None. + :paramtype search: str + :keyword execution_from: The end DateTime(ISO 8601 literal format) of test-run execution time + filter range. Default value is None. + :paramtype execution_from: ~datetime.datetime + :keyword execution_to: The start DateTime(ISO 8601 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, value can be - "ACCEPTED", + "NOTSTARTED","PROVISIONING","PROVISIONED","CONFIGURING", + "CONFIGURED","EXECUTING","EXECUTED","DEPROVISIONING","DEPROVISIONED","DONE","CANCELLED","FAILED". + Default value is None. + :paramtype status: str + :keyword max_page_size: Number of results in response. Default value is 50. + :paramtype max_page_size: int + :keyword test_id: Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. + Default value is None. + :paramtype test_id: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "value": [ + { + "createdBy": "str", # Optional. The user that created the + test run. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The + created DateTime(ISO 8601 literal format) of the test run. + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a test + run. + "duration": 0, # Optional. Test run duration in + milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test + run end DateTime(ISO 8601 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which + are defined as a set of pairs. + }, + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test + run initiated time. + "lastModifiedBy": "str", # Optional. The user that updated + the test run. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. + The last updated DateTime(ISO 8601 literal format) of the test run. + "loadTestConfig": { + "engineInstances": 0, # Optional. The number of + engine instances to execute load test. Supported values are in range + of 1-45. Required for creating a new test. + "splitAllCSVs": bool # Optional. Whether all the + input CSV files should be split evenly across all engines. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Either + "u2018stop"u2019 or "u2018continue"u2019 after the threshold + is met. Default is "u2018continue"u2019. + "actualValue": 0.0, # Optional. The + actual value of the client metric for the test run. + "aggregate": "str", # Optional. The + aggregation function to be applied on the client metric. + Allowed functions - "u2018percentage"u2019 - for error metric + ,"u2018avg"u2019, "u2018p50"u2019, "u2018p90"u2019, + "u2018p95"u2019, "u2018p99"u2019, "u2018min"u2019, + "u2018max"u2019 - for response_time_ms and latency metric, + "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. + "clientmetric": "str", # Optional. + The client metric on which the criteria should be applied. + Allowed values - "u2018response_time_ms"u2019 , + "u2018latency"u2019, "u2018error"u2019, "u2018requests"u2019, + "u2018requests_per_sec"u2019. + "condition": "str", # Optional. The + comparison operator. Supported types "u2018>"u2019. + "requestName": "str", # Optional. + Request name for which the Pass fail criteria has to be + applied. + "result": "str", # Optional. Outcome + of the test run. possible outcome - "u2018passed"u2019 , + "u2018failed"u2019 , "u2018undetermined"u2019. + "value": 0.0 # Optional. The value + to compare with the client metric. Allowed values - + "u2018error : [0.0 , 100.0] unit- % "u2019, response_time_ms + and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "resourceId": "str", # Optional. Load test resource Id. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. + eg. AKV_SECRET_URI/SECRET_VALUE. + "value": "str" # Optional. The value of the + secret, of type AKV_SECRET_URI or SECRET_VALUE. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test + run start DateTime(ISO 8601 literal format). + "status": "str", # Optional. The test run status. + "subnetId": "str", # Optional. Subnet ID on which the load + test instances should run. + "testArtifacts": { + "inputArtifacts": { + "additionalUrls": [ + { + "expireTime": "2020-02-20 + 00:00:00", # Optional. Expiry time of the file. + "fileId": "str", # Optional. + File unique identifier. + "fileType": 0, # Optional. + Integer representation of the file type (0 = JMX_FILE, 1 + = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known + values are: 0, 1, and 2. + "filename": "str", # + Optional. Name of the file. + "url": "str", # Optional. + File URL. + "validationStatus": "str" # + Optional. Validation status of the file. + } + ], + "configUrl": { + "expireTime": "2020-02-20 00:00:00", + # Optional. Expiry time of the file. + "fileId": "str", # Optional. File + unique identifier. + "fileType": 0, # Optional. Integer + representation of the file type (0 = JMX_FILE, 1 = + USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: + 0, 1, and 2. + "filename": "str", # Optional. Name + of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # + Optional. Validation status of the file. + }, + "inputArtifactsZipFileurl": { + "expireTime": "2020-02-20 00:00:00", + # Optional. Expiry time of the file. + "fileId": "str", # Optional. File + unique identifier. + "fileType": 0, # Optional. Integer + representation of the file type (0 = JMX_FILE, 1 = + USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: + 0, 1, and 2. + "filename": "str", # Optional. Name + of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # + Optional. Validation status of the file. + }, + "testScriptUrl": { + "expireTime": "2020-02-20 00:00:00", + # Optional. Expiry time of the file. + "fileId": "str", # Optional. File + unique identifier. + "fileType": 0, # Optional. Integer + representation of the file type (0 = JMX_FILE, 1 = + USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: + 0, 1, and 2. + "filename": "str", # Optional. Name + of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # + Optional. Validation status of the file. + }, + "userPropUrl": { + "expireTime": "2020-02-20 00:00:00", + # Optional. Expiry time of the file. + "fileId": "str", # Optional. File + unique identifier. + "fileType": 0, # Optional. Integer + representation of the file type (0 = JMX_FILE, 1 = + USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: + 0, 1, and 2. + "filename": "str", # Optional. Name + of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # + Optional. Validation status of the file. + } + }, + "outputArtifacts": { + "logsUrl": { + "expireTime": "2020-02-20 00:00:00", + # Optional. Expiry time of the file. + "fileId": "str", # Optional. File + unique identifier. + "fileType": 0, # Optional. Integer + representation of the file type (0 = JMX_FILE, 1 = + USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: + 0, 1, and 2. + "filename": "str", # Optional. Name + of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # + Optional. Validation status of the file. + }, + "resultUrl": { + "expireTime": "2020-02-20 00:00:00", + # Optional. Expiry time of the file. + "fileId": "str", # Optional. File + unique identifier. + "fileType": 0, # Optional. Integer + representation of the file type (0 = JMX_FILE, 1 = + USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: + 0, 1, and 2. + "filename": "str", # Optional. Name + of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # + Optional. Validation status of the file. + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail + criteria used during the test run. possible outcome - "u2018Passed"u2019 + , "u2018Failed"u2019 , "u2018Not Applicable"u2019. + "testRunId": "str", # Optional. Unique test run name as + identifier. + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error + percentage. + "maxResTime": 0.0, # Optional. Max response + time. + "meanResTime": 0.0, # Optional. Mean + response time. + "medianResTime": 0.0, # Optional. Median + response time. + "minResTime": 0.0, # Optional. Minimum + response time. + "pct1ResTime": 0.0, # Optional. 90 + percentile response time. + "pct2ResTime": 0.0, # Optional. 95 + percentile response time. + "pct3ResTime": 0.0, # Optional. 99 + percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. + Received network bytes. + "sampleCount": 0.0, # Optional. Sampler + count. + "sentKBytesPerSec": 0.0, # Optional. Sent + network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction + name. + } + }, + "vusers": 0 # Optional. Number of virtual users, for which + test has been run. + } + ], + "nextLink": "str" # Optional. Link for the next list of resources in case of + paginated results, if applicable. + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + request = build_test_run_list_test_runs_request( + order_by=order_by, + continuation_token_parameter=continuation_token_parameter, + search=search, + execution_from=execution_from, + execution_to=execution_to, + status=status, + max_page_size=max_page_size, + 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) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + @distributed_trace + def stop_test_run(self, test_run_id: str, **kwargs: Any) -> JSON: + """Stop test run by name. + + Stop test run by name. + + :param test_run_id: Unique name of the load test run, must be a valid URL character + ^[a-z0-9_-]*$. Required. + :type test_run_id: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "createdBy": "str", # Optional. The user that created the test run. + "createdDateTime": "2020-02-20 00:00:00", # Optional. The created + DateTime(ISO 8601 literal format) of the test run. + "description": "str", # Optional. The test run description. + "displayName": "str", # Optional. Display name of a test run. + "duration": 0, # Optional. Test run duration in milliseconds. + "endDateTime": "2020-02-20 00:00:00", # Optional. The test run end + DateTime(ISO 8601 literal format). + "environmentVariables": { + "str": "str" # Optional. Environment variables which are defined as + a set of pairs. + }, + "executedDateTime": "2020-02-20 00:00:00", # Optional. Test run initiated + time. + "lastModifiedBy": "str", # Optional. The user that updated the test run. + "lastModifiedDateTime": "2020-02-20 00:00:00", # Optional. The last updated + DateTime(ISO 8601 literal format) of the test run. + "loadTestConfig": { + "engineInstances": 0, # Optional. The number of engine instances to + execute load test. Supported values are in range of 1-45. Required for + creating a new test. + "splitAllCSVs": bool # Optional. Whether all the input CSV files + should be split evenly across all engines. + }, + "passFailCriteria": { + "passFailMetrics": { + "str": { + "action": "str", # Optional. Either "u2018stop"u2019 + or "u2018continue"u2019 after the threshold is met. Default is + "u2018continue"u2019. + "actualValue": 0.0, # Optional. The actual value of + the client metric for the test run. + "aggregate": "str", # Optional. The aggregation + function to be applied on the client metric. Allowed functions - + "u2018percentage"u2019 - for error metric ,"u2018avg"u2019, + "u2018p50"u2019, "u2018p90"u2019, "u2018p95"u2019, "u2018p99"u2019, + "u2018min"u2019, "u2018max"u2019 - for response_time_ms and latency + metric, "u2018avg"u2019 - for requests_per_sec, "u2018count"u2019 - + for requests. + "clientmetric": "str", # Optional. The client metric + on which the criteria should be applied. Allowed values - + "u2018response_time_ms"u2019 , "u2018latency"u2019, + "u2018error"u2019, "u2018requests"u2019, + "u2018requests_per_sec"u2019. + "condition": "str", # Optional. The comparison + operator. Supported types "u2018>"u2019. + "requestName": "str", # Optional. Request name for + which the Pass fail criteria has to be applied. + "result": "str", # Optional. Outcome of the test + run. possible outcome - "u2018passed"u2019 , "u2018failed"u2019 , + "u2018undetermined"u2019. + "value": 0.0 # Optional. The value to compare with + the client metric. Allowed values - "u2018error : [0.0 , 100.0] unit- + % "u2019, response_time_ms and latency : any integer value unit- ms. + } + } + }, + "portalUrl": "str", # Optional. Portal url. + "resourceId": "str", # Optional. Load test resource Id. + "secrets": { + "str": { + "type": "str", # Optional. Type of secret. eg. + AKV_SECRET_URI/SECRET_VALUE. + "value": "str" # Optional. The value of the secret, of type + AKV_SECRET_URI or SECRET_VALUE. + } + }, + "startDateTime": "2020-02-20 00:00:00", # Optional. The test run start + DateTime(ISO 8601 literal format). + "status": "str", # Optional. The test run status. + "subnetId": "str", # Optional. Subnet ID on which the load test instances + should run. + "testArtifacts": { + "inputArtifacts": { + "additionalUrls": [ + { + "expireTime": "2020-02-20 00:00:00", # + Optional. Expiry time of the file. + "fileId": "str", # Optional. File unique + identifier. + "fileType": 0, # Optional. Integer + representation of the file type (0 = JMX_FILE, 1 = + USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). Known values are: 0, + 1, and 2. + "filename": "str", # Optional. Name of the + file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. + Validation status of the file. + } + ], + "configUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "inputArtifactsZipFileurl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "testScriptUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "userPropUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + } + }, + "outputArtifacts": { + "logsUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + }, + "resultUrl": { + "expireTime": "2020-02-20 00:00:00", # Optional. + Expiry time of the file. + "fileId": "str", # Optional. File unique identifier. + "fileType": 0, # Optional. Integer representation of + the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = + ADDITIONAL_ARTIFACTS). Known values are: 0, 1, and 2. + "filename": "str", # Optional. Name of the file. + "url": "str", # Optional. File URL. + "validationStatus": "str" # Optional. Validation + status of the file. + } + } + }, + "testId": "str", # Optional. Associated test Id. + "testResult": "str", # Optional. Test result for pass/Fail criteria used + during the test run. possible outcome - "u2018Passed"u2019 , "u2018Failed"u2019 , + "u2018Not Applicable"u2019. + "testRunId": "str", # Optional. Unique test run name as identifier. + "testRunStatistics": { + "str": { + "errorCount": 0.0, # Optional. Error count. + "errorPct": 0.0, # Optional. Error percentage. + "maxResTime": 0.0, # Optional. Max response time. + "meanResTime": 0.0, # Optional. Mean response time. + "medianResTime": 0.0, # Optional. Median response time. + "minResTime": 0.0, # Optional. Minimum response time. + "pct1ResTime": 0.0, # Optional. 90 percentile response time. + "pct2ResTime": 0.0, # Optional. 95 percentile response time. + "pct3ResTime": 0.0, # Optional. 99 percentile response time. + "receivedKBytesPerSec": 0.0, # Optional. Received network + bytes. + "sampleCount": 0.0, # Optional. Sampler count. + "sentKBytesPerSec": 0.0, # Optional. Sent network bytes. + "throughput": 0.0, # Optional. Throughput. + "transaction": "str" # Optional. Transaction name. + } + }, + "vusers": 0 # Optional. Number of virtual users, for which test has been + run. + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + request = build_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) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + @overload + def get_test_run_client_metrics( + self, test_run_id: str, body: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> JSON: + """Get all client metrics for a load test run. + + Get all client metrics for a load test run. + + :param test_run_id: Unique name of the load test run, must be a valid URL character + ^[a-z0-9_-]*$. Required. + :type test_run_id: str + :param body: Client metrics request model. Required. + :type body: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "endTime": "2020-02-20 00:00:00", # End time. Required. + "startTime": "2020-02-20 00:00:00", # Start time. Required. + "errors": [ + "str" # Optional. List of errors, maximum supported errors for + queries are 20. In case of empty, by default will return metrics for maximum + 20 errors. + ], + "groupByInterval": "str", # Optional. For test duration less than 10 minutes + group by time interval can be any one of 5s,10s,1m,5m.""n""nFor test duration + greater than 10 minutes, group by time interval can be any one of 1m,5m,1h. + Default value is 1m. + "percentiles": [ + "str" # Optional. List of percentiles values for response time, + supported values 50,90,99,95. Default value is 50th percentile. + ], + "requestSamplers": [ + "str" # Optional. List of request samplers, maximum supported + samplers for queries are 20. In case of empty, it will return metrics for + maximum 20 samplers. + ] + } + + # response body for status code(s): 200 + response == { + "testRunId": "str", # Optional. Test run name for which client metrics + results is required. + "timeSeries": { + "activeUsers": { + "str": [ + { + "timestamp": "2020-02-20 00:00:00", # + Optional. Timestamp(ISO 8601 literal format). + "value": 0.0 # Optional. Value at timestamp. + } + ] + }, + "errors": { + "str": [ + { + "timestamp": "2020-02-20 00:00:00", # + Optional. Timestamp(ISO 8601 literal format). + "value": 0.0 # Optional. Value at timestamp. + } + ] + }, + "responseTime": { + "str": [ + { + "timestamp": "2020-02-20 00:00:00", # + Optional. Timestamp(ISO 8601 literal format). + "value": 0.0 # Optional. Value at timestamp. + } + ] + }, + "throughput": { + "str": [ + { + "timestamp": "2020-02-20 00:00:00", # + Optional. Timestamp(ISO 8601 literal format). + "value": 0.0 # Optional. Value at timestamp. + } + ] + } + } + } + """ + + @overload + def get_test_run_client_metrics( + self, test_run_id: str, body: IO, *, content_type: str = "application/json", **kwargs: Any + ) -> JSON: + """Get all client metrics for a load test run. + + Get all client metrics for a load test run. + + :param test_run_id: Unique name of the load test run, must be a valid URL character + ^[a-z0-9_-]*$. Required. + :type test_run_id: str + :param body: Client metrics request model. Required. + :type body: IO + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "testRunId": "str", # Optional. Test run name for which client metrics + results is required. + "timeSeries": { + "activeUsers": { + "str": [ + { + "timestamp": "2020-02-20 00:00:00", # + Optional. Timestamp(ISO 8601 literal format). + "value": 0.0 # Optional. Value at timestamp. + } + ] + }, + "errors": { + "str": [ + { + "timestamp": "2020-02-20 00:00:00", # + Optional. Timestamp(ISO 8601 literal format). + "value": 0.0 # Optional. Value at timestamp. + } + ] + }, + "responseTime": { + "str": [ + { + "timestamp": "2020-02-20 00:00:00", # + Optional. Timestamp(ISO 8601 literal format). + "value": 0.0 # Optional. Value at timestamp. + } + ] + }, + "throughput": { + "str": [ + { + "timestamp": "2020-02-20 00:00:00", # + Optional. Timestamp(ISO 8601 literal format). + "value": 0.0 # Optional. Value at timestamp. + } + ] + } + } + } + """ + + @distributed_trace + def get_test_run_client_metrics(self, test_run_id: str, body: Union[JSON, IO], **kwargs: Any) -> JSON: + """Get all client metrics for a load test run. + + Get all client metrics for a load test run. + + :param test_run_id: Unique name of the load test run, must be a valid URL character + ^[a-z0-9_-]*$. Required. + :type test_run_id: str + :param body: Client metrics request model. Is either a model type or a IO type. Required. + :type body: JSON or IO + :keyword content_type: Body Parameter content-type. Known values are: 'application/json'. + Default value is None. + :paramtype content_type: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "testRunId": "str", # Optional. Test run name for which client metrics + results is required. + "timeSeries": { + "activeUsers": { + "str": [ + { + "timestamp": "2020-02-20 00:00:00", # + Optional. Timestamp(ISO 8601 literal format). + "value": 0.0 # Optional. Value at timestamp. + } + ] + }, + "errors": { + "str": [ + { + "timestamp": "2020-02-20 00:00:00", # + Optional. Timestamp(ISO 8601 literal format). + "value": 0.0 # Optional. Value at timestamp. + } + ] + }, + "responseTime": { + "str": [ + { + "timestamp": "2020-02-20 00:00:00", # + Optional. Timestamp(ISO 8601 literal format). + "value": 0.0 # Optional. Value at timestamp. + } + ] + }, + "throughput": { + "str": [ + { + "timestamp": "2020-02-20 00:00:00", # + Optional. Timestamp(ISO 8601 literal format). + "value": 0.0 # Optional. Value at timestamp. + } + ] + } + } + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str] + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + content_type = content_type or "application/json" + _json = None + _content = None + if isinstance(body, (IO, bytes)): + _content = body + else: + _json = body + + request = build_test_run_get_test_run_client_metrics_request( + test_run_id=test_run_id, + content_type=content_type, + api_version=self._config.api_version, + json=_json, + 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) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) + + @distributed_trace + def get_test_run_client_metrics_filters(self, test_run_id: str, **kwargs: Any) -> JSON: + """Get all filters that are supported for client metrics for a given load test run. + + Get all filters that are supported for client metrics for a given load test run. + + :param test_run_id: Unique name for load test run, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type test_run_id: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "filters": { + "errorFiltersValues": [ + "str" # Optional. List of errors occurred for the test run, + for which client metrics can be filtered. + ], + "requestSamplerValues": [ + "str" # Optional. List of request sampler for the test run, + for which client metrics can be filtered. + ] + }, + "testRunId": "str", # Optional. Test run name for which client metrics + filters is required. + "timeRange": { + "endTime": "2020-02-20 00:00:00", # Optional. end DateTime(ISO 8601 + literal format) for the requested client metrics filter. + "startTime": "2020-02-20 00:00:00" # Optional. start DateTime(ISO + 8601 literal format) for the requested client metrics filter. + } + } + """ + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + request = build_test_run_get_test_run_client_metrics_filters_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) # type: ignore + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if response.content: + deserialized = response.json() + else: + deserialized = None + + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + + return cast(JSON, deserialized) diff --git a/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/operations/_patch.py b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/operations/_patch.py new file mode 100644 index 000000000000..5a8cc50de0e7 --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/operations/_patch.py @@ -0,0 +1,406 @@ +# ------------------------------------ +# 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 Any, IO, Optional, Union, cast, overload, List, BinaryIO + +from azure.core.exceptions import ( + ClientAuthenticationError, + HttpResponseError, + ResourceExistsError, + ResourceNotFoundError, + map_error, +) +from azure.core.rest import HttpRequest +from azure.core.tracing.decorator import distributed_trace +from azure.core.utils import case_insensitive_dict + +from ._operations import AppComponentOperations as AppComponentOperationsGenerated +from ._operations import TestOperations as TestOperationsGenerated, JSON, ClsType +from .._serialization import Serializer +from .._vendor import _format_url_section + +_SERIALIZER = Serializer() +_SERIALIZER.client_side_validation = False + + +def build_upload_test_file_request( + test_id: str, + file_id: str, + file: BinaryIO, + **kwargs, +) -> HttpRequest: + """ + Core logic for uploading a file + """ + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + # content_type = kwargs.pop('content_type', _headers.pop('Content-Type', None)) # type: Optional[str] + api_version = kwargs.pop("api_version", _params.pop("api-version", "2022-06-01-preview")) # type: str + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/loadtests/{testId}/files/{fileId}" + path_format_arguments = { + "testId": _SERIALIZER.url("test_id", test_id, "str", max_length=50, min_length=2, pattern=r"^[a-z0-9_-]*$"), + "fileId": _SERIALIZER.url("file_id", file_id, "str", max_length=50, min_length=2, pattern=r"^[a-z0-9_-]*$"), + } + + _url = _format_url_section(_url, **path_format_arguments) + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + files_json = {"file": file} + + return HttpRequest(method="PUT", url=_url, files=files_json, params=_params, headers=_headers, **kwargs) + + +class TestOperations(TestOperationsGenerated): + """ + for performing the operations on test + """ + + def __init__(self, *args, **kwargs): + super(TestOperations, self).__init__(*args, **kwargs) + + def upload_test_file(self, test_id: str, file_id: str, file: BinaryIO, **kwargs) -> JSON: + """Upload test file and link it to a test. + + Upload a test file to an existing test. + + :param test_id: Unique id for the test + :type test_id: str + :param file_id: Unique id for the file + :type file_id: str + :param file_content: dictionary containing file contet + :type file: BinaryIO (file opened in Binary read mode) + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + """ + + error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError} + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = kwargs.pop("params", {}) or {} + + cls = kwargs.pop("cls", None) # type: ClsType[JSON] + + _content = file + + request = build_upload_test_file_request( + test_id=test_id, + file_id=file_id, + file=file, + 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) # type: ignore + + request.method = "PUT" + + pipeline_response = self._client._pipeline.run( # type: ignore # pylint: disable=protected-access + request, stream=False, **kwargs + ) + response = pipeline_response.http_response + + if response.status_code not in [201]: + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + if response.content: + deserialized = response.json() + else: + deserialized = None + if cls: + return cls(pipeline_response, cast(JSON, deserialized), {}) + return cast(JSON, deserialized) + + +class AppComponentOperations: + def __init__(self, *args, **kwargs): + self.__app_component_operations_generated = AppComponentOperationsGenerated(*args, **kwargs) + + def get_app_components( + self, + *, + test_run_id: Optional[str] = None, + test_id: Optional[str] = None, + name: Optional[str] = None, + **kwargs: Any, + ) -> JSON: + """Get App Components for a test or a test run by its name. + + Get App Components for a test or a test run by its name. + + :keyword test_run_id: [Required, if testId is not provided] Test run Id. Default value is None. + :paramtype test_run_id: st + :keyword test_id: Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. + Default value is None. + :paramtype test_id: str + :keyword name: Unique name of the App Component, must be a valid URL character ^[a-z0-9_-]*$. + Default value is None. + :paramtype name: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200 + response == { + "name": "str", # Optional. AppComponent name. + "resourceId": "str", # Optional. Azure Load Testing resource Id. + "testId": "str", # Optional. [Required, if testRunId is not given] Load test + unique identifier. + "testRunId": "str", # Optional. [Required if testId is not given] Load test + run unique identifier. + "value": { + "str": { + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "resourceId": "str", # Fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name. Required. + "resourceType": "str", # Azure resource type. Required. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + } + } + """ + + if name is not None: + return self.__app_component_operations_generated.get_app_component_by_name(name=name, **kwargs) + else: + return self.__app_component_operations_generated.get_app_component( + test_run_id=test_run_id, test_id=test_id, **kwargs + ) + + @overload + def create_or_update_app_components( + self, name: str, body: JSON, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> JSON: + """Associate an App Component (Azure resource) to a test or test run. + + Associate an App Component (Azure resource) to a test or test run. + + :param name: Unique name of the App Component, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type name: 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: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # JSON input template you can fill out and use as your body input. + body = { + "name": "str", # Optional. AppComponent name. + "resourceId": "str", # Optional. Azure Load Testing resource Id. + "testId": "str", # Optional. [Required, if testRunId is not given] Load test + unique identifier. + "testRunId": "str", # Optional. [Required if testId is not given] Load test + run unique identifier. + "value": { + "str": { + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "resourceId": "str", # Fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name. Required. + "resourceType": "str", # Azure resource type. Required. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + } + } + + # response body for status code(s): 200, 201 + response == { + "name": "str", # Optional. AppComponent name. + "resourceId": "str", # Optional. Azure Load Testing resource Id. + "testId": "str", # Optional. [Required, if testRunId is not given] Load test + unique identifier. + "testRunId": "str", # Optional. [Required if testId is not given] Load test + run unique identifier. + "value": { + "str": { + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "resourceId": "str", # Fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name. Required. + "resourceType": "str", # Azure resource type. Required. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + } + } + """ + + @overload + def create_or_update_app_components( + self, name: str, body: IO, *, content_type: str = "application/merge-patch+json", **kwargs: Any + ) -> JSON: + """Associate an App Component (Azure resource) to a test or test run. + + Associate an App Component (Azure resource) to a test or test run. + + :param name: Unique name of the App Component, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type name: str + :param body: App Component model. Required. + :type body: IO + :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: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200, 201 + response == { + "name": "str", # Optional. AppComponent name. + "resourceId": "str", # Optional. Azure Load Testing resource Id. + "testId": "str", # Optional. [Required, if testRunId is not given] Load test + unique identifier. + "testRunId": "str", # Optional. [Required if testId is not given] Load test + run unique identifier. + "value": { + "str": { + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "resourceId": "str", # Fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name. Required. + "resourceType": "str", # Azure resource type. Required. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + } + } + """ + + @distributed_trace + def create_or_update_app_components(self, name: str, body: Union[JSON, IO], **kwargs: Any) -> JSON: + """Associate an App Component (Azure resource) to a test or test run. + + Associate an App Component (Azure resource) to a test or test run. + + :param name: Unique name of the App Component, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type name: str + :param body: App Component model. Is either a model type or a IO type. Required. + :type body: JSON or IO + :keyword content_type: Body Parameter content-type. Known values are: + 'application/merge-patch+json'. Default value is None. + :paramtype content_type: str + :return: JSON object + :rtype: JSON + :raises ~azure.core.exceptions.HttpResponseError: + + Example: + .. code-block:: python + + # response body for status code(s): 200, 201 + response == { + "name": "str", # Optional. AppComponent name. + "resourceId": "str", # Optional. Azure Load Testing resource Id. + "testId": "str", # Optional. [Required, if testRunId is not given] Load test + unique identifier. + "testRunId": "str", # Optional. [Required if testId is not given] Load test + run unique identifier. + "value": { + "str": { + "displayName": "str", # Optional. Azure resource display + name. + "kind": "str", # Optional. Kind of Azure resource type. + "resourceGroup": "str", # Optional. Resource group name of + the Azure resource. + "resourceId": "str", # Fully qualified resource Id e.g + subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}. + Required. + "resourceName": "str", # Azure resource name. Required. + "resourceType": "str", # Azure resource type. Required. + "subscriptionId": "str" # Optional. Subscription Id of the + Azure resource. + } + } + } + """ + return self.__app_component_operations_generated.create_or_update_app_components(name, body, **kwargs) + + @distributed_trace + def delete_app_components( # pylint: disable=inconsistent-return-statements + self, name: str, **kwargs: Any + ) -> None: + """Delete an App Component. + + Delete an App Component. + + :param name: Unique name of the App Component, must be a valid URL character ^[a-z0-9_-]*$. + Required. + :type name: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + return self.__app_component_operations_generated.delete_app_components(name, **kwargs) + + +__all__: List[str] = ["TestOperations", "AppComponentOperations"] + + +# 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/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/py.typed b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/py.typed new file mode 100644 index 000000000000..e5aff4f83af8 --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/azure/developer/loadtesting/py.typed @@ -0,0 +1 @@ +# Marker file for PEP 561. \ No newline at end of file diff --git a/sdk/loadtestservice/azure-developer-loadtesting/dev_requirements.txt b/sdk/loadtestservice/azure-developer-loadtesting/dev_requirements.txt new file mode 100644 index 000000000000..0ce780ad6a6c --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/dev_requirements.txt @@ -0,0 +1,6 @@ +-e ../../../tools/azure-devtools +-e ../../../tools/azure-sdk-tools +../../core/azure-core +../../identity/azure-identity +aiohttp +python-dotenv \ No newline at end of file diff --git a/sdk/loadtestservice/azure-developer-loadtesting/pytest.ini b/sdk/loadtestservice/azure-developer-loadtesting/pytest.ini new file mode 100644 index 000000000000..c0d4edd8f6bd --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/pytest.ini @@ -0,0 +1,3 @@ +# pytest.ini +[pytest] +asyncio_mode = auto \ No newline at end of file diff --git a/sdk/loadtestservice/azure-developer-loadtesting/samples/sample.jmx b/sdk/loadtestservice/azure-developer-loadtesting/samples/sample.jmx new file mode 100644 index 000000000000..02446fe5f0a8 --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/samples/sample.jmx @@ -0,0 +1,192 @@ + + + + + + false + true + false + + + + + + + + + + 10 + 0 + 180 + 240 + 5 + + + + false + -1 + + continue + + + + + + + app-service-sample-demo.azurewebsites.net + + https + + + GET + true + false + true + false + + HttpClient4 + 60000 + 60000 + + + + + + 10 + 50 + 180 + + + 50 + 50 + 240 + + + + + + false + + saveConfig + + + true + true + true + + true + true + true + true + false + true + true + false + false + false + true + false + false + false + true + 0 + true + true + true + true + true + true + + + + + + + false + + saveConfig + + + true + true + true + + true + true + true + true + false + true + true + false + false + false + true + false + false + false + true + 0 + true + true + true + true + true + true + + + + + + + false + + saveConfig + + + true + true + true + + true + true + true + true + false + true + true + false + false + false + true + false + false + false + true + 0 + true + true + true + true + true + true + + + + + + + + + + udv_webapp + ${__BeanShell( System.getenv("webapp") )} + Web App URL + = + + + + + + + diff --git a/sdk/loadtestservice/azure-developer-loadtesting/samples/sample.py b/sdk/loadtestservice/azure-developer-loadtesting/samples/sample.py new file mode 100644 index 000000000000..24a5646ceba9 --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/samples/sample.py @@ -0,0 +1,140 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# +# 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. +# +# -------------------------------------------------------------------------- +import logging +import os + +from azure.developer.loadtesting import LoadTestingClient +from azure.identity import DefaultAzureCredential +from azure.core.exceptions import HttpResponseError +import time + +# using python dotenv library to load environment variables from a .env file +from dotenv import load_dotenv + +logging.basicConfig(level=logging.DEBUG) +LOG = logging.getLogger() + +# Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables: +# AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET, LOADTESTSERVICE_ENDPOINT, SUBSCRIPTION_ID + +load_dotenv() + +endpoint = os.environ["LOADTESTSERVICE_ENDPOINT"] + +# Build a client through AAD +client = LoadTestingClient(credential=DefaultAzureCredential(), endpoint=endpoint) + +TEST_ID = "some-test-id" # ID to be assigned to a test +FILE_ID = "some-file-id" # ID to be assigned to file uploaded +TEST_RUN_ID = "some-testrun-id" # ID to be assigned to a test run +APP_COMPONENT = "some-appcomponent-id" # ID of the APP Component +DISPLAY_NAME = "new_namespace-new-namespace" # display name +SUBSCRIPTION_ID = os.environ["SUBSCRIPTION_ID"] + +# creating load test +try: + result = client.load_test_administration.create_or_update_test( + TEST_ID, + { + "resourceId": f"/subscriptions/{SUBSCRIPTION_ID}/resourceGroups/yashika-rg/providers/Microsoft.LoadTestService/loadtests/loadtestsdk", + "description": "", + "displayName": DISPLAY_NAME, + "loadTestConfig": { + "engineSize": "m", + "engineInstances": 1, + "splitAllCSVs": False, + }, + "secrets": {}, + "environmentVariables": {}, + "passFailCriteria": {"passFailMetrics": {}}, + "keyvaultReferenceIdentityType": "SystemAssigned", + "keyvaultReferenceIdentityId": None, + }, + ) + print(result) +except HttpResponseError as e: + print("Failed to process the request: {}".format(e.response.json())) +# uploading .jmx file to a test +try: + # opening .jmx file + + result = client.load_test_administration.upload_test_file(TEST_ID, FILE_ID, open("sample.jmx", "rb")) + print(result) +except HttpResponseError as e: + print("Failed to send JSON message: {}".format(e.response.json())) +# creating app component +try: + result = client.load_test_administration.create_or_update_app_components( + APP_COMPONENT, + { + "name": "app_component", + "testId": TEST_ID, + "value": { + f"/subscriptions/{SUBSCRIPTION_ID}/resourceGroups/App-Service-Sample-Demo-rg/providers/Microsoft.Web/sites/App-Service-Sample-Demo": { + "resourceId": f"/subscriptions/{SUBSCRIPTION_ID}/resourceGroups/App-Service-Sample-Demo-rg/providers/Microsoft.Web/sites/App-Service-Sample-Demo", + "resourceName": "App-Service-Sample-Demo", + "resourceType": "Microsoft.Web/sites", + "subscriptionId": SUBSCRIPTION_ID, + } + }, + }, + ) + print(result) +except HttpResponseError as e: + print("Failed to send JSON message: {}".format(e.response.json())) +# Creating the test run +try: + result = client.load_test_runs.create_and_update_test( + TEST_RUN_ID, + { + "testId": TEST_ID, + "displayName": DISPLAY_NAME, + "requestSamplers": [], + "errors": [], + "percentiles": ["90"], + "groupByInterval": "5s", + }, + ) + print(result) +except HttpResponseError as e: + print("Failed to send JSON message: {}".format(e.response.json())) +# Checking the test run status and printing metrics +try: + start_time = time.time() + + TIMEOUT = 6000 + REFRESH_RATE = 10 + + while time.time() - start_time < TIMEOUT: + result = client.load_test_runs.get_test_run(TEST_RUN_ID) + if result["status"] == "DONE" or result["status"] == "CANCELLED" or result["status"] == "FAILED": + break + else: + time.sleep(REFRESH_RATE) + print(result) +except HttpResponseError as e: + print("Failed to send JSON message: {}".format(e.response.json())) diff --git a/sdk/loadtestservice/azure-developer-loadtesting/setup.py b/sdk/loadtestservice/azure-developer-loadtesting/setup.py new file mode 100644 index 000000000000..2027d6df4227 --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/setup.py @@ -0,0 +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. +# Code generated by Microsoft (R) AutoRest Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# coding: utf-8 + +import os +import re +from setuptools import setup, find_packages + + +PACKAGE_NAME = "azure-developer-loadtesting" +PACKAGE_PPRINT_NAME = "Azure Developer LoadTesting" + +# a-b-c => a/b/c +package_folder_path = PACKAGE_NAME.replace("-", "/") + +# Version extraction inspired from 'requests' +with open(os.path.join(package_folder_path, "_version.py"), "r") as fd: + version = re.search(r'^VERSION\s*=\s*[\'"]([^\'"]*)[\'"]', fd.read(), re.MULTILINE).group(1) + +if not version: + raise RuntimeError("Cannot find version information") + + +setup( + name=PACKAGE_NAME, + version=version, + description="Microsoft Azure Developer LoadTesting Client Library for Python", + long_description=open("README.md", "r").read(), + long_description_content_type="text/markdown", + license="MIT License", + author="Microsoft Corporation", + author_email="azpysdkhelp@microsoft.com", + url="https://github.com/Azure/azure-sdk-for-python/tree/main/sdk", + keywords="azure, azure sdk", + classifiers=[ + "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", + "License :: OSI Approved :: MIT License", + ], + zip_safe=False, + packages=find_packages( + exclude=[ + "tests", + # Exclude packages that will be covered by PEP420 or nspkg + "azure", + "azure.developer", + ] + ), + include_package_data=True, + package_data={ + "pytyped": ["py.typed"], + }, + install_requires=[ + "isodate<1.0.0,>=0.6.1", + "azure-core<2.0.0,>=1.24.0", + ], + python_requires=">=3.7", +) diff --git a/sdk/loadtestservice/azure-developer-loadtesting/swagger/README.md b/sdk/loadtestservice/azure-developer-loadtesting/swagger/README.md new file mode 100644 index 000000000000..64dcdc29e756 --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/swagger/README.md @@ -0,0 +1,49 @@ +### Settings + +```yaml +input-file: https://github.com/Azure/azure-rest-api-specs/blob/main/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2022-06-01-preview/loadtestservice.json +output-folder: ../ +namespace: azure.developer.loadtesting +package-name: azure-developer-loadtesting +license-header: MICROSOFT_MIT_NO_VERSION +title: LoadTestingClient +package-version: 1.0.0b1 +package-mode: dataplane +package-pprint-name: Azure Developer LoadTesting +security: AADToken +security-scopes: https://loadtest.azure-dev.com/.default +directive: + - from: swagger-document + where: $["paths"]["/serverMetricsConfig/supportedResourceTypes"].get + transform: $["operationId"] = "ServerMetrics_ListSupportedResourceTypes" + - from: swagger-document + where: $["paths"]["/testruns/sortAndFilter"].get + transform: $["operationId"] = "TestRun_ListTestRuns" + - from: swagger-document + where: $["paths"]["/serverMetricsConfig"].get + transform: $["operationId"] = "ServerMetrics_ListGetServerMetrics" + - from: swagger-document + where: $["paths"]["/appcomponents/{name}"].delete + transform: $["operationId"] = "AppComponent_DeleteAppComponents" + - from: swagger-document + where: $["paths"]["/loadtests/{testId}/files"].get + transform: $["operationId"] = "Test_ListTestFiles" + - from: swagger-document + where: $["paths"]["/testruns/sortAndFilter"].get + transform: $["operationId"] = "TestRun_ListTestRuns" + - from: swagger-document + where: $["paths"]["/testruns/{testRunId}"].patch + transform: $["operationId"] = "TestRun_CreateOrUpdateTest" + - from: swagger-document + where: $["paths"]["/serverMetricsConfig/{name}"].get + transform: $["operationId"] = "ServerMetrics_GetServerMetricsConfigByName" + - from: swagger-document + where: $["paths"]["/serverMetricsConfig/{name}"].delete + transform: $["operationId"] = "ServerMetrics_DeleteServerMetricsConfig" + - from: swagger-document + where: $["paths"]["/serverMetricsConfig"].get + transform: $["operationId"] = "ServerMetrics_GetServerMetricsConfig" + - from: swagger-document + where: $["paths"]["/serverMetricsConfig/default"].get + transform: $["operationId"] = "ServerMetrics_GetServerDefaultMetricsConfig" +``` diff --git a/sdk/loadtestservice/azure-developer-loadtesting/tests/recordings/test_smoke.test_create_or_update_app_components.yaml b/sdk/loadtestservice/azure-developer-loadtesting/tests/recordings/test_smoke.test_create_or_update_app_components.yaml new file mode 100644 index 000000000000..98777b2fe44f --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/tests/recordings/test_smoke.test_create_or_update_app_components.yaml @@ -0,0 +1,45 @@ +interactions: +- request: + body: '{"name": "app_component", "testId": "TEST_ID", "value": {"/subscriptions/SUBSCRIPTION_ID/resourceGroups/App-Service-Sample-Demo-rg/providers/Microsoft.Web/sites/App-Service-Sample-Demo": + {"resourceId": "/subscriptions/SUBSCRIPTION_ID/resourceGroups/App-Service-Sample-Demo-rg/providers/Microsoft.Web/sites/App-Service-Sample-Demo", + "resourceName": "App-Service-Sample-Demo", "resourceType": "Microsoft.Web/sites", + "subscriptionId": "SUBSCRIPTION_ID"}}}' + headers: + Accept: + - application/json + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '531' + Content-Type: + - application/merge-patch+json + User-Agent: + - azsdk-python-developer-loadtesting/1.0.0b1 Python/3.8.8 (Windows-10-10.0.19041-SP0) + method: PATCH + uri: https://myservice.azure.com/appcomponents/APP_COMPONENT?api-version=2022-06-01-preview + response: + body: + string: '{"resourceId":"/subscriptions/SUBSCRIPTION_ID/resourcegroups/python-sdk-test/providers/microsoft.loadtestservice/loadtests/loadtest-jf","testId":"TEST_ID","testRunId":null,"name":"APP_COMPONENT","value":{"/subscriptions/SUBSCRIPTION_ID/resourceGroups/App-Service-Sample-Demo-rg/providers/Microsoft.Web/sites/App-Service-Sample-Demo":{"resourceId":"/subscriptions/SUBSCRIPTION_ID/resourceGroups/App-Service-Sample-Demo-rg/providers/Microsoft.Web/sites/App-Service-Sample-Demo","resourceName":"App-Service-Sample-Demo","resourceType":"Microsoft.Web/sites","displayName":null,"resourceGroup":"App-Service-Sample-Demo-rg","subscriptionId":"SUBSCRIPTION_ID","kind":null}}}' + headers: + api-supported-versions: + - 2021-07-01-preview, 2022-06-01-preview + connection: + - keep-alive + content-length: + - '777' + content-type: + - application/json; charset=utf-8 + date: + - Wed, 27 Jul 2022 08:20:12 GMT + mise-correlation-id: + - a1297ff9-03df-4b41-819f-dc1839cf9e59 + strict-transport-security: + - max-age=15724800; includeSubDomains + x-content-type-options: + - nosniff + status: + code: 200 + message: OK +version: 1 diff --git a/sdk/loadtestservice/azure-developer-loadtesting/tests/recordings/test_smoke.test_create_or_update_test_run.yaml b/sdk/loadtestservice/azure-developer-loadtesting/tests/recordings/test_smoke.test_create_or_update_test_run.yaml new file mode 100644 index 000000000000..26e520bd7454 --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/tests/recordings/test_smoke.test_create_or_update_test_run.yaml @@ -0,0 +1,43 @@ +interactions: +- request: + body: '{"testId": "TEST_ID", "displayName": "TestingResource", "requestSamplers": + [], "errors": [], "percentiles": ["90"], "groupByInterval": "5s"}' + headers: + Accept: + - application/json + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '156' + Content-Type: + - application/merge-patch+json + User-Agent: + - azsdk-python-developer-loadtesting/1.0.0b1 Python/3.8.8 (Windows-10-10.0.19041-SP0) + method: PATCH + uri: https://myservice.azure.com/testruns/TEST_RUN_ID?api-version=2022-06-01-preview + response: + body: + string: '{}' + headers: + api-supported-versions: + - 2021-07-01-preview, 2022-06-01-preview + connection: + - keep-alive + content-length: + - '3675' + content-type: + - application/json; charset=utf-8 + date: + - Wed, 27 Jul 2022 08:20:14 GMT + mise-correlation-id: + - 9f63646f-7bc1-47c9-8a69-6bffb3b63471 + strict-transport-security: + - max-age=15724800; includeSubDomains + x-content-type-options: + - nosniff + status: + code: 200 + message: OK +version: 1 diff --git a/sdk/loadtestservice/azure-developer-loadtesting/tests/recordings/test_smoke.test_get_app_components.yaml b/sdk/loadtestservice/azure-developer-loadtesting/tests/recordings/test_smoke.test_get_app_components.yaml new file mode 100644 index 000000000000..9074da490b72 --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/tests/recordings/test_smoke.test_get_app_components.yaml @@ -0,0 +1,74 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - azsdk-python-developer-loadtesting/1.0.0b1 Python/3.8.8 (Windows-10-10.0.19041-SP0) + method: GET + uri: https://myservice.azure.com/appcomponents?api-version=2022-06-01-preview&testId=TEST_ID + response: + body: + string: '{"resourceId":"/subscriptions/SUBSCRIPTION_ID/resourcegroups/python-sdk-test/providers/microsoft.loadtestservice/loadtests/loadtest-jf","testId":"TEST_ID","testRunId":null,"name":"APP_COMPONENT","value":{"/subscriptions/SUBSCRIPTION_ID/resourceGroups/App-Service-Sample-Demo-rg/providers/Microsoft.Web/sites/App-Service-Sample-Demo":{"resourceId":"/subscriptions/SUBSCRIPTION_ID/resourceGroups/App-Service-Sample-Demo-rg/providers/Microsoft.Web/sites/App-Service-Sample-Demo","resourceName":"App-Service-Sample-Demo","resourceType":"Microsoft.Web/sites","displayName":null,"resourceGroup":"App-Service-Sample-Demo-rg","subscriptionId":"SUBSCRIPTION_ID","kind":null}}}' + headers: + api-supported-versions: + - 2021-07-01-preview, 2022-06-01-preview + connection: + - keep-alive + content-length: + - '777' + content-type: + - application/json; charset=utf-8 + date: + - Wed, 27 Jul 2022 08:20:16 GMT + mise-correlation-id: + - 54e9e36b-7825-4cf1-b4e4-d19609d9a665 + strict-transport-security: + - max-age=15724800; includeSubDomains + x-content-type-options: + - nosniff + status: + code: 200 + message: OK +- request: + body: null + headers: + Accept: + - application/json + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + User-Agent: + - azsdk-python-developer-loadtesting/1.0.0b1 Python/3.8.8 (Windows-10-10.0.19041-SP0) + method: GET + uri: https://myservice.azure.com/appcomponents/APP_COMPONENT?api-version=2022-06-01-preview + response: + body: + string: '{"resourceId":"/subscriptions/SUBSCRIPTION_ID/resourcegroups/python-sdk-test/providers/microsoft.loadtestservice/loadtests/loadtest-jf","testId":"TEST_ID","testRunId":null,"name":"APP_COMPONENT","value":{"/subscriptions/SUBSCRIPTION_ID/resourceGroups/App-Service-Sample-Demo-rg/providers/Microsoft.Web/sites/App-Service-Sample-Demo":{"resourceId":"/subscriptions/SUBSCRIPTION_ID/resourceGroups/App-Service-Sample-Demo-rg/providers/Microsoft.Web/sites/App-Service-Sample-Demo","resourceName":"App-Service-Sample-Demo","resourceType":"Microsoft.Web/sites","displayName":null,"resourceGroup":"App-Service-Sample-Demo-rg","subscriptionId":"SUBSCRIPTION_ID","kind":null}}}' + headers: + api-supported-versions: + - 2021-07-01-preview, 2022-06-01-preview + connection: + - keep-alive + content-length: + - '777' + content-type: + - application/json; charset=utf-8 + date: + - Wed, 27 Jul 2022 08:20:17 GMT + mise-correlation-id: + - 5c56b7d9-9d51-4e4c-a1a0-6efa7db3c03e + strict-transport-security: + - max-age=15724800; includeSubDomains + x-content-type-options: + - nosniff + status: + code: 200 + message: OK +version: 1 diff --git a/sdk/loadtestservice/azure-developer-loadtesting/tests/recordings/test_smoke.test_smoke_create_or_update_test.yaml b/sdk/loadtestservice/azure-developer-loadtesting/tests/recordings/test_smoke.test_smoke_create_or_update_test.yaml new file mode 100644 index 000000000000..27da2dcdde81 --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/tests/recordings/test_smoke.test_smoke_create_or_update_test.yaml @@ -0,0 +1,46 @@ +interactions: +- request: + body: '{"resourceId": "/subscriptions/SUBSCRIPTION_ID/resourceGroups/yashika-rg/providers/Microsoft.LoadTestService/loadtests/loadtestsdk", + "description": "", "displayName": "TestingResource", "loadTestConfig": {"engineSize": + "m", "engineInstances": 1, "splitAllCSVs": false}, "secrets": {}, "environmentVariables": + {}, "passFailCriteria": {"passFailMetrics": {}}, "keyvaultReferenceIdentityType": + "SystemAssigned", "keyvaultReferenceIdentityId": null}' + headers: + Accept: + - application/json + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '466' + Content-Type: + - application/merge-patch+json + User-Agent: + - azsdk-python-developer-loadtesting/1.0.0b1 Python/3.8.8 (Windows-10-10.0.19041-SP0) + method: PATCH + uri: https://myservice.azure.com/loadtests/TEST_ID?api-version=2022-06-01-preview + response: + body: + string: '{}' + headers: + api-supported-versions: + - 2021-07-01-preview, 2022-06-01-preview + connection: + - keep-alive + content-length: + - '1127' + content-type: + - application/json; charset=utf-8 + date: + - Wed, 27 Jul 2022 08:20:19 GMT + mise-correlation-id: + - f139de97-8597-4065-9b9d-81b5d87b2aec + strict-transport-security: + - max-age=15724800; includeSubDomains + x-content-type-options: + - nosniff + status: + code: 200 + message: OK +version: 1 diff --git a/sdk/loadtestservice/azure-developer-loadtesting/tests/recordings/test_smoke.test_upload_test_file.yaml b/sdk/loadtestservice/azure-developer-loadtesting/tests/recordings/test_smoke.test_upload_test_file.yaml new file mode 100644 index 000000000000..5b7955c7f3bf --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/tests/recordings/test_smoke.test_upload_test_file.yaml @@ -0,0 +1,161 @@ +interactions: +- request: + body: "--b2f7f7d8e38b7c2ebe661cd7608c88d2\r\nContent-Disposition: form-data; name=\"file\"; + filename=\"sample.jmx\"\r\nContent-Type: application/octet-stream\r\n\r\n\r\n\r\n \r\n \r\n \r\n false\r\n + \ true\r\n false\r\n \r\n + \ \r\n \r\n + \ \r\n + \ \r\n \r\n \r\n \r\n \r\n + \ 10\r\n 0\r\n 180\r\n + \ 240\r\n 5\r\n \r\n \r\n + \ \r\n false\r\n + \ -1\r\n \r\n + \ continue\r\n + \ \r\n \r\n \r\n \r\n \r\n + \ \r\n app-service-sample-demo.azurewebsites.net\r\n + \ \r\n https\r\n \r\n + \ \r\n GET\r\n true\r\n + \ false\r\n + \ true\r\n false\r\n \r\n HttpClient4\r\n 60000\r\n 60000\r\n \r\n + \ \r\n \r\n \r\n \r\n + \ 10\r\n 50\r\n 180\r\n + \ \r\n \r\n + \ 50\r\n 50\r\n 240\r\n + \ \r\n \r\n \r\n + \ \r\n \r\n + \ false\r\n + \ \r\n saveConfig\r\n \r\n \r\n true\r\n + \ true\r\n true\r\n + \ \r\n true\r\n true\r\n + \ true\r\n true\r\n + \ false\r\n true\r\n + \ true\r\n false\r\n + \ false\r\n false\r\n + \ true\r\n false\r\n + \ false\r\n false\r\n + \ true\r\n + \ 0\r\n true\r\n + \ true\r\n true\r\n + \ true\r\n true\r\n + \ true\r\n \r\n \r\n + \ \r\n \r\n + \ \r\n \r\n + \ false\r\n + \ \r\n saveConfig\r\n \r\n \r\n true\r\n + \ true\r\n true\r\n + \ \r\n true\r\n true\r\n + \ true\r\n true\r\n + \ false\r\n true\r\n + \ true\r\n false\r\n + \ false\r\n false\r\n + \ true\r\n false\r\n + \ false\r\n false\r\n + \ true\r\n + \ 0\r\n true\r\n + \ true\r\n true\r\n + \ true\r\n true\r\n + \ true\r\n \r\n \r\n + \ \r\n \r\n + \ \r\n \r\n + \ false\r\n + \ \r\n saveConfig\r\n \r\n \r\n true\r\n + \ true\r\n true\r\n + \ \r\n true\r\n true\r\n + \ true\r\n true\r\n + \ false\r\n true\r\n + \ true\r\n false\r\n + \ false\r\n false\r\n + \ true\r\n false\r\n + \ false\r\n false\r\n + \ true\r\n + \ 0\r\n true\r\n + \ true\r\n true\r\n + \ true\r\n true\r\n + \ true\r\n \r\n \r\n + \ \r\n \r\n + \ \r\n \r\n \r\n + \ \r\n \r\n udv_webapp\r\n + \ ${__BeanShell( System.getenv("webapp") + )}\r\n Web App URL\r\n + \ =\r\n \r\n + \ \r\n \r\n \r\n \r\n + \ \r\n\r\n\r\n--b2f7f7d8e38b7c2ebe661cd7608c88d2--\r\n" + headers: + Accept: + - application/json + Accept-Encoding: + - gzip, deflate + Connection: + - keep-alive + Content-Length: + - '10320' + Content-Type: + - multipart/form-data; boundary=b2f7f7d8e38b7c2ebe661cd7608c88d2 + User-Agent: + - azsdk-python-developer-loadtesting/1.0.0b1 Python/3.8.8 (Windows-10-10.0.19041-SP0) + method: PUT + uri: https://myservice.azure.com/loadtests/TEST_ID/files/FILE_ID?api-version=2022-06-01-preview + response: + body: + string: '{"url":"https://stcntproddataeus.blob.core.windows.net/041c60a4-d25f-4102-b324-4f30261785e3/FILE_ID?sv=2020-04-08&se=2022-07-27T08%3A30%3A22Z&sr=b&sp=r&sig=wMK5eiIYYYKYeqhTSB6LLIlykWvTXzTw9j2r0l31a3Y%3D","fileId":"FILE_ID","filename":"sample.jmx","fileType":0,"expireTime":"2022-07-27T08:30:22.4468578","validationStatus":"VALIDATION_INITIATED"}' + headers: + api-supported-versions: + - 2021-07-01-preview, 2022-06-01-preview + connection: + - keep-alive + content-length: + - '377' + content-type: + - application/json; charset=utf-8 + date: + - Wed, 27 Jul 2022 08:20:22 GMT + location: + - https://myservice.azure.com/loadtests/TEST_ID/files/FILE_ID?resourceId=%2fsubscriptions%2fSUBSCRIPTION_ID%2fresourcegroups%2fpython-sdk-test%2fproviders%2fmicrosoft.loadtestservice%2floadtests%2floadtest-jf&api-version=2022-06-01-preview + mise-correlation-id: + - 1978540e-c9f2-4173-94e9-07b89ca54c59 + strict-transport-security: + - max-age=15724800; includeSubDomains + x-content-type-options: + - nosniff + status: + code: 201 + message: Created +version: 1 diff --git a/sdk/loadtestservice/azure-developer-loadtesting/tests/recordings/test_smoke_async.test_create_or_update_app_components.yaml b/sdk/loadtestservice/azure-developer-loadtesting/tests/recordings/test_smoke_async.test_create_or_update_app_components.yaml new file mode 100644 index 000000000000..d8c322df0845 --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/tests/recordings/test_smoke_async.test_create_or_update_app_components.yaml @@ -0,0 +1,34 @@ +interactions: +- request: + body: '{"name": "app_component", "testId": "TEST_ID", "value": {"/subscriptions/SUBSCRIPTION_ID/resourceGroups/App-Service-Sample-Demo-rg/providers/Microsoft.Web/sites/App-Service-Sample-Demo": + {"resourceId": "/subscriptions/SUBSCRIPTION_ID/resourceGroups/App-Service-Sample-Demo-rg/providers/Microsoft.Web/sites/App-Service-Sample-Demo", + "resourceName": "App-Service-Sample-Demo", "resourceType": "Microsoft.Web/sites", + "subscriptionId": "SUBSCRIPTION_ID"}}}' + headers: + Accept: + - application/json + Content-Length: + - '531' + Content-Type: + - application/merge-patch+json + User-Agent: + - azsdk-python-developer-loadtesting/1.0.0b1 Python/3.8.8 (Windows-10-10.0.19041-SP0) + method: PATCH + uri: https://myservice.azure.com/appcomponents/APP_COMPONENT?api-version=2022-06-01-preview + response: + body: + string: '{"resourceId":"/subscriptions/SUBSCRIPTION_ID/resourcegroups/python-sdk-test/providers/microsoft.loadtestservice/loadtests/loadtest-jf","testId":"TEST_ID","testRunId":null,"name":"APP_COMPONENT","value":{"/subscriptions/SUBSCRIPTION_ID/resourceGroups/App-Service-Sample-Demo-rg/providers/Microsoft.Web/sites/App-Service-Sample-Demo":{"resourceId":"/subscriptions/SUBSCRIPTION_ID/resourceGroups/App-Service-Sample-Demo-rg/providers/Microsoft.Web/sites/App-Service-Sample-Demo","resourceName":"App-Service-Sample-Demo","resourceType":"Microsoft.Web/sites","displayName":null,"resourceGroup":"App-Service-Sample-Demo-rg","subscriptionId":"SUBSCRIPTION_ID","kind":null}}}' + headers: + api-supported-versions: 2021-07-01-preview, 2022-06-01-preview + connection: keep-alive + content-length: '777' + content-type: application/json; charset=utf-8 + date: Wed, 27 Jul 2022 08:20:36 GMT + mise-correlation-id: f3528595-3cdb-4c20-841b-2f0b5665d3f4 + strict-transport-security: max-age=15724800; includeSubDomains + x-content-type-options: nosniff + status: + code: 200 + message: OK + url: https://946598fc-b4a7-4e07-8fbb-a68ca02a9f10.eus.cnt-prod.loadtesting.azure.com/appcomponents/01730263-6671-4216-b283?api-version=2022-06-01-preview +version: 1 diff --git a/sdk/loadtestservice/azure-developer-loadtesting/tests/recordings/test_smoke_async.test_get_app_components.yaml b/sdk/loadtestservice/azure-developer-loadtesting/tests/recordings/test_smoke_async.test_get_app_components.yaml new file mode 100644 index 000000000000..2fb728c4be1b --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/tests/recordings/test_smoke_async.test_get_app_components.yaml @@ -0,0 +1,27 @@ +interactions: +- request: + body: null + headers: + Accept: + - application/json + User-Agent: + - azsdk-python-developer-loadtesting/1.0.0b1 Python/3.8.8 (Windows-10-10.0.19041-SP0) + method: GET + uri: https://myservice.azure.com/appcomponents?api-version=2022-06-01-preview&testId=TEST_ID + response: + body: + string: '{"resourceId":"/subscriptions/SUBSCRIPTION_ID/resourcegroups/python-sdk-test/providers/microsoft.loadtestservice/loadtests/loadtest-jf","testId":"TEST_ID","testRunId":null,"name":"APP_COMPONENT","value":{"/subscriptions/SUBSCRIPTION_ID/resourceGroups/App-Service-Sample-Demo-rg/providers/Microsoft.Web/sites/App-Service-Sample-Demo":{"resourceId":"/subscriptions/SUBSCRIPTION_ID/resourceGroups/App-Service-Sample-Demo-rg/providers/Microsoft.Web/sites/App-Service-Sample-Demo","resourceName":"App-Service-Sample-Demo","resourceType":"Microsoft.Web/sites","displayName":null,"resourceGroup":"App-Service-Sample-Demo-rg","subscriptionId":"SUBSCRIPTION_ID","kind":null}}}' + headers: + api-supported-versions: 2021-07-01-preview, 2022-06-01-preview + connection: keep-alive + content-length: '777' + content-type: application/json; charset=utf-8 + date: Wed, 27 Jul 2022 08:20:38 GMT + mise-correlation-id: b318d708-64e6-4c1a-84db-7345df188cd2 + strict-transport-security: max-age=15724800; includeSubDomains + x-content-type-options: nosniff + status: + code: 200 + message: OK + url: https://946598fc-b4a7-4e07-8fbb-a68ca02a9f10.eus.cnt-prod.loadtesting.azure.com/appcomponents?api-version=2022-06-01-preview&testId=a011890b-0201-004d-010d +version: 1 diff --git a/sdk/loadtestservice/azure-developer-loadtesting/tests/recordings/test_smoke_async.test_smoke_create_or_update_test.yaml b/sdk/loadtestservice/azure-developer-loadtesting/tests/recordings/test_smoke_async.test_smoke_create_or_update_test.yaml new file mode 100644 index 000000000000..5e0bfd14149d --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/tests/recordings/test_smoke_async.test_smoke_create_or_update_test.yaml @@ -0,0 +1,35 @@ +interactions: +- request: + body: '{"resourceId": "/subscriptions/SUBSCRIPTION_ID/resourceGroups/yashika-rg/providers/Microsoft.LoadTestService/loadtests/loadtestsdk", + "description": "", "displayName": "TestingResource", "loadTestConfig": {"engineSize": + "m", "engineInstances": 1, "splitAllCSVs": false}, "secrets": {}, "environmentVariables": + {}, "passFailCriteria": {"passFailMetrics": {}}, "keyvaultReferenceIdentityType": + "SystemAssigned", "keyvaultReferenceIdentityId": null}' + headers: + Accept: + - application/json + Content-Length: + - '466' + Content-Type: + - application/merge-patch+json + User-Agent: + - azsdk-python-developer-loadtesting/1.0.0b1 Python/3.8.8 (Windows-10-10.0.19041-SP0) + method: PATCH + uri: https://myservice.azure.com/loadtests/TEST_ID?api-version=2022-06-01-preview + response: + body: + string: '{}' + headers: + api-supported-versions: 2021-07-01-preview, 2022-06-01-preview + connection: keep-alive + content-length: '1135' + content-type: application/json; charset=utf-8 + date: Wed, 27 Jul 2022 08:20:40 GMT + mise-correlation-id: c666d266-6acb-4569-b1c5-7685b904d0d8 + strict-transport-security: max-age=15724800; includeSubDomains + x-content-type-options: nosniff + status: + code: 200 + message: OK + url: https://946598fc-b4a7-4e07-8fbb-a68ca02a9f10.eus.cnt-prod.loadtesting.azure.com/loadtests/a011890b-0201-004d-010d?api-version=2022-06-01-preview +version: 1 diff --git a/sdk/loadtestservice/azure-developer-loadtesting/tests/sample.jmx b/sdk/loadtestservice/azure-developer-loadtesting/tests/sample.jmx new file mode 100644 index 000000000000..02446fe5f0a8 --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/tests/sample.jmx @@ -0,0 +1,192 @@ + + + + + + false + true + false + + + + + + + + + + 10 + 0 + 180 + 240 + 5 + + + + false + -1 + + continue + + + + + + + app-service-sample-demo.azurewebsites.net + + https + + + GET + true + false + true + false + + HttpClient4 + 60000 + 60000 + + + + + + 10 + 50 + 180 + + + 50 + 50 + 240 + + + + + + false + + saveConfig + + + true + true + true + + true + true + true + true + false + true + true + false + false + false + true + false + false + false + true + 0 + true + true + true + true + true + true + + + + + + + false + + saveConfig + + + true + true + true + + true + true + true + true + false + true + true + false + false + false + true + false + false + false + true + 0 + true + true + true + true + true + true + + + + + + + false + + saveConfig + + + true + true + true + + true + true + true + true + false + true + true + false + false + false + true + false + false + false + true + 0 + true + true + true + true + true + true + + + + + + + + + + udv_webapp + ${__BeanShell( System.getenv("webapp") )} + Web App URL + = + + + + + + + diff --git a/sdk/loadtestservice/azure-developer-loadtesting/tests/test_smoke.py b/sdk/loadtestservice/azure-developer-loadtesting/tests/test_smoke.py new file mode 100644 index 000000000000..634b9545b8bc --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/tests/test_smoke.py @@ -0,0 +1,90 @@ +# 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. +# ------------------------------------------------------------------------- +import os +from pathlib import Path + +from testcase import LoadtestingTest, LoadtestingPowerShellPreparer + +DISPLAY_NAME = "TestingResource" + + +class LoadtestingSmokeTest(LoadtestingTest): + @LoadtestingPowerShellPreparer() + def test_smoke_create_or_update_test(self, loadtesting_endpoint): + client = self.create_client(endpoint=loadtesting_endpoint) + result = client.load_test_administration.create_or_update_test( + self.test_id, + { + "resourceId": f"/subscriptions/{self.subscription_id}/resourceGroups/yashika-rg/providers/Microsoft.LoadTestService/loadtests/loadtestsdk", + "description": "", + "displayName": DISPLAY_NAME, + "loadTestConfig": { + "engineSize": "m", + "engineInstances": 1, + "splitAllCSVs": False, + }, + "secrets": {}, + "environmentVariables": {}, + "passFailCriteria": {"passFailMetrics": {}}, + "keyvaultReferenceIdentityType": "SystemAssigned", + "keyvaultReferenceIdentityId": None, + }, + ) + assert result is not None + + @LoadtestingPowerShellPreparer() + def test_upload_test_file(self, loadtesting_endpoint): + client = self.create_client(endpoint=loadtesting_endpoint) + result = client.load_test_administration.upload_test_file( + self.test_id, self.file_id, open(os.path.join(Path(__file__).resolve().parent, "sample.jmx"), "rb") + ) + assert result is not None + + @LoadtestingPowerShellPreparer() + def test_create_or_update_app_components(self, loadtesting_endpoint): + client = self.create_client(endpoint=loadtesting_endpoint) + result = client.load_test_administration.create_or_update_app_components( + self.app_component, + { + "name": "app_component", + "testId": self.test_id, + "value": { + f"/subscriptions/{self.subscription_id}/resourceGroups/App-Service-Sample-Demo-rg/providers/Microsoft.Web/sites/App-Service-Sample-Demo": { + "resourceId": f"/subscriptions/{self.subscription_id}/resourceGroups/App-Service-Sample-Demo-rg/providers/Microsoft.Web/sites/App-Service-Sample-Demo", + "resourceName": "App-Service-Sample-Demo", + "resourceType": "Microsoft.Web/sites", + "subscriptionId": self.subscription_id, + } + }, + }, + ) + assert result is not None + + @LoadtestingPowerShellPreparer() + def test_create_or_update_test_run(self, loadtesting_endpoint): + client = self.create_client(endpoint=loadtesting_endpoint) + result = client.load_test_runs.create_or_update_test( + self.test_run_id, + { + "testId": self.test_id, + "displayName": DISPLAY_NAME, + "requestSamplers": [], + "errors": [], + "percentiles": ["90"], + "groupByInterval": "5s", + }, + ) + assert result is not None + + @LoadtestingPowerShellPreparer() + def test_get_app_components(self, loadtesting_endpoint): + client = self.create_client(endpoint=loadtesting_endpoint) + result = client.load_test_administration.get_app_components(test_id=self.test_id) + assert result is not None + + result = client.load_test_administration.get_app_components(name=self.app_component) + assert result is not None diff --git a/sdk/loadtestservice/azure-developer-loadtesting/tests/test_smoke_async.py b/sdk/loadtestservice/azure-developer-loadtesting/tests/test_smoke_async.py new file mode 100644 index 000000000000..5cf10bd4a925 --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/tests/test_smoke_async.py @@ -0,0 +1,65 @@ +# 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. +# ------------------------------------------------------------------------- +from testcase import LoadtestingPowerShellPreparer +from testcase_async import LoadtestingAsyncTest +import os + +DISPLAY_NAME = "TestingResource" # display name + + +class LoadtestingSmokeAsyncTest(LoadtestingAsyncTest): + @LoadtestingPowerShellPreparer() + async def test_smoke_create_or_update_test(self, loadtesting_endpoint): + client = self.create_client(endpoint=loadtesting_endpoint) + result = await client.load_test_administration.create_or_update_test( + self.test_id, + { + "resourceId": f"/subscriptions/{self.subscription_id}/resourceGroups/yashika-rg/providers/Microsoft.LoadTestService/loadtests/loadtestsdk", + "description": "", + "displayName": DISPLAY_NAME, + "loadTestConfig": { + "engineSize": "m", + "engineInstances": 1, + "splitAllCSVs": False, + }, + "secrets": {}, + "environmentVariables": {}, + "passFailCriteria": {"passFailMetrics": {}}, + "keyvaultReferenceIdentityType": "SystemAssigned", + "keyvaultReferenceIdentityId": None, + }, + ) + assert result is not None + + @LoadtestingPowerShellPreparer() + async def test_create_or_update_app_components(self, loadtesting_endpoint): + client = self.create_client(endpoint=loadtesting_endpoint) + result = await client.load_test_administration.create_or_update_app_components( + self.app_component, + { + "name": "app_component", + "testId": self.test_id, + "value": { + f"/subscriptions/{self.subscription_id}/resourceGroups/App-Service-Sample-Demo-rg/providers/Microsoft.Web/sites/App-Service-Sample-Demo": { + "resourceId": f"/subscriptions/{self.subscription_id}/resourceGroups/App-Service-Sample-Demo-rg/providers/Microsoft.Web/sites/App-Service-Sample-Demo", + "resourceName": "App-Service-Sample-Demo", + "resourceType": "Microsoft.Web/sites", + "subscriptionId": self.subscription_id, + } + }, + }, + ) + assert result is not None + + @LoadtestingPowerShellPreparer() + async def test_get_app_components(self, loadtesting_endpoint): + client = self.create_client(endpoint=loadtesting_endpoint) + result = await client.load_test_administration.get_app_components(test_id=self.test_id) + assert result is not None + + result = client.load_test_administration.get_app_components(name=self.app_component) + assert result is not None diff --git a/sdk/loadtestservice/azure-developer-loadtesting/tests/testcase.py b/sdk/loadtestservice/azure-developer-loadtesting/tests/testcase.py new file mode 100644 index 000000000000..e9ff4e477fbc --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/tests/testcase.py @@ -0,0 +1,46 @@ +# 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. +# -------------------------------------------------------------------------- +import os +import functools +from devtools_testutils import AzureTestCase, PowerShellPreparer +from azure.developer.loadtesting import LoadTestingClient + +class LoadtestingTest(AzureTestCase): + def __init__(self, method_name, **kwargs): + super(LoadtestingTest, self).__init__(method_name, **kwargs) + + self.test_id = "TEST_ID" # ID to be assigned to a test + self.file_id = "FILE_ID" # ID to be assigned to file uploaded + self.test_run_id = "TEST_RUN_ID" # ID to be assigned to a test run + self.app_component = "APP_COMPONENT" # ID of the APP Component + self.subscription_id = "SUBSCRIPTION_ID" + + if self.is_live: + self.test_id = os.getenv("TEST_ID") + self.file_id = os.getenv("FILE_ID") + self.test_run_id = os.getenv("TEST_RUN_ID") + self.app_component = os.getenv("APP_COMPONENT") + self.subscription_id = os.getenv("SUBSCRIPTION_ID") + + self.scrubber.register_name_pair(self.test_id, "TEST_ID") + self.scrubber.register_name_pair(self.file_id, "FILE_ID") + self.scrubber.register_name_pair(self.test_run_id, "TEST_RUN_ID") + self.scrubber.register_name_pair(self.app_component, "APP_COMPONENT") + self.scrubber.register_name_pair(self.subscription_id, "SUBSCRIPTION_ID") + + def create_client(self, endpoint): + credential = self.get_credential(LoadTestingClient) + return self.create_client_from_credential( + LoadTestingClient, + credential=credential, + endpoint=endpoint, + ) + + +LoadtestingPowerShellPreparer = functools.partial( + PowerShellPreparer, "loadtesting", loadtesting_endpoint="https://myservice.azure.com" +) diff --git a/sdk/loadtestservice/azure-developer-loadtesting/tests/testcase_async.py b/sdk/loadtestservice/azure-developer-loadtesting/tests/testcase_async.py new file mode 100644 index 000000000000..88268102875b --- /dev/null +++ b/sdk/loadtestservice/azure-developer-loadtesting/tests/testcase_async.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. +# -------------------------------------------------------------------------- +from azure.developer.loadtesting.aio import LoadTestingClient +from testcase import LoadtestingTest + +class LoadtestingAsyncTest(LoadtestingTest): + def __init__(self, method_name, **kwargs): + super(LoadtestingAsyncTest, self).__init__(method_name, **kwargs) + + + def create_client(self, endpoint): + credential = self.get_credential(LoadTestingClient, is_async=True) + return self.create_client_from_credential( + LoadTestingClient, + credential=credential, + endpoint=endpoint, + ) diff --git a/sdk/loadtestservice/azure-mgmt-loadtestservice/azure/mgmt/loadtestservice/dev_requirements.txt b/sdk/loadtestservice/azure-mgmt-loadtestservice/azure/mgmt/loadtestservice/dev_requirements.txt new file mode 100644 index 000000000000..5f7c4806ade8 --- /dev/null +++ b/sdk/loadtestservice/azure-mgmt-loadtestservice/azure/mgmt/loadtestservice/dev_requirements.txt @@ -0,0 +1,5 @@ +-e ../../../tools/azure-devtools +-e ../../../tools/azure-sdk-tools +../../core/azure-core +../../identity/azure-identity +aiohttp diff --git a/sdk/loadtestservice/ci.yml b/sdk/loadtestservice/ci.yml index 171ec2bf8b6f..be1f32ebcf64 100644 --- a/sdk/loadtestservice/ci.yml +++ b/sdk/loadtestservice/ci.yml @@ -31,3 +31,5 @@ extends: Artifacts: - name: azure-mgmt-loadtestservice safeName: azuremgmtloadtestservice + - name: azure-developer-loadtesting + safeName: azuredeveloperloadtesting diff --git a/shared_requirements.txt b/shared_requirements.txt index a37446f45de1..87f1f80fb827 100644 --- a/shared_requirements.txt +++ b/shared_requirements.txt @@ -395,6 +395,8 @@ opentelemetry-sdk<2.0.0,>=1.5.0,!=1.10a0 #override azure-mgmt-automation msrest>=0.6.21 #override azure-mgmt-automation azure-mgmt-core>=1.3.1,<2.0.0 #override azure-mgmt-rdbms azure-mgmt-core>=1.3.1,<2.0.0 +#override azure-developer-loadtesting azure-core<2.0.0,>=1.24.0 +#override azure-developer-loadtesting isodate<1.0.0,>=0.6.1 #override azure-mgmt-datalake-analytics msrest>=0.6.21 #override azure-mgmt-datalake-analytics azure-mgmt-core>=1.3.1,<2.0.0 #override azure-mgmt-recoveryservices msrest>=0.6.21