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 in 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 Cloud PC objects. |
| Get cloudPC | cloudPC | Read the properties and relationships of a Cloud PC object. |
| Get provisioned Cloud PCs | cloudPC collection | Get all provisioned Cloud PCs of a specific service plan for users under a Microsoft Entra user group. |
| 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 Cloud PC object. |
| Power on | None | Power on a specific Windows Frontline Cloud PC object. This action supports MEM admin scenarios. |
| Power off | None | Power off a specific Windows Frontline Cloud PC object. This action supports MEM admin scenarios. |
| Reboot | None | Reboot a specific Cloud PC object. |
| Rename | None | Rename a specific Cloud PC object. Use this API to update the displayName for the Cloud PC entity. |
| Reprovision | None | Reprovision a Cloud PC object. |
| Resize | None | Upgrade or downgrade an existing Cloud PC to a configuration with a new virtual CPU (vCPU) and storage size. |
| Start | None | Start a specific Cloud PC for a user. Currently, only Windows 365 Frontline Cloud PCs are supported. |
| Stop | None | Stop a specific Cloud PC for a user. Currently, only Windows 365 Frontline Cloud PCs are supported. |
| Troubleshoot | None | Troubleshoot a specific Cloud PC object. Use this API to check the health status of the Cloud PC and the session host. |
| Restore | None | Restore a Cloud PC object to a previous state from a snapshot. |
| Set review status | None | Set the review status of a specific Cloud PC device using the Cloud PC ID. |
| Retrieve review status | cloudPcReviewStatus | Get the review status of a Cloud PC. |
| List for user | cloudPC collection | List the Cloud PC 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 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. |
| Retrieve remote action results | cloudPcRemoteActionResult collection | Retrieve remote action results and check the status of a specific remote action performed on the associated Cloud PC device. |
| Retry partner agent installation | None | Retry installation for the partner agents that failed to install on the Cloud PC. |
| Validate bulk resize | cloudPcResizeValidateResult collection | Validate that a set of Cloud PC devices meet the requirements to be bulk resized. |
| Create snapshot | None | Create a snapshot for a specific Cloud PC device. |
| Retrieve snapshots | cloudPcSnapshot collection | Get a list of cloudPcSnapshot resources for a Cloud PC. |
| Get frontline access state | frontlineCloudPcAccessState | Get the access state of the frontline Cloud PC. The possible values are: unassigned, noLicensesAvailable, activationFailed, active, activating, standbyMode, unknownFutureValue. The noLicensesAvailable member is deprecated and will stop returning on September 30, 2024. |
| Bulk reprovision remote action (deprecated) | None | Bulk reprovision a set of Cloud PC devices with Intune managed device IDs. This API is deprecated and stopped returning data on September 24, 2023. Going forward, use the cloudPcBulkReprovision resource. |
| Bulk resize (deprecated) | cloudPcRemoteActionResult collection | Perform a bulk resize action to resize a group of Cloud PCs that have successfully passed validation (cloudPC: validateBulkResize). If any devices can't be resized, they're labeled as "resize failed", while the remaining devices are provisioned for the resize process. This API is deprecated and stopped returning data on September 24, 2023. Going forward, use the cloudPcBulkResize resource. |
| Bulk restore remote action (deprecated) | 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. This API is deprecated and stopped returning data on September 24, 2023. Going forward, use the cloudPcBulkRestore resource. |
| Get remote action results (deprecated) | cloudPcRemoteActionResult | Check the Cloud PC-specified remote action results for a Cloud PC device. This API is deprecated and will stop returning data on September 30, 2024. Going forward, use the retrieveCloudPcRemoteActionResults API. |
| Get review status (deprecated) | cloudPcReviewStatus | Get the review status of a specific Cloud PC device by managedDeviceId. This API is deprecated and stopped returning data on April 30, 2024. Going forward, use the cloudPC: retrieveReviewStatus API. |
| Set review status (deprecated) | None | Set the review status of a specific Cloud PC device using the managed device ID. This API is deprecated and stopped returning data on April 30, 2024. Going forward, use the cloudPC: setReviewStatus API. |
| Bulk set review status (deprecated) | None | Set the review status of multiple Cloud PC devices with a single request that includes the IDs of Intune managed devices. This API is deprecated and stopped returning data on September 30, 2024. Going forward, use the cloudPcBulkSetReviewStatus resource. |
Properties
| Property | Type | Description |
|---|---|---|
| aadDeviceId | String | The Microsoft Entra device ID of the Cloud PC. |
| allotmentDisplayName | String | The allotment name divides tenant licenses into smaller batches or groups that help restrict the number of licenses available for use in a specific assignment. When the provisioningType is dedicated, the allotment name is null. Read-only. |
| connectivityResult | cloudPcConnectivityResult | The connectivity health check result of a Cloud PC, including the updated timestamp and whether the Cloud PC can be connected. |
| deviceRegionName | String | The name of the geographical region where the Cloud PC is currently provisioned. For example, westus3, eastus2, and southeastasia. Read-only. |
| disasterRecoveryCapability | cloudPcDisasterRecoveryCapability | The disaster recovery status of the Cloud PC, including the primary region, secondary region, and capability type. The default value is null that indicates that the disaster recovery setting is disabled. To receive a response with the disasterRecoveryCapability property, $select and $filter it by disasterRecoveryCapability/{subProperty} in the request URL. For more information, see Example 4: List Cloud PCs filtered by disaster recovery capability type. Read-only. |
| 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 or 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, 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, unknownFutureValue. |
| partnerAgentInstallResults | cloudPcPartnerAgentInstallResult collection | The results of every partner agent's installation status on Cloud PC. |
| powerState | cloudPcPowerState | The power state of a Cloud PC. The possible values are: running, poweredOff, unknown. This property only supports shift work Cloud PCs. |
| 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,sharedByUser, sharedByEntraGroup. You must use the Prefer: include-unknown-enum-members request header to get the following values from this evolvable enum: sharedByUser, sharedByEntraGroup. The default value is dedicated. CAUTION: The shared member is deprecated and will stop returning on April 30, 2027； in the future, use the sharedByUser member. |
| 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 | microsoft.graph.cloudPcStatus | The status of the Cloud PC. Possible values are: notProvisioned, provisioning, provisioned, inGracePeriod, deprovisioning, failed, provisionedWithWarnings, resizing, restoring, pendingProvision, unknownFutureValue, movingRegion, resizePendingLicense, modifyingSingleSignOn, preparing. You must use the Prefer: include-unknown-enum-members request header to get the following values from this evolvable enum: movingRegion, resizePendingLicense, modifyingSingleSignOn, preparing. |
| statusDetails (deprecated) | cloudPcStatusDetails | The details of the Cloud PC status. For example, { "code": "internalServerError", "message": "There was an error during the Cloud PC upgrade. Please contact support.", "additionalInformation": null }. This property is deprecated and will no longer be supported effective August 31, 2024. Use statusDetail instead. |
| statusDetail | cloudPcStatusDetail | Indicates the detailed status associated with Cloud PC, including error/warning code, error/warning message, additionalInformation. For example, { "code": "internalServerError", "message": "There was an error during the Cloud PC upgrade. Please contact support.", "additionalInformation": null }. |
| connectionSetting | cloudPcConnectionSetting | The connection setting of the Cloud PC. Possible values: enableSingleSignOn. Read Only. |
| userAccountType | cloudPcUserAccountType | The account type of the user on provisioned Cloud PCs. Possible values are: standardUser, administrator, unknownFutureValue. |
| userPrincipalName | String | The user principal name (UPN) of the user assigned to the Cloud PC. |
cloudPcDiskEncryptionState values
| Member | Description |
|---|---|
| notAvailable | The Cloud PC isn't provisioned or is in a state where encryption isn't available. |
| notEncrypted | The Cloud PC should be encrypted, but the encryption isn't done so yet (reserved, shouldn't happen). |
| encryptedUsingPlatformManagedKey | The Cloud PC is encrypted using a platform-managed key. This member is the default value if the customer-managed key isn't enabled. |
| encryptedUsingCustomerManagedKey | The Cloud PC is encrypted using the customer-managed key. |
| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. |
cloudPcPowerState values
| Member | Description |
|---|---|
| running | The Cloud PC status is running. |
| poweredOff | The Cloud PC status is powered off. |
| unknown | The Cloud PC status is unknown. |
cloudPcStatus values
The following table lists the members of an evolvable enumeration. Note that you must use the Prefer: include-unknown-enum-members request header to get the following values in this evolvable enum: movingRegion, resizePendingLicense, modifyingSingleSignOn, preparing.
| Member | Description |
|---|---|
| notProvisioned | The Cloud PC hasn't been provisioned yet. |
| provisioning | Cloud PC provisioning is in progress. |
| provisioned | The Cloud PC is provisioned and users can access it. |
| inGracePeriod | The Cloud PC is in the one-week grace period before deprovision. |
| deprovisioning | The Cloud PC is deprovisioning. |
| failed | The operation on Cloud PC failed. |
| provisionedWithWarnings | The Cloud PC is provisioned and end users can access it 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 the grace period is more than the number of total available licenses. |
| restoring | The Cloud PC is restoring. |
| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. |
| movingRegion | Indicates that the Cloud PC is being moved from one region to another. |
| resizePendingLicense | Indicates that the Cloud PC resize process was initiated but can't be completed because the target license hasn't been identified. It's currently awaiting customer action to resolve the licensing issue. |
| modifyingSingleSignOn | Indicates that the Cloud PC is updating the single sign on setting. |
| preparing | Indicates that the Cloud PC is preparing with IT admin defined configuration (Applications, Configuration and Security), appears after provisioning status. Only apply to Frontline Shared devices. |
frontlineCloudPcAccessState values
| Member | Description |
|---|---|
| unassigned | Set to unassigned if the Cloud PC doesn't consume any shared-use licenses. The default value is unassigned. |
| noLicensesAvailable (deprecated) | Indicates that all shared-use licenses are in use. The noLicensesAvailable member is deprecated and will stop returning on September 30, 2024. |
| activationFailed | Indicates that the frontline Cloud PC activation failed after the user requested a frontline Cloud PC. |
| active | Indicates that the frontline 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. |
| standbyMode | Indicates that the frontline Cloud PC is in a standby state before it's shut down and deallocated. A frontline Cloud PC in a standby state is still accessible by the user. |
| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. |
Relationships
None.
JSON representation
The following JSON representation shows the resource type.
{
"@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"
}