Update cloudPcUserSetting

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.

Update the properties of a cloudPcUserSetting object.

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

PATCH /deviceManagement/virtualEndpoint/userSettings/{id}

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 cloudPcUserSetting object.

The following table shows the properties that are required when you update the cloudPcUserSetting.

Property Type Description
displayName String The setting name displayed in the user interface.
lastModifiedDateTime DateTimeOffset The last date and time the setting was modified. The timestamp type represents the date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. 
localAdminEnabled Boolean To turn on the local admin option, change this setting to true.
resetEnabled Boolean Indicates whether an end user is allowed to reset their Cloud PC. When true, the user is allowed to reset their Cloud PC. When false, end-user initiated reset is not allowed. The default value is false.
restorePointSetting cloudPcRestorePointSetting Defines how frequently a restore point is created (that is, a snapshot is taken) for users' provisioned Cloud PCs (default is 12 hours), and whether the user is allowed to restore their own Cloud PCs to a backup made at a specific point in time.
selfServiceEnabled (deprecated) Boolean To turn on the self-service option, change this setting to true. The selfServiceEnabled property is deprecated and will stop returning data on December 1, 2023.

Response

If successful, this method returns a 200 OK response code and an updated cloudPcUserSetting object in the response body.

Examples

Request

The following example shows a request.

PATCH https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/userSettings/b0c2d35f-3385-46c8-a6f5-6c3dfad7ffff
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.cloudPcUserSetting",
  "displayName": "Example",
  "selfServiceEnabled": true,
  "restorePointSetting": {
    "frequencyInHours": 16,
    "frequencyType": "sixteenHours",
    "userRestoreEnabled": true
  },
  "localAdminEnabled": false,
  "resetEnabled": true
}

Response

The following example shows the response.

HTTP/1.1 204 No Content