cleanWindowsDevice action

Namespace: microsoft.graph

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

Clean Windows device

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

HTTP Request

POST /deviceManagement/managedDevices/{managedDeviceId}/cleanWindowsDevice
POST /deviceManagement/detectedApps/{detectedAppId}/managedDevices/{managedDeviceId}/cleanWindowsDevice
POST /deviceManagement/detectedApps/{detectedAppId}/managedDevices/{managedDeviceId}/users/{userId}/managedDevices/{managedDeviceId}/cleanWindowsDevice

Request headers

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

Request body

In the request body, supply JSON representation of the parameters.

The following table shows the parameters that can be used with this action.

Property	Type	Description
keepUserData	Boolean	Not yet documented

Response

If successful, this action returns a 204 No Content response code.

Example

Request

Here is an example of the request.

HTTP

POST https://graph.microsoft.com/v1.0/deviceManagement/managedDevices/{managedDeviceId}/cleanWindowsDevice
Content-type: application/json
Content-length: 28

{
  "keepUserData": true
}

C#

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

// Dependencies
using Microsoft.Graph.DeviceManagement.ManagedDevices.Item.CleanWindowsDevice;

var requestBody = new CleanWindowsDevicePostRequestBody
{
	KeepUserData = true,
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.DeviceManagement.ManagedDevices["{managedDevice-id}"].CleanWindowsDevice.PostAsync(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 managed-devices clean-windows-device post --managed-device-id {managedDevice-id} --body '{\
  "keepUserData": true\
}\
'

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

requestBody := graphdevicemanagement.NewCleanWindowsDevicePostRequestBody()
keepUserData := true
requestBody.SetKeepUserData(&keepUserData) 

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.DeviceManagement().ManagedDevices().ByManagedDeviceId("managedDevice-id").CleanWindowsDevice().Post(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);

com.microsoft.graph.devicemanagement.manageddevices.item.cleanwindowsdevice.CleanWindowsDevicePostRequestBody cleanWindowsDevicePostRequestBody = new com.microsoft.graph.devicemanagement.manageddevices.item.cleanwindowsdevice.CleanWindowsDevicePostRequestBody();
cleanWindowsDevicePostRequestBody.setKeepUserData(true);
graphClient.deviceManagement().managedDevices().byManagedDeviceId("{managedDevice-id}").cleanWindowsDevice().post(cleanWindowsDevicePostRequestBody);

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 cleanWindowsDevice = {
  keepUserData: true
};

await client.api('/deviceManagement/managedDevices/{managedDeviceId}/cleanWindowsDevice')
	.post(cleanWindowsDevice);

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\DeviceManagement\ManagedDevices\Item\CleanWindowsDevice\CleanWindowsDevicePostRequestBody;


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

$requestBody = new CleanWindowsDevicePostRequestBody();
$requestBody->setKeepUserData(true);

$graphServiceClient->deviceManagement()->managedDevices()->byManagedDeviceId('managedDevice-id')->cleanWindowsDevice()->post($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.Actions

$params = @{
	keepUserData = $true
}

Invoke-MgCleanDeviceManagementManagedDeviceWindowsDevice -ManagedDeviceId $managedDeviceId -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.devicemanagement.manageddevices.item.clean_windows_device.clean_windows_device_post_request_body import CleanWindowsDevicePostRequestBody
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = CleanWindowsDevicePostRequestBody(
	keep_user_data = True,
)

await graph_client.device_management.managed_devices.by_managed_device_id('managedDevice-id').clean_windows_device.post(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 204 No Content