Azure · lmazuel · Oct 20, 2022 · Jun 6, 2022 · Jun 6, 2022 · Jun 8, 2022
@@ -1,5 +1,14 @@
 # Release History
 
+## 1.0.0b2 (2022-10-17)
+
+### Bug Fixed 
+- `delete_app_components` method from `azure.developer.loadtesting.LoadTestingClient.load_test_administration.delete_app_components` was not discoverable in expected location, fixed discoverability.
+
+### Other Changes
+- Updated README
+
 ## 1.0.0b1 (2022-07-28)
 
+### Features Added
 - Initial version
@@ -1,11 +1,17 @@
 
-# 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.
+# Azure Load Testing client library for Python
+Azure Load Testing provides client library in python to the user by which they can interact natively with Azure Load Testing service. Azure Load Testing is a fully managed load-testing service that enables you to generate high-scale load. The service simulates traffic for your applications, regardless of where they're hosted. Developers, testers, and quality assurance (QA) engineers can use it to optimize application performance, scalability, or capacity.
 
+## Documentation
+Various documentation is available to help you get started
+
+<!-- - [Source code][source_code] -->
+- [API reference documentation][api_reference_doc]
+- [Product Documentation][product_documentation]
 
 ## Getting started
 
-### Installating the package
+### Installing the package
 
 ```bash
 python -m pip install azure-developer-loadtesting
@@ -16,26 +22,90 @@ python -m pip install azure-developer-loadtesting
 - 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`
+As an example, sign in via the Azure CLI `az login` command and [DefaultAzureCredential](https://learn.microsoft.com/python/api/azure-identity/azure.identity.defaultazurecredential?view=azure-python) will authenticate as that user.
+
+Use the returned token credential to authenticate the client.
 
-Use the returned token credential to authenticate the client:
+#### Create the client
+
+The data plane URI should be provided as the endpoint to create the client. 
 
 ```python
 from azure.developer.loadtesting import LoadTestingClient
+
+# for managing authentication and authorization
+# can be installed from pypi, follow: https://pypi.org/project/azure-identity/
+# using DefaultAzureCredentials, read more at: https://learn.microsoft.com/en-us/python/api/azure-identity/azure.identity.defaultazurecredential?view=azure-python
 from azure.identity import DefaultAzureCredential
+
 client = LoadTestingClient(endpoint='<endpoint>', credential=DefaultAzureCredential())
 ```
+## Key concepts
+
+The following components make up te 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 clients. There are two top-level clients which are the main entry points for the library
+
+- `LoadTestingClient` (`azure.developer.loadtesting.LoadTestingClient`)
+
+- Async `LoadTestingClient` (`azure.developer.loadtesting.aio.LoadTestingClient`)
+
+The two clients have similar methods in them except the methods in the async client are async as well.
+
+The top-level clients have two sub-clients
+
+- `load_test_runs` (`azure.developer.loadtesting.LoadTestingClient.load_test_runs`)
+
+- `load_test_administration` (`azure.developer.loadtesting.LoadTestingClient.load_test_administration`)
+
+These sub-clients are used for managing and using different components of the service.
+
+### Load Test Administration Client
+
+The `load_test_administration` sub-clients is used to administer and configure the load tests, app components and metrics.
+
+#### 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.
+
+#### 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.
+
+### Test Run Client
+
+The `load_test_runs` sub-clients is used to start and stop test runs corresponding to a load test. 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.
+
+### Data-Plane Endpoint
+
+Data-plane of Azure Load Testing resources is addressable using the following URL format:
+
+`00000000-0000-0000-0000-000000000000.aaa.cnt-prod.loadtesting.azure.com`
+
+The first GUID `00000000-0000-0000-0000-000000000000` is the unique identifier used for accessing the Azure Load Testing resource. This is followed by  `aaa` which is the Azure region of the resource.
+
+The data-plane endpoint is obtained from Control Plane APIs.
+
+**Example:** `1234abcd-12ab-12ab-12ab-123456abcdef.eus.cnt-prod.loadtesting.azure.com`
+
+In the above example, `eus` represents the Azure region `East US`.
 
 ## Examples
 
@@ -46,7 +116,7 @@ from azure.identity import DefaultAzureCredential
 from azure.core.exceptions import HttpResponseError
 
 TEST_ID = "some-test-id"  
-DISPLAY_NAME = "new_namespace-new-namespace"  
+DISPLAY_NAME = "my-load-test"  
 SUBSCRIPTION_ID = os.environ["SUBSCRIPTION_ID"]  
 
 client = LoadTestingClient(endpoint='<endpoint>', credential=DefaultAzureCredential())
@@ -55,24 +125,20 @@ 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,
+            "passFailCriteria": {"passFailMetrics": {}}
         },
     )
     print(result)
 except HttpResponseError as e:
-     print('service responds error: {}'.format(e.response.json()))
+     print('Service responded with error: {}'.format(e.response.json()))
 
 ```
 
@@ -92,7 +158,7 @@ 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()))
+    print("Failed with error: {}".format(e.response.json()))
 ```
 
 ### Running a Test
@@ -103,57 +169,26 @@ from azure.core.exceptions import HttpResponseError
 
 TEST_ID = "some-test-id"  
 TEST_RUN_ID = "some-testrun-id" 
-DISPLAY_NAME = "new_namespace-new-namespace"  
+DISPLAY_NAME = "my-load-test-run"  
 
 client = LoadTestingClient(endpoint='<endpoint>', credential=DefaultAzureCredential())
 
 try:
-    result = client.load_test_runs.create_and_update_test(
+    result = client.load_test_runs.create_or_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()))
+    print("Failed with error: {}".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...
+More samples can be found [here](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/loadtestservice/azure-developer-loadtesting/samples).
 
 ## Contributing
 
@@ -172,6 +207,9 @@ This project has adopted the
 see the Code of Conduct FAQ or contact [email protected] with any
 additional questions or comments.
 
+## Troubleshooting
+More about it is coming soon...
+
 <!-- LINKS -->
 [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
@@ -180,3 +218,5 @@ additional questions or comments.
 [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/
+[api_reference_doc]: https://docs.microsoft.com/rest/api/loadtesting/
+[product_documentation]: https://azure.microsoft.com/services/load-testing/
@@ -45,7 +45,7 @@ def __init__(self, endpoint: str, credential: "TokenCredential", **kwargs: Any)
         self.endpoint = endpoint
         self.credential = credential
         self.api_version = api_version
-        self.credential_scopes = kwargs.pop("credential_scopes", ["https://loadtest.azure-dev.com/.default"])
+        self.credential_scopes = kwargs.pop("credential_scopes", ["https://cnt-prod.loadtesting.azure.com/.default"])
         kwargs.setdefault("sdk_moniker", "developer-loadtesting/{}".format(VERSION))
         self._configure(**kwargs)
 

@@ -6,4 +6,4 @@
 # Changes may cause incorrect behavior and will be lost if the code is regenerated.
 # --------------------------------------------------------------------------
 
-VERSION = "1.0.0b1"
+VERSION = "1.0.0b2"
@@ -45,7 +45,7 @@ def __init__(self, endpoint: str, credential: "AsyncTokenCredential", **kwargs:
         self.endpoint = endpoint
         self.credential = credential
         self.api_version = api_version
-        self.credential_scopes = kwargs.pop("credential_scopes", ["https://loadtest.azure-dev.com/.default"])
+        self.credential_scopes = kwargs.pop("credential_scopes", ["https://cnt-prod.loadtesting.azure.com/.default"])
         kwargs.setdefault("sdk_moniker", "developer-loadtesting/{}".format(VERSION))
         self._configure(**kwargs)
 

@@ -6,9 +6,7 @@
 
 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 typing import Any, IO, Optional, Union, cast, overload, List, MutableMapping, Coroutine, BinaryIO, Awaitable
 from azure.core.exceptions import (
     ClientAuthenticationError,
     HttpResponseError,
@@ -95,14 +93,14 @@ class AppComponentOperations:
     def __init__(self, *args, **kwargs):
         self.__app_component_operations_generated = AppComponentOperationsGenerated(*args, **kwargs)
 
-    def get_app_components(
+    async 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]]:
+    ) -> 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.
@@ -150,14 +148,14 @@ def get_app_components(
         """
 
         if name is not None:
-            return self.__app_component_operations_generated.get_app_component_by_name(name=name, **kwargs)
+            return await self.__app_component_operations_generated.get_app_component_by_name(name=name, **kwargs)
         else:
-            return self.__app_component_operations_generated.get_app_component(
+            return await 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(
+    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.
@@ -233,7 +231,7 @@ def create_or_update_app_components(
         """
 
     @overload
-    def create_or_update_app_components(
+    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.
@@ -283,7 +281,9 @@ def create_or_update_app_components(
         """
 
     @distributed_trace
-    def create_or_update_app_components(self, name: str, body: Union[JSON, IO], **kwargs: Any) -> JSON:
+    async def create_or_update_app_components(
+        self, name: str, body: Union[JSON, IO], **kwargs: Any
+    ) -> MutableMapping[str, Any]:
         """Associate an App Component (Azure resource) to a test or test run.
 
         Associate an App Component (Azure resource) to a test or test run.
@@ -329,25 +329,25 @@ def create_or_update_app_components(self, name: str, body: Union[JSON, IO], **kw
                     }
                 }
         """
-        return self.__app_component_operations_generated.create_or_update_app_components(name, body, **kwargs)
+        return await 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.
+    @distributed_trace
+    async def delete_app_components(  # pylint: disable=inconsistent-return-statements
+        self, name: str, **kwargs: Any
+    ) -> None:
+        """Delete an App Component.
 
-            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:
-            """
+        :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)
+        return await self.__app_component_operations_generated.delete_app_components(name, **kwargs)
 
 
 __all__: List[str] = ["TestOperations", "AppComponentOperations"]