Update eBookInstallSummary

Namespace: microsoft.graph

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

Update the properties of a eBookInstallSummary 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)	DeviceManagementApps.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.
Application	DeviceManagementApps.ReadWrite.All

HTTP Request

PATCH /deviceAppManagement/managedEBooks/{managedEBookId}/installSummary

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 eBookInstallSummary object.

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

Property	Type	Description
id	String	Key of the entity.
installedDeviceCount	Int32	Number of Devices that have successfully installed this book.
failedDeviceCount	Int32	Number of Devices that have failed to install this book.
notInstalledDeviceCount	Int32	Number of Devices that does not have this book installed.
installedUserCount	Int32	Number of Users whose devices have all succeeded to install this book.
failedUserCount	Int32	Number of Users that have 1 or more device that failed to install this book.
notInstalledUserCount	Int32	Number of Users that did not install this book.

Response

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

Example

Request

Here is an example of the request.

HTTP

PATCH https://graph.microsoft.com/v1.0/deviceAppManagement/managedEBooks/{managedEBookId}/installSummary
Content-type: application/json
Content-length: 236

{
  "@odata.type": "#microsoft.graph.eBookInstallSummary",
  "installedDeviceCount": 4,
  "failedDeviceCount": 1,
  "notInstalledDeviceCount": 7,
  "installedUserCount": 2,
  "failedUserCount": 15,
  "notInstalledUserCount": 5
}

C#

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

// Dependencies
using Microsoft.Graph.Models;

var requestBody = new EBookInstallSummary
{
	OdataType = "#microsoft.graph.eBookInstallSummary",
	InstalledDeviceCount = 4,
	FailedDeviceCount = 1,
	NotInstalledDeviceCount = 7,
	InstalledUserCount = 2,
	FailedUserCount = 15,
	NotInstalledUserCount = 5,
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.DeviceAppManagement.ManagedEBooks["{managedEBook-id}"].InstallSummary.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-app-management managed-ebooks install-summary patch --managed-ebook-id {managedEBook-id} --body '{\
  "@odata.type": "#microsoft.graph.eBookInstallSummary",\
  "installedDeviceCount": 4,\
  "failedDeviceCount": 1,\
  "notInstalledDeviceCount": 7,\
  "installedUserCount": 2,\
  "failedUserCount": 15,\
  "notInstalledUserCount": 5\
}\
'

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

requestBody := graphmodels.NewEBookInstallSummary()
installedDeviceCount := int32(4)
requestBody.SetInstalledDeviceCount(&installedDeviceCount) 
failedDeviceCount := int32(1)
requestBody.SetFailedDeviceCount(&failedDeviceCount) 
notInstalledDeviceCount := int32(7)
requestBody.SetNotInstalledDeviceCount(&notInstalledDeviceCount) 
installedUserCount := int32(2)
requestBody.SetInstalledUserCount(&installedUserCount) 
failedUserCount := int32(15)
requestBody.SetFailedUserCount(&failedUserCount) 
notInstalledUserCount := int32(5)
requestBody.SetNotInstalledUserCount(&notInstalledUserCount) 

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
installSummary, err := graphClient.DeviceAppManagement().ManagedEBooks().ByManagedEBookId("managedEBook-id").InstallSummary().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);

EBookInstallSummary eBookInstallSummary = new EBookInstallSummary();
eBookInstallSummary.setOdataType("#microsoft.graph.eBookInstallSummary");
eBookInstallSummary.setInstalledDeviceCount(4);
eBookInstallSummary.setFailedDeviceCount(1);
eBookInstallSummary.setNotInstalledDeviceCount(7);
eBookInstallSummary.setInstalledUserCount(2);
eBookInstallSummary.setFailedUserCount(15);
eBookInstallSummary.setNotInstalledUserCount(5);
EBookInstallSummary result = graphClient.deviceAppManagement().managedEBooks().byManagedEBookId("{managedEBook-id}").installSummary().patch(eBookInstallSummary);

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 eBookInstallSummary = {
  '@odata.type': '#microsoft.graph.eBookInstallSummary',
  installedDeviceCount: 4,
  failedDeviceCount: 1,
  notInstalledDeviceCount: 7,
  installedUserCount: 2,
  failedUserCount: 15,
  notInstalledUserCount: 5
};

await client.api('/deviceAppManagement/managedEBooks/{managedEBookId}/installSummary')
	.update(eBookInstallSummary);

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\EBookInstallSummary;


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

$requestBody = new EBookInstallSummary();
$requestBody->setOdataType('#microsoft.graph.eBookInstallSummary');
$requestBody->setInstalledDeviceCount(4);
$requestBody->setFailedDeviceCount(1);
$requestBody->setNotInstalledDeviceCount(7);
$requestBody->setInstalledUserCount(2);
$requestBody->setFailedUserCount(15);
$requestBody->setNotInstalledUserCount(5);

$result = $graphServiceClient->deviceAppManagement()->managedEBooks()->byManagedEBookId('managedEBook-id')->installSummary()->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.Devices.CorporateManagement

$params = @{
	"@odata.type" = "#microsoft.graph.eBookInstallSummary"
	installedDeviceCount = 4
	failedDeviceCount = 1
	notInstalledDeviceCount = 7
	installedUserCount = 2
	failedUserCount = 15
	notInstalledUserCount = 5
}

Update-MgDeviceAppManagementManagedEBookInstallSummary -ManagedEBookId $managedEBookId -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.e_book_install_summary import EBookInstallSummary
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = EBookInstallSummary(
	odata_type = "#microsoft.graph.eBookInstallSummary",
	installed_device_count = 4,
	failed_device_count = 1,
	not_installed_device_count = 7,
	installed_user_count = 2,
	failed_user_count = 15,
	not_installed_user_count = 5,
)

result = await graph_client.device_app_management.managed_e_books.by_managed_e_book_id('managedEBook-id').install_summary.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: 285

{
  "@odata.type": "#microsoft.graph.eBookInstallSummary",
  "id": "9708ad78-ad78-9708-78ad-089778ad0897",
  "installedDeviceCount": 4,
  "failedDeviceCount": 1,
  "notInstalledDeviceCount": 7,
  "installedUserCount": 2,
  "failedUserCount": 15,
  "notInstalledUserCount": 5
}