analytics_items

Creates, updates, deletes, gets or lists an analytics_items resource.

Overview

Name	analytics_items
Type	Resource
Id	azure.application_insights.analytics_items

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
Content	string	The content of this item.
Id	string	Internally assigned unique id of the item definition.
Name	string	The user-defined name of the item.
Properties	object	A set of properties that can be defined in the context of a specific item type. Each type may have its own properties.
Scope	string	Enum indicating if this item definition is owned by a specific user or is shared between all users with access to the Application Insights component. Known values are: "shared" and "user". (shared, user)
TimeCreated	string	Date and time in UTC when this item was created.
TimeModified	string	Date and time in UTC of the last modification that was made to this item.
Type	string	Enum indicating the type of the Analytics item. Known values are: "none", "query", "recent", and "function". (none, query, recent, function)
Version	string	This instance's version of the data model. This can change as new features are added.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, resource_name, scope_path, subscription_id	id, name	Gets a specific Analytics Items defined within an Application Insights component.
delete	delete	resource_group_name, resource_name, scope_path, subscription_id	id, name	Deletes a specific Analytics Items defined within an Application Insights component.
put	exec	resource_group_name, resource_name, scope_path, subscription_id	overrideItem	Adds or Updates a specific Analytics Item within an Application Insights component.
list_raw	exec	resource_group_name, resource_name, scope_path, subscription_id	scope, type, includeContent	Gets a list of Analytics Items defined within an Application Insights component.

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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_name	string	The name of the Application Insights component resource. Required.
scope_path	string	Enum indicating if this item definition is owned by a specific user or is shared between all users with access to the Application Insights component. Known values are: "analyticsItems" and "myanalyticsItems". Required.
subscription_id	string
id	string	The Id of a specific item defined in the Application Insights component. Default value is None.
includeContent	boolean	Flag indicating whether or not to return the content of each applicable item. If false, only return the item information. Default value is None.
name	string	The name of a specific item defined in the Application Insights component. Default value is None.
overrideItem	boolean	Flag indicating whether or not to force save an item. This allows overriding an item if it already exists. Default value is None.
scope	string	Enum indicating if this item definition is owned by a specific user or is shared between all users with access to the Application Insights component. Known values are: "shared" and "user". Default value is None.
type	string	Enum indicating the type of the Analytics item. Known values are: "none", "query", "function", "folder", and "recent". Default value is None.

SELECT examples

get

Gets a specific Analytics Items defined within an Application Insights component.

SELECT
Content,
Id,
Name,
Properties,
Scope,
TimeCreated,
TimeModified,
Type,
Version
FROM azure.application_insights.analytics_items
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND scope_path = '{{ scope_path }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND id = '{{ id }}'
AND name = '{{ name }}'
;

DELETE examples

delete

Deletes a specific Analytics Items defined within an Application Insights component.

DELETE FROM azure.application_insights.analytics_items
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND scope_path = '{{ scope_path }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND id = '{{ id }}'
AND name = '{{ name }}'
;

Lifecycle Methods

put

Adds or Updates a specific Analytics Item within an Application Insights component.

EXEC azure.application_insights.analytics_items.put 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@scope_path='{{ scope_path }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@overrideItem={{ overrideItem }} 
@@json=
'{
"Id": "{{ Id }}", 
"Name": "{{ Name }}", 
"Content": "{{ Content }}", 
"Scope": "{{ Scope }}", 
"Type": "{{ Type }}", 
"Properties": "{{ Properties }}"
}'
;

list_raw

Gets a list of Analytics Items defined within an Application Insights component.

EXEC azure.application_insights.analytics_items.list_raw 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@scope_path='{{ scope_path }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@scope='{{ scope }}', 
@type='{{ type }}', 
@includeContent={{ includeContent }}
;