TemplateProperties interface

Package:

@azure/arm-securityinsight

Template property bag.

Properties

author	The creator of the content item.
categories	Categories for the item
contentId	Static 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
contentKind	The kind of content the template is for.
contentProductId	Unique 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
contentSchemaVersion	Schema version of the content. Can be used to distinguish between different flow based on the schema version
customVersion	The custom version of the content. A optional free text
dependantTemplates	Dependant templates. Expandable.
dependencies	Dependencies 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.
displayName	The display name of the template
firstPublishDate	first publish date content item
icon	the icon identifier. this id can later be fetched from the content metadata
isDeprecated	Flag indicates if this template is deprecated
lastPublishDate	last publish date for the content item
mainTemplate	The JSON of the ARM template to deploy active content. Expandable.
packageId	the package Id contains this template
packageKind	the packageKind of the package contains this template
packageName	the name of the package contains this template
packageVersion	Version 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
previewImages	preview image file names. These will be taken from the solution artifacts
previewImagesDark	preview image file names. These will be taken from the solution artifacts. used for dark theme support
providers	Providers for the content item
source	Source of the content. This is where/how it was created.
support	Support information for the template - type, name, contact information
threatAnalysisTactics	the tactics the resource covers
threatAnalysisTechniques	the techniques the resource covers, these have to be aligned with the tactics being used
version	Version 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

Property Details

author

The creator of the content item.

author?: MetadataAuthor

Property Value

MetadataAuthor

categories

Categories for the item

categories?: MetadataCategories

Property Value

MetadataCategories

contentId

Static 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

contentId?: string

Property Value

string

contentKind

The kind of content the template is for.

contentKind?: string

Property Value

string

contentProductId

Unique 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

contentProductId?: string

Property Value

string

contentSchemaVersion

Schema version of the content. Can be used to distinguish between different flow based on the schema version

contentSchemaVersion?: string

Property Value

string

customVersion

The custom version of the content. A optional free text

customVersion?: string

Property Value

string

dependantTemplates

Dependant templates. Expandable.

dependantTemplates?: TemplateProperties[]

Property Value

TemplateProperties[]

dependencies

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

dependencies?: MetadataDependencies

Property Value

MetadataDependencies

displayName

The display name of the template

displayName?: string

Property Value

string

firstPublishDate

first publish date content item

firstPublishDate?: Date

Property Value

Date

icon

the icon identifier. this id can later be fetched from the content metadata

icon?: string

Property Value

string

isDeprecated

Flag indicates if this template is deprecated

isDeprecated?: string

Property Value

string

lastPublishDate

last publish date for the content item

lastPublishDate?: Date

Property Value

Date

mainTemplate

The JSON of the ARM template to deploy active content. Expandable.

mainTemplate?: any

Property Value

any

packageId

the package Id contains this template

packageId?: string

Property Value

string

packageKind

the packageKind of the package contains this template

packageKind?: string

Property Value

string

packageName

the name of the package contains this template

packageName?: string

Property Value

string

packageVersion

Version 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

packageVersion?: string

Property Value

string

previewImages

preview image file names. These will be taken from the solution artifacts

previewImages?: string[]

Property Value

string[]

previewImagesDark

preview image file names. These will be taken from the solution artifacts. used for dark theme support

previewImagesDark?: string[]

Property Value

string[]

providers

Providers for the content item

providers?: string[]

Property Value

string[]

source

Source of the content. This is where/how it was created.

source?: MetadataSource

Property Value

MetadataSource

support

Support information for the template - type, name, contact information

support?: MetadataSupport

Property Value

MetadataSupport

threatAnalysisTactics

the tactics the resource covers

threatAnalysisTactics?: string[]

Property Value

string[]

threatAnalysisTechniques

the techniques the resource covers, these have to be aligned with the tactics being used

threatAnalysisTechniques?: string[]

Property Value

string[]

version

Version 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

version?: string

Property Value

string