Web Test

Overview

{
	"name": "sample-webtest-name",
	"test_locations": [
		"WestEurope",
		"WestUs",
		"UKSouth",
		"SoutheastAsia",
		"EastUS"
	],
	"request": {
		"http_verb": "GET",
		"url": "http://example.com",
		"parse_dependent_requests": true,
		"headers": {
			"Content-Type": "application/json"
		},
		"follow_redirects": true,
		"body": "Request body content"
	},
	"validation_rules": {
		"ssl_cert": false,
		"ssl_cert_remaining_days": 30,
		"ignore_http_status": false,
		"expected_status_code": 200,
		"content_validation": {
			"content_match": "Expected content",
			"ignore_case": false,
			"pass_if_found": true
		}
	},
	"frequency": 300,
	"timeout": 30,
	"retry": false,
	"enabled": true,
	"description": "Detailed description of the web test",
	"@application_insights_name": "sample-app-insights",
	"location": "northeurope",
	"external": false,
	"resource_group_name": "my-rg-name",
	"tags": { "example": "S0" }
}

Web Test Reference

Key	Type	Description
name (required)	string	The name of the Web Test (see how to name)
test_locations (required)	Test Locations[]	The test locations
request (required)	Request	The request configuration
validation_rules (required)	Validation Rules	The validation rules for the test (defaults to no validation rules)
frequency	int	The frequency of the test in seconds (defaults to 300)
timeout	int	The timeout of the test in seconds (defaults to 30)
retry	bool	Whether or not to retry the test (defaults to false)
enabled	bool	Whether or not the test is enabled (defaults to true)
location	string	Resource Location (defaults to the resource group location)
external	bool	A reference to an existing Container Registry (defaults to false)
resource_group_name	string	The name of the resource group where the resource is located, only with external resources (defaults to the resource group of the deployment)
tags	object	Additional tags for the resource (defaults to no additional tags)

TestLocations

Value	Description
AustraliaEast	Australia East
BrazilSouth	Brazil South
CentralUS	Central US
EastAsia	East Asia
EastUS	East US
FranceCentral	France Central
FranceSouth	France South
JapanEast	Japan East
NorthCentralUS	North Central US
NorthEurope	North Europe
SouthCentralUS	South Central US
SoutheastAsia	Southeast Asia
UKSouth	UK South
UKWest	UK West
WestEurope	West Europe
WestUS	West US

Request

Key	Type	Description
http_verb (required)	HTTP verb	The HTTP verb to use
url (required)	string	The URL to use for the web test
parse_dependent_requests (required)	bool	Whether or not to parse dependent requests
headers	Object	The headers to use for the request
follow_redirects	bool	Whether or not to follow redirects
body	string	The body content of the request

HTTPVerb

Value	Description
GET	GET
HEAD	HEAD
POST	POST
PUT	PUT
PATCH	PATCH
DELETE	DELETE
OPTIONS	OPTIONS

ValidationRules

Key	Type	Description
expected_status_code (required)	int	The expected status code (defaults to 200)
ssl_cert	bool	Whether or not to validate the SSL certificate (defaults to false)
ssl_cert_remaining_days	int	The number of days remaining on the SSL certificate (no default)
ignore_http_status	bool	Whether or not to ignore the HTTP status (defaults to false)
content_validation	ContentValidation	The content validation configuration (defaults to no content validation)

ContentValidation

Key	Type	Description
content_match (required)	string	The content to match
pass_if_found (required)	bool	Whether or not to pass if found
ignore_case	bool	Whether or not to ignore case (defaults to false)