通过

cloudPC 资源类型

命名空间：microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。

表示云托管的虚拟桌面。 此云电脑也在 Intune 中注册，并通过 Microsoft Endpoint Manager 门户进行管理，因此云电脑还具有相应的Intune托管设备 ID。

方法

方法 返回类型 说明
列出 cloudPC cloudPC 集合 列出云电脑对象的属性和关系。
获取 cloudPC cloudPC 读取云电脑对象的属性和关系。
获取预配的云电脑 cloudPC 集合 为Microsoft Entra用户组下的用户获取特定服务计划的所有预配云电脑。
更改用户帐户类型 None 更改特定云电脑上用户的帐户类型。
结束宽限期 None 结束云电脑对象的宽限期。
开机 None 打开特定的 Windows Frontline 云电脑对象。 此作支持 MEM 管理方案。
关机 None 关闭特定的 Windows Frontline 云电脑对象。 此作支持 MEM 管理方案。
重新启动 None 重新启动特定的云电脑对象。
Rename None 重命名特定的云电脑对象。 使用此 API 更新云电脑实体的 displayName 。
重新预配 None 重新预配云电脑对象。
Resize None 将现有云电脑升级或降级到具有新虚拟 CPU (vCPU) 和存储大小的配置。
Start None 启动特定的云电脑。 目前，仅支持Windows 365 Frontline云电脑。
Stop None 停止特定云。 目前，仅支持Windows 365 Frontline云电脑。
疑难解答 None 对特定云电脑对象进行故障排除。 使用此 API 检查云电脑和会话主机的运行状况。
还原 None 将云电脑对象从快照还原到以前的状态。
设置评审状态 None 使用云电脑 ID 设置特定云电脑设备的评审状态。
检索评审状态 cloudPcReviewStatus 获取云电脑的 评审状态 。
用户列表 cloudPC 集合 列出已登录用户的云电脑设备。
获取启动信息 cloudPcLaunchInfo 获取特定云电脑的 cloudPCLaunchInfo 。
获取连接历史记录 cloudPcConnectivityEvent 集合 获取云电脑连接历史记录。
获取支持的远程作 cloudPcRemoteActionCapability 集合 获取特定云电脑设备支持的云电脑远程作列表，包括作名称和功能。
检索远程作结果 cloudPcRemoteActionResult 集合 检索远程作结果，并检查在关联的云电脑设备上执行的特定远程作的状态。
重试合作伙伴代理安装 None 对于无法在云电脑上安装的合作伙伴代理，请重试安装。
验证批量调整大小 cloudPcResizeValidateResult 集合 验证一组云电脑设备是否满足批量调整大小的要求。
创建快照 None 为特定的云电脑设备创建快照。
检索快照 cloudPcSnapshot 集合 获取云电脑的 cloudPcSnapshot 资源列表。
获取一线访问状态 frontlineCloudPcAccessState 获取一线云电脑的访问状态。 可取值包括：unassigned、noLicensesAvailable、activationFailed、active、activating、standbyMode、unknownFutureValue。 成员 noLicensesAvailable 已弃用，将于 2024 年 9 月 30 日停止返回。

属性

属性 类型 说明
aadDeviceId String 云电脑Microsoft Entra设备 ID。
allotmentDisplayName String 分配名称将租户许可证划分为较小的批次或组，以帮助限制可用于特定分配的许可证数。 当 provisioningType 为 dedicated时，分配名称为 null。 只读。
connectivityResult cloudPcConnectivityResult 连接运行状况检查云电脑的结果，包括更新的时间戳以及云电脑是否可以连接。
deviceRegionName String 当前预配云电脑的地理区域的名称。 例如 、 westus3eastus2和 southeastasia。 只读。
disasterRecoveryCapability cloudPcDisasterRecoveryCapability 云电脑的灾难恢复状态，包括主要区域、次要区域和功能类型。 默认值为 null ，指示灾难恢复设置已禁用。 若要接收具有 disasterRecoveryCapability 属性的响应， $select 请在 $filter 请求 URL 中通过 disasterRecoveryCapability/{subProperty} 该属性接收响应。 有关详细信息，请参阅 示例 3：列出按灾难恢复功能类型筛选的云电脑。 只读。
diskEncryptionState cloudPcDiskEncryptionState 应用于云电脑的磁盘加密。 可能的值是：notAvailable、notEncrypted、encryptedUsingPlatformManagedKey、encryptedUsingCustomerManagedKey 和 unknownFutureValue。
displayName String 云电脑的显示名称。
frontlineCloudPcAvailability frontlineCloudPcAvailability 一线分配的云电脑的当前可用性。 可能的值：notApplicable、 availablenotAvailable 和 unknownFutureValue。 默认值为 notApplicable。 只读。
gracePeriodEndDateTime DateTimeOffset 宽限期结束并重新预配或取消预配的日期和时间。 仅当状态为 inGracePeriod时才需要 。 时间戳以 ISO 8601 格式和协调世界时 (UTC) 显示。 例如，2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z。
id String 云电脑的唯一标识符。 只读。
imageDisplayName String 云电脑上的 OS 映像的名称。
lastLoginResult cloudPcLoginResult 云电脑的上次登录结果。 例如，{ "time": "2014-01-01T00:00:00Z"}。
lastModifiedDateTime DateTimeOffset 云电脑的上次修改日期和时间。 时间戳类型表示采用 ISO 8601 格式的日期和时间信息，始终采用 UTC 时区。 例如，2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z。
lastRemoteActionResult cloudPcRemoteActionResult 企业云电脑的最后一个远程作结果。 支持的远程作包括：Reboot、、Rename、ReprovisionRestore、Troubleshoot。
managedDeviceId String 云电脑Intune设备 ID。
managedDeviceName String 云电脑Intune设备名称。
onPremisesConnectionName String 在预配云电脑期间应用的 Azure 网络连接。
osVersion cloudPcOperatingSystem 作系统的版本 (作系统) 在云电脑上进行预配。 可取值为：windows10、windows11、unknownFutureValue。
partnerAgentInstallResults cloudPcPartnerAgentInstallResult 集合 每个合作伙伴代理在云电脑上的安装状态的结果。
powerState cloudPcPowerState 云电脑的电源状态。 可能的值包括 running、poweredOff、unknown。 此属性仅支持排班工作云电脑。
productType cloudPcProductType 云电脑的产品类型。 可能的值包括 enterprise、frontline、devBox、powerAutomate、business、unknownFutureValue。 有关 、 frontline和 business的可用服务计划和定价enterprise，请参阅适用于企业的Windows 365。 有关 的 devBox定价信息，请参阅 Microsoft Dev Box 定价。 有关 的可用计划和定价 powerAutomate，请参阅 Power Automate 定价。 默认值为 enterprise。 支持 $filter 和 $select。 有关详细信息，请参阅 示例 4：列出按产品类型筛选的云电脑。 只读。
provisioningPolicyId String 云电脑的预配策略 ID。
provisioningPolicyName String 在预配云电脑期间应用的预配策略。
provisioningType cloudPcProvisioningType 使用此策略预配云电脑时要使用的许可证类型。 可能的值为：dedicated、、shared、unknownFutureValuesharedByUser、sharedByEntraGroup。 Prefer: include-unknown-enum-members使用请求标头从此可演变枚举中获取以下值：sharedByUser、sharedByEntraGroup。 默认值为 dedicated。 警告：该 shared 成员已弃用，将于 2027 年 4 月 30 日停止返回;将来，请使用该 sharedByUser 成员。
servicePlanId String 云电脑的服务计划 ID。
servicePlanName String 云电脑的服务计划名称。
servicePlanType cloudPcServicePlanType 云电脑的服务计划类型。
status cloudPcStatus 云电脑的状态。 可能的值为：、、provisioning、、provisionedpendingProvisionrestoringfailedinGracePeriodprovisionedWithWarningsresizingdeprovisioning、unknownFutureValue、movingRegion、 。 preparingresizePendingLicensemodifyingSingleSignOnnotProvisioned 必须使用Prefer: include-unknown-enum-members请求标头从此可演变枚举中获取以下值：movingRegion、resizePendingLicense、、modifyingSingleSignOnpreparing。
statusDetail cloudPcStatusDetail 指示与云电脑关联的详细状态，包括错误/警告代码、错误/警告消息、additionalInformation。 例如，{ "code": "internalServerError", "message": "There was an error during the Cloud PC upgrade. Please contact support.", "additionalInformation": null }。
connectionSetting cloudPcConnectionSetting 云电脑的连接设置。 可能的值： enableSingleSignOn。 只读。
userAccountType cloudPcUserAccountType 预配的云电脑上用户的帐户类型。 可取值为：standardUser、administrator、unknownFutureValue。
userPrincipalName String 分配给云电脑的用户的用户主体名称 (UPN) 。
statusDetails (已弃用) cloudPcStatusDetails 云电脑状态的详细信息。 例如，{ "code": "internalServerError", "message": "There was an error during the Cloud PC upgrade. Please contact support.", "additionalInformation": null }。 此属性已弃用，并且将不再受支持，自 2024 年 8 月 31 日起生效。 请改用 statusDetail。

cloudPcDiskEncryptionState 值

成员 说明
notAvailable 云电脑未预配或处于加密不可用的状态。
notEncrypted 应对云电脑进行加密，但加密尚未进行 (保留，不应) 进行加密。
encryptedUsingPlatformManagedKey 云电脑使用平台管理的密钥进行加密。 如果未启用客户管理的密钥，则此成员是默认值。
encryptedUsingCustomerManagedKey 云电脑使用客户管理的密钥进行加密。
unknownFutureValue 可演变枚举 sentinel 值。 请勿使用。

cloudPcPowerState 值

成员 说明
运行 云电脑状态正在运行。
poweredOff 云电脑状态已关闭。
unknown 云电脑状态未知。

cloudPcStatus 值

下表列出了 可演变枚举的成员。 必须使用Prefer: include-unknown-enum-members请求标头来获取此可演变枚举中的以下值：movingRegion、resizePendingLicense、、modifyingSingleSignOnpreparing。

成员 说明
notProvisioned 尚未预配云电脑。
供应 云电脑预配正在进行中。
已设置 云电脑已预配，用户可以访问它。
inGracePeriod 云电脑在取消预配前处于一周宽限期。
取消预配 云电脑正在取消预配。
失败 云电脑上的作失败。
provisionedWithWarnings 云电脑已预配，最终用户可以通过一些警告访问它。 用户可以继续使用此云电脑。
调整 云电脑正在调整大小。
pendingProvision 预配在云电脑上挂起。 在这种情况下，宽限期内的云电脑数大于可用许可证总数。
恢复 云电脑正在还原。
unknownFutureValue 可演变枚举 sentinel 值。 请勿使用。
movingRegion 指示云电脑正在从一个区域移动到另一个区域。
resizePendingLicense 指示云电脑大小调整过程已启动，但无法完成，因为尚未确定目标许可证。 它当前正在等待客户采取行动来解决许可问题。
modifyingSingleSignOn 指示云电脑正在更新单一登录设置。
准备 指示云电脑正在准备 IT 管理员定义的配置 (应用程序、配置和安全) ，在预配状态后显示。仅适用于一线共享设备。

frontlineCloudPcAccessState 值

成员 说明
未分配 如果云电脑不使用任何共享使用许可证，则设置为取消分配。 默认值为 unassigned。
noLicensesAvailable (已弃用) 指示所有共享使用许可证都在使用中。 成员 noLicensesAvailable 已弃用，将于 2024 年 9 月 30 日停止返回。
activationFailed 指示在用户请求一线云电脑后，一线云电脑激活失败。
积极 指示一线云电脑处于活动状态，并分配了共享使用许可证，并且用户可以连接到云电脑。
激活 指示请求连接云电脑和服务的用户正在启动。
standbyMode 指示一线云电脑在关闭和解除分配之前处于待机状态。 处于待机状态的一线云电脑仍可供用户访问。
unknownFutureValue 可演变枚举 sentinel 值。 请勿使用。

frontlineCloudPcAvailability 值

成员 说明
notApplicable 默认值。 云电脑不是一线分配的类型。
可用 当前一线云电脑可用，用户能够连接到它。
notAvailable 一线云电脑当前不可用，关联的用户无法连接到它。
unknownFutureValue 可演变枚举 sentinel 值。 请勿使用。

cloudPcProductType 值

成员 说明
企业 默认值。 指示想要在其组织中为无限数量的用户部署云电脑的大型企业的云电脑产品类型。
前线 指示一线和兼职员工共享设备的云电脑产品类型，允许他们在轮班期间使用云电脑。
devBox 指示为开发人员、开发团队和 IT 专业人员预配置的工具、服务和资源的云电脑产品类型。
powerAutomate 指示 Power Automate 客户在其云电脑上运行参与和无人参与的 RPA (机器人流程自动化) 的云电脑产品类型。
商 指示最多 300 名用户的小型企业客户的云电脑产品类型。
unknownFutureValue 可演变枚举 sentinel 值。 请勿使用。

关系

无。

JSON 表示形式

以下 JSON 表示形式显示了资源类型。

{
  "@odata.type": "#microsoft.graph.cloudPC",
  "aadDeviceId": "String",
  "allotmentDisplayName": "String",
  "connectivityResult": "String",
  "deviceRegionName": "String",
  "disasterRecoveryCapability": {"@odata.type": "microsoft.graph.cloudPcDisasterRecoveryCapability"},
  "diskEncryptionState": "String",
  "displayName": "String",
  "gracePeriodEndDateTime": "String (timestamp)",
  "id": "String (identifier)",
  "imageDisplayName": "String",
  "lastLoginResult": "String",
  "lastModifiedDateTime": "String (timestamp)",
  "lastRemoteActionResult": "String",
  "managedDeviceId": "String",
  "managedDeviceName": "String",
  "onPremisesConnectionName": "String",
  "powerState": "String",
  "osVersion": "String",
  "partnerAgentInstallResults": "String",
  "provisioningPolicyId": "String",
  "provisioningPolicyName": "String",
  "provisioningType": "String",
  "servicePlanId": "String",
  "servicePlanName": "String",
  "servicePlanType": "String",
  "status": "String",
  "userAccountType": "String",
  "userPrincipalName": "String"
}