Update windows10XVpnConfiguration

Namespace: microsoft.graph

Important: Microsoft Graph APIs under the /beta version are subject to change; production use is not supported.

Note: The Microsoft Graph API for Intune requires an active Intune license for the tenant.

Update the properties of a windows10XVpnConfiguration 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

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) DeviceManagementServiceConfig.ReadWrite.All
Delegated (personal Microsoft account) Not supported.
Application DeviceManagementServiceConfig.ReadWrite.All

HTTP Request

PATCH /deviceManagement/resourceAccessProfiles/{deviceManagementResourceAccessProfileBaseId}

Request headers

Header Value
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Accept application/json

Request body

In the request body, supply a JSON representation for the windows10XVpnConfiguration object.

The following table shows the properties that are required when you create the windows10XVpnConfiguration.

Property Type Description
id String Profile identifier Inherited from deviceManagementResourceAccessProfileBase
version Int32 Version of the profile Inherited from deviceManagementResourceAccessProfileBase
displayName String Profile display name Inherited from deviceManagementResourceAccessProfileBase
description String Profile description Inherited from deviceManagementResourceAccessProfileBase
creationDateTime DateTimeOffset DateTime profile was created Inherited from deviceManagementResourceAccessProfileBase
lastModifiedDateTime DateTimeOffset DateTime profile was last modified Inherited from deviceManagementResourceAccessProfileBase
roleScopeTagIds String collection Scope Tags Inherited from deviceManagementResourceAccessProfileBase
serverApplicabilityRules applicabilityRule collection The list of Applicability Rules for a Device Configuration Profile Inherited from deviceManagementResourceAccessProfileBase
authenticationCertificateId Guid ID to the Authentication Certificate
customXmlFileName String Custom Xml file name.
customXml Binary Custom XML commands that configures the VPN connection. (UTF8 byte encoding)

Response

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

Example

Request

Here is an example of the request.

PATCH https://graph.microsoft.com/beta/deviceManagement/resourceAccessProfiles/{deviceManagementResourceAccessProfileBaseId}
Content-type: application/json
Content-length: 589

{
  "@odata.type": "#microsoft.graph.windows10XVpnConfiguration",
  "version": 7,
  "displayName": "Display Name value",
  "description": "Description value",
  "creationDateTime": "2017-01-01T00:00:43.1365422-08:00",
  "roleScopeTagIds": [
    "Role Scope Tag Ids value"
  ],
  "serverApplicabilityRules": [
    {
      "@odata.type": "microsoft.graph.applicabilityRule",
      "filterType": "include"
    }
  ],
  "authenticationCertificateId": "39b4cd38-cd38-39b4-38cd-b43938cdb439",
  "customXmlFileName": "Custom Xml File Name value",
  "customXml": "Y3VzdG9tWG1s"
}

Response

Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

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

{
  "@odata.type": "#microsoft.graph.windows10XVpnConfiguration",
  "id": "6ee1c04f-c04f-6ee1-4fc0-e16e4fc0e16e",
  "version": 7,
  "displayName": "Display Name value",
  "description": "Description value",
  "creationDateTime": "2017-01-01T00:00:43.1365422-08:00",
  "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00",
  "roleScopeTagIds": [
    "Role Scope Tag Ids value"
  ],
  "serverApplicabilityRules": [
    {
      "@odata.type": "microsoft.graph.applicabilityRule",
      "filterType": "include"
    }
  ],
  "authenticationCertificateId": "39b4cd38-cd38-39b4-38cd-b43938cdb439",
  "customXmlFileName": "Custom Xml File Name value",
  "customXml": "Y3VzdG9tWG1s"
}