alert_rule_templates
Creates, updates, deletes, gets or lists an alert_rule_templates resource.
Overview
| Name | alert_rule_templates |
| Type | Resource |
| Id | azure.sentinel.alert_rule_templates |
Fields
The following fields are returned by SELECT queries:
- get
- list
OK, Operation successfully completed
| 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 |
kind | string | The alert rule kind |
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" |
OK, Operation successfully completed
| 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 |
kind | string | The alert rule kind |
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 | subscriptionId, resourceGroupName, workspaceName, alertRuleTemplateId | Gets the alert rule template. | |
list | select | subscriptionId, resourceGroupName, workspaceName | Gets all alert rule templates. |
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 |
|---|---|---|
alertRuleTemplateId | string | Alert rule template ID |
resourceGroupName | string | The name of the resource group. The name is case insensitive. |
subscriptionId | string | The ID of the target subscription. |
workspaceName | string | The name of the workspace. |
SELECT examples
- get
- list
Gets the alert rule template.
SELECT
id,
name,
kind,
systemData,
type
FROM azure.sentinel.alert_rule_templates
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND alertRuleTemplateId = '{{ alertRuleTemplateId }}' -- required
;
Gets all alert rule templates.
SELECT
id,
name,
kind,
systemData,
type
FROM azure.sentinel.alert_rule_templates
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
;