Get information about a web test in Azure Application Insights REST API

 

Updated: September 26, 2016

See Common parameters and headers for headers and parameters that are used by all requests related to web tests.

Method

Request URI

GET

https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/microsoft.insights/webTests/{web-test-name}?api-version={api-version}

Replace {web-test-name} with the name of the setting for which you want to get information.

Status code: 200; otherwise a 404.

JSON
Copy 
{
  "id": "/subscriptions/089bd33f-d4ec-47fe-8ba5-0753aa5c5b33/resourceGroups/Default-Web-CentralUS/providers/microsoft.insights/webtests/homepagetest ",
  "name": "homepagetest ",
  "type": "microsoft.insights/webtests",
  "location": "Central US",
  "tags": { },
  "properties": {
    "provisioningState": "Succeeded",
    "Name": "Homepagetest",
    "Description": "",
    "Enabled": true,
    "Frequency": 300,
    "Timeout": 30,
    "Kind": "ping",
    "Locations": [ {
      "Id": "apac-sg-sin-azr"
    },
    {
      "Id": "us-tx-sn1-azr"
    },
    {
      "Id": "emea-gb-db3-azr"
    } ],
    "Configuration": {
    "WebTest": "<WebTest     Name=\"Homepagetest\"     Id=\"062296d4-3660-40a9-b41d-f59f68d64565\"     Enabled=\"True\"     CssProjectStructure=\"\"     CssIteration=\"\"     Timeout=\"0\"     WorkItemIds=\"\"     xmlns=\"http://microsoft.com/schemas/VisualStudio/TeamTest/2010\"     Description=\"\"     CredentialUserName=\"\"     CredentialPassword=\"\"     PreAuthenticate=\"True\"     Proxy=\"default\"     StopOnError=\"False\"     RecordedResultFile=\"\"     ResultsLocale=\"\">  <Items>    <Request         Method=\"GET\"         Guid=\"a0443cd6-3be8-d87c-14ef-1562be1906f5\"         Version=\"1.1\"         Url=\"http://home.azurewebsites.net\"         ThinkTime=\"0\"         Timeout=\"300\"         ParseDependentRequests=\"True\"         FollowRedirects=\"True\"         RecordResult=\"True\"         Cache=\"False\"         ResponseTimeGoal=\"0\"         Encoding=\"utf-8\"         ExpectedHttpStatusCode=\"200\"         ExpectedResponseUrl=\"\"         ReportingName=\"\"         IgnoreHttpStatusCode=\"False\" />  </Items></WebTest>"
    },
    "SyntheticMonitorId": "homepagetest"
  }
}

Element name

Description

Id

The identifying URL of the web test.

name

The name of the web test.

type

Specifies that this is of type Microsoft.Insights/WebTests.

location

Specifies the supported Azure location of the web test. For more information, see List all of the available geo-locations.

tags

The tags and their values.

provisioningState

Contains a collection of automatic scaling profiles that specify different scaling parameters for different time periods. A maximum of 20 profiles can be specified.

enabled

Specifies whether the web test is enabled.

frequency

How frequently the web test should run (in seconds).

timeout

How long the web test should wait until the request is considered failed (in seconds).

kind

Either ping or multi-step.

locations

An array of locations to start the web test from.

configuration

The XML representation of the web test file.

syntheticMonitorId

The synthetic monitor id.

Show: