Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New metadata API #17942

Merged
merged 4 commits into from
Feb 24, 2022
Merged

New metadata API #17942

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
89d62c6
metadata changes
Feb 18, 2022
be12d73
addressed changes
Feb 20, 2022
08a6c2e
updated enum kind
Feb 23, 2022
65c8f18
updated values as well
Feb 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
123 changes: 122 additions & 1 deletion ...ghts/resource-manager/Microsoft.SecurityInsights/preview/2022-01-01-preview/Metadata.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -367,7 +367,9 @@
"Parser",
"Watchlist",
"WatchlistTemplate",
"Solution"
"Solution",
"AzureFunction",
"LogicAppsCustomConnector"
],
"x-ms-enum": {
"modelAsString": true,
Expand Down Expand Up @@ -414,6 +416,12 @@
},
{
"value": "Solution"
},
{
"value": "AzureFunction"
},
{
"value": "LogicAppsCustomConnector"
}
]
}
Expand Down Expand Up @@ -628,6 +636,63 @@
"type": "string",
"format": "date"
},
"metadataCustomVersion": {
"description": "The custom version of the content. A optional free text",
"type": "string"
},
"metadataContentSchemaVersion": {
"description": "Schema version of the content. Can be used to distinguish between different flow based on the schema version",
"type": "string"
},
"metadataIcon": {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

metadataIcon

Is this a known identifier? (e.g. a Guid?) might be good to specify the id format (in case there's one)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no, just a name, can be "bob", "roey", "random_name2"

"description": "the icon identifier. this id can later be fetched from the solution template",
"type": "string"
},
"metadataThreatAnalysisTactics": {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

metadataThreatAnalysisTactics

Is this is a well known list? Or do you expect this to be dynamic?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We expect this to be pretty dynamic. It changes in a high frequency.

"description": "the tactics the resource covers",
"type": "array",
"example": [
"reconnaissance",
"exfiltration"
],
"items": {
"type": "string"
}
},
"metadataThreatAnalysisTechniques": {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

metadataThreatAnalysisTechniques

Same as above, if is a well known list, might be good to model this as an enum

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Techniques can't be an enum, new techniques are added on a high cadence

"description": "the techniques the resource covers, these have to be aligned with the tactics being used",
"type": "array",
"example": [
"T1548",
"T1548.001",
"T1134.003"
],
"items": {
"type": "string"
}
},
"metadataPreviewImages": {
"description": "preview image file names. These will be taken from the solution artifacts",
"type": "array",
"example": [
"example.png",
"example2.jpeg"
],
"items": {
"type": "string"
}
},
"metadataPreviewImagesDark": {
"description": "preview image file names. These will be taken from the solution artifacts. used for dark theme support",
"type": "array",
"example": [
"example.png",
"example2.jpeg"
],
"items": {
"type": "string"
}
},
"metadataProperties": {
"description": "Metadata property bag.",
"required": [
Expand Down Expand Up @@ -683,6 +748,34 @@
"lastPublishDate": {
"$ref": "#/definitions/lastPublishDate",
"description": "last publish date for the solution content item"
},
"customVersion": {
"$ref": "#/definitions/metadataCustomVersion",
"description": "The custom version of the content. A optional free text"
},
"contentSchemaVersion": {
"$ref": "#/definitions/metadataContentSchemaVersion",
"description": "Schema version of the content. Can be used to distinguish between different flow based on the schema version"
},
"icon": {
"$ref": "#/definitions/metadataIcon",
"description": "the icon identifier. this id can later be fetched from the solution template"
},
"threatAnalysisTactics": {
"$ref": "#/definitions/metadataThreatAnalysisTactics",
"description": "the tactics the resource covers"
},
"threatAnalysisTechniques": {
"$ref": "#/definitions/metadataThreatAnalysisTechniques",
"description": "the techniques the resource covers, these have to be aligned with the tactics being used"
},
"previewImages": {
"$ref": "#/definitions/metadataPreviewImages",
"description": "preview image file names. These will be taken from the solution artifacts"
},
"previewImagesDark": {
"$ref": "#/definitions/metadataPreviewImagesDark",
"description": "preview image file names. These will be taken from the solution artifacts. used for dark theme support"
}
}
},
Expand Down Expand Up @@ -737,6 +830,34 @@
"lastPublishDate": {
"$ref": "#/definitions/lastPublishDate",
"description": "last publish date for the solution content item"
},
"customVersion": {
"$ref": "#/definitions/metadataCustomVersion",
"description": "The custom version of the content. A optional free text"
},
"contentSchemaVersion": {
"$ref": "#/definitions/metadataContentSchemaVersion",
"description": "Schema version of the content. Can be used to distinguish between different flow based on the schema version"
},
"icon": {
"$ref": "#/definitions/metadataIcon",
"description": "the icon identifier. this id can later be fetched from the solution template"
},
"threatAnalysisTactics": {
"$ref": "#/definitions/metadataThreatAnalysisTactics",
"description": "the tactics the resource covers"
},
"threatAnalysisTechniques": {
"$ref": "#/definitions/metadataThreatAnalysisTechniques",
"description": "the techniques the resource covers, these have to be aligned with the tactics being used"
},
"previewImages": {
"$ref": "#/definitions/metadataPreviewImages",
"description": "preview image file names. These will be taken from the solution artifacts"
},
"previewImagesDark": {
"$ref": "#/definitions/metadataPreviewImagesDark",
"description": "preview image file names. These will be taken from the solution artifacts. used for dark theme support"
}
}
}
Expand Down
20 changes: 19 additions & 1 deletion .../Microsoft.SecurityInsights/preview/2022-01-01-preview/examples/metadata/GetMetadata.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,25 @@
"Microsoft"
],
"firstPublishDate": "2021-05-18",
"lastPublishDate": "2021-05-18"
"lastPublishDate": "2021-05-18",
"previewImages": [
"firstImage.png",
"secondImage.jpeg"
],
"previewImagesDark": [
"firstImageDark.png",
"secondImageDark.jpeg"
],
"contentSchemaVersion": "2.0",
"customVersion": "1.0",
"threatAnalysisTactics": [
"reconnaissance",
"commandandcontrol"
],
"threatAnalysisTechniques": [
"T1548",
"T1548.001"
]
}
}
}
Expand Down
60 changes: 57 additions & 3 deletions .../Microsoft.SecurityInsights/preview/2022-01-01-preview/examples/metadata/PutMetadata.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,25 @@
"Microsoft"
],
"firstPublishDate": "2021-05-18",
"lastPublishDate": "2021-05-18"
"lastPublishDate": "2021-05-18",
"previewImages": [
"firstImage.png",
"secondImage.jpeg"
],
"previewImagesDark": [
"firstImageDark.png",
"secondImageDark.jpeg"
],
"contentSchemaVersion": "2.0",
"customVersion": "1.0",
"threatAnalysisTactics": [
"reconnaissance",
"commandandcontrol"
],
"threatAnalysisTechniques": [
"T1548",
"T1548.001"
]
}
}
},
Expand Down Expand Up @@ -149,7 +167,25 @@
"Microsoft"
],
"firstPublishDate": "2021-05-18",
"lastPublishDate": "2021-05-18"
"lastPublishDate": "2021-05-18",
"previewImages": [
"firstImage.png",
"secondImage.jpeg"
],
"previewImagesDark": [
"firstImageDark.png",
"secondImageDark.jpeg"
],
"contentSchemaVersion": "2.0",
"customVersion": "1.0",
"threatAnalysisTactics": [
"reconnaissance",
"commandandcontrol"
],
"threatAnalysisTechniques": [
"T1548",
"T1548.001"
]
}
}
},
Expand Down Expand Up @@ -224,7 +260,25 @@
"Microsoft"
],
"firstPublishDate": "2021-05-18",
"lastPublishDate": "2021-05-18"
"lastPublishDate": "2021-05-18",
"previewImages": [
"firstImage.png",
"secondImage.jpeg"
],
"previewImagesDark": [
"firstImageDark.png",
"secondImageDark.jpeg"
],
"contentSchemaVersion": "2.0",
"customVersion": "1.0",
"threatAnalysisTactics": [
"reconnaissance",
"commandandcontrol"
],
"threatAnalysisTechniques": [
"T1548",
"T1548.001"
]
}
}
}
Expand Down