命名空间:microsoft.graph
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
表示云托管的虚拟桌面。 此云电脑也已在 Intune 中注册并通过 Microsoft Endpoint Manager 门户进行管理,因此云电脑也具有相应的 Intune 托管设备 ID。
方法
属性
| 属性 |
类型 |
说明 |
| aadDeviceId |
String |
云电脑的 Microsoft Entra 设备 ID。 |
| allotmentDisplayName |
String |
分配名称将租户许可证划分为较小的批或组,以帮助限制可用于特定分配的许可证数量。 当 provisioningType 为 dedicated时,分配名称为 null。 只读。 |
| connectivityResult |
cloudPcConnectivityResult |
云电脑的连接运行状况检查结果,包括更新的时间戳以及是否可以连接云电脑。 |
| connectionSetting |
cloudPcConnectionSetting |
云电脑的连接设置。 可能值: enableSingleSignOn. 只读。 |
| deviceRegionName |
String |
当前预配了云电脑的地理区域的名称。 例如, westus3、 eastus2和 southeastasia。 只读。 |
| disasterRecoveryCapability |
cloudPcDisasterRecoveryCapability |
云电脑的灾难恢复状态,包括主要区域、次要区域和功能类型。 默认值指示 null 灾难恢复设置处于禁用状态。 以使用 disasterRecoveryCapability 属性接收响应, $select$filter 并在请求 URL 中通过 disasterRecoveryCapability/{subProperty} 。 有关详细信息,请参阅 示例 3:列出按灾难恢复功能类型筛选的云电脑。 只读。 |
| diskEncryptionState |
cloudPcDiskEncryptionState |
应用于云电脑的磁盘加密。 可能的值是:notAvailable、notEncrypted、encryptedUsingPlatformManagedKey、encryptedUsingCustomerManagedKey 和 unknownFutureValue。 |
| displayName |
String |
云电脑的显示名称。 |
| gracePeriodEndDateTime |
DateTimeOffset |
宽限期结束以及重新预配或取消预配的日期和时间。 仅当状态为 inGracePeriod时才需要 时间戳以 ISO 8601 格式和协调世界时 (UTC) 显示。 例如,2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z。 |
| groupDetail |
cloudPcEntraGroupDetail |
Microsoft Entra组详细信息 (例如,与用户的保留云电脑分配关联的 Entra ID 组的 ID 和显示名称) 。 只读。 |
| id |
String |
云电脑的唯一标识符。 只读。 |
| imageDisplayName |
String |
云电脑上的操作系统映像的名称。 |
| isDisasterRecoveryActive |
布尔值 |
指示发生故障转移事件后,云电脑当前是否在其灾难恢复区域中运行。
true 如果云电脑当前正在其灾难恢复区域中运行;否则为 false. 只读。 |
| lastLoginResult |
cloudPcLoginResult |
云电脑的上次登录结果。 例如,{ "time": "2014-01-01T00:00:00Z"}。 |
| lastLogoffDateTime |
DateTimeOffset |
用户上次注销云电脑会话的日期和时间。 如果用户从未建立会话或会话当前处于活动状态,则返回 null 。 时间戳以 ISO 8601 格式显示,并且始终采用 UTC 格式。 例如,2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z。 只读。 仅当使用 $select显式选择时返回。 |
| 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 |
要在云电脑上预配的操作系统 (OS) 的版本。 可能的值包括 windows10、windows11、unknownFutureValue。 |
| partnerAgentInstallResults |
cloudPcPartnerAgentInstallResult 集合 |
每个合作伙伴代理在云电脑上的安装状态的结果。 |
| powerState |
cloudPcPowerState |
云电脑的电源状态。 可能的值包括 running、poweredOff、unknown。 此属性仅支持排班工作云电脑。 |
| productType |
cloudPcProductType |
云电脑的产品类型。 可能的值包括 enterprise、frontline、devBox、powerAutomate、business、unknownFutureValue。 有关 、 和 frontlinebusiness的enterprise可用服务计划和定价,请参阅 Windows 365 商业版。 有关定价信息 devBox,请参阅 Microsoft Dev Box 定价。 有关可用计划和定价 powerAutomate,请参阅 Power Automate 定价。 默认值为 enterprise。 支持 $filter 和 $select。 有关详细信息,请参阅 示例 4:列出按产品类型筛选的云电脑。 只读。 |
| provisionedDateTime |
DateTimeOffset |
最新预配日期和时间,在云电脑的初始预配或任何后续重新预配期间自动生成和分配。 时间戳类型使用 ISO 8601 格式表示日期和时间信息,并且始终采用 UTC 格式。 例如,2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z。 |
| provisioningConfiguration |
cloudPcProvisioningConfiguration |
云电脑的策略派生配置。 包含从预配策略继承的属性,这些属性是在最近一次预配或重新预配期间应用的。 仅当使用 $select显式选择时返回。 只读。 |
| provisioningPolicyId |
String |
云电脑的预配策略 ID。 |
| provisioningPolicyName |
String |
在预配云电脑期间应用的预配策略。 |
| provisioningType |
cloudPcProvisioningType |
使用此策略预配云电脑时要使用的许可证类型。 可能的值包括 dedicated、shared、unknownFutureValue、sharedByUser、sharedByEntraGroup、reserve。 使用Prefer: include-unknown-enum-members请求标头从这个可进化的枚举中获取以下值: sharedByUser, , sharedByEntraGroupreserve. 默认值为 dedicated。 该 shared 成员已弃用,并将于 2027 年 4 月 30 日停止返回;今后,请使用该 sharedByUser 成员。 |
| scopeIds |
字符串集合 |
相应权限的范围 ID。 目前,它是 Intune 范围标记 ID。 只读。 |
| servicePlanId |
String |
云电脑的服务计划 ID。 |
| servicePlanName |
String |
云电脑的服务计划名称。 |
| servicePlanType |
cloudPcServicePlanType |
云电脑的服务计划类型。 |
| sharedDeviceDetail |
cloudPcFrontlineSharedDeviceDetail |
指示与一线共享服务计划关联的云电脑设备详细信息,包括用户的 UPN 以及会话开始日期和时间。 |
| status |
cloudPcStatus |
云电脑的状态。 可能的值为:notProvisioned、、provisioning、 provisionedinGracePerioddeprovisioningfailedprovisionedWithWarningsresizingrestoringpendingProvisionunknownFutureValuemovingRegionresizePendingLicensemodifyingSingleSignOnrefreshPolicyConfigurationpreparingfailoverInProgressfailbackInProgress 使用Prefer: include-unknown-enum-members请求标头从这个可进化的枚举中获取以下值: movingRegion, , resizePendingLicense, failoverInProgressmodifyingSingleSignOnpreparingrefreshPolicyConfigurationfailbackInProgress. |
| statusDetail |
cloudPcStatusDetail |
指示与云电脑关联的详细状态,包括错误/警告代码、错误/警告消息、additionalInformation。 例如,{ "code": "internalServerError", "message": "There was an error during the Cloud PC upgrade. Please contact support.", "additionalInformation": null }。 |
| userAccountType |
cloudPcUserAccountType |
预配的云电脑上用户的帐户类型。 可能的值包括 standardUser、administrator、unknownFutureValue。 |
| userExperienceType |
cloudPcUserExperienceType |
指定最终用户可以访问的云对象的类型。 可能的值包括 cloudPc、cloudApp、unknownFutureValue。 设置为 cloudPc时,表示最终用户可以访问整个桌面。 设置为 cloudApp时,表示最终用户只能访问在关联的预配策略下发布的云应用。 由于云应用体验还会创建出现在云电脑设备列表中的云电脑设备,因此此属性有助于区分它们。 默认值为 cloudPc。 此属性在预配策略中定义。 |
| userDetail |
cloudPcEntraUserDetail |
用户详细信息 (例如,与保留云电脑分配关联的用户的 ID 和显示名称) 。 只读。 |
| userPrincipalName |
String |
分配给云电脑的用户主体名称 (UPN) 。 |
| connectionSettings (已弃用) |
cloudPcConnectionSettings |
云电脑的连接设置。 可能值: enableSingleSignOn. 只读。 此属性已弃用,已于 2024 年 8 月 31 日停止重新调整数据。 接下来,使用 connectionSetting 属性。 |
| frontlineCloudPcAvailability (已弃用) |
frontlineCloudPcAvailability |
一线分配的云电脑的当前可用性。 可能的值:notApplicable、、 availablenotAvailable和 unknownFutureValue。 默认值为 notApplicable。 只读。 此属性已弃用,并将于 2025 年 10 月 30 日停止返回数据。 接下来,使用 retrieveFrontlineCloudPcDetail API。 |
| 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 |
可进化枚举哨兵值。 请勿使用。 |
cloudPcPowerState 值
| 成员 |
说明 |
| running |
云电脑状态为“运行”。 |
| poweredOff |
云电脑状态为已关闭电源。 |
| unknown |
云电脑状态未知。 |
cloudPcStatus 值
| 成员 |
说明 |
| 未预配 |
尚未预配云电脑。 |
| 预配 |
云电脑预配正在进行中。 |
| 已设置 |
云电脑已预配,用户可以访问它。 |
| inGracePeriod |
云电脑处于取消预配前的一周宽限期内。 |
| 取消预配 |
云电脑正在取消预配。 |
| 失败 |
云电脑上的操作失败。 |
| provisionedWithWarnings |
云电脑已预配,最终用户可以访问它,但出现一些警告。 用户可以继续使用此云电脑。 |
| 调整大小 |
云电脑正在调整大小。 |
| 还原 |
云电脑正在还原。 |
| pendingProvision |
预配在云电脑上处于挂起状态。 在这种情况下,宽限期内的云电脑数多于可用许可证总数。 |
| unknownFutureValue |
可进化枚举哨兵值。 请勿使用。 |
| movingRegion |
指示正在将云电脑从一个区域移动到另一个区域。 |
| resizePendingLicense |
指示云电脑大小调整过程已启动,但无法完成,因为尚未识别目标许可证。 目前正在等待客户采取行动来解决许可问题。 |
| modifyingSingleSignOn |
指示云电脑正在更新单一登录设置。 |
| refreshPolicyConfiguration |
指示云电脑正在刷新新的策略配置。 |
| 正在准备 |
指示云电脑正在准备 IT 管理员定义的配置 (应用程序、配置和安全) 出现在预配状态后。仅适用于一线共享设备。 |
| failoverInProgress |
指示正在为云电脑进行到灾难恢复区域的故障转移。 |
| failbackInProgress |
指示云电脑正在故障回复到主要区域。 |
frontlineCloudPcAccessState 值
| 成员 |
说明 |
| 未分配 |
如果云电脑不使用任何共享使用许可证,则设置为“未分配”。 默认值为 unassigned。 |
| noLicensesAvailable (已弃用) |
指示正在使用所有共享使用的许可证。 该 noLicensesAvailable 成员已弃用,并将于 2024 年 9 月 30 日停止返回。 |
| activationFailed |
指示在用户请求一线云电脑后,一线云电脑激活失败。 |
| 活动 |
指示一线云电脑处于活动状态,分配了共享使用许可证,且用户可以连接到云电脑。 |
| 激活 |
指示用户请求连接云电脑,并且服务正在启动。 |
| standbyMode |
指示一线云电脑在关闭和取消分配之前处于待机状态。 用户仍可以访问处于待机状态的一线云电脑。 |
| unknownFutureValue |
可进化枚举哨兵值。 请勿使用。 |
cloudPcProductType 值
| 成员 |
说明 |
| 企业版 |
默认值。 指示想要在整个组织中为无限数量的用户部署云电脑的大型企业的云电脑产品类型。 |
| 一线 |
指示供一线和兼职工作人员共享设备的云电脑产品类型,使他们能够在轮班期间使用云电脑。 |
| devBox |
指示为开发人员、开发团队和 IT 专业人员预配置了工具、服务和资源的云电脑产品类型。 |
| powerAutomate |
指示 Power Automate 客户在其云电脑上运行有人参与和无人参与 RPA (机器人流程自动化) 的云电脑产品类型。 |
| 商业版 |
指示面向最多拥有 300 个用户的小型企业客户的云电脑产品类型。 |
| unknownFutureValue |
可进化枚举哨兵值。 请勿使用。 |
关系
无。
JSON 表示形式
以下 JSON 表示形式显示资源类型。
{
"@odata.type": "#microsoft.graph.cloudPC",
"aadDeviceId": "String",
"allotmentDisplayName": "String",
"connectivityResult": {"@odata.type": "microsoft.graph.cloudPcConnectivityResult"},
"connectionSetting": {"@odata.type": "microsoft.graph.cloudPcConnectionSetting"},
"connectionSettings": {"@odata.type": "microsoft.graph.cloudPcConnectionSettings"},
"deviceRegionName": "String",
"disasterRecoveryCapability": {"@odata.type": "microsoft.graph.cloudPcDisasterRecoveryCapability"},
"diskEncryptionState": "String",
"displayName": "String",
"gracePeriodEndDateTime": "String (timestamp)",
"groupDetail": {"@odata.type": "microsoft.graph.cloudPcEntraGroupDetail"},
"id": "String (identifier)",
"imageDisplayName": "String",
"isDisasterRecoveryActive": "Boolean",
"lastLoginResult": "String",
"lastLoginResult": {"@odata.type": "microsoft.graph.cloudPcLoginResult"},
"lastLogoffDateTime": "String (timestamp)",
"lastModifiedDateTime": "String (timestamp)",
"lastRemoteActionResult": {"@odata.type": "microsoft.graph.cloudPcRemoteActionResult"},
"managedDeviceId": "String",
"managedDeviceName": "String",
"onPremisesConnectionName": "String",
"osVersion": "String",
"partnerAgentInstallResults": [{"@odata.type": "microsoft.graph.cloudPcPartnerAgentInstallResult"}],
"powerState": "String",
"productType": "String",
"provisionedDateTime": "String (timestamp)",
"provisioningConfiguration": {"@odata.type": "microsoft.graph.cloudPcProvisioningConfiguration"},
"provisioningPolicyId": "String",
"provisioningPolicyName": "String",
"provisioningType": "String",
"servicePlanId": "String",
"servicePlanName": "String",
"servicePlanType": "String",
"scopeIds": ["String"],
"sharedDeviceDetail": {"@odata.type": "microsoft.graph.cloudPcFrontlineSharedDeviceDetail"},
"status": "String",
"statusDetail": {"@odata.type": "microsoft.graph.cloudPcStatusDetail"},
"userAccountType": "String",
"userExperienceType": "String",
"userDetail": {"@odata.type": "microsoft.graph.cloudPcEntraUserDetail"},
"userPrincipalName": "String"
}