LoadTestingModelFactory.LoadTestRun 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.
Initializes a new instance of LoadTestRun.
public static Azure.Developer.LoadTesting.LoadTestRun LoadTestRun(string testRunId = default, Azure.Developer.LoadTesting.PassFailCriteria passFailCriteria = default, Azure.Developer.LoadTesting.AutoStopCriteria autoStopCriteria = default, System.Collections.Generic.IDictionary<string,Azure.Developer.LoadTesting.TestSecret> secrets = default, Azure.Developer.LoadTesting.TestCertificate certificate = default, System.Collections.Generic.IDictionary<string,string> environmentVariables = default, System.Collections.Generic.IEnumerable<Azure.Developer.LoadTesting.ErrorDetails> errorDetails = default, System.Collections.Generic.IReadOnlyDictionary<string,Azure.Developer.LoadTesting.TestRunStatistics> testRunStatistics = default, System.Collections.Generic.IReadOnlyDictionary<string,Azure.Developer.LoadTesting.TestRunStatistics> regionalStatistics = default, Azure.Developer.LoadTesting.LoadTestConfiguration loadTestConfiguration = default, Azure.Developer.LoadTesting.TestRunArtifacts testArtifacts = default, Azure.Developer.LoadTesting.PassFailTestResult? testResult = default, int? virtualUsers = default, string displayName = default, string testId = default, string description = default, Azure.Developer.LoadTesting.TestRunStatus? status = default, DateTimeOffset? startDateTime = default, DateTimeOffset? endDateTime = default, DateTimeOffset? executedDateTime = default, Uri portalUri = default, long? duration = default, double? virtualUserHours = default, string subnetId = default, Azure.Developer.LoadTesting.LoadTestKind? kind = default, Azure.Developer.LoadTesting.RequestDataLevel? requestDataLevel = default, bool? debugLogsEnabled = default, bool? publicIpDisabled = default, Azure.Developer.LoadTesting.CreatedByType? createdByType = default, DateTimeOffset? createdDateTime = default, string createdBy = default, DateTimeOffset? lastModifiedDateTime = default, string lastModifiedBy = default);
static member LoadTestRun : string * Azure.Developer.LoadTesting.PassFailCriteria * Azure.Developer.LoadTesting.AutoStopCriteria * System.Collections.Generic.IDictionary<string, Azure.Developer.LoadTesting.TestSecret> * Azure.Developer.LoadTesting.TestCertificate * System.Collections.Generic.IDictionary<string, string> * seq<Azure.Developer.LoadTesting.ErrorDetails> * System.Collections.Generic.IReadOnlyDictionary<string, Azure.Developer.LoadTesting.TestRunStatistics> * System.Collections.Generic.IReadOnlyDictionary<string, Azure.Developer.LoadTesting.TestRunStatistics> * Azure.Developer.LoadTesting.LoadTestConfiguration * Azure.Developer.LoadTesting.TestRunArtifacts * Nullable<Azure.Developer.LoadTesting.PassFailTestResult> * Nullable<int> * string * string * string * Nullable<Azure.Developer.LoadTesting.TestRunStatus> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Uri * Nullable<int64> * Nullable<double> * string * Nullable<Azure.Developer.LoadTesting.LoadTestKind> * Nullable<Azure.Developer.LoadTesting.RequestDataLevel> * Nullable<bool> * Nullable<bool> * Nullable<Azure.Developer.LoadTesting.CreatedByType> * Nullable<DateTimeOffset> * string * Nullable<DateTimeOffset> * string -> Azure.Developer.LoadTesting.LoadTestRun
Public Shared Function LoadTestRun (Optional testRunId As String = Nothing, Optional passFailCriteria As PassFailCriteria = Nothing, Optional autoStopCriteria As AutoStopCriteria = Nothing, Optional secrets As IDictionary(Of String, TestSecret) = Nothing, Optional certificate As TestCertificate = Nothing, Optional environmentVariables As IDictionary(Of String, String) = Nothing, Optional errorDetails As IEnumerable(Of ErrorDetails) = Nothing, Optional testRunStatistics As IReadOnlyDictionary(Of String, TestRunStatistics) = Nothing, Optional regionalStatistics As IReadOnlyDictionary(Of String, TestRunStatistics) = Nothing, Optional loadTestConfiguration As LoadTestConfiguration = Nothing, Optional testArtifacts As TestRunArtifacts = Nothing, Optional testResult As Nullable(Of PassFailTestResult) = Nothing, Optional virtualUsers As Nullable(Of Integer) = Nothing, Optional displayName As String = Nothing, Optional testId As String = Nothing, Optional description As String = Nothing, Optional status As Nullable(Of TestRunStatus) = Nothing, Optional startDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional endDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional executedDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional portalUri As Uri = Nothing, Optional duration As Nullable(Of Long) = Nothing, Optional virtualUserHours As Nullable(Of Double) = Nothing, Optional subnetId As String = Nothing, Optional kind As Nullable(Of LoadTestKind) = Nothing, Optional requestDataLevel As Nullable(Of RequestDataLevel) = Nothing, Optional debugLogsEnabled As Nullable(Of Boolean) = Nothing, Optional publicIpDisabled As Nullable(Of Boolean) = Nothing, Optional createdByType As Nullable(Of CreatedByType) = Nothing, Optional createdDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional createdBy As String = Nothing, Optional lastModifiedDateTime As Nullable(Of DateTimeOffset) = Nothing, Optional lastModifiedBy As String = Nothing) As LoadTestRun
Parameters
- testRunId
- String
Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.
- passFailCriteria
- PassFailCriteria
Pass fail criteria for a test.
- autoStopCriteria
- AutoStopCriteria
Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window.
- secrets
- IDictionary<String,TestSecret>
Secrets can be stored in an Azure Key Vault or any other secret store. If the secret is stored in an Azure Key Vault, the value should be the secret identifier and the type should be AKV_SECRET_URI. If the secret is stored elsewhere, the secret value should be provided directly and the type should be SECRET_VALUE.
- certificate
- TestCertificate
Certificates metadata.
- environmentVariables
- IDictionary<String,String>
Environment variables which are defined as a set of <name,value> pairs.
- errorDetails
- IEnumerable<ErrorDetails>
Error details if there is any failure in load test run.
- testRunStatistics
- IReadOnlyDictionary<String,TestRunStatistics>
Test run statistics. Key is the sampler name and value is the set of statistics for performance metrics like response time, throughput, etc. from the load test run. The sampler name is the same as the name mentioned in the test script. Sampler name "Total" represents the aggregated statistics of all the samplers.
- regionalStatistics
- IReadOnlyDictionary<String,TestRunStatistics>
Regional statistics. Key is the Azure region name and value is the test run statistics. The region name should of format accepted by ARM, and should be a region supported by Azure Load Testing. For example, East US should be passed as "eastus". The region name must match one of the strings in the "Name" column returned from running the "az account list-locations -o table" Azure CLI command.
- loadTestConfiguration
- LoadTestConfiguration
The load test configuration.
- testArtifacts
- TestRunArtifacts
Collection of test run artifacts.
- testResult
- Nullable<PassFailTestResult>
Test result for pass/Fail criteria used during the test run.
- displayName
- String
Display name of a testRun.
- testId
- String
Associated test Id.
- description
- String
The test run description.
- status
- Nullable<TestRunStatus>
The test run status.
- startDateTime
- Nullable<DateTimeOffset>
The test run start DateTime(RFC 3339 literal format).
- endDateTime
- Nullable<DateTimeOffset>
The test run end DateTime(RFC 3339 literal format).
- executedDateTime
- Nullable<DateTimeOffset>
Test run initiated time.
- portalUri
- Uri
Portal url.
- subnetId
- String
Subnet ID on which the load test instances should run.
- kind
- Nullable<LoadTestKind>
Type of test.
- requestDataLevel
- Nullable<RequestDataLevel>
Request data collection level for test run.
Enable or disable debug level logging. True if debug logs are enabled for the test run. False otherwise.
Inject load test engines without deploying public IP for outbound access.
- createdByType
- Nullable<CreatedByType>
The type of the entity that created the test run. (E.x. User, ScheduleTrigger, etc).
- createdDateTime
- Nullable<DateTimeOffset>
The creation datetime(RFC 3339 literal format).
- createdBy
- String
The user that created.
- lastModifiedDateTime
- Nullable<DateTimeOffset>
The last Modified datetime(RFC 3339 literal format).
- lastModifiedBy
- String
The user that last modified.
Returns
A new LoadTestRun instance for mocking.