cloudPC resource type

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Represents a cloud-managed virtual desktop. This Cloud PC is also enrolled into Intune and managed through the Microsoft Endpoint Manager portal, so the Cloud PC also has a corresponding Intune managed device ID.

Methods

Method Return type Description
List cloudPCs cloudPC collection List properties and relationships of the cloudPC objects.
Get cloudPC cloudPC Read the properties and relationships of a cloudPC object.
Change user account type None Change the account type of the user on a specific Cloud PC.
End grace period None End the grace period for a cloudPC object.
Get remote action results cloudPcRemoteActionResult Check the Cloud PC-specified remote action results for a Cloud PC device.
Reboot None Reboot a specific cloudPC object.
Rename None Rename a specific cloudPC object. Use this API to update the displayName for the Cloud PC entity.
Reprovision None Reprovision a cloudPC object.
Reprovision remote action None Reprovision a Cloud PC with an Intune managed device ID.
Bulk reprovision remote action None Bulk reprovision a set of Cloud PC devices with Intune managed device IDs.
Resize remote action None Upgrade or downgrade an existing Cloud PC to another configuration with new vCPU and storage size through Intune managed device ID.
Troubleshoot None Troubleshoot a specific cloudPC object. Use this API to check the health status of the Cloud PC and the session host.
Restore None Restore a cloudPC object to a previous state from a snapshot.
Restore remote action None Restore a Cloud PC device to a previous state with an Intune managed device ID.
Bulk restore remote action cloudPcBulkRemoteActionResult Restore multiple Cloud PC devices with a single request that includes the IDs of Intune managed devices and a restore point date and time.
Set review status None Set the review status of a specific Cloud PC device.
Get review status cloudPcReviewStatus Get the review status of a specific Cloud PC device.
Bulk set review status cloudPcBulkRemoteActionResult Set the review status of multiple Cloud PC devices with a single request that includes the IDs of Intune managed devices.
List for user cloudPC collection List the cloudPC devices that are attributed to the signed-in user.
Get launch info for user cloudPCLaunchInfo Get the cloudPCLaunchInfo for the signed-in user.
Get connectivity history cloudPcConnectivityEvent collection Get the Cloud PC connectivity history.

Properties

Property Type Description
aadDeviceId String The Azure Active Directory (Azure AD) device ID of the Cloud PC.
connectivityResult cloudPcConnectivityResult The connectivity health check result of a Cloud PC, including the updated timestamp and whether the Cloud PC is able to be connected or not.
displayName String The display name of the Cloud PC.
gracePeriodEndDateTime DateTimeOffset The date and time when the grace period ends and reprovisioning/deprovisioning happens. Required only if the status is inGracePeriod. The timestamp is shown in ISO 8601 format and Coordinated Universal Time (UTC). For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
id String The unique identifier for the Cloud PC. Read-only.
imageDisplayName String Name of the OS image that's on the Cloud PC.
lastLoginResult cloudPcLoginResult The last login result of the Cloud PC. For example, { "time": "2014-01-01T00:00:00Z"}.
lastModifiedDateTime DateTimeOffset The last modified date and time of the Cloud PC. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
lastRemoteActionResult cloudPcRemoteActionResult The last remote action result of the enterprise Cloud PCs. The supported remote actions are: Reboot, Rename, Reprovision, Restore, and Troubleshoot.
managedDeviceId String The Intune device ID of the Cloud PC.
managedDeviceName String The Intune device name of the Cloud PC.
onPremisesConnectionName String The Azure network connection that is applied during the provisioning of Cloud PCs.
osVersion cloudPcOperatingSystem The version of the operating system (OS) to provision on Cloud PCs. Possible values are: windows10, windows11, and unknownFutureValue.
provisioningPolicyId String The provisioning policy ID of the Cloud PC.
provisioningPolicyName String The provisioning policy that is applied during the provisioning of Cloud PCs.
servicePlanId String The service plan ID of the Cloud PC.
servicePlanName String The service plan name of the Cloud PC.
servicePlanType cloudPcServicePlanType The service plan type of the Cloud PC.
status cloudPcStatus The status of the Cloud PC. Possible values are: notProvisioned, provisioning, provisioned, upgrading, inGracePeriod, deprovisioning, failed, restoring.
statusDetails cloudPcStatusDetails The details of the Cloud PC status.
userAccountType cloudPcUserAccountType The account type of the user on provisioned Cloud PCs. Possible values are: standardUser, administrator, and unknownFutureValue.
userPrincipalName String The user principal name (UPN) of the user assigned to the Cloud PC.

cloudPcStatus values

Member Description
notProvisioned The Cloud PC hasn’t been provisioned.
provisioning Cloud PC provisioning is in progress.
provisioned The Cloud PC is provisioned and can be accessed by end users.
inGracePeriod The Cloud PC is in the one week grace period before it’s deprovisioned.
deprovisioning The Cloud PC is deprovisioning.
failed The operation on Cloud PC has failed.
provisionedWithWarnings The Cloud PC is provisioned and can be accessed by end users but with some warnings. The user can continue to use this Cloud PC.
resizing The Cloud PC is resizing.
pendingProvision The provisioning is pending on the Cloud PC. In this case, the number of Cloud PCs in grace period is more than the number of total available licenses.
restoring The Cloud PC is restoring.
unknownFutureValue Evolvable enumeration sentinel value. Do not use.

Relationships

None.

JSON representation

The following is a JSON representation of the resource.

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