Microsoft.Insights webtests

• Latest
• 2022-06-15
• 2020-10-05-preview
• 2018-05-01-preview
• 2015-05-01

Bicep resource definition

The webtests resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

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

resource symbolicname 'Microsoft.Insights/webtests@2022-06-15' = {
 kind: 'string'
 location: 'string'
 name: 'string'
 properties: {
 Configuration: {
 WebTest: 'string'
 }
 Description: 'string'
 Enabled: bool
 Frequency: int
 Kind: 'string'
 Locations: [
 {
 Id: 'string'
 }
 ]
 Name: 'string'
 Request: {
 FollowRedirects: bool
 Headers: [
 {
 key: 'string'
 value: 'string'
 }
 ]
 HttpVerb: 'string'
 ParseDependentRequests: bool
 RequestBody: 'string'
 RequestUrl: 'string'
 }
 RetryEnabled: bool
 SyntheticMonitorId: 'string'
 Timeout: int
 ValidationRules: {
 ContentValidation: {
 ContentMatch: 'string'
 IgnoreCase: bool
 PassIfTextFound: bool
 }
 ExpectedHttpStatusCode: int
 IgnoreHttpStatusCode: bool
 SSLCertRemainingLifetimeCheck: int
 SSLCheck: bool
 }
 }
 tags: {
 {customized property}: 'string'
 }
}

Property Values

Microsoft.Insights/webtests

HeaderField

WebTestGeolocation

WebTestProperties

WebTestPropertiesConfiguration

WebTestPropertiesRequest

WebTestPropertiesValidationRules

WebTestPropertiesValidationRulesContentValidation

WebtestsResourceTags

Usage Examples

Bicep Samples

A basic example of deploying Application Insights Standard WebTest.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource component 'Microsoft.Insights/components@2020-02-02' = {
 name: resourceName
 location: location
 kind: 'web'
 properties: {
 Application_Type: 'web'
 DisableIpMasking: false
 DisableLocalAuth: false
 ForceCustomerStorageForProfiler: false
 RetentionInDays: 90
 SamplingPercentage: 100
 publicNetworkAccessForIngestion: 'Enabled'
 publicNetworkAccessForQuery: 'Enabled'
 }
}

resource webTest 'Microsoft.Insights/webTests@2022-06-15' = {
 name: resourceName
 location: location
 kind: 'standard'
 properties: {
 Description: ''
 Enabled: false
 Frequency: 300
 Kind: 'standard'
 Locations: [
 {
 Id: 'us-tx-sn1-azr'
 }
 ]
 Name: resourceName
 Request: {
 FollowRedirects: false
 Headers: [
 {
 key: 'x-header'
 value: 'testheader'
 }
 {
 key: 'x-header-2'
 value: 'testheader2'
 }
 ]
 HttpVerb: 'GET'
 ParseDependentRequests: false
 RequestUrl: 'http://microsoft.com'
 }
 RetryEnabled: false
 SyntheticMonitorId: resourceName
 Timeout: 30
 ValidationRules: {
 ExpectedHttpStatusCode: 200
 SSLCheck: false
 }
 }
 tags: {
 'hidden-link:${component.id}': 'Resource'
 }
}

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

ARM template resource definition

The webtests resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

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

{
 "type": "Microsoft.Insights/webtests",
 "apiVersion": "2022-06-15",
 "name": "string",
 "kind": "string",
 "location": "string",
 "properties": {
 "Configuration": {
 "WebTest": "string"
 },
 "Description": "string",
 "Enabled": "bool",
 "Frequency": "int",
 "Kind": "string",
 "Locations": [
 {
 "Id": "string"
 }
 ],
 "Name": "string",
 "Request": {
 "FollowRedirects": "bool",
 "Headers": [
 {
 "key": "string",
 "value": "string"
 }
 ],
 "HttpVerb": "string",
 "ParseDependentRequests": "bool",
 "RequestBody": "string",
 "RequestUrl": "string"
 },
 "RetryEnabled": "bool",
 "SyntheticMonitorId": "string",
 "Timeout": "int",
 "ValidationRules": {
 "ContentValidation": {
 "ContentMatch": "string",
 "IgnoreCase": "bool",
 "PassIfTextFound": "bool"
 },
 "ExpectedHttpStatusCode": "int",
 "IgnoreHttpStatusCode": "bool",
 "SSLCertRemainingLifetimeCheck": "int",
 "SSLCheck": "bool"
 }
 },
 "tags": {
 "{customized property}": "string"
 }
}

Property Values

Microsoft.Insights/webtests

HeaderField

WebTestGeolocation

WebTestProperties

WebTestPropertiesConfiguration

WebTestPropertiesRequest

WebTestPropertiesValidationRules

WebTestPropertiesValidationRulesContentValidation

WebtestsResourceTags

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Terraform (AzAPI provider) resource definition

The webtests resource type can be deployed with operations that target:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

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

resource "azapi_resource" "symbolicname" {
 type = "Microsoft.Insights/webtests@2022-06-15"
 name = "string"
 parent_id = "string"
 location = "string"
 tags = {
 {customized property} = "string"
 }
 body = {
 kind = "string"
 properties = {
 Configuration = {
 WebTest = "string"
 }
 Description = "string"
 Enabled = bool
 Frequency = int
 Kind = "string"
 Locations = [
 {
 Id = "string"
 }
 ]
 Name = "string"
 Request = {
 FollowRedirects = bool
 Headers = [
 {
 key = "string"
 value = "string"
 }
 ]
 HttpVerb = "string"
 ParseDependentRequests = bool
 RequestBody = "string"
 RequestUrl = "string"
 }
 RetryEnabled = bool
 SyntheticMonitorId = "string"
 Timeout = int
 ValidationRules = {
 ContentValidation = {
 ContentMatch = "string"
 IgnoreCase = bool
 PassIfTextFound = bool
 }
 ExpectedHttpStatusCode = int
 IgnoreHttpStatusCode = bool
 SSLCertRemainingLifetimeCheck = int
 SSLCheck = bool
 }
 }
 }
}

Property Values

Microsoft.Insights/webtests

HeaderField

WebTestGeolocation

WebTestProperties

WebTestPropertiesConfiguration

WebTestPropertiesRequest

WebTestPropertiesValidationRules

WebTestPropertiesValidationRulesContentValidation

WebtestsResourceTags

Usage Examples

Terraform Samples

A basic example of deploying Application Insights Standard WebTest.

terraform {
 required_providers {
 azapi = {
 source = "Azure/azapi"
 }
 }
}

provider "azapi" {
 skip_provider_registration = false
}

variable "resource_name" {
 type = string
 default = "acctest0001"
}

variable "location" {
 type = string
 default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
 type = "Microsoft.Resources/resourceGroups@2020-06-01"
 name = var.resource_name
 location = var.location
}

resource "azapi_resource" "component" {
 type = "Microsoft.Insights/components@2020-02-02"
 parent_id = azapi_resource.resourceGroup.id
 name = var.resource_name
 location = var.location
 body = {
 kind = "web"
 properties = {
 Application_Type = "web"
 DisableIpMasking = false
 DisableLocalAuth = false
 ForceCustomerStorageForProfiler = false
 RetentionInDays = 90
 SamplingPercentage = 100
 publicNetworkAccessForIngestion = "Enabled"
 publicNetworkAccessForQuery = "Enabled"
 }
 }
 schema_validation_enabled = false
 response_export_values = ["*"]
}

resource "azapi_resource" "webTest" {
 type = "Microsoft.Insights/webTests@2022-06-15"
 parent_id = azapi_resource.resourceGroup.id
 name = var.resource_name
 location = var.location
 body = {
 kind = "standard"
 properties = {
 Description = ""
 Enabled = false
 Frequency = 300
 Kind = "standard"
 Locations = [
 {
 Id = "us-tx-sn1-azr"
 },
 ]
 Name = var.resource_name
 Request = {
 FollowRedirects = false
 Headers = [
 {
 key = "x-header"
 value = "testheader"
 },
 {
 key = "x-header-2"
 value = "testheader2"
 },
 ]
 HttpVerb = "GET"
 ParseDependentRequests = false
 RequestUrl = "http://microsoft.com"
 }
 RetryEnabled = false
 SyntheticMonitorId = var.resource_name
 Timeout = 30
 ValidationRules = {
 ExpectedHttpStatusCode = 200
 SSLCheck = false
 }
 }
 tags = {
 "hidden-link:${azapi_resource.component.id}" = "Resource"
 }
 }
 schema_validation_enabled = false
 response_export_values = ["*"]
}