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

A single item associated with the Application Insights component.

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.
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.
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	subscriptionId, resourceGroupName, resourceName, scopePath	id, name	Gets a specific Analytics Items defined within an Application Insights component.
put	replace	subscriptionId, resourceGroupName, resourceName, scopePath	overrideItem	Adds or Updates a specific Analytics Item within an Application Insights component.
delete	delete	subscriptionId, resourceGroupName, resourceName, scopePath	id, name	Deletes a specific Analytics Items defined within an Application Insights component.
list	exec	subscriptionId, resourceGroupName, resourceName, scopePath	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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
resourceName	string	The name of the Application Insights component resource.
scopePath	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.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
id	string	The Id of a specific item defined in the Application Insights component
includeContent	boolean	Flag indicating whether or not to return the content of each applicable item. If false, only return the item information.
name	string	The name of a specific item defined in the Application Insights component
overrideItem	boolean	Flag indicating whether or not to force save an item. This allows overriding an item if it already exists.
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.
type	string	Enum indicating the type of the Analytics item.

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 subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
AND scopePath = '{{ scopePath }}' -- required
AND id = '{{ id }}'
AND name = '{{ name }}'
;

REPLACE examples

put

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

REPLACE azure.application_insights.analytics_items
SET 
data__Id = '{{ Id }}',
data__Name = '{{ Name }}',
data__Content = '{{ Content }}',
data__Scope = '{{ Scope }}',
data__Type = '{{ Type }}',
data__Properties = '{{ Properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
AND scopePath = '{{ scopePath }}' --required
AND overrideItem = {{ overrideItem}}
RETURNING
Content,
Id,
Name,
Properties,
Scope,
TimeCreated,
TimeModified,
Type,
Version;

DELETE examples

delete

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

DELETE FROM azure.application_insights.analytics_items
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
AND scopePath = '{{ scopePath }}' --required
AND id = '{{ id }}'
AND name = '{{ name }}'
;

Lifecycle Methods

list

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

EXEC azure.application_insights.analytics_items.list 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@resourceName='{{ resourceName }}' --required, 
@scopePath='{{ scopePath }}' --required, 
@scope='{{ scope }}', 
@type='{{ type }}', 
@includeContent={{ includeContent }}
;