更新 azureADWindowsAutopilotDeploymentProfile

命名空间:microsoft.graph

重要: Microsoft Graph 中 /beta 版本下的 API 可能会发生更改,这可能会中断应用程序。 虽然 Microsoft 支持Intune /beta API,但你应自行决定使用这些 API。 通常,建议不要在生产应用程序中使用 /beta API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。

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

更新 azureADWindowsAutopilotDeploymentProfile 对象的属性。

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

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

权限

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

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

HTTP 请求

PATCH /deviceManagement/windowsAutopilotDeploymentProfiles/{windowsAutopilotDeploymentProfileId}
PATCH /deviceManagement/windowsAutopilotDeviceIdentities/{windowsAutopilotDeviceIdentityId}/deploymentProfile
PATCH /deviceManagement/windowsAutopilotDeviceIdentities/{windowsAutopilotDeviceIdentityId}/intendedDeploymentProfile

请求标头

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

请求正文

在请求正文中,提供 azureADWindowsAutopilotDeploymentProfile 对象的 JSON 表示形式。

下表显示了创建 azureADWindowsAutopilotDeploymentProfile 时所需的属性。

属性 类型 说明
id String 从 windows 继承的配置文件键 AutopilotDeploymentProfile
displayName String 部署配置文件的显示名称。 允许的最大长度为 200 个字符。 默认情况下返回。 支持:$select、$top、$skip、$orderby。 不支持$Search和$filter。 继承自 windowsAutopilotDeploymentProfile
description String 部署配置文件的说明。 允许的最大长度为 1500 个字符。 支持:$select、$top、$skip、$orderBy。 不支持$Search和$filter。 继承自 windowsAutopilotDeploymentProfile
language String 配置设备时要使用的语言代码。 例如 en-US。 默认值为 os-default。 支持:$select、$top、$skip。 不支持$Search、$orderBy和$filter。 只读。 从 2024 年 5 月开始,该属性将不再受支持,并将标记为已弃用。 请改用区域设置。 继承自 windowsAutopilotDeploymentProfile
区域设置 String 区域设置 (配置设备时要使用的语言) 。 例如 en-US。 默认值为 os-default。 支持:$select、$top、$skip。 不支持$Search、$orderBy和$filter。 继承自 windowsAutopilotDeploymentProfile
createdDateTime DateTimeOffset 创建部署配置文件的日期和时间。 无法修改该值,并且会在创建配置文件时自动填充。 时间戳类型使用 ISO 8601 格式表示日期和时间信息,并且始终采用 UTC 时间。 例如,2014 年 1 月 1 日午夜 (UTC) 如下所示:“2014-01-01T00:00:00Z”。 支持:$select、$top、$skip。 不支持$Search、$orderBy和$filter。 只读。 继承自 windowsAutopilotDeploymentProfile
lastModifiedDateTime DateTimeOffset 上次修改部署配置文件的日期和时间。 该值不能手动更新,并且会在对配置文件进行任何更改时自动填充。 时间戳类型表示采用 ISO 8601 格式的日期和时间信息,始终采用 UTC 时区。 例如,2014 年 1 月 1 日午夜 (UTC) 如下所示:“2014-01-01T00:00:00Z”。 支持:$select、$top、$skip。 $Search、$orderBy和$filter不支持只读。 继承自 windowsAutopilotDeploymentProfile
outOfBoxExperienceSettings outOfBoxExperienceSettings Autopilot 设备用于开箱即用体验的 Windows Autopilot Deployment 配置文件设置。 支持:$select、$top、$skip。 不支持$Search、$orderBy和$filter。 只读。 从 2024 年 5 月开始,该属性将不再受支持,并将标记为已弃用。 请改用 outOfBoxExperienceSetting。 继承自 windowsAutopilotDeploymentProfile
outOfBoxExperienceSetting outOfBoxExperienceSetting 设备用于开箱即用体验的Windows Autopilot Deployment配置文件设置。 支持:$select、$top、$skip。 不支持$Search、$orderBy和$filter。 继承自 windowsAutopilotDeploymentProfile
enrollmentStatusScreenSettings windowsEnrollmentStatusScreenSettings 注册状态屏幕设置继承自 windowsAutopilotDeploymentProfile
extractHardwareHash 布尔值 指示配置文件是否支持提取硬件哈希值并将设备注册到 Windows Autopilot。 如果为 TRUE,则指示下一次成功检查时是否会发生硬件提取和 Windows Autopilot 注册。 如果为 FALSE,则不会进行硬件哈希提取和 Windows Autopilot 注册。 默认值为 FALSE。 支持:$select、$top、$skip。 不支持$Search、$orderBy和$filter。 只读。 从 2024 年 5 月开始,该属性将不再受支持,并将标记为已弃用。 请改用 hardwareHashExtractionEnabled。 继承自 windowsAutopilotDeploymentProfile
hardwareHashExtractionEnabled 布尔值 指示配置文件是否支持提取硬件哈希值并将设备注册到 Windows Autopilot。 如果为 TRUE,则指示下一次成功检查时是否会发生硬件提取和 Windows Autopilot 注册。 如果为 FALSE,则不会进行硬件哈希提取和 Windows Autopilot 注册。 默认值为 FALSE。 支持:$select、$top、$skip。 不支持$Search、$orderBy和$filter。 继承自 windowsAutopilotDeploymentProfile
deviceNameTemplate String 用于命名 Autopilot 设备的模板。 这可以是自定义文本,也可以包含设备的序列号或随机生成的数字。 模板生成的文本的总长度不能超过 15 个字符。 支持:$select、$top、$skip。 不支持$Search、$orderBy和$filter。 继承自 windowsAutopilotDeploymentProfile
deviceType windowsAutopilotDeviceType 此配置文件适用的 Windows 设备类型。 可能的值包括 windowsPc、holoLens 和 virtualMachine。 默认值为 windowsPc。 支持:$select、$top、$skip。 不支持$Search、$orderBy和$filter。 继承自 windowsAutopilotDeploymentProfile。 可取值为:windowsPcholoLenssurfaceHub2surfaceHub2SvirtualMachineunknownFutureValue
enableWhiteGlove 布尔值 指示是否允许用户在“开箱即用”体验期间使用 Windows Autopilot 进行预预配部署模式, (OOBE) 。 如果为 TRUE,则指示允许预预配部署模式的 Windows Autopilot。 如果为 false,则不允许使用预预配部署模式的 Windows Autopilot。 默认值为 FALSE。 只读。 从 2024 年 5 月开始,该属性将不再受支持,并将标记为已弃用。 请改用 preprovisioningAllowed。 继承自 windowsAutopilotDeploymentProfile
preprovisioningAllowed 布尔值 指示是否允许用户在“开箱即用”体验期间使用 Windows Autopilot 进行预预配部署模式, (OOBE) 。 如果为 TRUE,则指示允许使用适用于 OOBE 的预预配部署模式的 Windows Autopilot。 如果为 false,则不允许使用适用于 OOBE 的预预配部署模式的 Windows Autopilot。 默认值为 FALSE。 继承自 windowsAutopilotDeploymentProfile
roleScopeTagIds 字符串集合 部署配置文件的角色范围标记列表。 继承自 windowsAutopilotDeploymentProfile
managementServiceAppId String 在基于客户端设备的注册发现过程中使用的 Entra 管理服务应用 ID。 支持:$select、$top、$skip。 不支持$Search、$orderBy和$filter。 继承自 windowsAutopilotDeploymentProfile

响应

如果成功,此方法在响应正文中返回响应 200 OK 代码和更新的 azureADWindowsAutopilotDeploymentProfile 对象。

示例

请求

下面是一个请求示例。

PATCH https://graph.microsoft.com/beta/deviceManagement/windowsAutopilotDeploymentProfiles/{windowsAutopilotDeploymentProfileId}
Content-type: application/json
Content-length: 1628

{
  "@odata.type": "#microsoft.graph.azureADWindowsAutopilotDeploymentProfile",
  "displayName": "Display Name value",
  "description": "Description value",
  "language": "Language value",
  "locale": "Locale value",
  "outOfBoxExperienceSettings": {
    "@odata.type": "microsoft.graph.outOfBoxExperienceSettings",
    "hidePrivacySettings": true,
    "hideEULA": true,
    "userType": "standard",
    "deviceUsageType": "shared",
    "skipKeyboardSelectionPage": true,
    "hideEscapeLink": true
  },
  "outOfBoxExperienceSetting": {
    "@odata.type": "microsoft.graph.outOfBoxExperienceSetting",
    "privacySettingsHidden": true,
    "eulaHidden": true,
    "userType": "standard",
    "deviceUsageType": "shared",
    "keyboardSelectionPageSkipped": true,
    "escapeLinkHidden": true
  },
  "enrollmentStatusScreenSettings": {
    "@odata.type": "microsoft.graph.windowsEnrollmentStatusScreenSettings",
    "hideInstallationProgress": true,
    "allowDeviceUseBeforeProfileAndAppInstallComplete": true,
    "blockDeviceSetupRetryByUser": true,
    "allowLogCollectionOnInstallFailure": true,
    "customErrorMessage": "Custom Error Message value",
    "installProgressTimeoutInMinutes": 15,
    "allowDeviceUseOnInstallFailure": true
  },
  "extractHardwareHash": true,
  "hardwareHashExtractionEnabled": true,
  "deviceNameTemplate": "Device Name Template value",
  "deviceType": "holoLens",
  "enableWhiteGlove": true,
  "preprovisioningAllowed": true,
  "roleScopeTagIds": [
    "Role Scope Tag Ids value"
  ],
  "managementServiceAppId": "Management Service App Id value"
}

响应

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

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

{
  "@odata.type": "#microsoft.graph.azureADWindowsAutopilotDeploymentProfile",
  "id": "e2ec4e69-4e69-e2ec-694e-ece2694eece2",
  "displayName": "Display Name value",
  "description": "Description value",
  "language": "Language value",
  "locale": "Locale value",
  "createdDateTime": "2017-01-01T00:02:43.5775965-08:00",
  "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00",
  "outOfBoxExperienceSettings": {
    "@odata.type": "microsoft.graph.outOfBoxExperienceSettings",
    "hidePrivacySettings": true,
    "hideEULA": true,
    "userType": "standard",
    "deviceUsageType": "shared",
    "skipKeyboardSelectionPage": true,
    "hideEscapeLink": true
  },
  "outOfBoxExperienceSetting": {
    "@odata.type": "microsoft.graph.outOfBoxExperienceSetting",
    "privacySettingsHidden": true,
    "eulaHidden": true,
    "userType": "standard",
    "deviceUsageType": "shared",
    "keyboardSelectionPageSkipped": true,
    "escapeLinkHidden": true
  },
  "enrollmentStatusScreenSettings": {
    "@odata.type": "microsoft.graph.windowsEnrollmentStatusScreenSettings",
    "hideInstallationProgress": true,
    "allowDeviceUseBeforeProfileAndAppInstallComplete": true,
    "blockDeviceSetupRetryByUser": true,
    "allowLogCollectionOnInstallFailure": true,
    "customErrorMessage": "Custom Error Message value",
    "installProgressTimeoutInMinutes": 15,
    "allowDeviceUseOnInstallFailure": true
  },
  "extractHardwareHash": true,
  "hardwareHashExtractionEnabled": true,
  "deviceNameTemplate": "Device Name Template value",
  "deviceType": "holoLens",
  "enableWhiteGlove": true,
  "preprovisioningAllowed": true,
  "roleScopeTagIds": [
    "Role Scope Tag Ids value"
  ],
  "managementServiceAppId": "Management Service App Id value"
}