TestRun 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
createdByType

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

Possible values: "User", "ScheduledTrigger", "AzurePipelines", "GitHubWorkflows"
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.
environmentVariables

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

Pass fail criteria for a test.
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.
testId

Associated test Id.

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?: AutoStopCriteria

Property Value

AutoStopCriteria

certificate

Certificates metadata

certificate?: CertificateMetadata

Property Value

CertificateMetadata

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

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

environmentVariables

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

environmentVariables?: Record<string, string>

Property Value

Record<string, string>

passFailCriteria

Pass fail criteria for a test.

passFailCriteria?: PassFailCriteria

Property Value

PassFailCriteria

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, Secret>

Property Value

Record<string, Secret>

testId

Associated test Id.

testId?: string

Property Value

string