Update cloudPcExternalPartnerSetting

Namespace: microsoft.graph


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


One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) CloudPC.ReadWrite.All
Delegated (personal Microsoft account) Not supported.
Application CloudPC.ReadWrite.All

HTTP request

PATCH /deviceManagement/virtualEndpoint/externalPartnerSettings/{cloudPcExternalPartnerSettingId}

Request headers

Name Description
Authorization Bearer {token}. Required.
Content-Type application/json. Required.

Request body

In the request body, supply only the values for properties that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values.

The following table specifies the properties that can be updated.

Property Type Description
enableConnection Boolean Enable or disable the connection to an external partner. If true, an external partner API will accept incoming calls from external partners. Required.


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



The following is an example of a request.

PATCH https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/externalPartnerSettings/b3548526-e615-3785-3118-be70b3968ec5
Content-Type: application/json

  "@odata.type": "#microsoft.graph.cloudPcExternalPartnerSetting",
  "enableConnection": true


The following is an example of the response.

HTTP/1.1 200 OK
Content-Type: application/json

  "@odata.type": "#microsoft.graph.cloudPcExternalPartnerSetting",
  "id": "b3548526-e615-3785-3118-be70b3968ec5",
  "partnerId": "198d7140-80bb-4843-8cc4-811377a49a92",
  "enableConnection": true,
  "lastSyncDateTime": "2020-11-03T12:43:14Z",
  "status": "available",
  "statusDetails": "The external partner is available"