LoadTestRunClient Class

Definition

Namespace:: Azure.Developer.LoadTesting

Assembly:: Azure.Developer.LoadTesting.dll

Package:: Azure.Developer.LoadTesting v1.0.2

Package:: Azure.Developer.LoadTesting v1.2.0-beta.1

Source:: LoadTestRunClient.cs

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.

The LoadTestRun service client.

public class LoadTestRunClient

type LoadTestRunClient = class

Public Class LoadTestRunClient

Inheritance: Object
LoadTestRunClient

Constructors

LoadTestRunClient()	Initializes a new instance of LoadTestRunClient for mocking.
LoadTestRunClient(Uri, TokenCredential, LoadTestingClientOptions)	Initializes a new instance of LoadTestRunClient.
LoadTestRunClient(Uri, TokenCredential)	Initializes a new instance of LoadTestRunClient.

Properties

Pipeline

The HTTP pipeline for sending and receiving REST requests and responses.

Methods

BeginTestProfileRun(WaitUntil, String, RequestContent, Nullable<TimeSpan>, RequestContext)	Create and start a new test profile run with the given name.
BeginTestProfileRunAsync(WaitUntil, String, RequestContent, Nullable<TimeSpan>, RequestContext)	Create and start a new test profile run with the given name.
BeginTestRun(WaitUntil, String, RequestContent, Nullable<TimeSpan>, String, RequestContext)	Create and start a new test run with the given name.
BeginTestRunAsync(WaitUntil, String, RequestContent, Nullable<TimeSpan>, String, RequestContext)	Create and start a new test run with the given name.
CreateOrUpdateAppComponents(String, RequestContent, RequestContext)	[Protocol Method] Add an app component to a test run. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateOrUpdateAppComponentsAsync(String, RequestContent, RequestContext)	[Protocol Method] Add an app component to a test run. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateOrUpdateServerMetricsConfig(String, RequestContent, RequestContext)	[Protocol Method] Configure server metrics for a test run This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateOrUpdateServerMetricsConfigAsync(String, RequestContent, RequestContext)	[Protocol Method] Configure server metrics for a test run This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteTestProfileRun(String, RequestContext)	[Protocol Method] Delete an existing load test profile run. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteTestProfileRunAsync(String, RequestContext)	[Protocol Method] Delete an existing load test profile run. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteTestRun(String, RequestContext)	[Protocol Method] Delete an existing load test run. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteTestRunAsync(String, RequestContext)	[Protocol Method] Delete an existing load test run. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetAppComponents(String, CancellationToken)	Get associated app component (collection of azure resources) for the given test run.
GetAppComponents(String, RequestContext)	[Protocol Method] Get associated app component (collection of azure resources) for the given test run. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetAppComponents(String, CancellationToken) convenience overload with strongly typed models first.
GetAppComponentsAsync(String, CancellationToken)	Get associated app component (collection of azure resources) for the given test run.
GetAppComponentsAsync(String, RequestContext)	[Protocol Method] Get associated app component (collection of azure resources) for the given test run. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetAppComponentsAsync(String, CancellationToken) convenience overload with strongly typed models first.
GetMetricDefinitions(String, String, CancellationToken)	List the metric definitions for a load test run.
GetMetricDefinitions(String, String, RequestContext)	[Protocol Method] List the metric definitions for a load test run. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetMetricDefinitions(String, String, CancellationToken) convenience overload with strongly typed models first.
GetMetricDefinitionsAsync(String, String, CancellationToken)	List the metric definitions for a load test run.
GetMetricDefinitionsAsync(String, String, RequestContext)	[Protocol Method] List the metric definitions for a load test run. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetMetricDefinitionsAsync(String, String, CancellationToken) convenience overload with strongly typed models first.
GetMetricDimensionValues(String, String, String, String, String, Nullable<TimeGrain>, CancellationToken)	List the dimension values for the given metric dimension name.
GetMetricDimensionValues(String, String, String, String, String, String, RequestContext)	[Protocol Method] List the dimension values for the given metric dimension name. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetMetricDimensionValues(String, String, String, String, String, Nullable<TimeGrain>, CancellationToken) convenience overload with strongly typed models first.
GetMetricDimensionValuesAsync(String, String, String, String, String, Nullable<TimeGrain>, CancellationToken)	List the dimension values for the given metric dimension name.
GetMetricDimensionValuesAsync(String, String, String, String, String, String, RequestContext)	[Protocol Method] List the dimension values for the given metric dimension name. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetMetricDimensionValuesAsync(String, String, String, String, String, Nullable<TimeGrain>, CancellationToken) convenience overload with strongly typed models first.
GetMetricNamespaces(String, CancellationToken)	List the metric namespaces for a load test run.
GetMetricNamespaces(String, RequestContext)	[Protocol Method] List the metric namespaces for a load test run. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetMetricNamespaces(String, CancellationToken) convenience overload with strongly typed models first.
GetMetricNamespacesAsync(String, CancellationToken)	List the metric namespaces for a load test run.
GetMetricNamespacesAsync(String, RequestContext)	[Protocol Method] List the metric namespaces for a load test run. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetMetricNamespacesAsync(String, CancellationToken) convenience overload with strongly typed models first.
GetMetrics(String, String, String, String, MetricsFilters, String, Nullable<TimeGrain>, CancellationToken)	List the metric values for a load test run.
GetMetrics(String, String, String, String, RequestContent, String, String, RequestContext)	List the metric values for a load test run.
GetMetricsAsync(String, String, String, String, MetricsFilters, String, Nullable<TimeGrain>, CancellationToken)	List the metric values for a load test run.
GetMetricsAsync(String, String, String, String, RequestContent, String, String, RequestContext)	List the metric values for a load test run.
GetServerMetricsConfig(String, CancellationToken)	Get associated server metrics configuration for the given test run.
GetServerMetricsConfig(String, RequestContext)	[Protocol Method] Get associated server metrics configuration for the given test run. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetServerMetricsConfig(String, CancellationToken) convenience overload with strongly typed models first.
GetServerMetricsConfigAsync(String, CancellationToken)	Get associated server metrics configuration for the given test run.
GetServerMetricsConfigAsync(String, RequestContext)	[Protocol Method] Get associated server metrics configuration for the given test run. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetServerMetricsConfigAsync(String, CancellationToken) convenience overload with strongly typed models first.
GetTestProfileRun(String, CancellationToken)	Get test profile run details.
GetTestProfileRun(String, RequestContext)	[Protocol Method] Get test profile run details. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetTestProfileRun(String, CancellationToken) convenience overload with strongly typed models first.
GetTestProfileRunAsync(String, CancellationToken)	Get test profile run details.
GetTestProfileRunAsync(String, RequestContext)	[Protocol Method] Get test profile run details. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetTestProfileRunAsync(String, CancellationToken) convenience overload with strongly typed models first.
GetTestProfileRuns(Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, IEnumerable<String>, IEnumerable<String>, IEnumerable<String>, CancellationToken)	List test profile runs.
GetTestProfileRuns(Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, IEnumerable<String>, IEnumerable<String>, IEnumerable<String>, RequestContext)	[Protocol Method] List test profile runs. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetTestProfileRuns(Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, IEnumerable<String>, IEnumerable<String>, IEnumerable<String>, CancellationToken) convenience overload with strongly typed models first.
GetTestProfileRunsAsync(Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, IEnumerable<String>, IEnumerable<String>, IEnumerable<String>, CancellationToken)	List test profile runs.
GetTestProfileRunsAsync(Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, IEnumerable<String>, IEnumerable<String>, IEnumerable<String>, RequestContext)	[Protocol Method] List test profile runs. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetTestProfileRunsAsync(Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, IEnumerable<String>, IEnumerable<String>, IEnumerable<String>, CancellationToken) convenience overload with strongly typed models first.
GetTestRun(String, CancellationToken)	Get test run details by test run Id.
GetTestRun(String, RequestContext)	[Protocol Method] Get test run details by test run Id. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetTestRun(String, CancellationToken) convenience overload with strongly typed models first.
GetTestRunAsync(String, CancellationToken)	Get test run details by test run Id.
GetTestRunAsync(String, RequestContext)	[Protocol Method] Get test run details by test run Id. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetTestRunAsync(String, CancellationToken) convenience overload with strongly typed models first.
GetTestRunFile(String, String, CancellationToken)	Get test run file by file name.
GetTestRunFile(String, String, RequestContext)	[Protocol Method] Get test run file by file name. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetTestRunFile(String, String, CancellationToken) convenience overload with strongly typed models first.
GetTestRunFileAsync(String, String, CancellationToken)	Get test run file by file name.
GetTestRunFileAsync(String, String, RequestContext)	[Protocol Method] Get test run file by file name. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetTestRunFileAsync(String, String, CancellationToken) convenience overload with strongly typed models first.
GetTestRuns(String, String, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, String, CancellationToken)	Get all test runs for the given filters.
GetTestRuns(String, String, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, String, RequestContext)	Get all test runs with given filters.
GetTestRunsAsync(String, String, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, String, CancellationToken)	Get all test runs for the given filters.
GetTestRunsAsync(String, String, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, String, RequestContext)	Get all test runs with given filters.
StopTestProfileRun(String, CancellationToken)	Stop test profile run.
StopTestProfileRun(String, RequestContext)	[Protocol Method] Stop test profile run. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler StopTestProfileRun(String, CancellationToken) convenience overload with strongly typed models first.
StopTestProfileRunAsync(String, CancellationToken)	Stop test profile run.
StopTestProfileRunAsync(String, RequestContext)	[Protocol Method] Stop test profile run. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler StopTestProfileRunAsync(String, CancellationToken) convenience overload with strongly typed models first.
StopTestRun(String, CancellationToken)	Stop test run by test run Id.
StopTestRun(String, RequestContext)	[Protocol Method] Stop test run by test run Id. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler StopTestRun(String, CancellationToken) convenience overload with strongly typed models first.
StopTestRunAsync(String, CancellationToken)	Stop test run by test run Id.
StopTestRunAsync(String, RequestContext)	[Protocol Method] Stop test run by test run Id. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler StopTestRunAsync(String, CancellationToken) convenience overload with strongly typed models first.

Applies to