PackageBaseProperties interface

Describes package properties

Properties

author

The author of the package

categories

The categories of the package

contentId

The content id of the package

contentKind

The package kind

contentProductId

Unique ID for the content. It should be generated based on the contentId, contentKind and the contentVersion of the package

contentSchemaVersion

The version of the content schema.

dependencies

The support tier of the package

description

The description of the package

displayName

The display name of the package

firstPublishDate

first publish date package item

icon

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

isDeprecated

Flag indicates if this template is deprecated

isFeatured

Flag indicates if this package is among the featured list.

isNew

Flag indicates if this is a newly published package.

isPreview

Flag indicates if this package is in preview.

lastPublishDate

last publish date for the package item

providers

Providers for the package item

publisherDisplayName

The publisher display name of the package

source

The source of the package

support

The support tier of the package

threatAnalysisTactics

the tactics the resource covers

threatAnalysisTechniques

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

version

the latest version number of the package

Property Details

author

The author of the package

author?: MetadataAuthor

Property Value

categories

The categories of the package

categories?: MetadataCategories

Property Value

contentId

The content id of the package

contentId?: string

Property Value

string

contentKind

The package kind

contentKind?: string

Property Value

string

contentProductId

Unique ID for the content. It should be generated based on the contentId, contentKind and the contentVersion of the package

contentProductId?: string

Property Value

string

contentSchemaVersion

The version of the content schema.

contentSchemaVersion?: string

Property Value

string

dependencies

The support tier of the package

dependencies?: MetadataDependencies

Property Value

description

The description of the package

description?: string

Property Value

string

displayName

The display name of the package

displayName?: string

Property Value

string

firstPublishDate

first publish date package 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

isFeatured

Flag indicates if this package is among the featured list.

isFeatured?: string

Property Value

string

isNew

Flag indicates if this is a newly published package.

isNew?: string

Property Value

string

isPreview

Flag indicates if this package is in preview.

isPreview?: string

Property Value

string

lastPublishDate

last publish date for the package item

lastPublishDate?: Date

Property Value

Date

providers

Providers for the package item

providers?: string[]

Property Value

string[]

publisherDisplayName

The publisher display name of the package

publisherDisplayName?: string

Property Value

string

source

The source of the package

source?: MetadataSource

Property Value

support

The support tier of the package

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

the latest version number of the package

version?: string

Property Value

string