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

Ann Application Insights web test definition.

Name	Datatype	Description
id	string	Azure resource Id
name	string	Azure resource name
kind	string	The kind of WebTest that this web test watches. Choices are ping, multistep and standard. (default: ping)
location	string	Resource location
properties	object	Metadata describing a web test for an Azure resource.
tags		Resource tags
type	string	Azure resource type

list_by_component

A list containing 0 or more web test definitions.

Name	Datatype	Description
id	string	Azure resource Id
name	string	Azure resource name
kind	string	The kind of WebTest that this web test watches. Choices are ping, multistep and standard. (default: ping)
location	string	Resource location
properties	object	Metadata describing a web test for an Azure resource.
tags		Resource tags
type	string	Azure resource type

list_by_resource_group

A list containing 0 or more web test definitions.

Name	Datatype	Description
id	string	Azure resource Id
name	string	Azure resource name
kind	string	The kind of WebTest that this web test watches. Choices are ping, multistep and standard. (default: ping)
location	string	Resource location
properties	object	Metadata describing a web test for an Azure resource.
tags		Resource tags
type	string	Azure resource type

list

A list of 0 or more Application Insights web test definitions.

Name	Datatype	Description
id	string	Azure resource Id
name	string	Azure resource name
kind	string	The kind of WebTest that this web test watches. Choices are ping, multistep and standard. (default: ping)
location	string	Resource location
properties	object	Metadata describing a web test for an Azure resource.
tags		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	resourceGroupName, subscriptionId, webTestName		Get a specific Application Insights web test definition.
list_by_component	select	componentName, resourceGroupName, subscriptionId		Get all Application Insights web tests defined for the specified component.
list_by_resource_group	select	resourceGroupName, subscriptionId		Get all Application Insights web tests defined for the specified resource group.
list	select	subscriptionId		Get all Application Insights web test definitions for the specified subscription.
create_or_update	insert	resourceGroupName, subscriptionId, webTestName		Creates or updates an Application Insights web test definition.
delete	delete	subscriptionId, resourceGroupName, webTestName		Deletes an Application Insights web test.
update_tags	exec	resourceGroupName, subscriptionId, webTestName		Updates the tags associated with 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
componentName	string	The name of the Application Insights component resource.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
webTestName	string	The name of the Application Insights WebTest resource.

SELECT examples

get

Get a specific Application Insights web test definition.

SELECT
id,
name,
kind,
location,
properties,
tags,
type
FROM azure.application_insights.web_tests
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND webTestName = '{{ webTestName }}' -- required
;

list_by_component

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

SELECT
id,
name,
kind,
location,
properties,
tags,
type
FROM azure.application_insights.web_tests
WHERE componentName = '{{ componentName }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_resource_group

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

SELECT
id,
name,
kind,
location,
properties,
tags,
type
FROM azure.application_insights.web_tests
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

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

SELECT
id,
name,
kind,
location,
properties,
tags,
type
FROM azure.application_insights.web_tests
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates an Application Insights web test definition.

INSERT INTO azure.application_insights.web_tests (
data__location,
data__tags,
data__kind,
data__properties,
resourceGroupName,
subscriptionId,
webTestName
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ kind }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ webTestName }}'
RETURNING
id,
name,
kind,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: web_tests
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the web_tests resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the web_tests resource.
    - name: webTestName
      value: string
      description: Required parameter for the web_tests resource.
    - name: location
      value: string
      description: |
        Resource location
    - name: tags
      value: string
      description: |
        Resource tags
    - name: kind
      value: string
      description: |
        The kind of WebTest that this web test watches. Choices are ping, multistep and standard.
      valid_values: ['ping', 'multistep', 'standard']
      default: ping
    - name: properties
      value: object
      description: |
        Metadata describing a web test for an Azure resource.

DELETE examples

delete

Deletes an Application Insights web test.

DELETE FROM azure.application_insights.web_tests
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND webTestName = '{{ webTestName }}' --required
;

Lifecycle Methods

update_tags

Updates the tags associated with an Application Insights web test.

EXEC azure.application_insights.web_tests.update_tags 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@webTestName='{{ webTestName }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;