query_packs

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

Overview

Name	query_packs
Type	Resource
Id	azure.log_analytics.query_packs

Fields

The following fields are returned by SELECT queries:

get

An Log Analytics QueryPack definition.

Name	Datatype	Description
id	string	Azure resource Id
name	string	Azure resource name
location	string	Resource location
properties	object	Properties that define a Log Analytics QueryPack resource.
tags	object	Resource tags
type	string	Azure resource type

list_by_resource_group

A list containing 0 or more Log Analytics QueryPack definitions.

Name	Datatype	Description
id	string	Azure resource Id
name	string	Azure resource name
location	string	Resource location
properties	object	Properties that define a Log Analytics QueryPack resource.
tags	object	Resource tags
type	string	Azure resource type

list

A list containing 0 or more Log Analytics QueryPack definitions.

Name	Datatype	Description
id	string	Azure resource Id
name	string	Azure resource name
location	string	Resource location
properties	object	Properties that define a Log Analytics QueryPack resource.
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	resourceGroupName, subscriptionId, queryPackName		Returns a Log Analytics QueryPack.
list_by_resource_group	select	resourceGroupName, subscriptionId		Gets a list of Log Analytics QueryPacks within a resource group.
list	select	subscriptionId		Gets a list of all Log Analytics QueryPacks within a subscription.
create_or_update	insert	resourceGroupName, subscriptionId, queryPackName, data__properties		Creates (or updates) a Log Analytics QueryPack. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.
delete	delete	resourceGroupName, subscriptionId, queryPackName		Deletes a Log Analytics QueryPack.
update_tags	exec	resourceGroupName, subscriptionId, queryPackName		Updates an existing QueryPack's tags. To update other fields use the CreateOrUpdate method.

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
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.

SELECT examples

get

Returns a Log Analytics QueryPack.

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

list_by_resource_group

Gets a list of Log Analytics QueryPacks within a resource group.

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

list

Gets a list of all Log Analytics QueryPacks within a subscription.

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

INSERT examples

create_or_update

Creates (or updates) a Log Analytics QueryPack. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.

INSERT INTO azure.log_analytics.query_packs (
data__properties,
data__location,
data__tags,
resourceGroupName,
subscriptionId,
queryPackName
)
SELECT 
'{{ properties }}' /* required */,
'{{ location }}',
'{{ tags }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ queryPackName }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: query_packs
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the query_packs resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the query_packs resource.
    - name: queryPackName
      value: string
      description: Required parameter for the query_packs resource.
    - name: properties
      value: object
      description: |
        Properties that define a Log Analytics QueryPack resource.
    - name: location
      value: string
      description: |
        Resource location
    - name: tags
      value: object
      description: |
        Resource tags

DELETE examples

delete

Deletes a Log Analytics QueryPack.

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

Lifecycle Methods

update_tags

Updates an existing QueryPack's tags. To update other fields use the CreateOrUpdate method.

EXEC azure.log_analytics.query_packs.update_tags 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@queryPackName='{{ queryPackName }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;