api-version = 1.0
This API provides a test infrastructure in the cloud to execute web load tests at a high scale and reliability without requiring any upfront setup, configuration or provisioning tax.
- For using the REST APIs, enable Basic authentication as detailed here.
.vscltto your account name to get redirected to the Cloud Load Test (CLT) service under visualstudio.com. For example, if your Visual Studio Team Services account URL is
https://fabrikam.visualstudio.com/, then use
https://fabrikam.vsclt.visualstudio.com/as endpoint for CLT REST APIs.
- To get started quickly you can refer to the API sample here.
How to use the APIs
The following steps are essential to be successful with these APIs. These are demonstrated in the sample linked above.
- Create a valid loadtest file. You can use the load test file from an earlier run through Visual Studio for this.
- Create a location to upload the file(s). This location is a drop folder on Azure Blob and is below referred to as "TestDrop".
- Upload the loadtest file and any other files required for the run, this includes the webtest files, settings file, etc. to this location or "TestDrop".
- Create a Test Run using the Testdrop from the previous step as all the files required for a run are now available at the drop location.
- Start the run.
- Once finished, download the results to your local machine. This will be a gzip file. Uncompress it to get the results file.
- Use Visual Studio to view the downloaded results.
- Creation of a test drop location requires the Azure Storage APIs which are available as part of the Azure SDK. Look up the sample to see how to use them.
- Uploading the files and downloading the results are also achieved through the Azure Storage APIs as results are stored as Azure Blobs. Refer to sample for details of downloading and importing the the load test results.
- Creating a load test cannot be achieved through the APIs. You will need Visual Studio IDE to author the web performance and load tests. Refer to MSDN documentation.
- Test Runs - runs which are queued on the Cloud Load Test service. Refer to Test Run Type for the detailed description of the test run resource type.
- Test Drops - a container where test binaries, test data files and the detailed test definition, such as LOADTEST XML are stored. Every test run is associated with a test drop. Refer to Test Drop Type for the detailed description of the test drop resource type.
- Counter Instances - counter instances from a specific load test run. Refer to Counter Instance Type for the detailed description of the test run resource type.
- Counter Samples - counter samples from a specific load test run. Refer to Counter Sample Type for the detailed description of the test run resource type.
- APM Plugins - available Application Performance Management (APM) plugins, such as Application Insights, which can be used to pull Application-side performance counters during the load test run. This resource allows query for plugin configuration.
- APM Applications - applications configured in the APM service. These application references can be used in the load test authoring to enable APM counter integration during the load test run.
- APM Counters - application counters configured and available for query in the APM service, such as Metrics in Application Insights.
- Configuration - get configuration details applicable at an account level, such as permitted target geo-locations (Azure regions) for the load agents.