Share via

TestRun interface

Package:
@azure-rest/load-testing

Load test run model

Properties

certificate

Certificates metadata
createdBy

The user that created.
createdDateTime

The creation datetime(ISO 8601 literal format).
description

The test run description.
displayName

Display name of a testRun.
duration

Test run duration in milliseconds.
endDateTime

The test run end DateTime(ISO 8601 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
executedDateTime

Test run initiated time.
lastModifiedBy

The user that last modified.
lastModifiedDateTime

The last Modified datetime(ISO 8601 literal format).
loadTestConfiguration

The load test configuration.
passFailCriteria

Pass fail criteria for a test.
portalUrl

Portal url.
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(ISO 8601 literal format).
status

The test run status.
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.
testRunId

Unique test run name as identifier
testRunStatistics

Test run statistics.
virtualUsers

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

Property Details

certificate

Certificates metadata

certificate?: CertificateMetadata

Property Value

CertificateMetadata

createdBy

The user that created.

createdBy?: string

Property Value

string

createdDateTime

The creation datetime(ISO 8601 literal format).

createdDateTime?: string | Date

Property Value

string | Date

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(ISO 8601 literal format).

endDateTime?: string | Date

Property Value

string | Date

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?: ErrorDetails[]

Property Value

ErrorDetails[]

executedDateTime

Test run initiated time.

executedDateTime?: string | Date

Property Value

string | Date

lastModifiedBy

The user that last modified.

lastModifiedBy?: string

Property Value

string

lastModifiedDateTime

The last Modified datetime(ISO 8601 literal format).

lastModifiedDateTime?: string | Date

Property Value

string | Date

loadTestConfiguration

The load test configuration.

loadTestConfiguration?: LoadTestConfiguration

Property Value

LoadTestConfiguration

passFailCriteria

Pass fail criteria for a test.

passFailCriteria?: PassFailCriteria

Property Value

PassFailCriteria

portalUrl

Portal url.

portalUrl?: 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, Secret>

Property Value

Record<string, Secret>

startDateTime

The test run start DateTime(ISO 8601 literal format).

startDateTime?: string | Date

Property Value

string | Date

status

The test run status.

status?: "VALIDATION_SUCCESS" | "VALIDATION_FAILURE" | "FAILED" | "ACCEPTED" | "NOTSTARTED" | "PROVISIONING" | "PROVISIONED" | "CONFIGURING" | "CONFIGURED" | "EXECUTING" | "EXECUTED" | "DEPROVISIONING" | "DEPROVISIONED" | "DONE" | "CANCELLING" | "CANCELLED"

Property Value

"VALIDATION_SUCCESS" | "VALIDATION_FAILURE" | "FAILED" | "ACCEPTED" | "NOTSTARTED" | "PROVISIONING" | "PROVISIONED" | "CONFIGURING" | "CONFIGURED" | "EXECUTING" | "EXECUTED" | "DEPROVISIONING" | "DEPROVISIONED" | "DONE" | "CANCELLING" | "CANCELLED"

subnetId

Subnet ID on which the load test instances should run.

subnetId?: string

Property Value

string

testArtifacts

Collection of test run artifacts

testArtifacts?: TestRunArtifacts

Property Value

TestRunArtifacts

testId

Associated test Id.

testId?: string

Property Value

string

testResult

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

testResult?: "PASSED" | "NOT_APPLICABLE" | "FAILED"

Property Value

"PASSED" | "NOT_APPLICABLE" | "FAILED"

testRunId

Unique test run name as identifier

testRunId?: string

Property Value

string

testRunStatistics

Test run statistics.

testRunStatistics?: Record<string, TestRunStatistics>

Property Value

Record<string, TestRunStatistics>

virtualUsers

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

virtualUsers?: number

Property Value

number