LoadTestAdministrationClient.DeleteTestAsync(String, RequestContext) Method

Definition

Namespace:

Azure.Developer.LoadTesting

Assembly:

Azure.Developer.LoadTesting.dll

Package:

Azure.Developer.LoadTesting v1.0.1

Source:

LoadTestAdministrationClient.cs

Delete a test by its name.

public virtual System.Threading.Tasks.Task<Azure.Response> DeleteTestAsync (string testId, Azure.RequestContext context = default);

abstract member DeleteTestAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteTestAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function DeleteTestAsync (testId As String, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

testId

String

Unique name for the load test, 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

Task<Response>

The response returned from the service.

Exceptions

ArgumentNullException

testId is null.

ArgumentException

testId 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 DeleteTestAsync with required parameters.

var credential = new DefaultAzureCredential();
var endpoint = new Uri("<https://my-service.azure.com>");
var client = new LoadTestAdministrationClient(endpoint, credential);

Response response = await client.DeleteTestAsync("<testId>");
Console.WriteLine(response.Status);