LoadTestRunClient.DeleteTestRun(String, RequestContext) Method

Reference

Definition

Namespace:: Azure.Developer.LoadTesting

Assembly:: Azure.Developer.LoadTesting.dll

Package:: Azure.Developer.LoadTesting v1.0.2

Source:: LoadTestRunClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

[Protocol Method] Delete a test run by its name.

This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

public virtual Azure.Response DeleteTestRun(string testRunId, Azure.RequestContext context = default);

abstract member DeleteTestRun : string * Azure.RequestContext -> Azure.Response
override this.DeleteTestRun : string * Azure.RequestContext -> Azure.Response

Public Overridable Function DeleteTestRun (testRunId As String, Optional context As RequestContext = Nothing) As Response

Parameters

testRunId: String

Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.

context: RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

testRunId is null.

ArgumentException

testRunId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call DeleteTestRun.

Uri endpoint = new Uri("<endpoint>");
TokenCredential credential = new DefaultAzureCredential();
LoadTestRunClient client = new LoadTestRunClient(endpoint, credential);

Response response = client.DeleteTestRun("<testRunId>");

Console.WriteLine(response.Status);

This sample shows how to call DeleteTestRun with all parameters.

Uri endpoint = new Uri("<endpoint>");
TokenCredential credential = new DefaultAzureCredential();
LoadTestRunClient client = new LoadTestRunClient(endpoint, credential);

Response response = client.DeleteTestRun("<testRunId>");

Console.WriteLine(response.Status);

Applies to

Share via