WebTestProperties interface
Metadata describing a web test for an Azure resource.
Properties
| configuration | An XML configuration specification for a WebTest. |
| description | User defined description for this WebTest. |
| enabled | Is the test actively being monitored. |
| frequency | Interval in seconds between test runs for this WebTest. Default value is 300. |
| locations | A list of where to physically run the tests from to give global coverage for accessibility of your application. |
| provisioning |
Current state of this component, whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Succeeded, Deploying, Canceled, and Failed. |
| request | The collection of request properties |
| retry |
Allow for retries should this WebTest fail. |
| synthetic |
Unique ID of this WebTest. This is typically the same value as the Name field. |
| timeout | Seconds until this WebTest will timeout and fail. Default value is 30. |
| validation |
The collection of validation rule properties |
| web |
The kind of web test this is, valid choices are ping, multistep and standard. |
| web |
User defined name if this WebTest. |
Property Details
configuration
An XML configuration specification for a WebTest.
configuration?: WebTestPropertiesConfiguration
Property Value
description
User defined description for this WebTest.
description?: string
Property Value
string
enabled
Is the test actively being monitored.
enabled?: boolean
Property Value
boolean
frequency
Interval in seconds between test runs for this WebTest. Default value is 300.
frequency?: number
Property Value
number
locations
A list of where to physically run the tests from to give global coverage for accessibility of your application.
locations: WebTestGeolocation[]
Property Value
provisioningState
Current state of this component, whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Succeeded, Deploying, Canceled, and Failed.
provisioningState?: string
Property Value
string
request
The collection of request properties
request?: WebTestPropertiesRequest
Property Value
retryEnabled
Allow for retries should this WebTest fail.
retryEnabled?: boolean
Property Value
boolean
syntheticMonitorId
Unique ID of this WebTest. This is typically the same value as the Name field.
syntheticMonitorId: string
Property Value
string
timeout
Seconds until this WebTest will timeout and fail. Default value is 30.
timeout?: number
Property Value
number
validationRules
The collection of validation rule properties
validationRules?: WebTestPropertiesValidationRules
Property Value
webTestKind
The kind of web test this is, valid choices are ping, multistep and standard.
webTestKind: WebTestKind
Property Value
webTestName
User defined name if this WebTest.
webTestName: string
Property Value
string