更新 macOSVpnConfiguration

项目
08/01/2024

命名空间：microsoft.graph

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

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

全局服务	美国政府 L4	美国政府 L5 (DOD)	由世纪互联运营的中国
✅	✅	✅	✅

权限

要调用此 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	持有者 {token}。必填。详细了解身份验证和授权。
接受	application/json

请求正文

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

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

属性	类型	说明
id	String	实体的键。继承自 deviceConfiguration
lastModifiedDateTime	DateTimeOffset	上次修改对象的日期/时间。继承自 deviceConfiguration
roleScopeTagIds	字符串集合	此实体实例的范围标记列表。继承自 deviceConfiguration
supportsScopeTags	布尔值	指示基础设备配置是否支持分配范围标记。如果此值为 false，并且实体对限定范围的用户不可见，则不允许向 ScopeTags 属性分配。这发生在 Silverlight 中创建的旧策略，可以通过在 Azure 门户中删除并重新创建策略来解决。此属性是只读的。继承自 deviceConfiguration
deviceManagementApplicabilityRuleOsEdition	deviceManagementApplicabilityRuleOsEdition	此策略的 OS 版本适用性。继承自 deviceConfiguration
deviceManagementApplicabilityRuleOsVersion	deviceManagementApplicabilityRuleOsVersion	此策略的 OS 版本适用性规则。继承自 deviceConfiguration
deviceManagementApplicabilityRuleDeviceMode	deviceManagementApplicabilityRuleDeviceMode	此策略的设备模式适用性规则。继承自 deviceConfiguration
createdDateTime	DateTimeOffset	创建对象的日期/时间。继承自 deviceConfiguration
description	String	管理员提供的设备配置的说明。继承自 deviceConfiguration
displayName	String	管理员提供的设备配置的名称。继承自 deviceConfiguration
version	Int32	设备配置的版本。继承自 deviceConfiguration
connectionName	String	向用户显示的连接名称。继承自 appleVpnConfiguration
connectionType	appleVpnConnectionType	连接类型。继承自 appleVpnConfiguration。可能的值为：、、、、`f5EdgeClientzscalerPrivateAccessciscoAnyConnectV2ciscoIPSeccitrixpaloAltoGlobalProtectcustomVpndellSonicWallMobileConnectcheckPointCapsuleVpn`、`f5Access2018alwaysOnikEv2paloAltoGlobalProtectV2citrixSso`、`microsoftTunnel`、`netMotionMobility`、。 `microsoftProtectpulseSecureciscoAnyConnect`
loginGroupOrDomain	String	当连接类型设置为 Dell SonicWALL Mobile Connection 时，登录组或域。继承自 appleVpnConfiguration
role	String	连接类型设置为 Pulse Secure 时的角色。继承自 appleVpnConfiguration
领域	String	连接类型设置为 Pulse Secure 时的领域。继承自 appleVpnConfiguration
服务器	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	布尔值	将其设置为 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	字符串集合	通过公共 Internet 而不是通过 VPN 访问的域，即使激活了从 appleVpnConfiguration 继承的按应用 VPN 也是如此
disableOnDemandUserOverride	布尔值	切换以防止用户在“设置”应用中禁用自动 VPN，该应用继承自 appleVpnConfiguration
disconnectOnIdle	布尔值	是否在按需连接空闲后断开连接继承自 appleVpnConfiguration
disconnectOnIdleTimerInSeconds	Int32	断开按需连接之前等待的时间长度（以秒为单位）。有效值 0 到 65535 继承自 appleVpnConfiguration
proxyServer	vpnProxyServer	代理服务器。继承自 appleVpnConfiguration
optInToDeviceIdSharing	布尔值	Opt-In 将设备的 ID 共享给第三方 vpn 客户端，以便在网络访问控制验证期间使用。继承自 appleVpnConfiguration
deploymentChannel	appleDeploymentChannel	指示用于部署配置文件的部署通道类型。可能的值为 deviceChannel、userChannel。可取值为：`deviceChannel`、`userChannel`、`unknownFutureValue`。

响应

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

示例

请求

下面是一个请求示例。

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

{
  "@odata.type": "#microsoft.graph.macOSVpnConfiguration",
  "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/",
      "interfaceTypeMatch": "ethernet",
      "dnsServerAddressMatch": [
        "Dns Server Address Match value"
      ]
    }
  ],
  "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,
  "deploymentChannel": "userChannel"
}

响应

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

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

{
  "@odata.type": "#microsoft.graph.macOSVpnConfiguration",
  "id": "8ce00178-0178-8ce0-7801-e08c7801e08c",
  "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/",
      "interfaceTypeMatch": "ethernet",
      "dnsServerAddressMatch": [
        "Dns Server Address Match value"
      ]
    }
  ],
  "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,
  "deploymentChannel": "userChannel"
}

通过

更新 macOSVpnConfiguration

权限

HTTP 请求

请求标头

请求正文

响应

示例

请求

响应

反馈

其他资源