擦除操作

命名空间：microsoft.graph

注意：适用于 Intune 的 Microsoft Graph API 需要适用于租户的活动 Intune 许可证。

擦除设备

此 API 可用于以下国家级云部署。

全局服务	美国政府 L4	美国政府 L5 (DOD)	由世纪互联运营的中国
✅	✅	✅	✅

权限

要调用此 API，需要以下权限之一。 若要了解详细信息，包括如何选择权限的信息，请参阅权限。

权限类型	权限（从最低特权到最高特权）
委派（工作或学校帐户）	DeviceManagementManagedDevices.ReadWrite.All、DeviceManagementManagedDevices.PrivilegedOperations.All
委派（个人 Microsoft 帐户）	不支持。
应用程序	DeviceManagementManagedDevices.ReadWrite.All、DeviceManagementManagedDevices.PrivilegedOperations.All

HTTP 请求

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

请求标头

标头	值
Authorization	持有者 {token}。 必填。 详细了解 身份验证和授权。
接受	application/json

请求正文

在请求正文中，提供参数的 JSON 表示形式。

下表显示了可用于此操作的参数。

属性	类型	说明
keepEnrollmentData	布尔	尚未记录
keepUserData	Boolean	尚未记录
macOsUnlockCode	字符串	尚未记录
obliterationBehavior	obliterationBehavior	尚未记录
persistEsimDataPlan	布尔值	尚未记录

响应

如果成功，此操作返回 204 No Content 响应代码。

示例

请求

下面是一个请求示例。

HTTP

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

{
  "keepEnrollmentData": true,
  "keepUserData": true,
  "macOsUnlockCode": "Mac Os Unlock Code value",
  "persistEsimDataPlan": true
}

C#

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

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

var requestBody = new WipePostRequestBody
{
	KeepEnrollmentData = true,
	KeepUserData = true,
	MacOsUnlockCode = "Mac Os Unlock Code value",
	PersistEsimDataPlan = 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}"].Wipe.PostAsync(requestBody);

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc device-management managed-devices wipe post --managed-device-id {managedDevice-id} --body '{\
  "keepEnrollmentData": true,\
  "keepUserData": true,\
  "macOsUnlockCode": "Mac Os Unlock Code value",\
  "persistEsimDataPlan": true\
}\
'

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

Go

import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphdevicemanagement "github.com/microsoftgraph/msgraph-sdk-go/devicemanagement"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphdevicemanagement.NewWipePostRequestBody()
keepEnrollmentData := true
requestBody.SetKeepEnrollmentData(&keepEnrollmentData) 
keepUserData := true
requestBody.SetKeepUserData(&keepUserData) 
macOsUnlockCode := "Mac Os Unlock Code value"
requestBody.SetMacOsUnlockCode(&macOsUnlockCode) 
persistEsimDataPlan := true
requestBody.SetPersistEsimDataPlan(&persistEsimDataPlan) 

graphClient.DeviceManagement().ManagedDevices().ByManagedDeviceId("managedDevice-id").Wipe().Post(context.Background(), requestBody, nil)

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

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.wipe.WipePostRequestBody wipePostRequestBody = new com.microsoft.graph.devicemanagement.manageddevices.item.wipe.WipePostRequestBody();
wipePostRequestBody.setKeepEnrollmentData(true);
wipePostRequestBody.setKeepUserData(true);
wipePostRequestBody.setMacOsUnlockCode("Mac Os Unlock Code value");
wipePostRequestBody.setPersistEsimDataPlan(true);
graphClient.deviceManagement().managedDevices().byManagedDeviceId("{managedDevice-id}").wipe().post(wipePostRequestBody);

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const wipe = {
  keepEnrollmentData: true,
  keepUserData: true,
  macOsUnlockCode: 'Mac Os Unlock Code value',
  persistEsimDataPlan: true
};

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

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

PHP

<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\WipePostRequestBody;


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

$requestBody = new WipePostRequestBody();
$requestBody->setKeepEnrollmentData(true);
$requestBody->setKeepUserData(true);
$requestBody->setMacOsUnlockCode('Mac Os Unlock Code value');
$requestBody->setPersistEsimDataPlan(true);

$graphServiceClient->deviceManagement()->managedDevices()->byManagedDeviceId('managedDevice-id')->wipe()->post($requestBody)->wait();

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

PowerShell

Import-Module Microsoft.Graph.DeviceManagement.Actions

$params = @{
	keepEnrollmentData = $true
	keepUserData = $true
	macOsUnlockCode = "Mac Os Unlock Code value"
	persistEsimDataPlan = $true
}

Clear-MgDeviceManagementManagedDevice -ManagedDeviceId $managedDeviceId -BodyParameter $params

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

Python

from msgraph import GraphServiceClient
from msgraph.generated.devicemanagement.manageddevices.item.wipe.wipe_post_request_body import WipePostRequestBody

graph_client = GraphServiceClient(credentials, scopes)

request_body = WipePostRequestBody(
	keep_enrollment_data = True,
	keep_user_data = True,
	mac_os_unlock_code = "Mac Os Unlock Code value",
	persist_esim_data_plan = True,
)

await graph_client.device_management.managed_devices.by_managed_device_id('managedDevice-id').wipe.post(request_body)

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

响应

下面是一个响应示例。 注意：为简洁起见，可能会截断此处显示的响应对象。 将从实际调用中返回所有属性。

HTTP/1.1 204 No Content