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.
Create a new cloudPcPoolAssignment for a cloudPcPool.
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.ReadWrite.All |
Not available. |
| Delegated (personal Microsoft account) |
Not supported. |
Not supported. |
| Application |
CloudPC.ReadWrite.All |
Not available. |
HTTP request
POST /deviceManagement/virtualEndpoint/cloudPcPools/{cloudPcPool-id}/assignments
Request body
In the request body, supply a JSON representation of a cloudPcPoolAssignment object. Use #microsoft.graph.cloudPcAgentPoolUserAssignment as the @odata.type.
The following table lists the properties that are required when you create a cloudPcPoolAssignment.
| Property |
Type |
Description |
| @odata.type |
String |
Required. The type of assignment. Use #microsoft.graph.cloudPcAgentPoolUserAssignment. |
| userPrincipalId |
String |
Required. The unique identifier of the user principal. |
Response
If successful, this method returns a 201 Created response code and a cloudPcPoolAssignment object in the response body.
Examples
Request
The following example shows a request.
POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/cloudPcPools/a1b2c3d4-e5f6-7890-abcd-ef1234567890/assignments
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.cloudPcAgentPoolUserAssignment",
"userPrincipalId": "f6a7b8c9-d0e1-2345-f678-901234567890"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models;
var requestBody = new CloudPcAgentPoolUserAssignment
{
OdataType = "#microsoft.graph.cloudPcAgentPoolUserAssignment",
UserPrincipalId = "f6a7b8c9-d0e1-2345-f678-901234567890",
};
// To initialize your graphClient, see https://dotnet.territoriali.olinfo.it/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.DeviceManagement.VirtualEndpoint.CloudPcPools["{cloudPcPool-id}"].Assignments.PostAsync(requestBody);
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
//other-imports
)
requestBody := graphmodels.NewCloudPcPoolAssignment()
userPrincipalId := "f6a7b8c9-d0e1-2345-f678-901234567890"
requestBody.SetUserPrincipalId(&userPrincipalId)
// To initialize your graphClient, see https://dotnet.territoriali.olinfo.it/en-us/graph/sdks/create-client?from=snippets&tabs=go
assignments, err := graphClient.DeviceManagement().VirtualEndpoint().CloudPcPools().ByCloudPcPoolId("cloudPcPool-id").Assignments().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
CloudPcAgentPoolUserAssignment cloudPcPoolAssignment = new CloudPcAgentPoolUserAssignment();
cloudPcPoolAssignment.setOdataType("#microsoft.graph.cloudPcAgentPoolUserAssignment");
cloudPcPoolAssignment.setUserPrincipalId("f6a7b8c9-d0e1-2345-f678-901234567890");
CloudPcPoolAssignment result = graphClient.deviceManagement().virtualEndpoint().cloudPcPools().byCloudPcPoolId("{cloudPcPool-id}").assignments().post(cloudPcPoolAssignment);
const options = {
authProvider,
};
const client = Client.init(options);
const cloudPcPoolAssignment = {
'@odata.type': '#microsoft.graph.cloudPcAgentPoolUserAssignment',
userPrincipalId: 'f6a7b8c9-d0e1-2345-f678-901234567890'
};
await client.api('/deviceManagement/virtualEndpoint/cloudPcPools/a1b2c3d4-e5f6-7890-abcd-ef1234567890/assignments')
.version('beta')
.post(cloudPcPoolAssignment);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\CloudPcAgentPoolUserAssignment;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new CloudPcAgentPoolUserAssignment();
$requestBody->setOdataType('#microsoft.graph.cloudPcAgentPoolUserAssignment');
$requestBody->setUserPrincipalId('f6a7b8c9-d0e1-2345-f678-901234567890');
$result = $graphServiceClient->deviceManagement()->virtualEndpoint()->cloudPcPools()->byCloudPcPoolId('cloudPcPool-id')->assignments()->post($requestBody)->wait();
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.cloud_pc_agent_pool_user_assignment import CloudPcAgentPoolUserAssignment
# To initialize your graph_client, see https://dotnet.territoriali.olinfo.it/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = CloudPcAgentPoolUserAssignment(
odata_type = "#microsoft.graph.cloudPcAgentPoolUserAssignment",
user_principal_id = "f6a7b8c9-d0e1-2345-f678-901234567890",
)
result = await graph_client.device_management.virtual_endpoint.cloud_pc_pools.by_cloud_pc_pool_id('cloudPcPool-id').assignments.post(request_body)
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 201 Created
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.cloudPcAgentPoolUserAssignment",
"id": "cloudPcPoolAssignmentId",
"userPrincipalId": "f6a7b8c9-d0e1-2345-f678-901234567890"
}