alert: updateAlerts

Namespace: microsoft.graph

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 multiple alerts in one request instead of multiple requests.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	SecurityEvents.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.
Application	SecurityEvents.ReadWrite.All

HTTP request

POST /security/alerts/updateAlerts

Request headers

Name	Description
Authorization	Bearer {code}

Request body

In the request body, provide a JSON object with the following parameters. Each entity must have id and vendorInformation properties. For details about properties that can be updated, see update alert.

Parameter	Type	Description
value	alert collection	Collection of alerts to update. Each entity must have id, vendorInformation, and other editable properties to be updated.

Response

If successful, this method returns 200, OK response code and alert collection object in the response body.

Examples

The following example shows how to call this API.

Request

The following is an example of the request.

HTTP

POST https://graph.microsoft.com/beta/security/alerts/updateAlerts
Content-type: application/json

{
  "value": [
    {
      "assignedTo": "String",
      "closedDateTime": "String (timestamp)",
      "comments": ["String"],
      "feedback": {"@odata.type": "microsoft.graph.alertFeedback"},
      "id": "String (identifier)",
      "status": {"@odata.type": "microsoft.graph.alertStatus"},
      "tags": ["String"],
      "vendorInformation":
        {
          "provider": "String",
          "vendor": "String"
        }
    }
  ]
}

C#

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

var graphClient = new GraphServiceClient(requestAdapter);

var requestBody = new Microsoft.Graph.Beta.Security.Alerts.UpdateAlerts.UpdateAlertsPostRequestBody
{
	Value = new List<Alert>
	{
		new Alert
		{
			AssignedTo = "String",
			ClosedDateTime = DateTimeOffset.Parse("String (timestamp)"),
			Comments = new List<string>
			{
				"String",
			},
			Feedback = new AlertFeedback
			{
				AdditionalData = new Dictionary<string, object>
				{
					{
						"@odata.type" , "microsoft.graph.alertFeedback"
					},
				},
			},
			Id = "String (identifier)",
			Status = new AlertStatus
			{
				AdditionalData = new Dictionary<string, object>
				{
					{
						"@odata.type" , "microsoft.graph.alertStatus"
					},
				},
			},
			Tags = new List<string>
			{
				"String",
			},
			VendorInformation = new SecurityVendorInformation
			{
				Provider = "String",
				Vendor = "String",
			},
		},
	},
};
var result = await graphClient.Security.Alerts.UpdateAlerts.PostAsync(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.

Go

import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/Security/Alerts/UpdateAlerts"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewUpdateAlertsPostRequestBody()


alert := graphmodels.NewAlert()
assignedTo := "String"
alert.SetAssignedTo(&assignedTo) 
closedDateTime , err := time.Parse(time.RFC3339, "String (timestamp)")
alert.SetClosedDateTime(&closedDateTime) 
comments := []string {
	"String",

}
alert.SetComments(comments)
feedback := graphmodels.NewAlertFeedback()
additionalData := map[string]interface{}{
}
feedback.SetAdditionalData(additionalData)
alert.SetFeedback(feedback)
id := "String (identifier)"
alert.SetId(&id) 
status := graphmodels.NewAlertStatus()
additionalData := map[string]interface{}{
}
status.SetAdditionalData(additionalData)
alert.SetStatus(status)
tags := []string {
	"String",

}
alert.SetTags(tags)
vendorInformation := graphmodels.NewSecurityVendorInformation()
provider := "String"
vendorInformation.SetProvider(&provider) 
vendor := "String"
vendorInformation.SetVendor(&vendor) 
alert.SetVendorInformation(vendorInformation)

value := []graphmodels.Objectable {
	alert,

}
requestBody.SetValue(value)

result, err := graphClient.Security().Alerts().UpdateAlerts().Post(context.Background(), requestBody, nil)

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.

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

LinkedList<Alert> valueList = new LinkedList<Alert>();
Alert value = new Alert();
value.assignedTo = "String";
value.closedDateTime = OffsetDateTimeSerializer.deserialize("String (timestamp)");
LinkedList<String> commentsList = new LinkedList<String>();
commentsList.add("String");
value.comments = commentsList;
AlertFeedback feedback = new AlertFeedback();
value.feedback = feedback;
value.id = "String (identifier)";
AlertStatus status = new AlertStatus();
value.status = status;
LinkedList<String> tagsList = new LinkedList<String>();
tagsList.add("String");
value.tags = tagsList;
SecurityVendorInformation vendorInformation = new SecurityVendorInformation();
vendorInformation.provider = "String";
vendorInformation.vendor = "String";
value.vendorInformation = vendorInformation;

valueList.add(value);
AlertCollectionResponse alertCollectionResponse = new AlertCollectionResponse();
alertCollectionResponse.value = valueList;
AlertCollectionPage alertCollectionPage = new AlertCollectionPage(alertCollectionResponse, null);

graphClient.security().alerts()
	.updateAlerts(AlertUpdateAlertsParameterSet
		.newBuilder()
		.withValue(valueList)
		.build())
	.buildRequest()
	.post();

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.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const alert = {
  value: [
    {
      assignedTo: 'String',
      closedDateTime: 'String (timestamp)',
      comments: ['String'],
      feedback: {'@odata.type': 'microsoft.graph.alertFeedback'},
      id: 'String (identifier)',
      status: {'@odata.type': 'microsoft.graph.alertStatus'},
      tags: ['String'],
      vendorInformation: 
        {
          provider: 'String',
          vendor: 'String'
        }
    }
  ]
};

await client.api('/security/alerts/updateAlerts')
	.version('beta')
	.post(alert);

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.

PHP

<?php

// THIS SNIPPET IS A PREVIEW FOR THE KIOTA BASED SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($requestAdapter);

$requestBody = new UpdateAlertsPostRequestBody();
$valueAlert1 = new Alert();
$valueAlert1->setAssignedTo('String');

$valueAlert1->setClosedDateTime(new DateTime('String (timestamp)'));

$valueAlert1->setComments(['String', ]);

$valueAlert1Feedback = new AlertFeedback();
$additionalData = [
	'@odata.type' => 'microsoft.graph.alertFeedback', 
];
$valueAlert1Feedback->setAdditionalData($additionalData);



$valueAlert1->setFeedback($valueAlert1Feedback);
$valueAlert1->setId('String (identifier)');

$valueAlert1Status = new AlertStatus();
$additionalData = [
	'@odata.type' => 'microsoft.graph.alertStatus', 
];
$valueAlert1Status->setAdditionalData($additionalData);



$valueAlert1->setStatus($valueAlert1Status);
$valueAlert1->setTags(['String', ]);

$valueAlert1VendorInformation = new SecurityVendorInformation();
$valueAlert1VendorInformation->setProvider('String');

$valueAlert1VendorInformation->setVendor('String');


$valueAlert1->setVendorInformation($valueAlert1VendorInformation);

$valueArray []= $valueAlert1;
$requestBody->setValue($valueArray);




$result = $graphServiceClient->security()->alerts()->updateAlerts()->post($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.

PowerShell

Import-Module Microsoft.Graph.Security

$params = @{
	value = @(
		@{
			assignedTo = "String"
			closedDateTime = [System.DateTime]::Parse("String (timestamp)")
			comments = @(
				"String"
			)
			feedback = @{
				"@odata.type" = "microsoft.graph.alertFeedback"
			}
			id = "String (identifier)"
			status = @{
				"@odata.type" = "microsoft.graph.alertStatus"
			}
			tags = @(
				"String"
			)
			vendorInformation = @{
				provider = "String"
				vendor = "String"
			}
		}
	)
}

Update-MgSecurityAlertMultiple -BodyParameter $params

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.

Response

The following is an example of the response.

Note

The response object shown here might be shortened for readability.

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

{
  "value": [
    {
      "activityGroupName": "activityGroupName-value",
      "assignedTo": "assignedTo-value",
      "azureSubscriptionId": "azureSubscriptionId-value",
      "azureTenantId": "azureTenantId-value",
      "category": "category-value",
      "closedDateTime": "datetime-value"
    }
  ]
}