更新 windows10EnrollmentCompletionPageConfiguration
命名空间:microsoft.graph
重要: Microsoft /beta 版本下的 Graph API 可能会发生更改;不支持生产使用。
注意:适用于 Intune 的 Microsoft Graph API 需要适用于租户的活动 Intune 许可证。
更新 windows10EnrollmentCompletionPageConfiguration 对象的属性。
此 API 可用于以下国家级云部署。
全局服务 | 美国政府 L4 | 美国政府 L5 (DOD) | 由世纪互联运营的中国 |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
权限
要调用此 API,需要以下权限之一。 若要了解详细信息,包括如何选择权限的信息,请参阅权限。
权限类型 | 权限(从最低特权到最高特权) |
---|---|
委派(工作或学校帐户) | DeviceManagementServiceConfig.ReadWrite.All、DeviceManagementConfiguration.ReadWrite.All |
委派(个人 Microsoft 帐户) | 不支持。 |
应用程序 | DeviceManagementServiceConfig.ReadWrite.All、DeviceManagementConfiguration.ReadWrite.All |
HTTP 请求
PATCH /deviceManagement/deviceEnrollmentConfigurations/{deviceEnrollmentConfigurationId}
请求标头
标头 | 值 |
---|---|
Authorization | 持有者 {token}。 必填。 详细了解 身份验证和授权。 |
接受 | application/json |
请求正文
在请求正文中,提供 windows10EnrollmentCompletionPageConfiguration 对象的 JSON 表示形式。
下表显示了创建 windows10EnrollmentCompletionPageConfiguration 时所需的属性。
属性 | 类型 | 说明 |
---|---|---|
id | String | 继承自 deviceEnrollmentConfiguration 的帐户的唯一标识符 |
displayName | String | 继承自 deviceEnrollmentConfiguration 的设备注册配置的显示名称 |
description | String | 继承自 deviceEnrollmentConfiguration 的设备注册配置的说明 |
priority | Int32 | 当用户存在于分配的注册配置的多个组中时,将使用优先级。 用户仅受具有最低优先级值的配置的约束。 继承自 deviceEnrollmentConfiguration |
createdDateTime | DateTimeOffset | 从 deviceEnrollmentConfiguration 继承的设备注册配置的 UTC 创建日期时间 |
lastModifiedDateTime | DateTimeOffset | 设备注册配置的上次修改日期时间(UTC)继承自 deviceEnrollmentConfiguration |
version | Int32 | 继承自 deviceEnrollmentConfiguration 的设备注册配置版本 |
roleScopeTagIds | 字符串集合 | 注册限制的可选角色范围标记。 继承自 deviceEnrollmentConfiguration |
deviceEnrollmentConfigurationType | deviceEnrollmentConfigurationType | 支持从 deviceEnrollmentConfiguration 继承的注册配置类型。 可能的值是:unknown 、limit 、platformRestrictions 、windowsHelloForBusiness 、defaultLimit 、defaultPlatformRestrictions 、defaultWindowsHelloForBusiness 、defaultWindows10EnrollmentCompletionPageConfiguration 、windows10EnrollmentCompletionPageConfiguration 、deviceComanagementAuthorityConfiguration 、singlePlatformRestriction 、unknownFutureValue 、enrollmentNotificationsConfiguration 。 |
showInstallationProgress | 布尔值 | 如果为 TRUE,则向用户显示安装进度。 如果为 false,则隐藏安装进度。 默认值为 false。 |
blockDeviceSetupRetryByUser | 布尔值 | 如果为 TRUE,则阻止用户在安装失败时重试安装程序。 如果为 false,则允许用户重试。 默认值为 false。 |
allowDeviceResetOnInstallFailure | 布尔值 | 如果为 TRUE,则允许在安装失败时重置设备。 如果为 false,则阻止重置。 默认值为 false。 |
allowLogCollectionOnInstallFailure | 布尔值 | 如果为 TRUE,则允许在安装失败时收集日志。 如果为 false,则不允许收集日志。 默认值为 false。 |
customErrorMessage | String | 安装失败时要显示的自定义错误消息。 最大长度为 10000。 示例:“无法完成设置。 请重试,或者联系你的 IT 支持人员以获取帮助。” |
installProgressTimeoutInMinutes | Int32 | 安装进度超时(以分钟为单位)。 默认值为 60 分钟。 |
allowDeviceUseOnInstallFailure | 布尔值 | 如果为 TRUE,则允许用户在安装失败时继续使用设备。 如果为 false,则会在安装失败时阻止用户。 默认值为 false。 |
selectedMobileAppIds | 字符串集合 | 要跟踪安装状态的所选应用程序。 它采用 GUID 数组的形式。 |
allowNonBlockingAppInstallation | 布尔值 | 如果为 TRUE,ESP (注册状态页) 安装技术人员阶段面向的所有必需应用,并忽略非阻止应用的任何故障。 如果为 FALSE,则 ESP 在应用安装过程中出现任何错误时失败。 默认值为 false。 |
installQualityUpdates | 布尔值 | 允许在 OOBE 期间安装质量更新 |
trackInstallProgressForAutopilotOnly | 布尔值 | 如果为 TRUE,则仅跟踪 Autopilot 注册方案的安装进度。 如果为 false,则也会跟踪其他方案。 默认值为 false。 |
disableUserStatusTrackingAfterFirstUser | 布尔值 | 如果为 TRUE,则禁用显示注册后第一个用户的安装进度。 如果为 false,则启用显示进度。 默认值为 false。 |
响应
如果成功,此方法在响应正文中返回响应 200 OK
代码和更新的 windows10EnrollmentCompletionPageConfiguration 对象。
示例
请求
下面是一个请求示例。
PATCH https://graph.microsoft.com/beta/deviceManagement/deviceEnrollmentConfigurations/{deviceEnrollmentConfigurationId}
Content-type: application/json
Content-length: 873
{
"@odata.type": "#microsoft.graph.windows10EnrollmentCompletionPageConfiguration",
"displayName": "Display Name value",
"description": "Description value",
"priority": 8,
"version": 7,
"roleScopeTagIds": [
"Role Scope Tag Ids value"
],
"deviceEnrollmentConfigurationType": "limit",
"showInstallationProgress": true,
"blockDeviceSetupRetryByUser": true,
"allowDeviceResetOnInstallFailure": true,
"allowLogCollectionOnInstallFailure": true,
"customErrorMessage": "Custom Error Message value",
"installProgressTimeoutInMinutes": 15,
"allowDeviceUseOnInstallFailure": true,
"selectedMobileAppIds": [
"Selected Mobile App Ids value"
],
"allowNonBlockingAppInstallation": true,
"installQualityUpdates": true,
"trackInstallProgressForAutopilotOnly": true,
"disableUserStatusTrackingAfterFirstUser": true
}
响应
下面是一个响应示例。 注意:为简洁起见,可能会截断此处显示的响应对象。 将从实际调用中返回所有属性。
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1045
{
"@odata.type": "#microsoft.graph.windows10EnrollmentCompletionPageConfiguration",
"id": "77bf8248-8248-77bf-4882-bf774882bf77",
"displayName": "Display Name value",
"description": "Description value",
"priority": 8,
"createdDateTime": "2017-01-01T00:02:43.5775965-08:00",
"lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00",
"version": 7,
"roleScopeTagIds": [
"Role Scope Tag Ids value"
],
"deviceEnrollmentConfigurationType": "limit",
"showInstallationProgress": true,
"blockDeviceSetupRetryByUser": true,
"allowDeviceResetOnInstallFailure": true,
"allowLogCollectionOnInstallFailure": true,
"customErrorMessage": "Custom Error Message value",
"installProgressTimeoutInMinutes": 15,
"allowDeviceUseOnInstallFailure": true,
"selectedMobileAppIds": [
"Selected Mobile App Ids value"
],
"allowNonBlockingAppInstallation": true,
"installQualityUpdates": true,
"trackInstallProgressForAutopilotOnly": true,
"disableUserStatusTrackingAfterFirstUser": true
}