Skip to main content

content_templates

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

Overview

Namecontent_templates
TypeResource
Idazure.security_insight.content_templates

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringFully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
namestringThe name of the resource.
authorobjectThe creator of the content item.
categoriesobjectCategories for the item.
contentIdstringStatic ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Dynamic for user-created. This is the resource name.
contentKindstringThe kind of content the template is for. Known values are: "DataConnector", "DataType", "Workbook", "WorkbookTemplate", "Playbook", "PlaybookTemplate", "AnalyticsRuleTemplate", "AnalyticsRule", "HuntingQuery", "InvestigationQuery", "Parser", "Watchlist", "WatchlistTemplate", "Solution", "AzureFunction", "LogicAppsCustomConnector", "AutomationRule", "ResourcesDataConnector", "Notebook", "Standalone", "SummaryRule", and "CustomDetection". (DataConnector, DataType, Workbook, WorkbookTemplate, Playbook, PlaybookTemplate, AnalyticsRuleTemplate, AnalyticsRule, HuntingQuery, InvestigationQuery, Parser, Watchlist, WatchlistTemplate, Solution, AzureFunction, LogicAppsCustomConnector, AutomationRule, ResourcesDataConnector, Notebook, Standalone, SummaryRule, CustomDetection)
contentProductIdstringUnique ID for the content. It should be generated based on the contentId of the package, contentId of the template, contentKind of the template and the contentVersion of the template.
contentSchemaVersionstringSchema version of the content. Can be used to distinguish between different flow based on the schema version.
customVersionstringThe custom version of the content. A optional free text.
dependantTemplatesarrayDependant templates. Expandable.
dependenciesobjectDependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex formats.
displayNamestringThe display name of the template.
etagstringEtag of the azure resource.
firstPublishDatestring (date)first publish date content item.
iconstringthe icon identifier. this id can later be fetched from the content metadata.
isDeprecatedstringFlag indicates if this template is deprecated. Known values are: "true" and "false". (true, false)
lastPublishDatestring (date)last publish date for the content item.
mainTemplateobjectThe JSON of the ARM template to deploy active content. Expandable.
packageIdstringthe package Id contains this template.
packageKindstringthe packageKind of the package contains this template. Known values are: "Solution" and "Standalone". (Solution, Standalone)
packageNamestringthe name of the package contains this template.
packageVersionstringVersion of the package. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM metadata best practices. Can also be any string, but then we cannot guarantee any version checks.
previewImagesarraypreview image file names. These will be taken from the solution artifacts.
previewImagesDarkarraypreview image file names. These will be taken from the solution artifacts. used for dark theme support.
providersarrayProviders for the content item.
sourceobjectSource of the content. This is where/how it was created.
supportobjectSupport information for the template - type, name, contact information.
systemDataobjectAzure Resource Manager metadata containing createdBy and modifiedBy information.
threatAnalysisTacticsarraythe tactics the resource covers.
threatAnalysisTechniquesarraythe techniques the resource covers, these have to be aligned with the tactics being used.
typestringThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
versionstringVersion of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM metadata best practices. Can also be any string, but then we cannot guarantee any version checks.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectresource_group_name, workspace_name, subscription_id$filter, $orderby, $expand, $search, $count, $top, $skip, $skipTokenGets all installed templates. Expandable properties: * properties/mainTemplate * properties/dependantTemplates.

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.

NameDatatypeDescription
resource_group_namestringThe name of the resource group. The name is case insensitive. Required.
subscription_idstring
workspace_namestringThe name of the monitor workspace. Required.
$countbooleanInstructs the server to return only object count without actual body. Optional. Default value is None.
$expandstringExpands the object with optional fiends that are not included by default. Optional. Default value is None.
$filterstringFilters the results, based on a Boolean condition. Optional. Default value is None.
$orderbystringSorts the results. Optional. Default value is None.
$searchstringSearches for a substring in the response. Optional. Default value is None.
$skipintegerUsed to skip n elements in the OData query (offset). Returns a nextLink to the next page of results if there are any left. Default value is None.
$skipTokenstringSkiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. Optional. Default value is None.
$topintegerReturns only the first n results. Optional. Default value is None.

SELECT examples

Gets all installed templates. Expandable properties: * properties/mainTemplate * properties/dependantTemplates.

SELECT
id,
name,
author,
categories,
contentId,
contentKind,
contentProductId,
contentSchemaVersion,
customVersion,
dependantTemplates,
dependencies,
displayName,
etag,
firstPublishDate,
icon,
isDeprecated,
lastPublishDate,
mainTemplate,
packageId,
packageKind,
packageName,
packageVersion,
previewImages,
previewImagesDark,
providers,
source,
support,
systemData,
threatAnalysisTactics,
threatAnalysisTechniques,
type,
version
FROM azure.security_insight.content_templates
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $orderby = '{{ $orderby }}'
AND $expand = '{{ $expand }}'
AND $search = '{{ $search }}'
AND $count = '{{ $count }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
AND $skipToken = '{{ $skipToken }}'
;