Update deviceConfigurationUserOverview

Namespace: microsoft.graph

Note: The Microsoft Graph API for Intune requires an active Intune license for the tenant.

Update the properties of a deviceConfigurationUserOverview 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

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

HTTP Request

PATCH /deviceManagement/deviceConfigurations/{deviceConfigurationId}/userStatusOverview

Request headers

Header	Value
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Accept	application/json

Request body

In the request body, supply a JSON representation for the deviceConfigurationUserOverview object.

The following table shows the properties that are required when you create the deviceConfigurationUserOverview.

Property	Type	Description
id	String	Key of the entity.
pendingCount	Int32	Number of pending Users
notApplicableCount	Int32	Number of not applicable users
successCount	Int32	Number of succeeded Users
errorCount	Int32	Number of error Users
failedCount	Int32	Number of failed Users
lastUpdateDateTime	DateTimeOffset	Last update time
configurationVersion	Int32	Version of the policy for that overview

Response

If successful, this method returns a 200 OK response code and an updated deviceConfigurationUserOverview object in the response body.

Example

Request

Here is an example of the request.

HTTP

PATCH https://graph.microsoft.com/v1.0/deviceManagement/deviceConfigurations/{deviceConfigurationId}/userStatusOverview
Content-type: application/json
Content-length: 282

{
  "@odata.type": "#microsoft.graph.deviceConfigurationUserOverview",
  "pendingCount": 12,
  "notApplicableCount": 2,
  "successCount": 12,
  "errorCount": 10,
  "failedCount": 11,
  "lastUpdateDateTime": "2016-12-31T23:58:21.6459442-08:00",
  "configurationVersion": 4
}

C#

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

// Dependencies
using Microsoft.Graph.Models;

var requestBody = new DeviceConfigurationUserOverview
{
	OdataType = "#microsoft.graph.deviceConfigurationUserOverview",
	PendingCount = 12,
	NotApplicableCount = 2,
	SuccessCount = 12,
	ErrorCount = 10,
	FailedCount = 11,
	LastUpdateDateTime = DateTimeOffset.Parse("2016-12-31T23:58:21.6459442-08:00"),
	ConfigurationVersion = 4,
};

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

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

CLI

mgc device-management device-configurations user-status-overview patch --device-configuration-id {deviceConfiguration-id} --body '{\
  "@odata.type": "#microsoft.graph.deviceConfigurationUserOverview",\
  "pendingCount": 12,\
  "notApplicableCount": 2,\
  "successCount": 12,\
  "errorCount": 10,\
  "failedCount": 11,\
  "lastUpdateDateTime": "2016-12-31T23:58:21.6459442-08:00",\
  "configurationVersion": 4\
}\
'

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 $v1.*

// Dependencies
import (
	  "context"
	  "time"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
	  //other-imports
)

requestBody := graphmodels.NewDeviceConfigurationUserOverview()
pendingCount := int32(12)
requestBody.SetPendingCount(&pendingCount) 
notApplicableCount := int32(2)
requestBody.SetNotApplicableCount(&notApplicableCount) 
successCount := int32(12)
requestBody.SetSuccessCount(&successCount) 
errorCount := int32(10)
requestBody.SetErrorCount(&errorCount) 
failedCount := int32(11)
requestBody.SetFailedCount(&failedCount) 
lastUpdateDateTime , err := time.Parse(time.RFC3339, "2016-12-31T23:58:21.6459442-08:00")
requestBody.SetLastUpdateDateTime(&lastUpdateDateTime) 
configurationVersion := int32(4)
requestBody.SetConfigurationVersion(&configurationVersion) 

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
userStatusOverview, err := graphClient.DeviceManagement().DeviceConfigurations().ByDeviceConfigurationId("deviceConfiguration-id").UserStatusOverview().Patch(context.Background(), requestBody, nil)

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);

DeviceConfigurationUserOverview deviceConfigurationUserOverview = new DeviceConfigurationUserOverview();
deviceConfigurationUserOverview.setOdataType("#microsoft.graph.deviceConfigurationUserOverview");
deviceConfigurationUserOverview.setPendingCount(12);
deviceConfigurationUserOverview.setNotApplicableCount(2);
deviceConfigurationUserOverview.setSuccessCount(12);
deviceConfigurationUserOverview.setErrorCount(10);
deviceConfigurationUserOverview.setFailedCount(11);
OffsetDateTime lastUpdateDateTime = OffsetDateTime.parse("2016-12-31T23:58:21.6459442-08:00");
deviceConfigurationUserOverview.setLastUpdateDateTime(lastUpdateDateTime);
deviceConfigurationUserOverview.setConfigurationVersion(4);
DeviceConfigurationUserOverview result = graphClient.deviceManagement().deviceConfigurations().byDeviceConfigurationId("{deviceConfiguration-id}").userStatusOverview().patch(deviceConfigurationUserOverview);

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 deviceConfigurationUserOverview = {
  '@odata.type': '#microsoft.graph.deviceConfigurationUserOverview',
  pendingCount: 12,
  notApplicableCount: 2,
  successCount: 12,
  errorCount: 10,
  failedCount: 11,
  lastUpdateDateTime: '2016-12-31T23:58:21.6459442-08:00',
  configurationVersion: 4
};

await client.api('/deviceManagement/deviceConfigurations/{deviceConfigurationId}/userStatusOverview')
	.update(deviceConfigurationUserOverview);

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\GraphServiceClient;
use Microsoft\Graph\Generated\Models\DeviceConfigurationUserOverview;


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

$requestBody = new DeviceConfigurationUserOverview();
$requestBody->setOdataType('#microsoft.graph.deviceConfigurationUserOverview');
$requestBody->setPendingCount(12);
$requestBody->setNotApplicableCount(2);
$requestBody->setSuccessCount(12);
$requestBody->setErrorCount(10);
$requestBody->setFailedCount(11);
$requestBody->setLastUpdateDateTime(new \DateTime('2016-12-31T23:58:21.6459442-08:00'));
$requestBody->setConfigurationVersion(4);

$result = $graphServiceClient->deviceManagement()->deviceConfigurations()->byDeviceConfigurationId('deviceConfiguration-id')->userStatusOverview()->patch($requestBody)->wait();

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.DeviceManagement

$params = @{
	"@odata.type" = "#microsoft.graph.deviceConfigurationUserOverview"
	pendingCount = 12
	notApplicableCount = 2
	successCount = 12
	errorCount = 10
	failedCount = 11
	lastUpdateDateTime = [System.DateTime]::Parse("2016-12-31T23:58:21.6459442-08:00")
	configurationVersion = 4
}

Update-MgDeviceManagementDeviceConfigurationUserStatusOverview -DeviceConfigurationId $deviceConfigurationId -BodyParameter $params

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 import GraphServiceClient
from msgraph.generated.models.device_configuration_user_overview import DeviceConfigurationUserOverview
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = DeviceConfigurationUserOverview(
	odata_type = "#microsoft.graph.deviceConfigurationUserOverview",
	pending_count = 12,
	not_applicable_count = 2,
	success_count = 12,
	error_count = 10,
	failed_count = 11,
	last_update_date_time = "2016-12-31T23:58:21.6459442-08:00",
	configuration_version = 4,
)

result = await graph_client.device_management.device_configurations.by_device_configuration_id('deviceConfiguration-id').user_status_overview.patch(request_body)

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

Response

Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

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

{
  "@odata.type": "#microsoft.graph.deviceConfigurationUserOverview",
  "id": "000e52d7-52d7-000e-d752-0e00d7520e00",
  "pendingCount": 12,
  "notApplicableCount": 2,
  "successCount": 12,
  "errorCount": 10,
  "failedCount": 11,
  "lastUpdateDateTime": "2016-12-31T23:58:21.6459442-08:00",
  "configurationVersion": 4
}