MetadataModel interface

Metadata resource definition.

Extends

Properties

author

The creator of the content item.

categories

Categories for the solution content 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

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

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.

firstPublishDate

first publish date solution content item

icon

the icon identifier. this id can later be fetched from the solution template

kind

The kind of content the metadata is for.

lastPublishDate

last publish date for the solution content item

parentId

Full parent resource ID of the content item the metadata is for. This is the full resource ID including the scope (subscription and resource group)

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 solution content item

source

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

support

Support information for the metadata - 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 template best practices. Can also be any string, but then we cannot guarantee any version checks

Inherited Properties

etag

Etag of the azure resource

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

author

The creator of the content item.

author?: MetadataAuthor

Property Value

categories

Categories for the solution content item

categories?: MetadataCategories

Property Value

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

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

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

firstPublishDate

first publish date solution content item

firstPublishDate?: Date

Property Value

Date

icon

the icon identifier. this id can later be fetched from the solution template

icon?: string

Property Value

string

kind

The kind of content the metadata is for.

kind?: string

Property Value

string

lastPublishDate

last publish date for the solution content item

lastPublishDate?: Date

Property Value

Date

parentId

Full parent resource ID of the content item the metadata is for. This is the full resource ID including the scope (subscription and resource group)

parentId?: 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 solution content item

providers?: string[]

Property Value

string[]

source

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

source?: MetadataSource

Property Value

support

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

support?: MetadataSupport

Property Value

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 template best practices. Can also be any string, but then we cannot guarantee any version checks

version?: string

Property Value

string

Inherited Property Details

etag

Etag of the azure resource

etag?: string

Property Value

string

Inherited From ResourceWithEtag.etag

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ResourceWithEtag.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ResourceWithEtag.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

Inherited From ResourceWithEtag.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ResourceWithEtag.type