TemplateProperties Class

Template property bag.

Constructor

TemplateProperties(*args: Any, **kwargs: Any)

Variables

Name Description
content_id
str

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.

content_product_id
str

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.

package_version
str

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.

version
str

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.

display_name
str

The display name of the template.

content_kind
str or Kind

The 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".

source

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

author

The creator of the content item.

support

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

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.

categories

Categories for the item.

providers

Providers for the content item.

first_publish_date

first publish date content item.

last_publish_date

last publish date for the content item.

custom_version
str

The custom version of the content. A optional free text.

content_schema_version
str

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

icon
str

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

threat_analysis_tactics

the tactics the resource covers.

threat_analysis_techniques

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

preview_images

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

preview_images_dark

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

package_id
str

the package Id contains this template.

package_kind

the packageKind of the package contains this template. Known values are: "Solution" and "Standalone".

package_name
str

the name of the package contains this template.

is_deprecated
str or Flag

Flag indicates if this template is deprecated. Known values are: "true" and "false".

main_template
any

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

dependant_templates

Dependant templates. Expandable.

Attributes

author

The creator of the content item.

author: _models.MetadataAuthor | None

categories

Categories for the item.

categories: _models.MetadataCategories | None

content_id

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.

content_id: str | None

content_kind

"DataConnector", "DataType", "Workbook", "WorkbookTemplate", "Playbook", "PlaybookTemplate", "AnalyticsRuleTemplate", "AnalyticsRule", "HuntingQuery", "InvestigationQuery", "Parser", "Watchlist", "WatchlistTemplate", "Solution", "AzureFunction", "LogicAppsCustomConnector", "AutomationRule", "ResourcesDataConnector", "Notebook", "Standalone", "SummaryRule", and "CustomDetection".

content_kind: str | _models.Kind | None

content_product_id

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.

content_product_id: str | None

content_schema_version

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

content_schema_version: str | None

custom_version

The custom version of the content. A optional free text.

custom_version: str | None

dependant_templates

Dependant templates. Expandable.

dependant_templates: list['_models.TemplateProperties'] | None

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: _models.MetadataDependencies | None

display_name

The display name of the template.

display_name: str | None

first_publish_date

first publish date content item.

first_publish_date: date | None

icon

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

icon: str | None

is_deprecated

"true" and "false".

is_deprecated: str | _models.Flag | None

last_publish_date

last publish date for the content item.

last_publish_date: date | None

main_template

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

main_template: Any | None

package_id

the package Id contains this template.

package_id: str | None

package_kind

"Solution" and "Standalone".

package_kind: str | _models.PackageKind | None

package_name

the name of the package contains this template.

package_name: str | None

package_version

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.

package_version: str | None

preview_images

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

preview_images: list[str] | None

preview_images_dark

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

preview_images_dark: list[str] | None

providers

Providers for the content item.

providers: list[str] | None

source

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

source: _models.MetadataSource | None

support

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

support: _models.MetadataSupport | None

threat_analysis_tactics

the tactics the resource covers.

threat_analysis_tactics: list[str] | None

threat_analysis_techniques

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

threat_analysis_techniques: list[str] | None

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: str | None