summary_logs

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

Overview

Name	summary_logs
Type	Resource
Id	azure.log_analytics.summary_logs

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.
description	string	The description of the Summary rule.
displayName	string	The display name of the Summary rule.
isActive	boolean	Indicates if Summary rule is active. If not, Summary rule execution stops.
provisioningState	string	Summary rule is in provisioning state. If set to 'updating' or 'deleting', indicates a resource lock due to an ongoing operation, preventing any update to the Summary rule until the operation is complete. Known values are: "Updating", "Succeeded", "Deleting", "Failed", and "Canceled". (Updating, Succeeded, Deleting, Failed, Canceled)
ruleDefinition	object	Rule definition parameters.
ruleType	string	SummaryRules rule type: User. "User" (User)
statusCode	string	Indicates the reason for rule deactivation. Known values are: "UserAction" and "DataPlaneError". (UserAction, DataPlaneError)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_workspace

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.
description	string	The description of the Summary rule.
displayName	string	The display name of the Summary rule.
isActive	boolean	Indicates if Summary rule is active. If not, Summary rule execution stops.
provisioningState	string	Summary rule is in provisioning state. If set to 'updating' or 'deleting', indicates a resource lock due to an ongoing operation, preventing any update to the Summary rule until the operation is complete. Known values are: "Updating", "Succeeded", "Deleting", "Failed", and "Canceled". (Updating, Succeeded, Deleting, Failed, Canceled)
ruleDefinition	object	Rule definition parameters.
ruleType	string	SummaryRules rule type: User. "User" (User)
statusCode	string	Indicates the reason for rule deactivation. Known values are: "UserAction" and "DataPlaneError". (UserAction, DataPlaneError)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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, workspace_name, summary_logs_name, subscription_id		Gets Log Analytics workspace Summary rules.
list_by_workspace	select	resource_group_name, workspace_name, subscription_id		Gets all summary rules for the specified Log Analytics workspace.
create_or_update	insert	resource_group_name, workspace_name, summary_logs_name, subscription_id		Creates or updates Log Analytics workspace Summary rules.
create_or_update	replace	resource_group_name, workspace_name, summary_logs_name, subscription_id		Creates or updates Log Analytics workspace Summary rules.
delete	delete	resource_group_name, workspace_name, summary_logs_name, subscription_id		Deletes Log Analytics workspace Summary rules.
start	exec	resource_group_name, workspace_name, summary_logs_name, subscription_id		Starts an inactive Summary rule.
stop	exec	resource_group_name, workspace_name, summary_logs_name, subscription_id		Stops an active Summary rule.
retry_bin	exec	resource_group_name, workspace_name, summary_logs_name, subscription_id		Retries a failed Summary rule bin.

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.
subscription_id	string
summary_logs_name	string	The name of the summary logs. Must not contain '/'. Required.
workspace_name	string	The name of the workspace. Required.

SELECT examples

get

Gets Log Analytics workspace Summary rules.

SELECT
id,
name,
description,
displayName,
isActive,
provisioningState,
ruleDefinition,
ruleType,
statusCode,
systemData,
type
FROM azure.log_analytics.summary_logs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND summary_logs_name = '{{ summary_logs_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_workspace

Gets all summary rules for the specified Log Analytics workspace.

SELECT
id,
name,
description,
displayName,
isActive,
provisioningState,
ruleDefinition,
ruleType,
statusCode,
systemData,
type
FROM azure.log_analytics.summary_logs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates Log Analytics workspace Summary rules.

INSERT INTO azure.log_analytics.summary_logs (
properties,
resource_group_name,
workspace_name,
summary_logs_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ summary_logs_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: summary_logs
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the summary_logs resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the summary_logs resource.
  - name: summary_logs_name
    value: "{{ summary_logs_name }}"
    description: Required parameter for the summary_logs resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the summary_logs resource.
  - name: properties
    description: |
      Summary rule properties.
    value:
      ruleType: "{{ ruleType }}"
      displayName: "{{ displayName }}"
      description: "{{ description }}"
      isActive: {{ isActive }}
      statusCode: "{{ statusCode }}"
      provisioningState: "{{ provisioningState }}"
      ruleDefinition:
        query: "{{ query }}"
        binSize: {{ binSize }}
        binDelay: {{ binDelay }}
        binStartTime: "{{ binStartTime }}"
        timeSelector: "{{ timeSelector }}"
        destinationTable: "{{ destinationTable }}"

REPLACE examples

create_or_update

Creates or updates Log Analytics workspace Summary rules.

REPLACE azure.log_analytics.summary_logs
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND summary_logs_name = '{{ summary_logs_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes Log Analytics workspace Summary rules.

DELETE FROM azure.log_analytics.summary_logs
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND summary_logs_name = '{{ summary_logs_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

start

Starts an inactive Summary rule.

EXEC azure.log_analytics.summary_logs.start 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@summary_logs_name='{{ summary_logs_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

stop

Stops an active Summary rule.

EXEC azure.log_analytics.summary_logs.stop 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@summary_logs_name='{{ summary_logs_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

retry_bin

Retries a failed Summary rule bin.

EXEC azure.log_analytics.summary_logs.retry_bin 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@summary_logs_name='{{ summary_logs_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;