Share via


TemplateProperties Class

Definition

Template property bag.

public class TemplateProperties : Azure.ResourceManager.SecurityInsights.Models.TemplateBaseProperties, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.SecurityInsights.Models.TemplateProperties>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.SecurityInsights.Models.TemplateProperties>
type TemplateProperties = class
    inherit TemplateBaseProperties
    interface IJsonModel<TemplateProperties>
    interface IPersistableModel<TemplateProperties>
Public Class TemplateProperties
Inherits TemplateBaseProperties
Implements IJsonModel(Of TemplateProperties), IPersistableModel(Of TemplateProperties)
Inheritance
TemplateProperties
Implements

Properties

Author

The creator of the content item.

(Inherited from TemplateBaseProperties)
Categories

Categories for the item.

(Inherited from TemplateBaseProperties)
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.

(Inherited from TemplateBaseProperties)
ContentKind

The kind of content the template is for.

(Inherited from TemplateBaseProperties)
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.

(Inherited from TemplateBaseProperties)
ContentSchemaVersion

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

(Inherited from TemplateBaseProperties)
CustomVersion

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

(Inherited from TemplateBaseProperties)
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.

(Inherited from TemplateBaseProperties)
DisplayName

The display name of the template.

(Inherited from TemplateBaseProperties)
FirstPublishOn

first publish date content item.

(Inherited from TemplateBaseProperties)
Icon

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

(Inherited from TemplateBaseProperties)
IsDeprecated

Flag indicates if this template is deprecated.

(Inherited from TemplateBaseProperties)
LastPublishOn

last publish date for the content item.

(Inherited from TemplateBaseProperties)
MainTemplate

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

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

PackageId

the package Id contains this template.

(Inherited from TemplateBaseProperties)
PackageKind

the packageKind of the package contains this template.

(Inherited from TemplateBaseProperties)
PackageName

the name of the package contains this template.

(Inherited from TemplateBaseProperties)
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.

(Inherited from TemplateBaseProperties)
PreviewImages

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

(Inherited from TemplateBaseProperties)
PreviewImagesDark

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

(Inherited from TemplateBaseProperties)
Providers

Providers for the content item.

(Inherited from TemplateBaseProperties)
Source

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

(Inherited from TemplateBaseProperties)
Support

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

(Inherited from TemplateBaseProperties)
ThreatAnalysisTactics

the tactics the resource covers.

(Inherited from TemplateBaseProperties)
ThreatAnalysisTechniques

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

(Inherited from TemplateBaseProperties)
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.

(Inherited from TemplateBaseProperties)

Explicit Interface Implementations

IJsonModel<TemplateBaseProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from TemplateBaseProperties)
IJsonModel<TemplateBaseProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from TemplateBaseProperties)
IJsonModel<TemplateProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<TemplateProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<TemplateBaseProperties>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from TemplateBaseProperties)
IPersistableModel<TemplateBaseProperties>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from TemplateBaseProperties)
IPersistableModel<TemplateBaseProperties>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from TemplateBaseProperties)
IPersistableModel<TemplateProperties>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<TemplateProperties>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<TemplateProperties>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to