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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Current state of this QueryPack: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Succeeded, Deploying, Canceled, and Failed.
queryPackId	string	The unique ID of your application. This field cannot be changed.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
timeCreated	string (date-time)	Creation Date for the Log Analytics QueryPack, in ISO 8601 format.
timeModified	string (date-time)	Last modified date of the Log Analytics QueryPack, in ISO 8601 format.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Current state of this QueryPack: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Succeeded, Deploying, Canceled, and Failed.
queryPackId	string	The unique ID of your application. This field cannot be changed.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
timeCreated	string (date-time)	Creation Date for the Log Analytics QueryPack, in ISO 8601 format.
timeModified	string (date-time)	Last modified date of the Log Analytics QueryPack, in ISO 8601 format.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Current state of this QueryPack: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Succeeded, Deploying, Canceled, and Failed.
queryPackId	string	The unique ID of your application. This field cannot be changed.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
timeCreated	string (date-time)	Creation Date for the Log Analytics QueryPack, in ISO 8601 format.
timeModified	string (date-time)	Last modified date of the Log Analytics QueryPack, in ISO 8601 format.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, query_pack_name, subscription_id		Returns a Log Analytics QueryPack.
list_by_resource_group	select	resource_group_name, subscription_id		Gets a list of Log Analytics QueryPacks within a resource group.
list	select	subscription_id		Gets a list of all Log Analytics QueryPacks within a subscription.
create_or_update	insert	resource_group_name, query_pack_name, subscription_id, location, properties		Creates (or updates) a Log Analytics QueryPack. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.
update_tags	update	resource_group_name, query_pack_name, subscription_id		Updates an existing QueryPack's tags. To update other fields use the CreateOrUpdate method.
create_or_update	replace	resource_group_name, query_pack_name, subscription_id, location, 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	resource_group_name, query_pack_name, subscription_id		Deletes a Log Analytics QueryPack.
create_or_update_without_name	exec	resource_group_name, subscription_id, location, properties		Creates a Log Analytics QueryPack. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.

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
query_pack_name	string	The name of the Log Analytics QueryPack resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Returns a Log Analytics QueryPack.

SELECT
id,
name,
location,
provisioningState,
queryPackId,
systemData,
tags,
timeCreated,
timeModified,
type
FROM azure.log_analytics.query_packs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND query_pack_name = '{{ query_pack_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

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

SELECT
id,
name,
location,
provisioningState,
queryPackId,
systemData,
tags,
timeCreated,
timeModified,
type
FROM azure.log_analytics.query_packs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

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

SELECT
id,
name,
location,
provisioningState,
queryPackId,
systemData,
tags,
timeCreated,
timeModified,
type
FROM azure.log_analytics.query_packs
WHERE subscription_id = '{{ subscription_id }}' -- 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 (
tags,
location,
properties,
resource_group_name,
query_pack_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ query_pack_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: query_packs
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the query_packs resource.
  - name: query_pack_name
    value: "{{ query_pack_name }}"
    description: Required parameter for the query_packs resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the query_packs resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Properties that define a Log Analytics QueryPack resource. Required.
    value:
      queryPackId: "{{ queryPackId }}"
      timeCreated: "{{ timeCreated }}"
      timeModified: "{{ timeModified }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update_tags

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

UPDATE azure.log_analytics.query_packs
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND query_pack_name = '{{ query_pack_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

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

REPLACE azure.log_analytics.query_packs
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND query_pack_name = '{{ query_pack_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a Log Analytics QueryPack.

DELETE FROM azure.log_analytics.query_packs
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND query_pack_name = '{{ query_pack_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

create_or_update_without_name

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

EXEC azure.log_analytics.query_packs.create_or_update_without_name 
@resource_group_name='{{ resource_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"tags": "{{ tags }}", 
"location": "{{ location }}", 
"properties": "{{ properties }}"
}'
;