LoadTestRunClient.BeginTestRunAsync Method

Definition

Create and start a new test run with the given name.

public virtual System.Threading.Tasks.Task<Azure.Developer.LoadTesting.TestRunResultOperation> BeginTestRunAsync (Azure.WaitUntil waitUntil, string testRunId, Azure.Core.RequestContent content, TimeSpan? timeSpan = default, string oldTestRunId = default, Azure.RequestContext context = default);
abstract member BeginTestRunAsync : Azure.WaitUntil * string * Azure.Core.RequestContent * Nullable<TimeSpan> * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Developer.LoadTesting.TestRunResultOperation>
override this.BeginTestRunAsync : Azure.WaitUntil * string * Azure.Core.RequestContent * Nullable<TimeSpan> * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Developer.LoadTesting.TestRunResultOperation>
Public Overridable Function BeginTestRunAsync (waitUntil As WaitUntil, testRunId As String, content As RequestContent, Optional timeSpan As Nullable(Of TimeSpan) = Nothing, Optional oldTestRunId As String = Nothing, Optional context As RequestContext = Nothing) As Task(Of TestRunResultOperation)

Parameters

waitUntil
WaitUntil

Defines how to use the LRO, if passed WaitUntil.Completed then waits for test run to get completed

testRunId
String

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

content
RequestContent

The content to send as the body of the request. Details of the request body schema are in the Remarks section below.

timeSpan
Nullable<TimeSpan>

pollingInterval for poller class, default value or null value is treated as 5 secs

oldTestRunId
String

Existing test run identifier that should be rerun, if this is provided, the test will run with the JMX file, configuration and app components from the existing test run. You can override the configuration values for new test run in the request body.

context
RequestContext

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

Returns

The response returned from the service. Details of the response body schema are in the Remarks section below.

Exceptions

testRunId or content is null.

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

Service returned a non-success status code.

Applies to