Skip to content

Commit ecf14f6

Browse files
[Azure.Developer.LoadTesting] Updated SDK for API Version 2024-05-01-preview (Azure#47655)
Updated SDK for Azure.Developer.LoadTesting to API version 2024-05-01-preview
1 parent e270422 commit ecf14f6

File tree

166 files changed

+24003
-4837
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

166 files changed

+24003
-4837
lines changed

.github/CODEOWNERS

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -590,10 +590,10 @@
590590
# ServiceOwners: @Tanmayeekamath
591591

592592
# PRLabel: %Load Test Service
593-
/sdk/loadtestservice/ @abranj1219 @ninallam @christothes
593+
/sdk/loadtestservice/ @prativen @mitsha-microsoft @ninallam
594594

595595
# ServiceLabel: %Load Test Service
596-
# ServiceOwners: @abranj1219 @ninallam
596+
# ServiceOwners: @prativen @mitsha-microsoft @ninallam
597597

598598
# ServiceLabel: %Logic App
599599
# ServiceOwners: @Azure/azure-logicapps-team
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
**/*.jmx binary

sdk/loadtestservice/Azure.Developer.LoadTesting/CHANGELOG.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,21 @@
11
# Release History
22

3-
## 1.1.0-beta.1 (Unreleased)
3+
## 1.2.0-beta.1 (2025-04-15)
44

55
### Features Added
66

7-
### Breaking Changes
8-
9-
### Bugs Fixed
10-
11-
### Other Changes
7+
- Added capabilities to support all changes present in Azure Load Testing API Version 2024-05-01-preview
8+
- This release adds all the models for all the APIs supported by Azure Load Testing. Relevant new client method overloads are also added to work with these new methods
9+
- Added support for the following features:
10+
- Support for specifying AutoStopCriteria for LoadTests
11+
- Support for Quick Load Tests with `RequestsPerSecond` input
12+
- Support for URL Tests with JSON Based Test Plans and Locust Tests using the `TestKind` field
13+
- Support for multi region load tests to generate load from multiple regions
14+
- Support for disabling Public IP Deployment for Private Load Tests using the `publicIpDisabled` field
15+
- Support for uploading Zipped Artifacts as test input artifacts
16+
- Added Client Methods to work with `TestProfiles` and `TestProfileRuns`
17+
- Added methods `CreateOrUpdateTestProfile`, `GetTestProfile`, `DeleteTestProfile` and `GetTestProfiles` along with their async variants to work with test profiles
18+
- Added methods `BeginTestProfileRun`, `GetTestProfileRun`, `DeleteTestProfileRun` and `GetTestProfileRuns` along with their async variants to work with test profile runs
1219

1320
## 1.0.2 (2025-01-20)
1421

sdk/loadtestservice/Azure.Developer.LoadTesting/README.md

Lines changed: 55 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,31 @@
11
# Azure Load Testing client library for .NET
2+
23
Azure Load Testing provides client library in .NET 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.
34

4-
[Source code](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/loadtestservice/Azure.Developer.LoadTesting/src) | [Package (NuGet)](https://www.nuget.org/packages?q=Azure.Developer.Loadtesting) | [API reference documentation](https://azure.github.io/azure-sdk-for-net) | [Product documentation](https://learn.microsoft.com/azure/load-testing/)
5+
[Source code][source_code] | [Package (NuGet)][nuget_package] | [API reference documentation][sdk_api_reference] | [Product documentation](https://learn.microsoft.com/azure/load-testing/)
56

67

78
## Documentation
89

910
Various documentation is available to help you get started
1011

11-
<!-- - [Source code][source_code] -->
12-
- [API reference documentation](https://learn.microsoft.com/rest/api/loadtesting/)
12+
- [Source code][source_code]
13+
- [REST API reference documentation](https://learn.microsoft.com/rest/api/loadtesting/)
1314
- [Product Documentation](https://azure.microsoft.com/services/load-testing/)
1415

1516
## Getting started
1617

17-
1818
### Install the package
1919

20-
Install the client library for .NET with [NuGet](https://www.nuget.org/ ):
20+
Install the client library for .NET with [NuGet](https://www.nuget.org/):
2121

2222
```dotnetcli
2323
dotnet add package Azure.Developer.LoadTesting
2424
```
2525

2626
### Prerequisites
27-
You must have an [Azure subscription](https://azure.microsoft.com/free/dotnet/) and [Azure Load Test Service Resource](https://learn.microsoft.com/azure/load-testing/). In order to take advantage of the C# 8.0 syntax, it is recommended that you compile using the [.NET Core SDK](https://dotnet.microsoft.com/download) 3.0 or higher with a [language version](https://learn.microsoft.com/dotnet/csharp/language-reference/configure-language-version#override-a-default) of `latest`. It is also possible to compile with the .NET Core SDK 2.1.x using a language version of `preview`.
27+
28+
You must have an [Azure subscription](https://azure.microsoft.com/free/dotnet/) and [Azure Load Test Service Resource](https://learn.microsoft.com/azure/load-testing/) to use this package. You can create the resource via the [Azure Portal](https://portal.azure.com), or the [Azure CLI](https://learn.microsoft.com/cli/azure).
2829

2930

3031
### Authenticate the client
@@ -49,7 +50,7 @@ The following components make up the Azure Load Testing service. The Azure Load
4950

5051
- `LoadTestRunClient`
5152

52-
These clients are used for managing and using different components of the service. For each method in both of these sub-clients there is a corresponding Async method in the same class, with the same implementation however enabling async functionalities. For example, if there is a method, `CreateOrUpdateTest` as a part of `LoadTestAdministrationClient` then there always exists one more function `CreateOrUpdateTestAsync` in the same client class.
53+
These clients are used for managing and using different components of the service. For each method in both of these sub-clients there is a corresponding Async method in the same class, with the same implementation however enabling async functionalities. For example, if there is a method, `CreateOrUpdateTest` as a part of `LoadTestAdministrationClient` then there always exists one more method `CreateOrUpdateTestAsync` in the same client class.
5354

5455
### Load Test Administration Client
5556

@@ -73,7 +74,7 @@ During a load test, Azure Load Testing collects metrics about the test execution
7374

7475
### Test Run Client
7576

76-
The `LoadTestRunClient` client 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.
77+
The `LoadTestRunClient` client 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 test script, the load test configuration, the list of app components to monitor, and the results of the test.
7778

7879
### Data-Plane Endpoint
7980

@@ -83,50 +84,72 @@ Data-plane of Azure Load Testing resources is addressable using the following UR
8384

8485
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.
8586

86-
The data-plane endpoint is obtained from Control Plane APIs.
87+
The data-plane endpoint is obtained from Control Plane APIs. To obtain the data-plane endpoint for your resource, follow [this documentation][obtaining_data_plane_uri].
88+
89+
**Example:** `1234abcd-12ab-12ab-12ab-123456abcdef.eastus.cnt-prod.loadtesting.azure.com`
90+
91+
In the above example, `eastus` represents the Azure region `East US`.
92+
93+
### Thread Safety
94+
95+
We guarantee that all client instance methods are thread-safe and independent of each other ([guideline](https://azure.github.io/azure-sdk/dotnet_introduction.html#dotnet-service-methods-thread-safety)). This ensures that the recommendation of reusing client instances is always safe, even across threads.
96+
97+
### Additional concepts
98+
<!-- CLIENT COMMON BAR -->
99+
[Client options](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#configuring-service-clients-using-clientoptions) |
100+
[Accessing the response](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#accessing-http-response-details-using-responset) |
101+
[Long-running operations](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#consuming-long-running-operations-using-operationt) |
102+
[Handling failures](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#reporting-errors-requestfailedexception) |
103+
[Diagnostics](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/Diagnostics.md) |
104+
[Mocking](https://learn.microsoft.com/dotnet/azure/sdk/unit-testing-mocking) |
105+
[Client lifetime](https://devblogs.microsoft.com/azure-sdk/lifetime-management-and-thread-safety-guarantees-of-azure-sdk-net-clients/)
106+
<!-- CLIENT COMMON BAR -->
87107

88-
**Example:** `1234abcd-12ab-12ab-12ab-123456abcdef.eus.cnt-prod.loadtesting.azure.com`
89108

90-
In the above example, `eus` represents the Azure region `East US`.
91109
## Examples
92110

93111
You can familiarize yourself with different APIs using [Samples](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/loadtestservice/Azure.Developer.LoadTesting/samples).
94112

95-
96113
## Troubleshooting
97-
More about it is coming soon...
98114

115+
### Setting up console logging
99116

100-
### Thread safety
117+
The simplest way to see the logs is to enable the console logging. To create an Azure SDK log listener that outputs messages to the console, use `AzureEventSourceListener.CreateConsoleLogger` method.
101118

102-
We guarantee that all client instance methods are thread-safe and independent of each other ([guideline](https://azure.github.io/azure-sdk/dotnet_introduction.html#dotnet-service-methods-thread-safety)). This ensures that the recommendation of reusing client instances is always safe, even across threads.
119+
```cs
120+
// Setup a listener to monitor logged events.
121+
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger();
122+
```
123+
124+
To learn more about other logging mechanisms see [here][azure_core_diagnostics].
103125

104126
## Next steps
105127

106-
Get started with our [samples](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/loadtestservice/Azure.Developer.LoadTesting/samples).
128+
For more extensive documentation on Azure Load Testing, see the [Azure Load Testing documentation][product_documentation].
129+
130+
Get started with our [samples](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/loadtestservice/Azure.Developer.LoadTesting/samples) that cover common scenarios.
107131

108132
## Contributing
109133

110-
This is a template, but your SDK readme should include details on how to contribute code to the repo/package.
134+
See the [CONTRIBUTING.md](https://github.com/Azure/azure-sdk-for-net/blob/main/CONTRIBUTING.md) file for information about how to onboard and contribute to the overall Azure SDK ecosystem.
135+
136+
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 [cla.microsoft.com][cla].
137+
138+
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.
139+
140+
This project has adopted the [Microsoft Open Source Code of Conduct][code_of_conduct]. For more information see the [Code of Conduct FAQ][code_of_conduct_faq] or contact [[email protected]][email_opencode] with any additional questions or comments.
111141

112-
### Additional concepts
113-
<!-- CLIENT COMMON BAR -->
114-
[Client options](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#configuring-service-clients-using-clientoptions) |
115-
[Accessing the response](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#accessing-http-response-details-using-responset) |
116-
[Long-running operations](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#consuming-long-running-operations-using-operationt) |
117-
[Handling failures](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#reporting-errors-requestfailedexception) |
118-
[Diagnostics](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/Diagnostics.md) |
119-
[Mocking](https://learn.microsoft.com/dotnet/azure/sdk/unit-testing-mocking) |
120-
[Client lifetime](https://devblogs.microsoft.com/azure-sdk/lifetime-management-and-thread-safety-guarantees-of-azure-sdk-net-clients/)
121-
<!-- CLIENT COMMON BAR -->
122142

123143
<!-- LINKS -->
124-
<!-- LINKS -->
125-
<!-- [source_code]: https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/loadtesting/azure-developer-loadtesting/src -->
126-
<!-- [sample_code]: https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/loadtesting/azure-developer-loadtesting/src/samples -->
144+
[source_code]: https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/loadtestservice/Azure.Developer.LoadTesting/src
145+
[nuget_package]: https://www.nuget.org/packages/Azure.Developer.LoadTesting
146+
[sdk_api_reference]: https://azure.github.io/azure-sdk-for-net/loadtesting.html
127147
[style-guide-msft]: https://learn.microsoft.com/style-guide/capitalization
128148
[style-guide-cloud]: https://aka.ms/azsdk/cloud-style-guide
129149
[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/
150+
[cla]: https://cla.microsoft.com
151+
[code_of_conduct_faq]: https://opensource.microsoft.com/codeofconduct/faq/
152+
[email_opencode]: mailto:[email protected]
130153
[authenticate_with_token]: https://learn.microsoft.com/aspnet/core/security/authentication/identity
131154
[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/identity/Azure.Identity#credentials
132155
[azure_identity_nuget]: https://www.nuget.org/packages/Azure.Identity/1.7.0
@@ -135,3 +158,5 @@ This is a template, but your SDK readme should include details on how to contrib
135158
[azure_sub]: https://azure.microsoft.com/free/
136159
[api_reference_doc]: https://learn.microsoft.com/rest/api/loadtesting/
137160
[product_documentation]: https://azure.microsoft.com/services/load-testing/
161+
[obtaining_data_plane_uri]: https://learn.microsoft.com/rest/api/loadtesting/data-plane-uri
162+
[azure_core_diagnostics]: https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/Diagnostics.md

0 commit comments

Comments
 (0)