Update enrichedAuditLogs

Namespace: microsoft.graph.networkaccess

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 settings for the enriched audit logs workloads to control the enrichment feature for each partner workload, such as SharePoint, Teams, and Exchange.

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)	NetworkAccess.ReadWrite.All	Not available.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	NetworkAccess.ReadWrite.All	Not available.

Important

In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. The following least privileged roles are supported for this operation.

• Global Secure Access Administrator
• Security Administrator

HTTP request

PATCH /networkAccess/settings/enrichedAuditLogs

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
sharepoint	microsoft.graph.networkaccess.enrichedAuditLogsSettings	Sharepoint enrichment log status. Optional.
teams	microsoft.graph.networkaccess.enrichedAuditLogsSettings	Teams enrichment log status. Optional.
exchange	microsoft.graph.networkaccess.enrichedAuditLogsSettings	Exchange enrichment log status. Optional.

Response

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

Examples

Request

The following example shows a request.

HTTP

PATCH https://graph.microsoft.com/beta/networkAccess/settings/enrichedAuditLogs
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.networkaccess.enrichedAuditLogs",
  "sharepoint": {
    "@odata.type": "microsoft.graph.networkaccess.enrichedAuditLogsSettings"
  },
  "teams": {
    "@odata.type": "microsoft.graph.networkaccess.enrichedAuditLogsSettings"
  },
  "exchange": {
    "@odata.type": "microsoft.graph.networkaccess.enrichedAuditLogsSettings"
  }
}

C#

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

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

var requestBody = new EnrichedAuditLogs
{
	OdataType = "#microsoft.graph.networkaccess.enrichedAuditLogs",
	Sharepoint = new EnrichedAuditLogsSettings
	{
		OdataType = "microsoft.graph.networkaccess.enrichedAuditLogsSettings",
	},
	Teams = new EnrichedAuditLogsSettings
	{
		OdataType = "microsoft.graph.networkaccess.enrichedAuditLogsSettings",
	},
	Exchange = new EnrichedAuditLogsSettings
	{
		OdataType = "microsoft.graph.networkaccess.enrichedAuditLogsSettings",
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.NetworkAccess.Settings.EnrichedAuditLogs.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.

CLI

mgc-beta network-access settings enriched-audit-logs patch --body '{\
  "@odata.type": "#microsoft.graph.networkaccess.enrichedAuditLogs",\
  "sharepoint": {\
    "@odata.type": "microsoft.graph.networkaccess.enrichedAuditLogsSettings"\
  },\
  "teams": {\
    "@odata.type": "microsoft.graph.networkaccess.enrichedAuditLogsSettings"\
  },\
  "exchange": {\
    "@odata.type": "microsoft.graph.networkaccess.enrichedAuditLogsSettings"\
  }\
}\
'

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

// 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"
	  graphmodelsnetworkaccess "github.com/microsoftgraph/msgraph-beta-sdk-go/models/networkaccess"
	  //other-imports
)

requestBody := graphmodelsnetworkaccess.NewEnrichedAuditLogs()
sharepoint := graphmodelsnetworkaccess.NewEnrichedAuditLogsSettings()
requestBody.SetSharepoint(sharepoint)
teams := graphmodelsnetworkaccess.NewEnrichedAuditLogsSettings()
requestBody.SetTeams(teams)
exchange := graphmodelsnetworkaccess.NewEnrichedAuditLogsSettings()
requestBody.SetExchange(exchange)

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
enrichedAuditLogs, err := graphClient.NetworkAccess().Settings().EnrichedAuditLogs().Patch(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

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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.beta.models.networkaccess.EnrichedAuditLogs enrichedAuditLogs = new com.microsoft.graph.beta.models.networkaccess.EnrichedAuditLogs();
enrichedAuditLogs.setOdataType("#microsoft.graph.networkaccess.enrichedAuditLogs");
com.microsoft.graph.beta.models.networkaccess.EnrichedAuditLogsSettings sharepoint = new com.microsoft.graph.beta.models.networkaccess.EnrichedAuditLogsSettings();
sharepoint.setOdataType("microsoft.graph.networkaccess.enrichedAuditLogsSettings");
enrichedAuditLogs.setSharepoint(sharepoint);
com.microsoft.graph.beta.models.networkaccess.EnrichedAuditLogsSettings teams = new com.microsoft.graph.beta.models.networkaccess.EnrichedAuditLogsSettings();
teams.setOdataType("microsoft.graph.networkaccess.enrichedAuditLogsSettings");
enrichedAuditLogs.setTeams(teams);
com.microsoft.graph.beta.models.networkaccess.EnrichedAuditLogsSettings exchange = new com.microsoft.graph.beta.models.networkaccess.EnrichedAuditLogsSettings();
exchange.setOdataType("microsoft.graph.networkaccess.enrichedAuditLogsSettings");
enrichedAuditLogs.setExchange(exchange);
com.microsoft.graph.models.networkaccess.EnrichedAuditLogs result = graphClient.networkAccess().settings().enrichedAuditLogs().patch(enrichedAuditLogs);

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 enrichedAuditLogs = {
  '@odata.type': '#microsoft.graph.networkaccess.enrichedAuditLogs',
  sharepoint: {
    '@odata.type': 'microsoft.graph.networkaccess.enrichedAuditLogsSettings'
  },
  teams: {
    '@odata.type': 'microsoft.graph.networkaccess.enrichedAuditLogsSettings'
  },
  exchange: {
    '@odata.type': 'microsoft.graph.networkaccess.enrichedAuditLogsSettings'
  }
};

await client.api('/networkAccess/settings/enrichedAuditLogs')
	.version('beta')
	.update(enrichedAuditLogs);

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
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\Networkaccess\EnrichedAuditLogs;
use Microsoft\Graph\Beta\Generated\Models\Networkaccess\EnrichedAuditLogsSettings;


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

$requestBody = new EnrichedAuditLogs();
$requestBody->setOdataType('#microsoft.graph.networkaccess.enrichedAuditLogs');
$sharepoint = new EnrichedAuditLogsSettings();
$sharepoint->setOdataType('microsoft.graph.networkaccess.enrichedAuditLogsSettings');
$requestBody->setSharepoint($sharepoint);
$teams = new EnrichedAuditLogsSettings();
$teams->setOdataType('microsoft.graph.networkaccess.enrichedAuditLogsSettings');
$requestBody->setTeams($teams);
$exchange = new EnrichedAuditLogsSettings();
$exchange->setOdataType('microsoft.graph.networkaccess.enrichedAuditLogsSettings');
$requestBody->setExchange($exchange);

$result = $graphServiceClient->networkAccess()->settings()->enrichedAuditLogs()->patch($requestBody)->wait();

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.Beta.NetworkAccess

$params = @{
	"@odata.type" = "#microsoft.graph.networkaccess.enrichedAuditLogs"
	sharepoint = @{
		"@odata.type" = "microsoft.graph.networkaccess.enrichedAuditLogsSettings"
	}
	teams = @{
		"@odata.type" = "microsoft.graph.networkaccess.enrichedAuditLogsSettings"
	}
	exchange = @{
		"@odata.type" = "microsoft.graph.networkaccess.enrichedAuditLogsSettings"
	}
}

Update-MgBetaNetworkAccessSettingEnrichedAuditLog -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.

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.networkaccess.enriched_audit_logs import EnrichedAuditLogs
from msgraph_beta.generated.models.networkaccess.enriched_audit_logs_settings import EnrichedAuditLogsSettings
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = EnrichedAuditLogs(
	odata_type = "#microsoft.graph.networkaccess.enrichedAuditLogs",
	sharepoint = EnrichedAuditLogsSettings(
		odata_type = "microsoft.graph.networkaccess.enrichedAuditLogsSettings",
	),
	teams = EnrichedAuditLogsSettings(
		odata_type = "microsoft.graph.networkaccess.enrichedAuditLogsSettings",
	),
	exchange = EnrichedAuditLogsSettings(
		odata_type = "microsoft.graph.networkaccess.enrichedAuditLogsSettings",
	),
)

result = await graph_client.network_access.settings.enriched_audit_logs.patch(request_body)

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 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.networkaccess.enrichedAuditLogs",
  "id": "c477a530-2fe6-302f-79d5-f908851eae6e",
  "sharepoint": {
    "@odata.type": "microsoft.graph.networkaccess.enrichedAuditLogsSettings"
  },
  "teams": {
    "@odata.type": "microsoft.graph.networkaccess.enrichedAuditLogsSettings"
  },
  "exchange": {
    "@odata.type": "microsoft.graph.networkaccess.enrichedAuditLogsSettings"
  }
}