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. |
| Get shift work access state | shiftWorkCloudPcAccessState | Get the access state of the shift work Cloud PC. The possible values are: {unassigned, noLicensesAvailable, activationFailed, active, activating, waitlisted, unknownFutureValue, hibernated}. Note that you must use the Prefer: include-unknown-enum-members request header to get the following value in this shiftWorkCloudPcAccessState: {hibernated}. |
| Get supported remote actions | cloudPcRemoteActionCapability collection | Get a list of supported Cloud PC remote actions for a specific Cloud PC device, including the action names and capabilities. |
| Retry partner agent installation | None | Retry installation for the partner agents which failed to install on the cloudPC. |
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 can be connected. |
| diskEncryptionState | cloudPcDiskEncryptionState | The disk encryption applied to the Cloud PC. Possible values: notAvailable, notEncrypted, encryptedUsingPlatformManagedKey, encryptedUsingCustomerManagedKey, and unknownFutureValue. |
| 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. |
| partnerAgentInstallResults | cloudPcPartnerAgentInstallResult collection | The results of every partner agent's installation status on Cloud PC. |
| provisioningPolicyId | String | The provisioning policy ID of the Cloud PC. |
| provisioningPolicyName | String | The provisioning policy that is applied during the provisioning of Cloud PCs. |
| provisioningType | cloudPcProvisioningType | The type of licenses to be used when provisioning Cloud PCs using this policy. Possible values are: dedicated, shared, unknownFutureValue. Default value is dedicated. |
| 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. |
cloudPcDiskEncryptionState values
| Member | Description |
|---|---|
| notAvailable | The Cloud PC is not provisioned, or is in a state where encryption is not available. |
| notEncrypted | The Cloud PC should be encrypted, but the encryption is not done yet (reserved, should not happen). |
| encryptedUsingPlatformManagedKey | The Cloud PC is encrypted using a platform managed key. This is the default value if the customer-managed key is not enabled. |
| encryptedUsingCustomerManagedKey | The Cloud PC is encrypted using the customer-managed key. |
| unknownFutureValue | Evolvable enumeration sentinel value. Do not use. |
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. |
shiftWorkCloudPcAccessState values
The following table lists the members of an evolvable enumeration. You must use the Prefer: include-unknown-enum-members request header to get the following values in this evolvable enum: hibernated.
| Member | Description |
|---|---|
| unassigned | Set to unassigned if the Cloud PC is not consuming any shared-use licenses. The default value is unassigned. |
| noLicensesAvailable | Indicates that all shared-use licenses are in use. |
| activationFailed | Indicates that the shift work Cloud PC activation failed after the user requested a shift work Cloud PC. |
| active | Indicates that the shift work Cloud PC is in an active state with a shared-use license assigned, and the user can connect to the Cloud PC. |
| activating | Indicates that a user requested to connect the Cloud PC and the service is starting. |
| waitlisted (deprecated) | Indicates that the shift work Cloud PC is in waitlisted state after the user requests to connect this Cloud PC and all shared use licenses are being actively used. This value is deprecated and will stop returning on May 17, 2023. |
| unknownFutureValue | Evolvable enumeration sentinel value. Do not use. |
| hibernated | Indicates that the shift work Cloud PC is in the hibernated state before it's shut down and deallocated. A shift work Cloud PC in hibernated state is still accessible by the user. |
Relationships
None.
JSON representation
The following is a JSON representation of the resource.
{
"@odata.type": "#microsoft.graph.cloudPC",
"aadDeviceId": "String",
"connectivityResult": "String",
"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",
"osVersion": "String",
"partnerAgentInstallResults": "String",
"provisioningPolicyId": "String",
"provisioningPolicyName": "String",
"provisioningType": "String",
"servicePlanId": "String",
"servicePlanName": "String",
"servicePlanType": "String",
"status": "String",
"userAccountType": "String",
"userPrincipalName": "String"
}
Feedback
Submit and view feedback for