LoadTestRunClient.DeleteTestRunAsync Method
Definition
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.
Overloads
| Name | Description |
|---|---|
| DeleteTestRunAsync(String, RequestContext) |
[Protocol Method] Delete an existing load test run by providing the testRunId.
|
| DeleteTestRunAsync(String, CancellationToken) |
Delete an existing load test run by providing the testRunId. |
DeleteTestRunAsync(String, RequestContext)
- Source:
- LoadTestRunClient.cs
- Source:
- LoadTestRunClient.cs
[Protocol Method] Delete an existing load test run by providing the testRunId.
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
public virtual System.Threading.Tasks.Task<Azure.Response> DeleteTestRunAsync(string testRunId, Azure.RequestContext context = default);public virtual System.Threading.Tasks.Task<Azure.Response> DeleteTestRunAsync(string testRunId, Azure.RequestContext context);abstract member DeleteTestRunAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteTestRunAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function DeleteTestRunAsync (testRunId As String, Optional context As RequestContext = Nothing) As Task(Of Response)Public Overridable Function DeleteTestRunAsync (testRunId As String, context As RequestContext) As Task(Of Response)Parameters
- testRunId
- String
Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.
- context
- RequestContext
The request options, which can override default behaviors of the client pipeline on a per-call basis.
Returns
The response returned from the service.
Exceptions
testRunId is null.
testRunId is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
Examples
This sample shows how to call DeleteTestRunAsync.
Uri endpoint = new Uri("<endpoint>");
TokenCredential credential = new DefaultAzureCredential();
LoadTestRunClient client = new LoadTestRunClient(endpoint, credential);
Response response = await client.DeleteTestRunAsync("<testRunId>");
Console.WriteLine(response.Status);
This sample shows how to call DeleteTestRunAsync with all parameters.
Uri endpoint = new Uri("<endpoint>");
TokenCredential credential = new DefaultAzureCredential();
LoadTestRunClient client = new LoadTestRunClient(endpoint, credential);
Response response = await client.DeleteTestRunAsync("<testRunId>");
Console.WriteLine(response.Status);
Applies to
DeleteTestRunAsync(String, CancellationToken)
- Source:
- LoadTestRunClient.cs
Delete an existing load test run by providing the testRunId.
public virtual System.Threading.Tasks.Task<Azure.Response> DeleteTestRunAsync(string testRunId, System.Threading.CancellationToken cancellationToken = default);abstract member DeleteTestRunAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteTestRunAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function DeleteTestRunAsync (testRunId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)Parameters
- testRunId
- String
Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.
- cancellationToken
- CancellationToken
The cancellation token that can be used to cancel the operation.
Returns
Exceptions
testRunId is null.
testRunId is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
