cloudPC: getProvisionedCloudPCs
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.
Get all provisioned Cloud PCs of a specific service plan for users under a Microsoft Entra user group.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ❌ |
Permissions
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | CloudPC.Read.All | CloudPC.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | CloudPC.Read.All | CloudPC.ReadWrite.All |
HTTP request
GET /deviceManagement/virtualEndpoint/cloudPCs/getProvisionedCloudPCs(groupId='{groupId}',servicePlanId='{servicePlanId}')
Optional query parameters
This method supports the $select
OData query parameter to help customize the response. You can use $select
to get specific properties, including those properties that aren't returned by default.
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Request parameter
Parameter | Type | Description |
---|---|---|
groupId | String | The unique identifier for Microsoft Entra user group. |
servicePlanId | String | The unique identifier of the service plan. |
Request body
Don't supply a request body for this method.
Response
If successful, this method returns a 200 OK
response code and a collection of cloudPC objects in the response body.
Examples
Example 1: Get all provisioned Cloud PCs and their default properties
The following example shows how to get all provisioned Cloud PCs and their default properties.
Request
The following example shows a request.
GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/cloudPCs/getProvisionedCloudPCs(groupId='30d0e128-de93-41dc-89ec-33d84bb662a0',servicePlanId='9ecf691d-8b82-46cb-b254-cd061b2c02fb')
Response
The following example shows the response. It includes only the default properties.
Note: The response object shown here might be shortened for readability. All the default properties are returned in an actual call.
HTTP/1.1 200 OK
Content-Type: application/json
{
"value": [
{
"@odata.type": "#microsoft.graph.cloudPC",
"id": "662009bc-7732-4f6f-8726-25883518b33e",
"displayName": "Demo-0",
"imageDisplayName": "Windows-10 19h1-evd",
"aadDeviceId": "f5ff445f-7488-40f8-8ab9-ee784a9c1f33",
"diskEncryptionState": "encryptedUsingCustomerManagedKey",
"managedDeviceId": "bdc8e6dd-0455-4412-83d9-c818664fe1f1",
"managedDeviceName": "CPC-ps1-SHYL-46",
"provisioningPolicyId": "7ed725ad-0a00-4117-b557-d965c3732450",
"servicePlanId": "9ecf691d-8b82-46cb-b254-cd061b2c02fb",
"servicePlanName": "Cloud PC Enterprise 4vCPU/16GB/256GB",
"servicePlanType": "enterprise",
"status": "provisioned",
"userPrincipalName": "pmitchell@contoso.com",
"lastModifiedDateTime": "2020-07-23T10:29:57Z",
"statusDetails": null,
"provisioningType": "dedicated",
"allotmentDisplayName": null,
"deviceRegionName": "eastus2",
"gracePeriodEndDateTime": null,
"onPremisesConnectionName": "Test-OPNC",
"partnerAgentInstallResults": null,
"provisioningPolicyName": "Test-Policy"
},
{
"@odata.type": "#microsoft.graph.cloudPC",
"id": "ac74ae8b-85f7-4272-88cc-5419267403ed",
"displayName": "Demo-1",
"imageDisplayName": "Custom image name",
"aadDeviceId": "61289490-ef06-4962-8f49-455329c8893c",
"diskEncryptionState": "encryptedUsingCustomerManagedKey",
"managedDeviceId": "e87f50c7-fa7f-4687-aade-dd45f3d65970",
"managedDeviceName": "CPC-ps2-7ERZ-QE",
"provisioningPolicyId": "13fa0778-ba00-438a-96d3-488c86029dff",
"servicePlanId": "9ecf691d-8b82-46cb-b254-cd061b2c02fb",
"servicePlanName": "Cloud PC Enterprise 4vCPU/16GB/256GB",
"servicePlanType": "enterprise",
"status": "provisioned",
"userPrincipalName": "pmitchell@contoso.com",
"lastModifiedDateTime": "2020-07-28T18:14:34Z",
"statusDetails": null,
"provisioningType": "dedicated",
"allotmentDisplayName": null,
"deviceRegionName": "eastus2",
"gracePeriodEndDateTime": null,
"onPremisesConnectionName": "Test-OPNC",
"partnerAgentInstallResults": null,
"provisioningPolicyName": "Test-Policy"
}
]
}
Example 2: Get all provisioned Cloud PCs and specific properties
The following example shows how to get all provisioned Cloud PCs and use $select
to get specific properties, including those properties that aren't returned by default.
Request
The following example shows a request.
GET https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/cloudPCs/getProvisionedCloudPCs(groupId='30d0e128-de93-41dc-89ec-33d84bb662a0',servicePlanId='9ecf691d-8b82-46cb-b254-cd061b2c02fb')?$select=id,displayName,powerState,connectivityResult,lastLoginResult,lastRemoteActionResult,osVersion,provisioningPolicyName,userAccountType
Response
The following example shows the response.
HTTP/1.1 200 OK
Content-Type: application/json
{
"value": [
{
"@odata.type": "#microsoft.graph.cloudPC",
"id": "662009bc-7732-4f6f-8726-25883518b33e",
"displayName": "Demo-0",
"powerState": "running",
"connectivityResult": "",
"lastLoginResult": "2020-07-23T10:29:57Z",
"lastRemoteActionResult": "Succeed",
"osVersion": null,
"provisioningPolicyName": "Test-Policy",
"userAccountType": null
},
{
"@odata.type": "#microsoft.graph.cloudPC",
"id": "ac74ae8b-85f7-4272-88cc-5419267403ed",
"displayName": "Demo-1",
"powerState": "running",
"connectivityResult": "",
"lastLoginResult": "2020-07-23T10:29:57Z",
"lastRemoteActionResult": "Succeed",
"osVersion": null,
"provisioningPolicyName": "Test-Policy",
"userAccountType": null
}
]
}