Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MetadataPatch

Package version

Metadata patch request body.

Hierarchy

Index

Properties

Optional author

The creator of the content item.

Optional categories

categories: MetadataCategories

Categories for the solution content item

Optional contentId

contentId: undefined | string

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

Optional contentSchemaVersion

contentSchemaVersion: undefined | string

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

Optional customVersion

customVersion: undefined | string

The custom version of the content. A optional free text

Optional dependencies

dependencies: MetadataDependencies

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.

Optional etag

etag: undefined | string

Etag of the azure resource

Optional firstPublishDate

firstPublishDate: Date

first publish date solution content item

Optional icon

icon: undefined | string

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

Optional id

id: undefined | string

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.

Optional kind

kind: Kind

The kind of content the metadata is for.

Optional lastPublishDate

lastPublishDate: Date

last publish date for the solution content item

Optional name

name: undefined | string

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

Optional parentId

parentId: undefined | string

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)

Optional previewImages

previewImages: string[]

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

Optional previewImagesDark

previewImagesDark: string[]

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

Optional providers

providers: string[]

Providers for the solution content item

Optional source

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

Optional support

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

Optional systemData

systemData: 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.

Optional threatAnalysisTactics

threatAnalysisTactics: string[]

the tactics the resource covers

Optional threatAnalysisTechniques

threatAnalysisTechniques: string[]

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

Optional type

type: undefined | string

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.

Optional version

version: undefined | string

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

Generated using TypeDoc