TestOutput interface

Load test 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.

baselineTestRunId

Id of the test run to be marked as baseline to view trends of client-side metrics from recent test runs

certificate

Certificates metadata.

createdBy

The user that created.

createdDateTime

The creation datetime(RFC 3339 literal format).

description

The test description.

displayName

Display name of a test.

engineBuiltInIdentityIds

Resource Ids of the managed identity built in to load test engines. Required if engineBuiltInIdentityType is UserAssigned.

engineBuiltInIdentityType

Type of the managed identity built in load test engines

Possible values: "SystemAssigned", "UserAssigned"

environmentVariables

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

estimatedVirtualUserHours

Estimated virtual user hours for the test.

inputArtifacts

The input artifacts for the test.

keyvaultReferenceIdentityId

Resource Id of the managed identity referencing the Key vault.

keyvaultReferenceIdentityType

Type of the managed identity referencing the Key vault.

kind

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

metricsReferenceIdentityId

Resource Id of the managed identity referencing the metrics.

metricsReferenceIdentityType

Type of the managed identity referencing the metrics.

Possible values: "SystemAssigned", "UserAssigned"

passFailCriteria

Pass fail criteria for a test.

preferences

Preferences for the test.

publicIPDisabled

Inject load test engines without deploying public IP for outbound access

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.

subnetId

Subnet ID on which the load test instances should run.

testId

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

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

baselineTestRunId

Id of the test run to be marked as baseline to view trends of client-side metrics from recent test runs

baselineTestRunId?: string

Property Value

string

certificate

Certificates metadata.

certificate?: CertificateMetadataOutput

Property Value

createdBy

The user that created.

createdBy?: string

Property Value

string

createdDateTime

The creation datetime(RFC 3339 literal format).

createdDateTime?: string

Property Value

string

description

The test description.

description?: string

Property Value

string

displayName

Display name of a test.

displayName?: string

Property Value

string

engineBuiltInIdentityIds

Resource Ids of the managed identity built in to load test engines. Required if engineBuiltInIdentityType is UserAssigned.

engineBuiltInIdentityIds?: string[]

Property Value

string[]

engineBuiltInIdentityType

Type of the managed identity built in load test engines

Possible values: "SystemAssigned", "UserAssigned"

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

estimatedVirtualUserHours

Estimated virtual user hours for the test.

estimatedVirtualUserHours?: number

Property Value

number

inputArtifacts

The input artifacts for the test.

inputArtifacts?: TestInputArtifactsOutput

Property Value

keyvaultReferenceIdentityId

Resource Id of the managed identity referencing the Key vault.

keyvaultReferenceIdentityId?: string

Property Value

string

keyvaultReferenceIdentityType

Type of the managed identity referencing the Key vault.

keyvaultReferenceIdentityType?: string

Property Value

string

kind

Kind 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

metricsReferenceIdentityId

Resource Id of the managed identity referencing the metrics.

metricsReferenceIdentityId?: string

Property Value

string

metricsReferenceIdentityType

Type of the managed identity referencing the metrics.

Possible values: "SystemAssigned", "UserAssigned"

metricsReferenceIdentityType?: string

Property Value

string

passFailCriteria

Pass fail criteria for a test.

passFailCriteria?: PassFailCriteriaOutput

Property Value

preferences

Preferences for the test.

preferences?: TestPreferencesOutput

Property Value

publicIPDisabled

Inject load test engines without deploying public IP for outbound access

publicIPDisabled?: boolean

Property Value

boolean

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>

subnetId

Subnet ID on which the load test instances should run.

subnetId?: string

Property Value

string

testId

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

testId: string

Property Value

string