WebTest interface

Package:

@azure/arm-appinsights

An Application Insights web test definition.

Extends

WebtestsResource

Properties

configuration	An XML configuration specification for a WebTest.
description	Purpose/user defined descriptive test for this WebTest.
enabled	Is the test actively being monitored.
frequency	Interval in seconds between test runs for this WebTest. Default value is 300. Default value: 300.
kind	The kind of web test that this web test watches. Choices are ping and multistep. Possible values include: 'ping', 'multistep'. Default value: 'ping'.
locations	A list of where to physically run the tests from to give global coverage for accessibility of your application.
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. NOTE: This property will not be serialized. It can only be populated by the server.
retryEnabled	Allow for retries should this WebTest fail.
syntheticMonitorId	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. Default value: 30.
webTestKind	The kind of web test this is, valid choices are ping and multistep. Possible values include: 'ping', 'multistep'. Default value: 'ping'.
webTestName	User defined name if this WebTest.

Inherited Properties

id	Azure resource Id NOTE: This property will not be serialized. It can only be populated by the server.
location	Resource location
name	Azure resource name NOTE: This property will not be serialized. It can only be populated by the server.
tags	Resource tags
type	Azure resource type NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

configuration

An XML configuration specification for a WebTest.

configuration?: WebTestPropertiesConfiguration

Property Value

WebTestPropertiesConfiguration

description

Purpose/user defined descriptive test 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. Default value: 300.

frequency?: number

Property Value

number

kind

The kind of web test that this web test watches. Choices are ping and multistep. Possible values include: 'ping', 'multistep'. Default value: 'ping'.

kind?: WebTestKind

Property Value

WebTestKind

locations

A list of where to physically run the tests from to give global coverage for accessibility of your application.

locations: WebTestGeolocation[]

Property Value

WebTestGeolocation[]

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. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

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. Default value: 30.

timeout?: number

Property Value

number

webTestKind

The kind of web test this is, valid choices are ping and multistep. Possible values include: 'ping', 'multistep'. Default value: 'ping'.

webTestKind: WebTestKind

Property Value

WebTestKind

webTestName

User defined name if this WebTest.

webTestName: string

Property Value

string

Inherited Property Details

id

Azure resource Id NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From WebtestsResource.id

location

Resource location

location: string

Property Value

string

Inherited From WebtestsResource.location

name

Azure resource name NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From WebtestsResource.name

tags

Resource tags

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From WebtestsResource.tags

type

Azure resource type NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From WebtestsResource.type