更新 iosVpnConfiguration

项目
09/12/2021

命名空间：microsoft.graph

重要提示： Microsoft Graph /beta 版本下的 API 可能会更改;不支持生产使用。

注意： 适用于 Intune 的 Microsoft Graph API 需要适用于租户的活动 Intune 许可证。

先决条件

要调用此 API，需要以下权限之一。要了解详细信息，包括如何选择权限的信息，请参阅权限。

权限类型	权限（从最低特权到最高特权）
委派（工作或学校帐户）	DeviceManagementConfiguration.ReadWrite.All
委派（个人 Microsoft 帐户）	不支持。
应用程序	DeviceManagementConfiguration.ReadWrite.All

HTTP 请求

PATCH /deviceManagement/deviceConfigurations/{deviceConfigurationId}
PATCH /deviceManagement/deviceConfigurations/{deviceConfigurationId}/groupAssignments/{deviceConfigurationGroupAssignmentId}/deviceConfiguration
PATCH /deviceManagement/deviceConfigurations/{deviceConfigurationId}/microsoft.graph.windowsDomainJoinConfiguration/networkAccessConfigurations/{deviceConfigurationId}

请求标头

标头	值
Authorization	Bearer <token>。必需。
接受	application/json

请求正文

在请求正文中，提供 iosVpnConfiguration 对象的 JSON 表示形式。

下表显示创建 iosVpnConfiguration 时所需的属性。

属性	类型	说明
id	String	实体的键。继承自 deviceConfiguration
lastModifiedDateTime	DateTimeOffset	上次修改对象的日期/时间。继承自 deviceConfiguration
roleScopeTagIds	String collection	此实体实例的范围标记列表。继承自 deviceConfiguration
supportsScopeTags	Boolean	指示基础设备配置是否支持分配范围标记。当此值为 false 且实体对范围用户不可见时，不允许分配给 ScopeTags 属性。这适用于在 Silverlight 中创建的旧版策略，可通过在 Azure 门户中删除和重新创建策略来解决。此属性是只读的。继承自 deviceConfiguration
deviceManagementApplicabilityRuleOsEdition	deviceManagementApplicabilityRuleOsEdition	此策略的操作系统版本适用性。继承自 deviceConfiguration
deviceManagementApplicabilityRuleOsVersion	deviceManagementApplicabilityRuleOsVersion	此策略的操作系统版本适用性规则。继承自 deviceConfiguration
deviceManagementApplicabilityRuleDeviceMode	deviceManagementApplicabilityRuleDeviceMode	此策略的设备模式适用性规则。继承自 deviceConfiguration
createdDateTime	DateTimeOffset	创建对象的日期/时间。继承自 deviceConfiguration
说明	String	管理员提供的设备配置的说明。继承自 deviceConfiguration
displayName	String	管理员提供的设备配置的名称。继承自 deviceConfiguration
version	Int32	设备配置的版本。继承自 deviceConfiguration
connectionName	String	向用户显示的连接名称。继承自 appleVpnConfiguration
connectionType	appleVpnConnectionType	连接类型。继承自 appleVpnConfiguration。可能的值是 `ciscoAnyConnect` `pulseSecure` `f5EdgeClient` ：、、、、、、、、 `dellSonicWallMobileConnect` `checkPointCapsuleVpn` `customVpn` `ciscoIPSec` `citrix` `ciscoAnyConnectV2` `paloAltoGlobalProtect` `zscalerPrivateAccess` `f5Access2018` `citrixSso` `paloAltoGlobalProtectV2` `ikEv2` `alwaysOn` `microsoftTunnel` `netMotionMobility` `microsoftProtect` 。
loginGroupOrDomain	String	连接类型设置为 Dell SonicWALL 移动连接时登录组或域。继承自 appleVpnConfiguration
role	String	将连接类型设置为 Pulse Secure 时的角色。继承自 appleVpnConfiguration
realm	String	将连接类型设置为 Pulse Secure 时的领域。继承自 appleVpnConfiguration
server	vpnServer	VPN 服务器。确保最终用户可以访问此网络位置。继承自 appleVpnConfiguration
标识符	String	连接类型设置为自定义 VPN 时 VPN 供应商提供的标识符。例如：Cisco AnyConnect 使用 com.cisco.anyconnect.applevpn.plugin 形式的标识符继承自 appleVpnConfiguration
customData	keyValue 集合	连接类型设置为自定义 VPN 时自定义数据。使用此字段启用 Intune 不支持但在 VPN 解决方案中提供的功能。请联系 VPN 供应商，了解如何添加这些键/值对。此集合最多可包含 25 个元素。继承自 appleVpnConfiguration
customKeyValueData	keyValuePair 集合	连接类型设置为自定义 VPN 时自定义数据。使用此字段启用 Intune 不支持但在 VPN 解决方案中提供的功能。请联系 VPN 供应商，了解如何添加这些键/值对。此集合最多可包含 25 个元素。继承自 appleVpnConfiguration
enableSplitTunneling	布尔值	通过 VPN 发送所有网络流量。继承自 appleVpnConfiguration
authenticationMethod	vpnAuthenticationMethod	此 VPN 连接的身份验证方法。继承自 appleVpnConfiguration。可取值为：`certificate`、`usernameAndPassword`、`sharedSecret`、`derivedCredential`、`azureAD`。
enablePerApp	Boolean	如果设置为 true，Per-App VPN 有效负载，稍后可关联到可在最终用户的 iOS 设备上触发此 VPN 连接的应用。继承自 appleVpnConfiguration
safariDomains	字符串集合	启用"每个应用此 VPN"设置时，Safari 域。除了与此 VPN 关联的应用之外，此处指定的 Safari 域还将能够触发此 VPN 连接。继承自 appleVpnConfiguration
onDemandRules	vpnOnDemandRule 集合	按需规则。该集合最多可包含 500 个元素。继承自 appleVpnConfiguration
providerType	vpnProviderType	每个应用 VPN 的提供程序类型。继承自 appleVpnConfiguration。可取值为：`notConfigured`、`appProxy`、`packetTunnel`。
associatedDomains	字符串集合	关联域继承自 appleVpnConfiguration
excludedDomains	String collection	通过公共 Internet 而不是 VPN 访问的域，即使已激活每应用 VPN 也是如此。继承自 appleVpnConfiguration
disableOnDemandUserOverride	Boolean	切换以阻止用户在应用中禁用自动 VPN 设置继承自appleVpnConfiguration
disconnectOnIdle	Boolean	在按需连接空闲后是否断开连接继承自 appleVpnConfiguration
disconnectOnIdleTimerInSeconds	Int32	断开按需连接之前要等待的时间长度（秒）。有效值 0 至 65535 继承自 appleVpnConfiguration
proxyServer	vpnProxyServer	代理服务器。继承自 appleVpnConfiguration
optInToDeviceIdSharing	布尔值	Opt-In将设备 ID 共享给第三方 vpn 客户端，以在网络访问控制验证期间使用。继承自 appleVpnConfiguration
userDomain	String	仅 Zscaler。输入静态域，以在 Zscaler 应用中预填充登录字段。如果此域留空，将Azure Active Directory用户域名。
strictEnforcement	布尔值	仅 Zscaler。阻止网络流量，直到用户登录 Zscaler 应用。 "True"表示流量被阻止。
cloudName	String	仅 Zscaler。用户分配到的 Zscaler 云。
excludeList	String collection	仅 Zscaler。未通过 Zscaler 云发送的网络地址列表。
targetedMobileApps	appListItem 集合	目标移动应用。该集合最多可包含 500 个元素。
microsoftTunnelSiteId	String	Microsoft Tunnel网站 ID。

响应

如果成功，此方法在响应正文中返回响应代码和更新的 200 OK iosVpnConfiguration 对象。

示例

请求

下面是一个请求示例。

PATCH https://graph.microsoft.com/beta/deviceManagement/deviceConfigurations/{deviceConfigurationId}
Content-type: application/json
Content-length: 3368

{
  "@odata.type": "#microsoft.graph.iosVpnConfiguration",
  "roleScopeTagIds": [
    "Role Scope Tag Ids value"
  ],
  "supportsScopeTags": true,
  "deviceManagementApplicabilityRuleOsEdition": {
    "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsEdition",
    "osEditionTypes": [
      "windows10EnterpriseN"
    ],
    "name": "Name value",
    "ruleType": "exclude"
  },
  "deviceManagementApplicabilityRuleOsVersion": {
    "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsVersion",
    "minOSVersion": "Min OSVersion value",
    "maxOSVersion": "Max OSVersion value",
    "name": "Name value",
    "ruleType": "exclude"
  },
  "deviceManagementApplicabilityRuleDeviceMode": {
    "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleDeviceMode",
    "deviceMode": "sModeConfiguration",
    "name": "Name value",
    "ruleType": "exclude"
  },
  "description": "Description value",
  "displayName": "Display Name value",
  "version": 7,
  "connectionName": "Connection Name value",
  "connectionType": "pulseSecure",
  "loginGroupOrDomain": "Login Group Or Domain value",
  "role": "Role value",
  "realm": "Realm value",
  "server": {
    "@odata.type": "microsoft.graph.vpnServer",
    "description": "Description value",
    "address": "Address value",
    "isDefaultServer": true
  },
  "identifier": "Identifier value",
  "customData": [
    {
      "@odata.type": "microsoft.graph.keyValue",
      "key": "Key value",
      "value": "Value value"
    }
  ],
  "customKeyValueData": [
    {
      "@odata.type": "microsoft.graph.keyValuePair",
      "name": "Name value",
      "value": "Value value"
    }
  ],
  "enableSplitTunneling": true,
  "authenticationMethod": "usernameAndPassword",
  "enablePerApp": true,
  "safariDomains": [
    "Safari Domains value"
  ],
  "onDemandRules": [
    {
      "@odata.type": "microsoft.graph.vpnOnDemandRule",
      "ssids": [
        "Ssids value"
      ],
      "dnsSearchDomains": [
        "Dns Search Domains value"
      ],
      "probeUrl": "https://example.com/probeUrl/",
      "action": "evaluateConnection",
      "domainAction": "neverConnect",
      "domains": [
        "Domains value"
      ],
      "probeRequiredUrl": "https://example.com/probeRequiredUrl/"
    }
  ],
  "providerType": "appProxy",
  "associatedDomains": [
    "Associated Domains value"
  ],
  "excludedDomains": [
    "Excluded Domains value"
  ],
  "disableOnDemandUserOverride": true,
  "disconnectOnIdle": true,
  "disconnectOnIdleTimerInSeconds": 14,
  "proxyServer": {
    "@odata.type": "microsoft.graph.vpnProxyServer",
    "automaticConfigurationScriptUrl": "https://example.com/automaticConfigurationScriptUrl/",
    "address": "Address value",
    "port": 4
  },
  "optInToDeviceIdSharing": true,
  "userDomain": "User Domain value",
  "strictEnforcement": true,
  "cloudName": "Cloud Name value",
  "excludeList": [
    "Exclude List value"
  ],
  "targetedMobileApps": [
    {
      "@odata.type": "microsoft.graph.appListItem",
      "name": "Name value",
      "publisher": "Publisher value",
      "appStoreUrl": "https://example.com/appStoreUrl/",
      "appId": "App Id value"
    }
  ],
  "microsoftTunnelSiteId": "Microsoft Tunnel Site Id value"
}

响应

下面是一个响应示例。注意：为了简单起见，可能会将此处所示的响应对象截断。将从实际调用中返回所有属性。

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

{
  "@odata.type": "#microsoft.graph.iosVpnConfiguration",
  "id": "bd12424c-424c-bd12-4c42-12bd4c4212bd",
  "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00",
  "roleScopeTagIds": [
    "Role Scope Tag Ids value"
  ],
  "supportsScopeTags": true,
  "deviceManagementApplicabilityRuleOsEdition": {
    "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsEdition",
    "osEditionTypes": [
      "windows10EnterpriseN"
    ],
    "name": "Name value",
    "ruleType": "exclude"
  },
  "deviceManagementApplicabilityRuleOsVersion": {
    "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleOsVersion",
    "minOSVersion": "Min OSVersion value",
    "maxOSVersion": "Max OSVersion value",
    "name": "Name value",
    "ruleType": "exclude"
  },
  "deviceManagementApplicabilityRuleDeviceMode": {
    "@odata.type": "microsoft.graph.deviceManagementApplicabilityRuleDeviceMode",
    "deviceMode": "sModeConfiguration",
    "name": "Name value",
    "ruleType": "exclude"
  },
  "createdDateTime": "2017-01-01T00:02:43.5775965-08:00",
  "description": "Description value",
  "displayName": "Display Name value",
  "version": 7,
  "connectionName": "Connection Name value",
  "connectionType": "pulseSecure",
  "loginGroupOrDomain": "Login Group Or Domain value",
  "role": "Role value",
  "realm": "Realm value",
  "server": {
    "@odata.type": "microsoft.graph.vpnServer",
    "description": "Description value",
    "address": "Address value",
    "isDefaultServer": true
  },
  "identifier": "Identifier value",
  "customData": [
    {
      "@odata.type": "microsoft.graph.keyValue",
      "key": "Key value",
      "value": "Value value"
    }
  ],
  "customKeyValueData": [
    {
      "@odata.type": "microsoft.graph.keyValuePair",
      "name": "Name value",
      "value": "Value value"
    }
  ],
  "enableSplitTunneling": true,
  "authenticationMethod": "usernameAndPassword",
  "enablePerApp": true,
  "safariDomains": [
    "Safari Domains value"
  ],
  "onDemandRules": [
    {
      "@odata.type": "microsoft.graph.vpnOnDemandRule",
      "ssids": [
        "Ssids value"
      ],
      "dnsSearchDomains": [
        "Dns Search Domains value"
      ],
      "probeUrl": "https://example.com/probeUrl/",
      "action": "evaluateConnection",
      "domainAction": "neverConnect",
      "domains": [
        "Domains value"
      ],
      "probeRequiredUrl": "https://example.com/probeRequiredUrl/"
    }
  ],
  "providerType": "appProxy",
  "associatedDomains": [
    "Associated Domains value"
  ],
  "excludedDomains": [
    "Excluded Domains value"
  ],
  "disableOnDemandUserOverride": true,
  "disconnectOnIdle": true,
  "disconnectOnIdleTimerInSeconds": 14,
  "proxyServer": {
    "@odata.type": "microsoft.graph.vpnProxyServer",
    "automaticConfigurationScriptUrl": "https://example.com/automaticConfigurationScriptUrl/",
    "address": "Address value",
    "port": 4
  },
  "optInToDeviceIdSharing": true,
  "userDomain": "User Domain value",
  "strictEnforcement": true,
  "cloudName": "Cloud Name value",
  "excludeList": [
    "Exclude List value"
  ],
  "targetedMobileApps": [
    {
      "@odata.type": "microsoft.graph.appListItem",
      "name": "Name value",
      "publisher": "Publisher value",
      "appStoreUrl": "https://example.com/appStoreUrl/",
      "appId": "App Id value"
    }
  ],
  "microsoftTunnelSiteId": "Microsoft Tunnel Site Id value"
}

更新 iosVpnConfiguration

先决条件

HTTP 请求

请求标头

请求正文

响应

示例

请求

响应

反馈