Skip to content

DataConnectors - MDTI and PMDTI connectors 2024-09-01 #31491

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

Merged
xuhumsft merged 13 commits into from
Nov 20, 2024
Merged

DataConnectors - MDTI and PMDTI connectors 2024-09-01 #31491

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
bf44b95
fix prettier check
xuhumsft Nov 6, 2024
1798130
mdti stable swagger
ni-bhandari Nov 10, 2024
a8fe0e5
pmdti stable swagger
ni-bhandari Nov 10, 2024
2044fd7
fix example name
ni-bhandari Nov 10, 2024
729a251
fix pmdti swagger
ni-bhandari Nov 10, 2024
383f3d0
add pmdti examples
ni-bhandari Nov 11, 2024
685af85
fix spellcheck
ni-bhandari Nov 11, 2024
9bf6e2d
fix enums
ni-bhandari Nov 11, 2024
b41d4ec
prettier fix
ni-bhandari Nov 11, 2024
eb3042a
update lookback
ni-bhandari Nov 14, 2024
4f50e35
lookback period for pmdti
ni-bhandari Nov 14, 2024
169a632
fix date-time format in examples
ni-bhandari Nov 19, 2024
5a8d5d6
minor format fix
ni-bhandari Nov 19, 2024
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
3 changes: 2 additions & 1 deletion cSpell.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1169,7 +1169,8 @@
{
"filename": "**/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/**/*.json",
"words": [
"Criterias"
"Criterias",
"Mdti"
]
},
{
Expand Down
1 change: 0 additions & 1 deletion ...sights/resource-manager/Microsoft.SecurityInsights/stable/2024-09-01/AutomationRules.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1548,4 +1548,3 @@
"application/json"
]
}

152 changes: 152 additions & 0 deletions ...nsights/resource-manager/Microsoft.SecurityInsights/stable/2024-09-01/DataConnectors.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,12 @@
},
"Get a RestApiPoller data connector": {
"$ref": "./examples/dataConnectors/GetRestApiPollerById.json"
},
"Get a MicrosoftThreatIntelligence data connector": {
"$ref": "./examples/dataConnectors/GetMicrosoftThreatIntelligenceById.json"
},
"Get a PremiumMicrosoftDefenderForThreatIntelligence data connector": {
"$ref": "./examples/dataConnectors/GetPremiumMicrosoftDefenderForThreatIntelligenceById.json"
}
},
"tags": [
Expand Down Expand Up @@ -155,6 +161,12 @@
},
"Creates or updates an Threat Intelligence Platform data connector.": {
"$ref": "./examples/dataConnectors/CreateThreatIntelligenceDataConnector.json"
},
"Creates or updates a MicrosoftThreatIntelligence data connector.": {
"$ref": "./examples/dataConnectors/CreateMicrosoftThreatIntelligenceDataConnector.json"
},
"Creates or updates a PremiumMicrosoftDefenderForThreatIntelligence data connector.": {
"$ref": "./examples/dataConnectors/CreatePremiumMicrosoftDefenderForThreatIntelligenceDataConnector.json"
}
},
"tags": [
Expand Down Expand Up @@ -207,6 +219,12 @@
"x-ms-examples": {
"Delete an Office365 data connector.": {
"$ref": "./examples/dataConnectors/DeleteOfficeDataConnetor.json"
},
"Delete an MicrosoftThreatIntelligence data connector": {
"$ref": "./examples/dataConnectors/DeleteMicrosoftThreatIntelligenceDataConnector.json"
},
"Deletes a PremiumMicrosoftDefenderForThreatIntelligence data connector.": {
"$ref": "./examples/dataConnectors/DeletePremiumMicrosoftDefenderForThreatIntelligenceDataConnector.json"
}
},
"tags": [
Expand Down Expand Up @@ -1375,6 +1393,8 @@
"AzureSecurityCenter",
"MicrosoftCloudAppSecurity",
"ThreatIntelligence",
"MicrosoftThreatIntelligence",
"PremiumMicrosoftDefenderForThreatIntelligence",
"Office365",
"AmazonWebServicesCloudTrail",
"AzureAdvancedThreatProtection",
Expand All @@ -1398,6 +1418,12 @@
{
"value": "ThreatIntelligence"
},
{
"value": "MicrosoftThreatIntelligence"
},
{
"value": "PremiumMicrosoftDefenderForThreatIntelligence"
},
{
"value": "Office365"
},
Expand Down Expand Up @@ -1608,6 +1634,132 @@
},
"type": "object"
},
"MSTIDataConnector": {
"allOf": [
{
"$ref": "#/definitions/DataConnector"
}
],
"description": "Represents Microsoft Threat Intelligence data connector.",
"properties": {
"properties": {
"$ref": "#/definitions/MSTIDataConnectorProperties",
"description": "Microsoft Threat Intelligence data connector properties.",
"x-ms-client-flatten": true
}
},
"type": "object",
"x-ms-discriminator-value": "MicrosoftThreatIntelligence"
},
"MSTIDataConnectorDataTypes": {
"description": "The available data types for Microsoft Threat Intelligence data connector.",
"properties": {
"microsoftEmergingThreatFeed": {
"allOf": [
{
"$ref": "#/definitions/DataConnectorDataTypeCommon"
}
],
"properties": {
"lookbackPeriod": {
"description": "The lookback period for the feed to be imported. The date-time to begin importing the feed from, for example: 2024-01-01T00:00:00.000Z.",
"format": "date-time",
"type": "string"
}
},
"description": "Data type for Microsoft Threat Intelligence data connector.",
"type": "object",
"required": [
"lookbackPeriod"
]
}
},
"type": "object",
"required": [
"microsoftEmergingThreatFeed"
]
},
"MSTIDataConnectorProperties": {
"allOf": [
{
"$ref": "#/definitions/DataConnectorTenantId"
}
],
"description": "Microsoft Threat Intelligence data connector properties.",
"properties": {
"dataTypes": {
"$ref": "#/definitions/MSTIDataConnectorDataTypes",
"description": "The available data types for the connector."
}
},
"required": [
"dataTypes"
],
"type": "object"
},
"PremiumMicrosoftDefenderForThreatIntelligence": {
"allOf": [
{
"$ref": "#/definitions/DataConnector"
}
],
"description": "Represents Premium Microsoft Defender for Threat Intelligence data connector.",
"properties": {
"properties": {
"$ref": "#/definitions/PremiumMdtiDataConnectorProperties",
"description": "Premium Microsoft Defender for Threat Intelligence data connector properties.",
"x-ms-client-flatten": true
}
},
"type": "object",
"x-ms-discriminator-value": "PremiumMicrosoftDefenderForThreatIntelligence"
},
"PremiumMdtiDataConnectorDataTypes": {
"description": "The available data types for Premium Microsoft Defender for Threat Intelligence data connector.",
"properties": {
"connector": {
"allOf": [
{
"$ref": "#/definitions/DataConnectorDataTypeCommon"
}
],
"description": "Data type for Premium Microsoft Defender for Threat Intelligence data connector.",
"type": "object"
}
},
"type": "object",
"required": [
"connector"
]
},
"PremiumMdtiDataConnectorProperties": {
"description": "Premium Microsoft Defender for Threat Intelligence data connector properties.",
"allOf": [
{
"$ref": "#/definitions/DataConnectorTenantId"
}
],
"properties": {
"lookbackPeriod": {
"description": "The lookback period for the feed to be imported. The date-time to begin importing the feed from, for example: 2024-01-01T00:00:00.000Z.",
"format": "date-time",
"type": "string"
},
"requiredSKUsPresent": {
Copy link
Copy Markdown
Member

@razvanbadea-msft razvanbadea-msft Nov 13, 2024

Choose a reason for hiding this comment

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

requiredSKUsPresent

you should replace this with an enum to have values like [PremiumSKU. None] so that in case a new type apears you can add it to the enum.

Enums are always a more flexible and future proof option because they allow additional values to be added in the future in a non-breaking way, e.g. [Enabled, Disabled, Suspended, Deallocated].

Copy link
Copy Markdown
Contributor Author

@ni-bhandari ni-bhandari Nov 14, 2024

Choose a reason for hiding this comment

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

reviewing this.

Copy link
Copy Markdown
Contributor Author

@ni-bhandari ni-bhandari Nov 19, 2024

Choose a reason for hiding this comment

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

Hi, @razvanbadea-msft , I reviewed this with my team, and we think that the boolean value here is sufficient for the purposes of this API. If, in the future, there are other types of connectors that require different types of SKUs, then that would not affect this field much. If we have such a connector, say ConnectorX, then the value of "requiredSkusPresent" will be calculated differently for ConnectorX than for this (PMDTI) connector, but the resulting values for this field would still be either true or false.
Our backend is capable of handling different SKUs required by different connector types and checking if they are present for the respective customer (the caller does not need all the details), and in the response, we are just presenting whether the customer meets the requirements to use this particular connector. Also, we do not need the caller to handle other states like Disabled, Suspended, etc. as we have the "state" property of the connector for that purpose.

"description": "The flag to indicate whether the tenant has the premium SKU required to access this connector.",
"type": "boolean"
},
"dataTypes": {
"$ref": "#/definitions/PremiumMdtiDataConnectorDataTypes",
"description": "The available data types for the connector."
}
},
"required": [
"dataTypes",
"lookbackPeriod"
],
"type": "object"
},
"OfficeDataConnector": {
"allOf": [
{
Expand Down
1 change: 0 additions & 1 deletion ...rityinsights/resource-manager/Microsoft.SecurityInsights/stable/2024-09-01/Incidents.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1675,4 +1675,3 @@
}
}
}

1 change: 0 additions & 1 deletion ...ghts/resource-manager/Microsoft.SecurityInsights/stable/2024-09-01/common/AlertTypes.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,3 @@
},
"parameters": {}
}

1 change: 0 additions & 1 deletion ...ource-manager/Microsoft.SecurityInsights/stable/2024-09-01/common/ContentCommonTypes.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -644,4 +644,3 @@
},
"parameters": {}
}

1 change: 0 additions & 1 deletion ...s/resource-manager/Microsoft.SecurityInsights/stable/2024-09-01/common/IncidentTypes.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,4 +244,3 @@
},
"parameters": {}
}

1 change: 0 additions & 1 deletion ...icrosoft.SecurityInsights/stable/2024-09-01/examples/actions/CreateActionOfAlertRule.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,3 @@
}
}
}

1 change: 0 additions & 1 deletion ...icrosoft.SecurityInsights/stable/2024-09-01/examples/actions/DeleteActionOfAlertRule.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,3 @@
"204": {}
}
}

1 change: 0 additions & 1 deletion ...crosoft.SecurityInsights/stable/2024-09-01/examples/actions/GetActionOfAlertRuleById.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,3 @@
}
}
}

1 change: 0 additions & 1 deletion ...crosoft.SecurityInsights/stable/2024-09-01/examples/actions/GetAllActionsByAlertRule.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,3 @@
}
}
}

1 change: 0 additions & 1 deletion ...urityInsights/stable/2024-09-01/examples/alertRuleTemplates/GetAlertRuleTemplateById.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,4 +78,3 @@
}
}
}

1 change: 0 additions & 1 deletion ...SecurityInsights/stable/2024-09-01/examples/alertRuleTemplates/GetAlertRuleTemplates.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,4 +84,3 @@
}
}
}

1 change: 0 additions & 1 deletion ...crosoft.SecurityInsights/stable/2024-09-01/examples/alertRules/CreateFusionAlertRule.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,3 @@
}
}
}

1 change: 0 additions & 1 deletion ...able/2024-09-01/examples/alertRules/CreateMicrosoftSecurityIncidentCreationAlertRule.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,3 @@
}
}
}

1 change: 0 additions & 1 deletion ...soft.SecurityInsights/stable/2024-09-01/examples/alertRules/CreateScheduledAlertRule.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,4 +279,3 @@
}
}
}

1 change: 0 additions & 1 deletion ...ger/Microsoft.SecurityInsights/stable/2024-09-01/examples/alertRules/DeleteAlertRule.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,3 @@
"204": {}
}
}

1 change: 0 additions & 1 deletion ...er/Microsoft.SecurityInsights/stable/2024-09-01/examples/alertRules/GetAllAlertRules.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,4 +131,3 @@
}
}
}

1 change: 0 additions & 1 deletion .../Microsoft.SecurityInsights/stable/2024-09-01/examples/alertRules/GetFusionAlertRule.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,3 @@
}
}
}

1 change: 0 additions & 1 deletion .../stable/2024-09-01/examples/alertRules/GetMicrosoftSecurityIncidentCreationAlertRule.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,3 @@
}
}
}

1 change: 0 additions & 1 deletion ...crosoft.SecurityInsights/stable/2024-09-01/examples/alertRules/GetScheduledAlertRule.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,4 +90,3 @@
}
}
}

1 change: 0 additions & 1 deletion ...tyInsights/stable/2024-09-01/examples/automationRules/AutomationRules_CreateOrUpdate.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,4 +169,3 @@
}
}
}

1 change: 0 additions & 1 deletion ...t.SecurityInsights/stable/2024-09-01/examples/automationRules/AutomationRules_Delete.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,3 @@
}
}
}

1 change: 0 additions & 1 deletion ...soft.SecurityInsights/stable/2024-09-01/examples/automationRules/AutomationRules_Get.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,3 @@
}
}
}

1 change: 0 additions & 1 deletion ...oft.SecurityInsights/stable/2024-09-01/examples/automationRules/AutomationRules_List.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,4 +66,3 @@
}
}
}

1 change: 0 additions & 1 deletion ...nager/Microsoft.SecurityInsights/stable/2024-09-01/examples/bookmarks/CreateBookmark.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,4 +91,3 @@
}
}
}

1 change: 0 additions & 1 deletion ...nager/Microsoft.SecurityInsights/stable/2024-09-01/examples/bookmarks/DeleteBookmark.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,3 @@
"204": {}
}
}

1 change: 0 additions & 1 deletion ...ager/Microsoft.SecurityInsights/stable/2024-09-01/examples/bookmarks/GetBookmarkById.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,3 @@
}
}
}

1 change: 0 additions & 1 deletion ...manager/Microsoft.SecurityInsights/stable/2024-09-01/examples/bookmarks/GetBookmarks.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,3 @@
}
}
}

1 change: 0 additions & 1 deletion ...Microsoft.SecurityInsights/stable/2024-09-01/examples/contentPackages/GetPackageById.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,3 @@
}
}
}

1 change: 0 additions & 1 deletion ...er/Microsoft.SecurityInsights/stable/2024-09-01/examples/contentPackages/GetPackages.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,3 @@
}
}
}

1 change: 0 additions & 1 deletion ...ft.SecurityInsights/stable/2024-09-01/examples/contentPackages/GetProductPackageById.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,3 @@
}
}
}

1 change: 0 additions & 1 deletion ...osoft.SecurityInsights/stable/2024-09-01/examples/contentPackages/GetProductPackages.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,4 +76,3 @@
}
}
}

1 change: 0 additions & 1 deletion ...Microsoft.SecurityInsights/stable/2024-09-01/examples/contentPackages/InstallPackage.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,4 +149,3 @@
}
}
}

1 change: 0 additions & 1 deletion ...crosoft.SecurityInsights/stable/2024-09-01/examples/contentPackages/UninstallPackage.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,3 @@
"204": {}
}
}

1 change: 0 additions & 1 deletion ...icrosoft.SecurityInsights/stable/2024-09-01/examples/contentTemplates/DeleteTemplate.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,3 @@
"204": {}
}
}

1 change: 0 additions & 1 deletion ....SecurityInsights/stable/2024-09-01/examples/contentTemplates/GetProductTemplateById.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,3 @@
}
}
}

1 change: 0 additions & 1 deletion ...crosoft.SecurityInsights/stable/2024-09-01/examples/contentTemplates/GetTemplateById.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,3 @@
}
}
}

1 change: 0 additions & 1 deletion .../Microsoft.SecurityInsights/stable/2024-09-01/examples/contentTemplates/GetTemplates.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,3 @@
}
}
}

1 change: 0 additions & 1 deletion ...crosoft.SecurityInsights/stable/2024-09-01/examples/contentTemplates/InstallTemplate.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,4 +226,3 @@
}
}
}

Loading