appleVpnConfiguration resource type

Important: APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported.

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

Apple VPN configuration profile.

Inherits from deviceConfiguration

Methods

Method Return Type Description
List appleVpnConfigurations appleVpnConfiguration collection List properties and relationships of the appleVpnConfiguration objects.
Get appleVpnConfiguration appleVpnConfiguration Read properties and relationships of the appleVpnConfiguration object.

Properties

Property Type Description
id String Key of the entity. Inherited from deviceConfiguration
lastModifiedDateTime DateTimeOffset DateTime the object was last modified. Inherited from deviceConfiguration
roleScopeTagIds String collection List of Scope Tags for this Entity instance. Inherited from deviceConfiguration
supportsScopeTags Boolean Indicates whether or not the underlying Device Configuration supports the assignment of scope tags. Assigning to the ScopeTags property is not allowed when this value is false and entities will not be visible to scoped users. This occurs for Legacy policies created in Silverlight and can be resolved by deleting and recreating the policy in the Azure Portal. This property is read-only. 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.
connectionType appleVpnConnectionType Connection type. Possible values are: ciscoAnyConnect, pulseSecure, f5EdgeClient, dellSonicWallMobileConnect, checkPointCapsuleVpn, customVpn, ciscoIPSec, citrix, ciscoAnyConnectV2, paloAltoGlobalProtect, zscalerPrivateAccess, f5Access2018, citrixSso, paloAltoGlobalProtectV2.
loginGroupOrDomain String Login group or domain when connection type is set to Dell SonicWALL Mobile Connection.
role String Role when connection type is set to Pulse Secure.
realm String Realm when connection type is set to Pulse Secure.
server vpnServer VPN Server on the network. Make sure end users can access this network location.
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
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.
customKeyValueData keyValuePair 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.
enableSplitTunneling Boolean Send all network traffic through VPN.
authenticationMethod vpnAuthenticationMethod Authentication method for this VPN connection. 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.
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.
onDemandRules vpnOnDemandRule collection On-Demand Rules. This collection can contain a maximum of 500 elements.
proxyServer vpnProxyServer Proxy Server.
optInToDeviceIdSharing Boolean Opt-In to sharing the device's Id to third-party vpn clients for use during network access control validation.

Relationships

Relationship Type Description
groupAssignments deviceConfigurationGroupAssignment collection The list of group assignments for the device configuration profile. Inherited from deviceConfiguration
assignments deviceConfigurationAssignment collection The list of assignments for the device configuration profile. Inherited from deviceConfiguration
deviceStatuses deviceConfigurationDeviceStatus collection Device configuration installation status by device. Inherited from deviceConfiguration
userStatuses deviceConfigurationUserStatus collection Device configuration installation status 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

JSON Representation

Here is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.appleVpnConfiguration",
  "id": "String (identifier)",
  "lastModifiedDateTime": "String (timestamp)",
  "roleScopeTagIds": [
    "String"
  ],
  "supportsScopeTags": true,
  "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",
    "address": "String",
    "isDefaultServer": true
  },
  "identifier": "String",
  "customData": [
    {
      "@odata.type": "microsoft.graph.keyValue",
      "key": "String",
      "value": "String"
    }
  ],
  "customKeyValueData": [
    {
      "@odata.type": "microsoft.graph.keyValuePair",
      "name": "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
  },
  "optInToDeviceIdSharing": true
}