MetadataPatch interface
Metadata patch request body.
- Extends
Properties
| author | The creator of the content item. |
| categories | Categories for the solution content item |
| content |
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 |
| content |
Schema version of the content. Can be used to distinguish between different flow based on the schema version |
| custom |
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. |
| first |
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. |
| last |
last publish date for the solution content item |
| parent |
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) |
| preview |
preview image file names. These will be taken from the solution artifacts |
| preview |
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 |
| threat |
the tactics the resource covers |
| threat |
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. |
| system |
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
categories
Categories for the solution content item
categories?: MetadataCategoriesProperty 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?: stringProperty Value
string
contentSchemaVersion
Schema version of the content. Can be used to distinguish between different flow based on the schema version
contentSchemaVersion?: stringProperty Value
string
customVersion
The custom version of the content. A optional free text
customVersion?: stringProperty 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?: MetadataDependenciesProperty Value
firstPublishDate
first publish date solution content item
firstPublishDate?: DateProperty Value
Date
icon
the icon identifier. this id can later be fetched from the solution template
icon?: stringProperty Value
string
kind
The kind of content the metadata is for.
kind?: stringProperty Value
string
lastPublishDate
last publish date for the solution content item
lastPublishDate?: DateProperty 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?: stringProperty 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?: MetadataSourceProperty Value
support
Support information for the metadata - type, name, contact information
support?: MetadataSupportProperty 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?: stringProperty Value
string
Inherited Property Details
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?: stringProperty 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?: stringProperty 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?: SystemDataProperty 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?: stringProperty Value
string
Inherited From ResourceWithEtag.type
Azure SDK for JavaScript
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for