macOSVpnConfiguration resource type

Note: Using the Microsoft Graph APIs to configure Intune controls and policies still requires that the Intune service is correctly licensed by the customer.

By providing the configurations in this profile you can instruct the Mac device to connect to desired VPN endpoint. By specifying the authentication method and security types expected by VPN endpoint you can make the VPN connection seamless for end user.

Inherits from appleVpnConfiguration

Methods

Method Return Type Description
List macOSVpnConfigurations macOSVpnConfiguration collection List properties and relationships of the macOSVpnConfiguration objects.
Get macOSVpnConfiguration macOSVpnConfiguration Read properties and relationships of the macOSVpnConfiguration object.
Create macOSVpnConfiguration macOSVpnConfiguration Create a new macOSVpnConfiguration object.
Delete macOSVpnConfiguration None Deletes a macOSVpnConfiguration.
Update macOSVpnConfiguration macOSVpnConfiguration Update the properties of a macOSVpnConfiguration object.
List deviceConfigurationGroupAssignments deviceConfigurationGroupAssignment collection Get the deviceConfigurationGroupAssignments from the groupAssignments navigation property.
List deviceConfigurationDeviceStatuses deviceConfigurationDeviceStatus collection Get the deviceConfigurationDeviceStatuses from the deviceStatuses navigation property.
List deviceConfigurationUserStatuses deviceConfigurationUserStatus collection Get the deviceConfigurationUserStatuses from the userStatuses navigation property.
Get deviceConfigurationDeviceOverview deviceConfigurationDeviceOverview Get the deviceConfigurationDeviceOverview from the deviceStatusOverview navigation property.
Get deviceConfigurationUserOverview deviceConfigurationUserOverview Get the deviceConfigurationUserOverview from the userStatusOverview navigation property.
List settingStateDeviceSummaries settingStateDeviceSummary collection Get the settingStateDeviceSummaries from the deviceSettingStateSummaries navigation property.
Get macOSCertificateProfileBase macOSCertificateProfileBase Get the macOSCertificateProfileBase from the identityCertificate navigation property.

Properties

Property Type Description
id String Key of the entity. Inherited from deviceConfiguration
lastModifiedDateTime DateTimeOffset DateTime the object was last modified. Inherited from deviceConfiguration
createdDateTime DateTimeOffset DateTime the object was created. Inherited from deviceConfiguration
description String Admin provided description of the Device Configuration. Inherited from deviceConfiguration
displayName String Admin provided name of the device configuration. Inherited from deviceConfiguration
version Int32 Version of the device configuration. Inherited from deviceConfiguration
connectionName String Connection name displayed to the user. Inherited from appleVpnConfiguration
connectionType String Connection type. Inherited from appleVpnConfiguration Possible values are: ciscoAnyConnect, pulseSecure, f5EdgeClient, dellSonicWallMobileConnect, checkPointCapsuleVpn, customVpn, ciscoIPSec, citrix.
loginGroupOrDomain String Login group or domain when connection type is set to Dell SonicWALL Mobile Connection. Inherited from appleVpnConfiguration
role String Role when connection type is set to Pulse Secure. Inherited from appleVpnConfiguration
realm String Realm when connection type is set to Pulse Secure. Inherited from appleVpnConfiguration
server vpnServer VPN Server on the network. Make sure end users can access this network location. Inherited from appleVpnConfiguration
identifier String Identifier provided by VPN vendor when connection type is set to Custom VPN. For example: Cisco AnyConnect uses an identifier of the form com.cisco.anyconnect.applevpn.plugin Inherited from appleVpnConfiguration
customData keyValue collection Custom data when connection type is set to Custom VPN. Use this field to enable functionality not supported by Intune, but available in your VPN solution. Contact your VPN vendor to learn how to add these key/value pairs. This collection can contain a maximum of 25 elements. Inherited from appleVpnConfiguration
enableSplitTunneling Boolean Send all network traffic through VPN. Inherited from appleVpnConfiguration
authenticationMethod String Authentication method for this VPN connection. Inherited from appleVpnConfiguration Possible values are: certificate, usernameAndPassword.
enablePerApp Boolean Setting this to true creates Per-App VPN payload which can later be associated with Apps that can trigger this VPN conneciton on the end user's iOS device. Inherited from appleVpnConfiguration
safariDomains String collection Safari domains when this VPN per App setting is enabled. In addition to the apps associated with this VPN, Safari domains specified here will also be able to trigger this VPN connection. Inherited from appleVpnConfiguration
onDemandRules vpnOnDemandRule collection On-Demand Rules. This collection can contain a maximum of 500 elements. Inherited from appleVpnConfiguration
proxyServer vpnProxyServer Proxy Server. Inherited from appleVpnConfiguration

Relationships

Relationship Type Description
groupAssignments deviceConfigurationGroupAssignment collection The list of group assignments for the device configuration profile. Inherited from deviceConfiguration
deviceStatuses deviceConfigurationDeviceStatus collection Device configuration installation stauts by device. Inherited from deviceConfiguration
userStatuses deviceConfigurationUserStatus collection Device configuration installation stauts by user. Inherited from deviceConfiguration
deviceStatusOverview deviceConfigurationDeviceOverview Device Configuration devices status overview Inherited from deviceConfiguration
userStatusOverview deviceConfigurationUserOverview Device Configuration users status overview Inherited from deviceConfiguration
deviceSettingStateSummaries settingStateDeviceSummary collection Device Configuration Setting State Device Summary Inherited from deviceConfiguration
identityCertificate macOSCertificateProfileBase Identity certificate for client authentication when authentication method is certificate.

JSON Representation

Here is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.macOSVpnConfiguration",
  "id": "String (identifier)",
  "lastModifiedDateTime": "String (timestamp)",
  "createdDateTime": "String (timestamp)",
  "description": "String",
  "displayName": "String",
  "version": 1024,
  "connectionName": "String",
  "connectionType": "String",
  "loginGroupOrDomain": "String",
  "role": "String",
  "realm": "String",
  "server": {
    "@odata.type": "microsoft.graph.vpnServer",
    "description": "String",
    "ipAddressOrFqdn": "String",
    "isDefaultServer": true
  },
  "identifier": "String",
  "customData": [
    {
      "@odata.type": "microsoft.graph.keyValue",
      "key": "String",
      "value": "String"
    }
  ],
  "enableSplitTunneling": true,
  "authenticationMethod": "String",
  "enablePerApp": true,
  "safariDomains": [
    "String"
  ],
  "onDemandRules": [
    {
      "@odata.type": "microsoft.graph.vpnOnDemandRule",
      "ssids": [
        "String"
      ],
      "dnsSearchDomains": [
        "String"
      ],
      "probeUrl": "String",
      "action": "String",
      "domainAction": "String",
      "domains": [
        "String"
      ],
      "probeRequiredUrl": "String"
    }
  ],
  "proxyServer": {
    "@odata.type": "microsoft.graph.vpnProxyServer",
    "automaticConfigurationScriptUrl": "String",
    "address": "String",
    "port": 1024
  }
}