Test interface
Load test model.
Properties
| auto |
Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window. |
| baseline |
Id of the test run to be marked as baseline to view trends of client-side metrics from recent test runs |
| certificate | Certificates metadata. |
| description | The test description. |
| display |
Display name of a test. |
| engine |
Resource Ids of the managed identity built in to load test engines. Required if engineBuiltInIdentityType is UserAssigned. |
| engine |
Type of the managed identity built in load test engines Possible values: "SystemAssigned", "UserAssigned" |
| environment |
Environment variables which are defined as a set of <name,value> pairs. |
| keyvault |
Resource Id of the managed identity referencing the Key vault. |
| keyvault |
Type of the managed identity referencing the Key vault. |
| kind | Kind of test. Possible values: "URL", "JMX", "Locust" |
| load |
The load test configuration. |
| metrics |
Resource Id of the managed identity referencing the metrics. |
| metrics |
Type of the managed identity referencing the metrics. Possible values: "SystemAssigned", "UserAssigned" |
| pass |
Pass fail criteria for a test. |
| preferences | Preferences for the test. |
| public |
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. |
| subnet |
Subnet ID on which the load test instances should 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?: AutoStopCriteriaProperty Value
baselineTestRunId
Id of the test run to be marked as baseline to view trends of client-side metrics from recent test runs
baselineTestRunId?: stringProperty Value
string
certificate
description
The test description.
description?: stringProperty Value
string
displayName
Display name of a test.
displayName?: stringProperty 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?: stringProperty Value
string
environmentVariables
Environment variables which are defined as a set of <name,value> pairs.
environmentVariables?: Record<string, string>Property Value
Record<string, string>
keyvaultReferenceIdentityId
Resource Id of the managed identity referencing the Key vault.
keyvaultReferenceIdentityId?: stringProperty Value
string
keyvaultReferenceIdentityType
Type of the managed identity referencing the Key vault.
keyvaultReferenceIdentityType?: stringProperty Value
string
kind
Kind of test.
Possible values: "URL", "JMX", "Locust"
kind?: stringProperty Value
string
loadTestConfiguration
The load test configuration.
loadTestConfiguration?: LoadTestConfigurationProperty Value
metricsReferenceIdentityId
Resource Id of the managed identity referencing the metrics.
metricsReferenceIdentityId?: stringProperty Value
string
metricsReferenceIdentityType
Type of the managed identity referencing the metrics.
Possible values: "SystemAssigned", "UserAssigned"
metricsReferenceIdentityType?: stringProperty Value
string
passFailCriteria
preferences
publicIPDisabled
Inject load test engines without deploying public IP for outbound access
publicIPDisabled?: booleanProperty 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, Secret>Property Value
Record<string, Secret>
subnetId
Subnet ID on which the load test instances should run.
subnetId?: stringProperty Value
string
