cloudPC: rename
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.
Rename a specific Cloud PC. Use this API to update the displayName for the Cloud PC entity.
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
To rename the cloudPC of the specified user (who is the signed-in user) in the organization using delegated permission:
POST /me/cloudPCs/{cloudPCId}/rename
POST /users/{userId}/cloudPCs/{cloudPCId}/rename
To rename the specified cloudPC in the organization, using either delegated permission (the signed-in user should be the administrator) or application permission:
POST /deviceManagement/virtualEndpoint/cloudPCs/{cloudPCId}/rename
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Content-Type | application/json. Required. |
Request body
In the request body, supply a JSON representation of the parameters.
The following table shows the parameters that can be used with this action.
Property | Type | Description |
---|---|---|
displayName | String | The new display name for the Cloud PC. |
Response
If successful, this method returns a 204 No Content
response code.
Examples
Example 1: Rename the cloudPC for the administrator
Request
POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/cloudPCs/c2bbb5dd-2574-451b-a508-bbaa6ac48ace/rename
Content-Type: application/json
{
displayName: "Cloud PC-HR"
}
Response
HTTP/1.1 204 No Content
Example 2: Rename the cloudPC for the signed-in user
Request
POST https://graph.microsoft.com/beta/me/cloudPCs/36bd4942-0ca8-11ed-861d-0242ac120002/rename
Response
HTTP/1.1 204 No Content