androidWorkProfileVpnConfiguration resource type

Article
09/12/2024

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.

By providing the configurations in this profile you can instruct the Android Work Profile 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 deviceConfiguration

Methods

Method	Return Type	Description
List androidWorkProfileVpnConfigurations	androidWorkProfileVpnConfiguration collection	List properties and relationships of the androidWorkProfileVpnConfiguration objects.
Get androidWorkProfileVpnConfiguration	androidWorkProfileVpnConfiguration	Read properties and relationships of the androidWorkProfileVpnConfiguration object.
Create androidWorkProfileVpnConfiguration	androidWorkProfileVpnConfiguration	Create a new androidWorkProfileVpnConfiguration object.
Delete androidWorkProfileVpnConfiguration	None	Deletes a androidWorkProfileVpnConfiguration.
Update androidWorkProfileVpnConfiguration	androidWorkProfileVpnConfiguration	Update the properties of a androidWorkProfileVpnConfiguration 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
deviceManagementApplicabilityRuleOsEdition	deviceManagementApplicabilityRuleOsEdition	The OS edition applicability for this Policy. Inherited from deviceConfiguration
deviceManagementApplicabilityRuleOsVersion	deviceManagementApplicabilityRuleOsVersion	The OS version applicability rule for this Policy. Inherited from deviceConfiguration
deviceManagementApplicabilityRuleDeviceMode	deviceManagementApplicabilityRuleDeviceMode	The device mode applicability rule for this Policy. 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	androidWorkProfileVpnConnectionType	Connection type. Possible values are: `ciscoAnyConnect`, `pulseSecure`, `f5EdgeClient`, `dellSonicWallMobileConnect`, `checkPointCapsuleVpn`, `citrix`, `paloAltoGlobalProtect`, `microsoftTunnel`, `netMotionMobility`, `microsoftProtect`.
role	String	Role when connection type is set to Pulse Secure.
realm	String	Realm when connection type is set to Pulse Secure.
servers	vpnServer collection	List of VPN Servers on the network. Make sure end users can access these network locations. This collection can contain a maximum of 500 elements.
fingerprint	String	Fingerprint is a string that will be used to verify the VPN server can be trusted, which is only applicable when connection type is Check Point Capsule VPN.
customData	keyValue collection	Custom data when connection type is set to Citrix. This collection can contain a maximum of 25 elements.
customKeyValueData	keyValuePair collection	Custom data when connection type is set to Citrix. This collection can contain a maximum of 25 elements.
authenticationMethod	vpnAuthenticationMethod	Authentication method. Possible values are: `certificate`, `usernameAndPassword`, `sharedSecret`, `derivedCredential`, `azureAD`.
proxyServer	vpnProxyServer	Proxy server.
targetedPackageIds	String collection	Targeted App package IDs.
targetedMobileApps	appListItem collection	Targeted mobile apps. This collection can contain a maximum of 500 elements.
alwaysOn	Boolean	Whether or not to enable always-on VPN connection.
alwaysOnLockdown	Boolean	If always-on VPN connection is enabled, whether or not to lock network traffic when that VPN is disconnected.
microsoftTunnelSiteId	String	Microsoft Tunnel site ID.
proxyExclusionList	String collection	List of hosts to exclude using the proxy on connections for. These hosts can use wildcards such as *.example.com.

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
identityCertificate	androidWorkProfileCertificateProfileBase	Identity certificate for client authentication when authentication method is certificate.

JSON Representation

Here is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.androidWorkProfileVpnConfiguration",
  "id": "String (identifier)",
  "lastModifiedDateTime": "String (timestamp)",
  "roleScopeTagIds": [
    "String"
  ],
  "supportsScopeTags": true,
  "deviceManagementApplicabilityRuleOsEdition": {
    "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsEdition",
    "osEditionTypes": [
      "String"
    ],
    "name": "String",
    "ruleType": "String"
  },
  "deviceManagementApplicabilityRuleOsVersion": {
    "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsVersion",
    "minOSVersion": "String",
    "maxOSVersion": "String",
    "name": "String",
    "ruleType": "String"
  },
  "deviceManagementApplicabilityRuleDeviceMode": {
    "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleDeviceMode",
    "deviceMode": "String",
    "name": "String",
    "ruleType": "String"
  },
  "createdDateTime": "String (timestamp)",
  "description": "String",
  "displayName": "String",
  "version": 1024,
  "connectionName": "String",
  "connectionType": "String",
  "role": "String",
  "realm": "String",
  "servers": [
    {
      "@odata.type": "microsoft.graph.vpnServer",
      "description": "String",
      "address": "String",
      "isDefaultServer": true
    }
  ],
  "fingerprint": "String",
  "customData": [
    {
      "@odata.type": "microsoft.graph.keyValue",
      "key": "String",
      "value": "String"
    }
  ],
  "customKeyValueData": [
    {
      "@odata.type": "microsoft.graph.keyValuePair",
      "name": "String",
      "value": "String"
    }
  ],
  "authenticationMethod": "String",
  "proxyServer": {
    "@odata.type": "microsoft.graph.vpnProxyServer",
    "automaticConfigurationScriptUrl": "String",
    "address": "String",
    "port": 1024
  },
  "targetedPackageIds": [
    "String"
  ],
  "targetedMobileApps": [
    {
      "@odata.type": "microsoft.graph.appListItem",
      "name": "String",
      "publisher": "String",
      "appStoreUrl": "String",
      "appId": "String"
    }
  ],
  "alwaysOn": true,
  "alwaysOnLockdown": true,
  "microsoftTunnelSiteId": "String",
  "proxyExclusionList": [
    "String"
  ]
}

Share via

androidWorkProfileVpnConfiguration resource type

Methods

Properties

Relationships

JSON Representation

Feedback

Additional resources