cloudPC: rename

Namespace: microsoft.graph

Rename a specific cloudPC object. Use this API to update the displayName of a 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 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 parameter that you can use 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

Request

The following example shows a request to rename a Cloud PC for the administrator.

HTTP

POST https://graph.microsoft.com/v1.0/deviceManagement/virtualEndpoint/cloudPCs/c2bbb5dd-2574-451b-a508-bbaa6ac48ace/rename
Content-Type: application/json

{
  displayName: "Cloud PC-HR"
}

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc device-management virtual-endpoint cloud-pcs rename post --cloud-pcid {cloudPC-id} --body '{\
  displayName: "Cloud PC-HR"\
}\
'

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const rename = {
  displayName: 'Cloud PC-HR'
};

await client.api('/deviceManagement/virtualEndpoint/cloudPCs/c2bbb5dd-2574-451b-a508-bbaa6ac48ace/rename')
	.post(rename);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following example shows the response.

HTTP/1.1 204 No Content