PackageProperties interface
Describes package properties
- Extends
Inherited Properties
| author | The author of the package |
| categories | The categories of the package |
| content |
The content id of the package |
| content |
The package kind |
| content |
Unique ID for the content. It should be generated based on the contentId, contentKind and the contentVersion of the package |
| content |
The version of the content schema. |
| dependencies | The support tier of the package |
| description | The description of the package |
| display |
The display name of the package |
| first |
first publish date package item |
| icon | the icon identifier. this id can later be fetched from the content metadata |
| is |
Flag indicates if this template is deprecated |
| is |
Flag indicates if this package is among the featured list. |
| is |
Flag indicates if this is a newly published package. |
| is |
Flag indicates if this package is in preview. |
| last |
last publish date for the package item |
| providers | Providers for the package item |
| publisher |
The publisher display name of the package |
| source | The source of the package |
| support | The support tier of the package |
| threat |
the tactics the resource covers |
| threat |
the techniques the resource covers, these have to be aligned with the tactics being used |
| version | the latest version number of the package |
Inherited Property Details
author
The author of the package
author?: MetadataAuthor
Property Value
Inherited From PackageBaseProperties.author
categories
The categories of the package
categories?: MetadataCategories
Property Value
Inherited From PackageBaseProperties.categories
contentId
The content id of the package
contentId?: string
Property Value
string
Inherited From PackageBaseProperties.contentId
contentKind
The package kind
contentKind?: string
Property Value
string
Inherited From PackageBaseProperties.contentKind
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
Inherited From PackageBaseProperties.contentProductId
contentSchemaVersion
The version of the content schema.
contentSchemaVersion?: string
Property Value
string
Inherited From PackageBaseProperties.contentSchemaVersion
dependencies
The support tier of the package
dependencies?: MetadataDependencies
Property Value
Inherited From PackageBaseProperties.dependencies
description
The description of the package
description?: string
Property Value
string
Inherited From PackageBaseProperties.description
displayName
The display name of the package
displayName?: string
Property Value
string
Inherited From PackageBaseProperties.displayName
firstPublishDate
first publish date package item
firstPublishDate?: Date
Property Value
Date
Inherited From PackageBaseProperties.firstPublishDate
icon
the icon identifier. this id can later be fetched from the content metadata
icon?: string
Property Value
string
Inherited From PackageBaseProperties.icon
isDeprecated
Flag indicates if this template is deprecated
isDeprecated?: string
Property Value
string
Inherited From PackageBaseProperties.isDeprecated
isFeatured
Flag indicates if this package is among the featured list.
isFeatured?: string
Property Value
string
Inherited From PackageBaseProperties.isFeatured
isNew
Flag indicates if this is a newly published package.
isNew?: string
Property Value
string
Inherited From PackageBaseProperties.isNew
isPreview
Flag indicates if this package is in preview.
isPreview?: string
Property Value
string
Inherited From PackageBaseProperties.isPreview
lastPublishDate
last publish date for the package item
lastPublishDate?: Date
Property Value
Date
Inherited From PackageBaseProperties.lastPublishDate
providers
Providers for the package item
providers?: string[]
Property Value
string[]
Inherited From PackageBaseProperties.providers
publisherDisplayName
The publisher display name of the package
publisherDisplayName?: string
Property Value
string
Inherited From PackageBaseProperties.publisherDisplayName
source
The source of the package
source?: MetadataSource
Property Value
Inherited From PackageBaseProperties.source
support
The support tier of the package
support?: MetadataSupport
Property Value
Inherited From PackageBaseProperties.support
threatAnalysisTactics
the tactics the resource covers
threatAnalysisTactics?: string[]
Property Value
string[]
Inherited From PackageBaseProperties.threatAnalysisTactics
threatAnalysisTechniques
the techniques the resource covers, these have to be aligned with the tactics being used
threatAnalysisTechniques?: string[]
Property Value
string[]
Inherited From PackageBaseProperties.threatAnalysisTechniques
version
the latest version number of the package
version?: string
Property Value
string
Inherited From PackageBaseProperties.version