Update sensor

Article
2024-09-26

Namespace: microsoft.graph.security

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Update the properties of a sensor object.

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	✅	✅	❌

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.

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	SecurityIdentitiesSensors.ReadWrite.All	Not available.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	SecurityIdentitiesSensors.ReadWrite.All	Not available.

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

In the request body, supply only the values for properties to update. Existing properties that aren't included in the request body maintain their previous values or are recalculated based on changes to other property values.

The following table specifies the properties that can be updated.

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.

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
  }
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models.Security;

var requestBody = new Sensor
{
	Settings = new SensorSettings
	{
		Description = "dc1 settings new description",
		DomainControllerDnsNames = new List<string>
		{
			"DC1.domain1.test.local",
		},
		IsDelayedDeploymentEnabled = false,
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Security.Identities.Sensors["{sensor-id}"].PatchAsync(requestBody);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



mgc-beta security identities sensors patch --sensor-id {sensor-id} --body '{\
  "settings": {\
    "description": "dc1 settings new description",\
    "domainControllerDnsNames": [\
        "DC1.domain1.test.local"\
    ],\
    "isDelayedDeploymentEnabled": false\
  }\
}\
'

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodelssecurity "github.com/microsoftgraph/msgraph-beta-sdk-go/models/security"
	  //other-imports
)

requestBody := graphmodelssecurity.NewSensor()
settings := graphmodelssecurity.NewSensorSettings()
description := "dc1 settings new description"
settings.SetDescription(&description) 
domainControllerDnsNames := []string {
	"DC1.domain1.test.local",
}
settings.SetDomainControllerDnsNames(domainControllerDnsNames)
isDelayedDeploymentEnabled := false
settings.SetIsDelayedDeploymentEnabled(&isDelayedDeploymentEnabled) 
requestBody.SetSettings(settings)

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
sensors, err := graphClient.Security().Identities().Sensors().BySensorId("sensor-id").Patch(context.Background(), requestBody, nil)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.beta.models.security.Sensor sensor = new com.microsoft.graph.beta.models.security.Sensor();
com.microsoft.graph.beta.models.security.SensorSettings settings = new com.microsoft.graph.beta.models.security.SensorSettings();
settings.setDescription("dc1 settings new description");
LinkedList<String> domainControllerDnsNames = new LinkedList<String>();
domainControllerDnsNames.add("DC1.domain1.test.local");
settings.setDomainControllerDnsNames(domainControllerDnsNames);
settings.setIsDelayedDeploymentEnabled(false);
sensor.setSettings(settings);
com.microsoft.graph.models.security.Sensor result = graphClient.security().identities().sensors().bySensorId("{sensor-id}").patch(sensor);

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


const options = {
	authProvider,
};

const client = Client.init(options);

const sensor = {
  settings: {
    description: 'dc1 settings new description',
    domainControllerDnsNames: [
        'DC1.domain1.test.local'
    ],
    isDelayedDeploymentEnabled: false
  }
};

await client.api('/security/identities/sensors/d31dd827-92cd-4cd6-b269-c151a0eec55d')
	.version('beta')
	.update(sensor);

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\Security\Sensor;
use Microsoft\Graph\Beta\Generated\Models\Security\SensorSettings;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new Sensor();
$settings = new SensorSettings();
$settings->setDescription('dc1 settings new description');
$settings->setDomainControllerDnsNames(['DC1.domain1.test.local', 	]);
$settings->setIsDelayedDeploymentEnabled(false);
$requestBody->setSettings($settings);

$result = $graphServiceClient->security()->identities()->sensors()->bySensorId('sensor-id')->patch($requestBody)->wait();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


Import-Module Microsoft.Graph.Beta.Security

$params = @{
	settings = @{
		description = "dc1 settings new description"
		domainControllerDnsNames = @(
		"DC1.domain1.test.local"
	)
	isDelayedDeploymentEnabled = $false
}
}

Update-MgBetaSecurityIdentitySensor -SensorId $sensorId -BodyParameter $params

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.security.sensor import Sensor
from msgraph_beta.generated.models.security.sensor_settings import SensorSettings
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = Sensor(
	settings = SensorSettings(
		description = "dc1 settings new description",
		domain_controller_dns_names = [
			"DC1.domain1.test.local",
		],
		is_delayed_deployment_enabled = False,
	),
)

result = await graph_client.security.identities.sensors.by_sensor_id('sensor-id').patch(request_body)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the 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
    }
}

Share via

Update sensor

Permissions

HTTP request

Request headers

Request body

Response

Examples

Request

Response

Feedback

Additional resources