queries

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

Overview

Name	queries
Type	Resource
Id	azure.log_analytics.queries

Fields

The following fields are returned by SELECT queries:

get

A single query contained within the Log Analytics QueryPack.

Name	Datatype	Description
id	string	Azure resource Id
name	string	Azure resource name
properties	object	Properties that define an Log Analytics QueryPack-Query resource.
systemData	object	Read only system data
type	string	Azure resource type

list

A list containing 0 or more queries contained within the Log Analytics QueryPack.

Name	Datatype	Description
id	string	Azure resource Id
name	string	Azure resource name
properties	object	Properties that define an Log Analytics QueryPack-Query resource.
systemData	object	Read only system data
type	string	Azure resource type

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, queryPackName, id		Gets a specific Log Analytics Query defined within a Log Analytics QueryPack.
list	select	subscriptionId, resourceGroupName, queryPackName	$top, includeBody, $skipToken	Gets a list of Queries defined within a Log Analytics QueryPack.
update	update	subscriptionId, resourceGroupName, queryPackName, id		Adds or Updates a specific Query within a Log Analytics QueryPack.
put	replace	subscriptionId, resourceGroupName, queryPackName, id		Adds or Updates a specific Query within a Log Analytics QueryPack.
delete	delete	subscriptionId, resourceGroupName, queryPackName, id		Deletes a specific Query defined within an Log Analytics QueryPack.
search	exec	subscriptionId, resourceGroupName, queryPackName	$top, includeBody, $skipToken	Search a list of Queries defined within a Log Analytics QueryPack according to given search properties.

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
id	string	The id of a specific query defined in the Log Analytics QueryPack
queryPackName	string	The name of the Log Analytics QueryPack resource.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
$skipToken	string	Base64 encoded token used to fetch the next page of items. Default is null.
$top	integer (int64)	Maximum items returned in page.
includeBody	boolean	Flag indicating whether or not to return the body of each applicable query. If false, only return the query information.

SELECT examples

get

Gets a specific Log Analytics Query defined within a Log Analytics QueryPack.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.log_analytics.queries
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND queryPackName = '{{ queryPackName }}' -- required
AND id = '{{ id }}' -- required
;

list

Gets a list of Queries defined within a Log Analytics QueryPack.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.log_analytics.queries
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND queryPackName = '{{ queryPackName }}' -- required
AND $top = '{{ $top }}'
AND includeBody = '{{ includeBody }}'
AND $skipToken = '{{ $skipToken }}'
;

UPDATE examples

update

Adds or Updates a specific Query within a Log Analytics QueryPack.

UPDATE azure.log_analytics.queries
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND queryPackName = '{{ queryPackName }}' --required
AND id = '{{ id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

put

Adds or Updates a specific Query within a Log Analytics QueryPack.

REPLACE azure.log_analytics.queries
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND queryPackName = '{{ queryPackName }}' --required
AND id = '{{ id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a specific Query defined within an Log Analytics QueryPack.

DELETE FROM azure.log_analytics.queries
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND queryPackName = '{{ queryPackName }}' --required
AND id = '{{ id }}' --required
;

Lifecycle Methods

search

Search a list of Queries defined within a Log Analytics QueryPack according to given search properties.

EXEC azure.log_analytics.queries.search 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@queryPackName='{{ queryPackName }}' --required, 
@$top='{{ $top }}', 
@includeBody={{ includeBody }}, 
@$skipToken='{{ $skipToken }}' 
@@json=
'{
"related": "{{ related }}", 
"tags": "{{ tags }}"
}'
;