Microsoft.Insights webtests 2015-05-01

The webtests resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.Insights/webtests resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.Insights/webtests@2015-05-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  kind: 'string'
  properties: {
    Configuration: {
      WebTest: 'string'
    }
    Description: 'string'
    Enabled: bool
    Frequency: int
    Kind: 'string'
    Locations: [
      {
        Id: 'string'
      }
    ]
    Name: 'string'
    RetryEnabled: bool
    SyntheticMonitorId: 'string'
    Timeout: int
  }
}

Property values

webtests

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.Insights/webtests'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2015-05-01'
name The resource name string (required)
location Resource location string (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates
kind The kind of web test that this web test watches. Choices are ping and multistep. 'multistep'
'ping'
properties Metadata describing a web test for an Azure resource. WebTestProperties

WebTestProperties

Name Description Value
Configuration An XML configuration specification for a WebTest. WebTestPropertiesConfiguration
Description Purpose/user defined descriptive test for this WebTest. string
Enabled Is the test actively being monitored. bool
Frequency Interval in seconds between test runs for this WebTest. Default value is 300. int
Kind The kind of web test that this web test watches. Choices are ping and multistep. 'multistep'
'ping'
Locations A list of where to physically run the tests from to give global coverage for accessibility of your application. WebTestGeolocation[] (required)
Name User defined name if this WebTest. string (required)
RetryEnabled Allow for retries should this WebTest fail. bool
SyntheticMonitorId Unique ID of this WebTest. This is typically the same value as the Name field. string (required)
Timeout Seconds until this WebTest will timeout and fail. Default value is 30. int

WebTestPropertiesConfiguration

Name Description Value
WebTest The XML specification of a WebTest to run against an application. string

WebTestGeolocation

Name Description Value
Id Location ID for the webtest to run from. string

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Dynamic Web Test Creation

Deploy to Azure
Create any number of App Insights web (ping) tests.
Metric alert rule for an availability test

Deploy to Azure
This template creates an Application Insights availability test along with a metric alert rule that monitors it.