Skip to content

Commit 1b133dc

Browse files
authored
Merge pull request Azure#12865 from tzhou-obsidian/master
create Obsidian Datasharing solution
2 parents aadab97 + 204e050 commit 1b133dc

12 files changed

+4621
-0
lines changed
Lines changed: 174 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,174 @@
1+
{
2+
"name": "ObsidianDatasharing",
3+
"apiVersion": "2022-09-01-preview",
4+
"type": "Microsoft.SecurityInsights/dataConnectorDefinitions",
5+
"location": "{{location}}",
6+
"kind": "Customizable",
7+
"properties": {
8+
"connectorUiConfig": {
9+
"id": "ObsidianDatasharing",
10+
"title": "Obsidian Datasharing Connector",
11+
"publisher": "Obsidian Security",
12+
"descriptionMarkdown": "The Obsidian Datasharing connector provides the capability to read raw event data from Obsidian Datasharing in Microsoft Sentinel.",
13+
"graphQueries": [
14+
{
15+
"metricName": "Activity",
16+
"legend": "ObsidianActivity_CL",
17+
"baseQuery": "ObsidianActivity_CL"
18+
},
19+
{
20+
"metricName": "Threat",
21+
"legend": "ObsidianThreat_CL",
22+
"baseQuery": "ObsidianThreat_CL"
23+
}
24+
],
25+
"sampleQueries": [
26+
{
27+
"description": "Obsidian - All Threats",
28+
"query": "ObsidianThreat_CL\n | sort by TimeGenerated desc"
29+
},
30+
{
31+
"description": "Obsidian - All Activity events",
32+
"query": "ObsidianActivity_CL\n | sort by TimeGenerated desc"
33+
}
34+
],
35+
"dataTypes": [
36+
{
37+
"name": "ObsidianActivity_CL",
38+
"lastDataReceivedQuery": "ObsidianActivity_CL\n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)"
39+
},
40+
{
41+
"name": "ObsidianThreat_CL",
42+
"lastDataReceivedQuery": "ObsidianThreat_CL\n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)"
43+
}
44+
],
45+
"connectivityCriteria": [
46+
{
47+
"type": "IsConnectedQuery",
48+
"value": [
49+
"ObsidianActivity_CL\n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(7d)",
50+
"ObsidianThreat_CL\n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(7d)"
51+
]
52+
}
53+
],
54+
"availability": {
55+
"status": 1
56+
},
57+
"permissions": {
58+
"resourceProvider": [
59+
{
60+
"provider": "Microsoft.OperationalInsights/workspaces",
61+
"permissionsDisplayText": "read and write permissions are required.",
62+
"providerDisplayName": "Workspace",
63+
"scope": "Workspace",
64+
"requiredPermissions": {
65+
"write": true,
66+
"read": true,
67+
"delete": true
68+
}
69+
}
70+
],
71+
"customs": [
72+
{
73+
"name": "Microsoft Entra",
74+
"description": "Permission to create an app registration in Microsoft Entra ID. Typically requires Entra ID Application Developer role or higher."
75+
},
76+
{
77+
"name": "Microsoft Azure",
78+
"description": "Permission to assign Monitoring Metrics Publisher role on data collection rule (DCR). Typically requires Azure RBAC Owner or User Access Administrator role"
79+
}
80+
]
81+
},
82+
"instructionSteps": [
83+
{
84+
"title": "1. Create ARM Resources and Provide the Required Permissions",
85+
"description": "This connector reads data from the tables that Obsidian Datasharing uses in a Microsoft Analytics Workspace, if the data forwarding option is enabled in Obsidian Datasharing then raw event data is sent to the Microsoft Sentinel Ingestion API.",
86+
"instructions": [
87+
{
88+
"type": "Markdown",
89+
"parameters": {
90+
"content": "#### Automated Configuration and Secure Data Ingestion with Entra Application \nClicking on \"Deploy\" will trigger the creation of Log Analytics tables and a Data Collection Rule (DCR). \nIt will then create an Entra application, link the DCR to it, and set the entered secret in the application. This setup enables data to be sent securely to the DCR using an Entra token."
91+
}
92+
},
93+
{
94+
"parameters": {
95+
"label": "Deploy Obsidian Datasharing connector resources",
96+
"applicationDisplayName": "Obsidian Datasharing Connector Application"
97+
},
98+
"type": "DeployPushConnectorButton"
99+
}
100+
]
101+
},
102+
{
103+
"title": "2. Push your logs into the workspace",
104+
"description": "Use the following parameters to configure the your machine to send the logs to the workspace.",
105+
"instructions": [
106+
{
107+
"parameters": {
108+
"label": "Tenant ID (Directory ID)",
109+
"fillWith": [
110+
"TenantId"
111+
]
112+
},
113+
"type": "CopyableLabel"
114+
},
115+
{
116+
"parameters": {
117+
"label": "Entra App Registration Application ID",
118+
"fillWith": [
119+
"ApplicationId"
120+
],
121+
"placeholder": "Deploy push connector to get the App Registration Application ID"
122+
},
123+
"type": "CopyableLabel"
124+
},
125+
{
126+
"parameters": {
127+
"label": "Entra App Registration Secret",
128+
"fillWith": [
129+
"ApplicationSecret"
130+
],
131+
"placeholder": "Deploy push connector to get the App Registration Secret"
132+
},
133+
"type": "CopyableLabel"
134+
},
135+
{
136+
"parameters": {
137+
"label": "Data Collection Endpoint Uri",
138+
"fillWith": [
139+
"DataCollectionEndpoint"
140+
],
141+
"placeholder": "Deploy push connector to get the Data Collection Endpoint Uri"
142+
},
143+
"type": "CopyableLabel"
144+
},
145+
{
146+
"parameters": {
147+
"label": "Data Collection Rule Immutable ID",
148+
"fillWith": [
149+
"DataCollectionRuleId"
150+
],
151+
"placeholder": "Deploy push connector to get the Data Collection Rule Immutable ID"
152+
},
153+
"type": "CopyableLabel"
154+
},
155+
{
156+
"parameters": {
157+
"label": "Activity Stream Name",
158+
"value": "Custom-ObsidianActivity_CL"
159+
},
160+
"type": "CopyableLabel"
161+
},
162+
{
163+
"parameters": {
164+
"label": "Threat Stream Name",
165+
"value": "Custom-ObsidianThreat_CL"
166+
},
167+
"type": "CopyableLabel"
168+
}
169+
]
170+
}
171+
]
172+
}
173+
}
174+
}

0 commit comments

Comments
 (0)