TestRunOutput interface

Package:
@azure-rest/load-testing

Load test run model

Properties

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.
certificate

Certificates metadata
createdBy

The user that created.
createdByType

The type of the entity that created the test run. (E.x. User, ScheduleTrigger, etc).

Possible values: "User", "ScheduledTrigger", "AzurePipelines", "GitHubWorkflows"
createdByUri

The URI pointing to the entity that created the test run.
createdDateTime

The creation datetime(RFC 3339 literal format).
debugLogsEnabled

Enable or disable debug level logging. True if debug logs are enabled for the test run. False otherwise
description

The test run description.
displayName

Display name of a testRun.
duration

Test run duration in milliseconds.
endDateTime

The test run end DateTime(RFC 3339 literal format).
environmentVariables

Environment variables which are defined as a set of <name,value> pairs.
errorDetails

Error details if there is any failure in load test run
estimatedVirtualUserHours

Estimated virtual user hours for the test run.
executedDateTime

Test run initiated time. This is legacy, new developments should use createdDateTime.
executionEndDateTime

The test run execution end DateTime(RFC 3339 literal format).
executionStartDateTime

The test run execution start DateTime(RFC 3339 literal format).
kind

Type of test.

Possible values: "URL", "JMX", "Locust"
lastModifiedBy

The user that last modified.
lastModifiedDateTime

The last Modified datetime(RFC 3339 literal format).
loadTestConfiguration

The load test configuration.
passFailCriteria

Pass fail criteria for a test.
portalUrl

Portal url.
publicIPDisabled

Inject load test engines without deploying public IP for outbound access
regionalStatistics

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.
requestDataLevel

Request data collection level for test run

Possible values: "NONE", "ERRORS"
secrets

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.
startDateTime

The test run start DateTime(RFC 3339 literal format).
status

The test run status.

Possible values: "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", "VALIDATION_FAILURE"
subnetId

Subnet ID on which the load test instances should run.
testArtifacts

Collection of test run artifacts
testId

Associated test Id.
testResult

Test result for pass/Fail criteria used during the test run.

Possible values: "PASSED", "NOT_APPLICABLE", "FAILED"
testRunId

Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.
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.
virtualUserHours

Virtual user hours consumed by the test run.
virtualUsers

Number of virtual users, for which test has been run.

Property Details

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.

autoStopCriteria?: AutoStopCriteriaOutput

Property Value

AutoStopCriteriaOutput

certificate

Certificates metadata

certificate?: CertificateMetadataOutput

Property Value

CertificateMetadataOutput

createdBy

The user that created.

createdBy?: string

Property Value

string

createdByType

The type of the entity that created the test run. (E.x. User, ScheduleTrigger, etc).

Possible values: "User", "ScheduledTrigger", "AzurePipelines", "GitHubWorkflows"

createdByType?: string

Property Value

string

createdByUri

The URI pointing to the entity that created the test run.

createdByUri?: string

Property Value

string

createdDateTime

The creation datetime(RFC 3339 literal format).

createdDateTime?: string

Property Value

string

debugLogsEnabled

Enable or disable debug level logging. True if debug logs are enabled for the test run. False otherwise

debugLogsEnabled?: boolean

Property Value

boolean

description

The test run description.

description?: string

Property Value

string

displayName

Display name of a testRun.

displayName?: string

Property Value

string

duration

Test run duration in milliseconds.

duration?: number

Property Value

number

endDateTime

The test run end DateTime(RFC 3339 literal format).

endDateTime?: string

Property Value

string

environmentVariables

Environment variables which are defined as a set of <name,value> pairs.

environmentVariables?: Record<string, string>

Property Value

Record<string, string>

errorDetails

Error details if there is any failure in load test run

errorDetails?: ErrorDetailsOutput[]

Property Value

ErrorDetailsOutput[]

estimatedVirtualUserHours

Estimated virtual user hours for the test run.

estimatedVirtualUserHours?: number

Property Value

number

executedDateTime

Test run initiated time. This is legacy, new developments should use createdDateTime.

executedDateTime?: string

Property Value

string

executionEndDateTime

The test run execution end DateTime(RFC 3339 literal format).

executionEndDateTime?: string

Property Value

string

executionStartDateTime

The test run execution start DateTime(RFC 3339 literal format).

executionStartDateTime?: string

Property Value

string

kind

Type of test.

Possible values: "URL", "JMX", "Locust"

kind?: string

Property Value

string

lastModifiedBy

The user that last modified.

lastModifiedBy?: string

Property Value

string

lastModifiedDateTime

The last Modified datetime(RFC 3339 literal format).

lastModifiedDateTime?: string

Property Value

string

loadTestConfiguration

The load test configuration.

loadTestConfiguration?: LoadTestConfigurationOutput

Property Value

LoadTestConfigurationOutput

passFailCriteria

Pass fail criteria for a test.

passFailCriteria?: PassFailCriteriaOutput

Property Value

PassFailCriteriaOutput

portalUrl

Portal url.

portalUrl?: string

Property Value

string

publicIPDisabled

Inject load test engines without deploying public IP for outbound access

publicIPDisabled?: boolean

Property Value

boolean

regionalStatistics

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.

regionalStatistics?: Record<string, TestRunStatisticsOutput>

Property Value

Record<string, TestRunStatisticsOutput>

requestDataLevel

Request data collection level for test run

Possible values: "NONE", "ERRORS"

requestDataLevel?: string

Property Value

string

secrets

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.

secrets?: Record<string, SecretOutput>

Property Value

Record<string, SecretOutput>

startDateTime

The test run start DateTime(RFC 3339 literal format).

startDateTime?: string

Property Value

string

status

The test run status.

Possible values: "ACCEPTED", "NOTSTARTED", "PROVISIONING", "PROVISIONED", "CONFIGURING", "CONFIGURED", "EXECUTING", "EXECUTED", "DEPROVISIONING", "DEPROVISIONED", "DONE", "CANCELLING", "CANCELLED", "FAILED", "VALIDATION_SUCCESS", "VALIDATION_FAILURE"

status?: string

Property Value

string

subnetId

Subnet ID on which the load test instances should run.

subnetId?: string

Property Value

string

testArtifacts

Collection of test run artifacts

testArtifacts?: TestRunArtifactsOutput

Property Value

TestRunArtifactsOutput

testId

Associated test Id.

testId?: string

Property Value

string

testResult

Test result for pass/Fail criteria used during the test run.

Possible values: "PASSED", "NOT_APPLICABLE", "FAILED"

testResult?: string

Property Value

string

testRunId

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

testRunId: string

Property Value

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.

testRunStatistics?: Record<string, TestRunStatisticsOutput>

Property Value

Record<string, TestRunStatisticsOutput>

virtualUserHours

Virtual user hours consumed by the test run.

virtualUserHours?: number

Property Value

number

virtualUsers

Number of virtual users, for which test has been run.

virtualUsers?: number

Property Value

number