Skip to content

Commit 5648820

Browse files
authored
Merge pull request #25546 from microsoftgraph/user/naalmog/sensorsv10
sensor apis v10
2 parents 48648e6 + 524b384 commit 5648820

36 files changed

+1247
-54
lines changed

api-reference/beta/api/security-identitycontainer-list-sensors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ GET /security/identities/sensors
3737

3838
## Optional query parameters
3939

40-
This method supports the following OData query parameters to help customize the response: `$count`, `$filter`, `$skip`, `$top`. For general information, see [OData query parameters](/graph/query-parameters).
40+
This method supports the `$count`, `$filter`, `$skip`, and `$top` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
4141

4242
## Request headers
4343

api-reference/beta/api/security-identitycontainer-delete-sensors.md renamed to api-reference/beta/api/security-sensor-delete.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ Delete a [sensor](../resources/security-sensor.md) object.
2222

2323
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
2424

25-
<!-- { "blockType": "permissions", "name": "security_identitycontainer_delete_sensors" } -->
26-
[!INCLUDE [permissions-table](../includes/permissions/security-identitycontainer-delete-sensors-permissions.md)]
25+
<!-- { "blockType": "permissions", "name": "security_sensor_delete" } -->
26+
[!INCLUDE [permissions-table](../includes/permissions/security-sensor-delete-permissions.md)]
2727

2828
## HTTP request
2929

api-reference/beta/api/security-sensor-get.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ GET /security/identities/sensors/{sensorId}
3737

3838
## Optional query parameters
3939

40-
This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
40+
This method supports the `$select` and `$expand` OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters).
4141

4242
## Request headers
4343

api-reference/beta/includes/permissions/security-identitycontainer-delete-sensors-permissions.md

Lines changed: 0 additions & 8 deletions
This file was deleted.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
description: "Automatically generated file. DO NOT MODIFY"
3+
ms.topic: include
4+
ms.localizationpriority: medium
5+
---
6+
7+
|Permission type|Least privileged permission|Higher privileged permissions|
8+
|:---|:---|:---|
9+
|Delegated (work or school account)|SecurityIdentitiesSensors.ReadWrite.All|Not available.|
10+
|Delegated (personal Microsoft account)|Not supported.|Not supported.|
11+
|Application|SecurityIdentitiesSensors.ReadWrite.All|Not available.|

api-reference/beta/resources/security-api-overview.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,10 @@ The Microsoft Defender for Identity health issues API allows you to monitor the
131131

132132
> **Note:** The Microsoft Defender for Identity health issues API is only available on the Defender for Identity plan or Microsoft 365 E5/A5/G5/F5 Security service plans.
133133
134+
### Sensors
135+
136+
The Defender for Identity sensors management API allows you to create detailed reports of the sensors in your workspace, including information about the server name, sensor version, type, state, and health status. It also enables you to manage sensor settings, such as adding descriptions, enabling or disabling delayed updates, and specifying the domain controller that the sensor connects to for querying Entra ID.
137+
134138
## Incidents
135139

136140
An [incident](security-incident.md) is a collection of correlated  [alerts](security-alert.md) and associated data that make up the story of an attack. Incident management is part of Microsoft 365 Defender and is available in the Microsoft 365 Defender portal (https://security.microsoft.com/).
@@ -267,8 +271,8 @@ The following are some of the most popular requests for working with the Microso
267271
|Get details of a single message instance|[GET analyzedemails/Id](../api/security-analyzedemail-get.md)|[https://graph.microsoft.com/beta/security/collaboration/analyzedemails/{Id}](https://developer.microsoft.com/graph/graph-explorer?request=security/collaboration/analyzedemails/Id&method=GET&version=beta&GraphUrl=https://graph.microsoft.com)|
268272
|Remediate analyzed email|[analyzedEmail: remediate](../api/security-analyzedemail-remediate.md )|[https://graph.microsoft.com/beta/security/collaboration/analyzedemails/remediate](https://developer.microsoft.com/graph/graph-explorer?request=security/collaboration/analyzedemails/remediate&method=POST&version=beta&GraphUrl=https://graph.microsoft.com)|
269273
| **Identities**|||
270-
| List health issues | [List health issues](../api/security-identityContainer-list-healthIssues.md) | [https://graph.microsoft.com/beta/security/identities/healthIssues](https://developer.microsoft.com/graph/graph-explorer?request=security/identities/healthIssues&method=GET&version=beta&GraphUrl=https://graph.microsoft.com) |
271-
| List sensors | [List sensors](../api/security-identityContainer-list-sensors.md) | [https://graph.microsoft.com/beta/security/identities/sensors](https://developer.microsoft.com/graph/graph-explorer?request=security/identities/sensors&method=GET&version=beta&GraphUrl=https://graph.microsoft.com) |
274+
| List health issues | [List health issues](../api/security-identitycontainer-list-healthissues.md) | [https://graph.microsoft.com/beta/security/identities/healthIssues](https://developer.microsoft.com/graph/graph-explorer?request=security/identities/healthIssues&method=GET&version=beta&GraphUrl=https://graph.microsoft.com) |
275+
| List sensors | [List sensors](../api/security-identitycontainer-list-sensors.md) | [https://graph.microsoft.com/beta/security/identities/sensors](https://developer.microsoft.com/graph/graph-explorer?request=security/identities/sensors&method=GET&version=beta&GraphUrl=https://graph.microsoft.com) |
272276

273277

274278
You can use Microsoft Graph [webhooks](/graph/webhooks) to subscribe to and receive notifications about updates to Microsoft Graph security API entities.

api-reference/beta/resources/security-networkadapter.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,12 @@ Namespace: microsoft.graph.security
1616

1717
Represents the network adapter from which the Microsoft Defender for Identity sensor analyzes network traffic.
1818

19-
20-
Inherits from [microsoft.graph.entity](../resources/entity.md).
19+
Inherits from [entity](../resources/entity.md).
2120

2221
## Properties
2322
|Property|Type|Description|
2423
|:---|:---|:---|
25-
|ID|String|A unique identifier that represents the network adapter.|
24+
|id|String|A unique identifier that represents the network adapter. Inherited from [entity](../resources/entity.md).|
2625
|isEnabled|Boolean|Indicates whether the network adapter is selected for capturing and analyzing network traffic.|
2726
|name|String|The name of the network adapter.|
2827

@@ -46,4 +45,4 @@ The following JSON representation shows the resource type.
4645
"isEnabled": "Boolean",
4746
"name": "String"
4847
}
49-
```
48+
```

api-reference/beta/resources/security-sensor.md

Lines changed: 27 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -16,71 +16,69 @@ Namespace: microsoft.graph.security
1616

1717
Represents a Microsoft Defender for Identity sensor.
1818

19-
Inherits from [microsoft.graph.entity](../resources/entity.md).
19+
Inherits from [entity](../resources/entity.md).
2020

2121
## Methods
2222
|Method|Return type|Description|
2323
|:---|:---|:---|
24-
|[List](../api/security-identitycontainer-list-sensors.md)|[microsoft.graph.security.sensor](../resources/security-sensor.md) collection|Get a list of the [microsoft.graph.security.sensor](../resources/security-sensor.md) objects and their properties.|
25-
|[Get](../api/security-sensor-get.md)|[microsoft.graph.security.sensor](../resources/security-sensor.md)|Read the properties and relationships of a [microsoft.graph.security.sensor](../resources/security-sensor.md) object.|
26-
|[Update](../api/security-sensor-update.md)|[microsoft.graph.security.sensor](../resources/security-sensor.md)|Update the properties of a [microsoft.graph.security.sensor](../resources/security-sensor.md) object.|
27-
|[Delete](../api/security-identitycontainer-delete-sensors.md)|None|Delete a [microsoft.graph.security.sensor](../resources/security-sensor.md) object.|
28-
|[Get deployment package URI](../api/security-sensor-getdeploymentpackageuri.md)|[microsoft.graph.security.sensorDeploymentPackage](../resources/security-sensordeploymentpackage.md)|Get the sensor deployment package URL and version. You can use this URL to download the installer to install the sensor on a server.|
24+
|[List](../api/security-identitycontainer-list-sensors.md)|[microsoft.graph.security.sensor](../resources/security-sensor.md) collection|Get a list of [sensor](../resources/security-sensor.md) objects and their properties.|
25+
|[Get](../api/security-sensor-get.md)|[microsoft.graph.security.sensor](../resources/security-sensor.md)|Read the properties and relationships of a [sensor](../resources/security-sensor.md) object.|
26+
|[Update](../api/security-sensor-update.md)|[microsoft.graph.security.sensor](../resources/security-sensor.md)|Update the properties of a [sensor](../resources/security-sensor.md) object.|
27+
|[Delete](../api/security-sensor-delete.md)|None|Delete a [sensor](../resources/security-sensor.md) object.|
2928
|[Get deployment access key](../api/security-sensor-getdeploymentaccesskey.md)|[microsoft.graph.security.deploymentAccessKeyType](../resources/security-deploymentaccesskeytype.md)|Get the deployment access key associated with the Microsoft Defender for Identity workspace, needed to install sensors associated with the workspace.|
29+
|[Get deployment package URI](../api/security-sensor-getdeploymentpackageuri.md)|[microsoft.graph.security.sensorDeploymentPackage](../resources/security-sensordeploymentpackage.md)|Get the sensor deployment package URL and version.|
3030
|[Regenerate deployment access key](../api/security-sensor-regeneratedeploymentaccesskey.md)|[microsoft.graph.security.deploymentAccessKeyType](../resources/security-deploymentaccesskeytype.md)|Generate a new deployment access key that can be used to install sensors associated with the workspace.|
3131

3232
## Properties
3333
|Property|Type|Description|
3434
|:---|:---|:---|
35-
|createdDateTime|DateTimeOffset|The date and time when the sensor was generated.|
35+
|createdDateTime|DateTimeOffset|The date and time when the sensor was generated. The Timestamp represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is `2014-01-01T00:00:00Z`.|
3636
|deploymentStatus|[microsoft.graph.security.deploymentStatus](#deploymentstatus-values)|The deployment status of the sensor. The possible values are: `upToDate`, `outdated`, `updating`, `updateFailed`, `notConfigured`, `unreachable`, `disconnected`, `startFailure`, `syncing`, `unknownFutureValue`.|
3737
|displayName|String|The display name of the sensor.|
3838
|domainName|String|The fully qualified domain name of the sensor.|
3939
|healthStatus|[microsoft.graph.security.sensorHealthStatus](#sensorhealthstatus-values)|The health status of the sensor. The possible values are: `healthy`, `notHealthyLow`, `notHealthyMedium`, `notHealthyHigh`, `unknownFutureValue`.|
40-
|ID|String|Unique identifier to represent the sensor.|
40+
|id|String|Unique identifier to represent the sensor. Inherited from [entity](../resources/entity.md).|
4141
|openHealthIssuesCount|Int64|This field displays the count of health issues related to this sensor.|
4242
|sensorType|[microsoft.graph.security.sensorType](#sensortype-values)|The type of the sensor. The possible values are: `adConnectIntegrated`, `adcsIntegrated`, `adfsIntegrated`, `domainControllerIntegrated`, `domainControllerStandalone`, `unknownFutureValue`.|
4343
|settings|[microsoft.graph.security.sensorSettings](../resources/security-sensorsettings.md)|Sensor settings information.|
4444
|version|String|The version of the sensor.|
4545

46-
#### deploymentStatus values
46+
### deploymentStatus values
4747

48-
| Member | Description |
49-
| :--------------------------| :--------------------------------------------------------------------------------------------------------------------------- |
48+
| Member | Description |
49+
| :--------------------------| :-------------------------------- |
5050
| upToDate |Sensor is running a current version of the sensor.|
5151
| outdated |Sensor is running a version of the software that is at least three versions behind the current version.|
5252
| updating |Sensor software is being updated.|
5353
| updateFailed |Sensor failed to update to a new version.|
54-
| notConfigured |Sensor requires more configuration before it's fully operational. This applies to sensors installed on AD FS / AD CS servers or standalone sensors.|
54+
| notConfigured |Sensor requires more configuration before it's fully operational. This applies to sensors installed on ADFS and ADCS servers or standalone sensors.|
5555
| unreachable |The domain controller was deleted from Active Directory. However, the sensor installation wasn't uninstalled and removed from the domain controller before it was decommissioned. You can safely delete this entry.|
5656
| disconnected |The Defender for Identity service hasn't seen any communication from this sensor in 10 minutes.|
5757
| startFailure |Sensor didn't pull configuration for more than 30 minutes.|
5858
| syncing |Sensor has configuration updates pending, but it didn't yet pull the new configuration.|
5959
| unknownFutureValue |Evolvable enumeration sentinel value. Don't use.|
6060

61-
#### sensorHealthStatus values
61+
### sensorHealthStatus values
6262

63-
| Member | Description |
64-
| :--------------------------| :--------------------------------------------------------------------------------------------------------------------------- |
63+
| Member | Description |
64+
| :--------------------------| :-------------------------------- |
6565
| healthy |No opened health issues.|
6666
| notHealthyLow |The highest severity opened health issue is low.|
6767
| notHealthyMedium |The highest severity opened health issue is medium.|
6868
| notHealthyHigh |The highest severity opened health issue is high.|
6969
| unknownFutureValue |Evolvable enumeration sentinel value. Don't use.|
7070

71-
#### sensorType values
71+
### sensorType values
7272

73-
| Member | Description |
74-
| :--------------------------| :--------------------------------------------------------------------------------------------------------------------------- |
73+
| Member | Description |
74+
| :--------------------------| :-------------------------------- |
7575
| adConnectIntegrated |Entra Connect sensor.|
7676
| adcsIntegrated |Active Directory Certificate Services (ADCS) sensor.|
7777
| adfsIntegrated |Active Directory Federation Services (ADFS) sensor.|
78-
| domainControllerIntegrated |Domain Controller sensor.|
78+
| domainControllerIntegrated |Domain controller sensor.|
7979
| domainControllerStandalone |Standalone sensor.|
8080
| unknownFutureValue |Evolvable enumeration sentinel value. Don't use.|
8181

82-
83-
8482
## Relationships
8583
|Relationship|Type|Description|
8684
|:---|:---|:---|
@@ -99,17 +97,15 @@ The following JSON representation shows the resource type.
9997
``` json
10098
{
10199
"@odata.type": "#microsoft.graph.security.sensor",
102-
"id": "String (identifier)",
103-
"displayName": "String",
104-
"sensorType": "String",
105-
"version": "String",
106-
"deploymentStatus": "String",
107100
"createdDateTime": "String (timestamp)",
101+
"deploymentStatus": "String",
102+
"displayName": "String",
108103
"domainName": "String",
109104
"healthStatus": "String",
110-
"openHealthIssuesCount": "Integer",
111-
"settings": {
112-
"@odata.type": "microsoft.graph.security.sensorSettings"
113-
}
105+
"id": "String (identifier)",
106+
"openHealthIssuesCount": "Int64",
107+
"sensorType": "String",
108+
"settings": {"@odata.type": "microsoft.graph.security.sensorSettings"},
109+
"version": "String"
114110
}
115-
```
111+
```

api-reference/beta/toc/security/toc.yml

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -485,13 +485,25 @@ items:
485485
- name: Update
486486
href: ../../api/security-sensor-update.md
487487
- name: Delete
488-
href: ../../api/security-identitycontainer-delete-sensors.md
489-
- name: Get deployment package URI
490-
href: ../../api/security-sensor-getdeploymentpackageuri.md
488+
href: ../../api/security-sensor-delete.md
491489
- name: Get deployment access key
492490
href: ../../api/security-sensor-getdeploymentaccesskey.md
491+
- name: Get deployment package URI
492+
href: ../../api/security-sensor-getdeploymentpackageuri.md
493493
- name: Regenerate deployment access key
494494
href: ../../api/security-sensor-regeneratedeploymentaccesskey.md
495+
- name: Complex types
496+
items:
497+
- name: Deployment access key type
498+
href: ../../resources/security-deploymentaccesskeytype.md
499+
- name: Identity container
500+
href: ../../resources/security-identitycontainer.md
501+
- name: Network adapter
502+
href: ../../resources/security-networkadapter.md
503+
- name: Sensor deployment package
504+
href: ../../resources/security-sensordeploymentpackage.md
505+
- name: Sensor settings
506+
href: ../../resources/security-sensorsettings.md
495507
- name: Information protection
496508
items:
497509
- name: Information protection label

api-reference/beta/toc/toc.mapping.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2521,6 +2521,13 @@
25212521
"resources": [
25222522
"microsoft.graph.security.healthIssue",
25232523
"microsoft.graph.security.sensor"
2524+
],
2525+
"complexTypes": [
2526+
"microsoft.graph.security.deploymentAccessKeyType",
2527+
"microsoft.graph.security.identityContainer",
2528+
"microsoft.graph.security.networkAdapter",
2529+
"microsoft.graph.security.sensorDeploymentPackage",
2530+
"microsoft.graph.security.sensorSettings"
25242531
]
25252532
},
25262533
{

0 commit comments

Comments
 (0)