web_tests

Creates, updates, deletes, gets or lists a web_tests resource.

Overview

Name	web_tests
Type	Resource
Id	azure.application_insights.web_tests

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Azure resource Id.
name	string	Azure resource name.
Configuration	object	An XML configuration specification for a WebTest.
Description	string	User defined description for this WebTest.
Enabled	boolean	Is the test actively being monitored.
Frequency	integer	Interval in seconds between test runs for this WebTest. Default value is 300.
Kind	string	The kind of web test this is, valid choices are ping, multistep and standard. Required. Known values are: "ping", "multistep", and "standard". (ping, multistep, standard)
Locations	array	A list of where to physically run the tests from to give global coverage for accessibility of your application. Required.
Name	string	User defined name if this WebTest. Required.
Request	object	The collection of request properties.
RetryEnabled	boolean	Allow for retries should this WebTest fail.
SyntheticMonitorId	string	Unique ID of this WebTest. This is typically the same value as the Name field. Required.
Timeout	integer	Seconds until this WebTest will timeout and fail. Default value is 30.
ValidationRules	object	The collection of validation rule properties.
kind	string	The kind of WebTest that this web test watches. Choices are ping, multistep and standard. Known values are: "ping", "multistep", and "standard". (ping, multistep, standard)
location	string	Resource location. Required.
provisioningState	string	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.
tags	object	Resource tags.
type	string	Azure resource type.

list_by_component

Name	Datatype	Description
id	string	Azure resource Id.
name	string	Azure resource name.
Configuration	object	An XML configuration specification for a WebTest.
Description	string	User defined description for this WebTest.
Enabled	boolean	Is the test actively being monitored.
Frequency	integer	Interval in seconds between test runs for this WebTest. Default value is 300.
Kind	string	The kind of web test this is, valid choices are ping, multistep and standard. Required. Known values are: "ping", "multistep", and "standard". (ping, multistep, standard)
Locations	array	A list of where to physically run the tests from to give global coverage for accessibility of your application. Required.
Name	string	User defined name if this WebTest. Required.
Request	object	The collection of request properties.
RetryEnabled	boolean	Allow for retries should this WebTest fail.
SyntheticMonitorId	string	Unique ID of this WebTest. This is typically the same value as the Name field. Required.
Timeout	integer	Seconds until this WebTest will timeout and fail. Default value is 30.
ValidationRules	object	The collection of validation rule properties.
kind	string	The kind of WebTest that this web test watches. Choices are ping, multistep and standard. Known values are: "ping", "multistep", and "standard". (ping, multistep, standard)
location	string	Resource location. Required.
provisioningState	string	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.
tags	object	Resource tags.
type	string	Azure resource type.

list_by_resource_group

Name	Datatype	Description
id	string	Azure resource Id.
name	string	Azure resource name.
Configuration	object	An XML configuration specification for a WebTest.
Description	string	User defined description for this WebTest.
Enabled	boolean	Is the test actively being monitored.
Frequency	integer	Interval in seconds between test runs for this WebTest. Default value is 300.
Kind	string	The kind of web test this is, valid choices are ping, multistep and standard. Required. Known values are: "ping", "multistep", and "standard". (ping, multistep, standard)
Locations	array	A list of where to physically run the tests from to give global coverage for accessibility of your application. Required.
Name	string	User defined name if this WebTest. Required.
Request	object	The collection of request properties.
RetryEnabled	boolean	Allow for retries should this WebTest fail.
SyntheticMonitorId	string	Unique ID of this WebTest. This is typically the same value as the Name field. Required.
Timeout	integer	Seconds until this WebTest will timeout and fail. Default value is 30.
ValidationRules	object	The collection of validation rule properties.
kind	string	The kind of WebTest that this web test watches. Choices are ping, multistep and standard. Known values are: "ping", "multistep", and "standard". (ping, multistep, standard)
location	string	Resource location. Required.
provisioningState	string	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.
tags	object	Resource tags.
type	string	Azure resource type.

list

Name	Datatype	Description
id	string	Azure resource Id.
name	string	Azure resource name.
Configuration	object	An XML configuration specification for a WebTest.
Description	string	User defined description for this WebTest.
Enabled	boolean	Is the test actively being monitored.
Frequency	integer	Interval in seconds between test runs for this WebTest. Default value is 300.
Kind	string	The kind of web test this is, valid choices are ping, multistep and standard. Required. Known values are: "ping", "multistep", and "standard". (ping, multistep, standard)
Locations	array	A list of where to physically run the tests from to give global coverage for accessibility of your application. Required.
Name	string	User defined name if this WebTest. Required.
Request	object	The collection of request properties.
RetryEnabled	boolean	Allow for retries should this WebTest fail.
SyntheticMonitorId	string	Unique ID of this WebTest. This is typically the same value as the Name field. Required.
Timeout	integer	Seconds until this WebTest will timeout and fail. Default value is 30.
ValidationRules	object	The collection of validation rule properties.
kind	string	The kind of WebTest that this web test watches. Choices are ping, multistep and standard. Known values are: "ping", "multistep", and "standard". (ping, multistep, standard)
location	string	Resource location. Required.
provisioningState	string	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.
tags	object	Resource tags.
type	string	Azure resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, web_test_name, subscription_id		Get a specific Application Insights web test definition.
list_by_component	select	component_name, resource_group_name, subscription_id		Get all Application Insights web tests defined for the specified component.
list_by_resource_group	select	resource_group_name, subscription_id		Get all Application Insights web tests defined for the specified resource group.
list	select	subscription_id		Get all Application Insights web test definitions for the specified subscription.
create_or_update	insert	resource_group_name, web_test_name, subscription_id, location		Creates or updates an Application Insights web test definition.
update_tags	update	resource_group_name, web_test_name, subscription_id		Updates the tags associated with an Application Insights web test.
create_or_update	replace	resource_group_name, web_test_name, subscription_id, location		Creates or updates an Application Insights web test definition.
delete	delete	resource_group_name, web_test_name, subscription_id		Deletes an Application Insights web test.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
component_name	string	The name of the Application Insights component resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
web_test_name	string	The name of the Application Insights WebTest resource. Required.

SELECT examples

get

Get a specific Application Insights web test definition.

SELECT
id,
name,
Configuration,
Description,
Enabled,
Frequency,
Kind,
Locations,
Name,
Request,
RetryEnabled,
SyntheticMonitorId,
Timeout,
ValidationRules,
kind,
location,
provisioningState,
tags,
type
FROM azure.application_insights.web_tests
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND web_test_name = '{{ web_test_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_component

Get all Application Insights web tests defined for the specified component.

SELECT
id,
name,
Configuration,
Description,
Enabled,
Frequency,
Kind,
Locations,
Name,
Request,
RetryEnabled,
SyntheticMonitorId,
Timeout,
ValidationRules,
kind,
location,
provisioningState,
tags,
type
FROM azure.application_insights.web_tests
WHERE component_name = '{{ component_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Get all Application Insights web tests defined for the specified resource group.

SELECT
id,
name,
Configuration,
Description,
Enabled,
Frequency,
Kind,
Locations,
Name,
Request,
RetryEnabled,
SyntheticMonitorId,
Timeout,
ValidationRules,
kind,
location,
provisioningState,
tags,
type
FROM azure.application_insights.web_tests
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Get all Application Insights web test definitions for the specified subscription.

SELECT
id,
name,
Configuration,
Description,
Enabled,
Frequency,
Kind,
Locations,
Name,
Request,
RetryEnabled,
SyntheticMonitorId,
Timeout,
ValidationRules,
kind,
location,
provisioningState,
tags,
type
FROM azure.application_insights.web_tests
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates an Application Insights web test definition.

INSERT INTO azure.application_insights.web_tests (
location,
tags,
kind,
properties,
resource_group_name,
web_test_name,
subscription_id
)
SELECT 
'{{ location }}' /* required */,
'{{ tags }}',
'{{ kind }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ web_test_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
kind,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: web_tests
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the web_tests resource.
  - name: web_test_name
    value: "{{ web_test_name }}"
    description: Required parameter for the web_tests resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the web_tests resource.
  - name: location
    value: "{{ location }}"
    description: |
      Resource location. Required.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: kind
    value: "{{ kind }}"
    description: |
      The kind of WebTest that this web test watches. Choices are ping, multistep and standard. Known values are: "ping", "multistep", and "standard".
    valid_values: ['ping', 'multistep', 'standard']
  - name: properties
    description: |
      Metadata describing a web test for an Azure resource.
    value:
      SyntheticMonitorId: "{{ SyntheticMonitorId }}"
      Name: "{{ Name }}"
      Description: "{{ Description }}"
      Enabled: {{ Enabled }}
      Frequency: {{ Frequency }}
      Timeout: {{ Timeout }}
      Kind: "{{ Kind }}"
      RetryEnabled: {{ RetryEnabled }}
      Locations:
        - Id: "{{ Id }}"
      Configuration:
        WebTest: "{{ WebTest }}"
      provisioningState: "{{ provisioningState }}"
      Request:
        RequestUrl: "{{ RequestUrl }}"
        Headers:
          - key: "{{ key }}"
            value: "{{ value }}"
        HttpVerb: "{{ HttpVerb }}"
        RequestBody: "{{ RequestBody }}"
        ParseDependentRequests: {{ ParseDependentRequests }}
        FollowRedirects: {{ FollowRedirects }}
      ValidationRules:
        ContentValidation:
          ContentMatch: "{{ ContentMatch }}"
          IgnoreCase: {{ IgnoreCase }}
          PassIfTextFound: {{ PassIfTextFound }}
        SSLCheck: {{ SSLCheck }}
        SSLCertRemainingLifetimeCheck: {{ SSLCertRemainingLifetimeCheck }}
        ExpectedHttpStatusCode: {{ ExpectedHttpStatusCode }}
        IgnoreHttpStatusCode: {{ IgnoreHttpStatusCode }}

UPDATE examples

update_tags

Updates the tags associated with an Application Insights web test.

UPDATE azure.application_insights.web_tests
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND web_test_name = '{{ web_test_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
kind,
location,
properties,
tags,
type;

REPLACE examples

create_or_update

Creates or updates an Application Insights web test definition.

REPLACE azure.application_insights.web_tests
SET 
location = '{{ location }}',
tags = '{{ tags }}',
kind = '{{ kind }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND web_test_name = '{{ web_test_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
kind,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes an Application Insights web test.

DELETE FROM azure.application_insights.web_tests
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND web_test_name = '{{ web_test_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;