Skip to content

security-sensor-update.md

Latest commit

 

History

History
152 lines (118 loc) · 5.07 KB

security-sensor-update.md

File metadata and controls

152 lines (118 loc) · 5.07 KB
title Update sensor
description Update the properties of a sensor object.
author amirfeldman
ms.localizationpriority medium
ms.subservice security
doc_type apiPageType
ms.date 09/10/2024

Update sensor

Namespace: microsoft.graph.security

[!INCLUDE beta-disclaimer]

Update the properties of a sensor object.

[!INCLUDE national-cloud-support]

Permissions

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. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

HTTP request

PATCH /security/identities/sensors/{sensorId}

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Request body

[!INCLUDE table-intro]

Property Type Description
settings microsoft.graph.security.sensorSettings Sensor settings information. The description property can be updated for all sensor types. The isDelayedUpdateEnabled property can be updated for all sensors with version < 3.X. The domainControllerDnsNames property can be updated for all sensors with version < 3.X except for domain controller sensors.

Response

If successful, this method returns a 200 OK response code and an updated microsoft.graph.security.sensor object in the response body.

Examples

Request

The following example shows a request.

HTTP

PATCH https://graph.microsoft.com/beta/security/identities/sensors/d31dd827-92cd-4cd6-b269-c151a0eec55d
Content-Type: application/json

{
  "settings": {
    "description": "dc1 settings new description",
    "domainControllerDnsNames": [
        "DC1.domain1.test.local"
    ],
    "isDelayedDeploymentEnabled": false
  }
}

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.type": "#microsoft.graph.security.sensor",
    "id": "b3c1b5fc-828c-45fa-a1e1-10d74f6d6e9c",
    "displayName": "DC1",
    "sensorType": "domainControllerIntegrated",
    "version": "2.239.18124.58593",
    "deploymentStatus": "upToDate",
    "createdDateTime": "2023-11-16T09:41:24.2585071Z",
    "domainName": "domain1.test.local",
    "healthStatus": "healthy",
    "openHealthIssuesCount": 0,
    "settings": {
        "@odata.type": "microsoft.graph.security.sensorSettings",
        "description": "dc1 settings new description",
        "domainControllerDnsNames": [
            "DC1.domain1.test.local"
        ],
        "isDelayedDeploymentEnabled": false
    },
    "serviceStatus": "running"
}