Создание iosVpnConfiguration

  • Статья

Пространство имен: microsoft.graph

Важно: API Microsoft Graph в версии /beta могут быть изменены; Использование в рабочей среде не поддерживается.

Примечание. API Microsoft Graph для Intune требует наличия активной лицензии Intune для клиента.

Создайте новый объект iosVpnConfiguration .

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба Правительство США L4 Правительство США L5 (DOD) Китай управляется 21Vianet
✅ ✅ ✅ ✅

Разрешения

Для вызова этого API требуется одно из следующих разрешений. Дополнительные сведения, включая сведения о том, как выбрать разрешения, см. в статье Разрешения.

Тип разрешения Разрешения (в порядке повышения привилегий)
Делегированные (рабочая или учебная учетная запись) DeviceManagementConfiguration.ReadWrite.All
Делегированные (личная учетная запись Майкрософт) Не поддерживается.
Приложение DeviceManagementConfiguration.ReadWrite.All

HTTP-запрос

POST /deviceManagement/deviceConfigurations
POST /deviceManagement/deviceConfigurations/{deviceConfigurationId}/microsoft.graph.windowsDomainJoinConfiguration/networkAccessConfigurations

Заголовки запроса

Заголовок Значение
Авторизация Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.
Accept application/json

Текст запроса

В тексте запроса укажите представление объекта iosVpnConfiguration в формате JSON.

В следующей таблице показаны свойства, необходимые при создании iosVpnConfiguration.

Свойство Тип Описание
id String Ключ объекта. Наследуется от объекта deviceConfiguration.
lastModifiedDateTime DateTimeOffset Дата и время последнего изменения объекта. Наследуется от объекта deviceConfiguration.
roleScopeTagIds Коллекция строк Список тегов области для этого экземпляра сущности. Наследуется от объекта deviceConfiguration.
supportsScopeTags Логический Указывает, поддерживает ли базовая конфигурация устройства назначение тегов область. Назначение свойству ScopeTags не допускается, если это значение равно false, а сущности не будут видны пользователям с областью действия. Это происходит для устаревших политик, созданных в Silverlight, и его можно устранить путем удаления и повторного создания политики на портале Azure. Это свойство доступно только для чтения. Наследуется от объекта deviceConfiguration.
deviceManagementApplicabilityRuleOsEdition deviceManagementApplicabilityRuleOsEdition Применимость выпуска ОС для этой политики. Наследуется от объекта deviceConfiguration.
deviceManagementApplicabilityRuleOsVersion deviceManagementApplicabilityRuleOsVersion Правило применимости версий ОС для этой политики. Наследуется от объекта deviceConfiguration.
deviceManagementApplicabilityRuleDeviceMode deviceManagementApplicabilityRuleDeviceMode Правило применимости режима устройства для этой политики. Наследуется от объекта deviceConfiguration.
createdDateTime DateTimeOffset Дата и время создания объекта. Наследуется от объекта deviceConfiguration.
description String Указанное администратором описание конфигурации устройства. Наследуется от объекта deviceConfiguration.
displayName String Указанное администратором имя конфигурации устройства. Наследуется от объекта deviceConfiguration.
version Int32 Версия конфигурации устройства. Наследуется от объекта deviceConfiguration.
connectionName String Имя подключения, отображаемое для пользователя. Наследуется от appleVpnConfiguration
connectionType appleVpnConnectionType Тип подключения. Наследуется от appleVpnConfiguration. Возможные значения: ciscoAnyConnect, , f5EdgeClientpulseSecure, dellSonicWallMobileConnect, checkPointCapsuleVpn, customVpn, ciscoIPSec, citrix, ciscoAnyConnectV2, paloAltoGlobalProtect, zscalerPrivateAccess, f5Access2018, , citrixSso, paloAltoGlobalProtectV2, ikEv2, alwaysOn, , microsoftTunnel, netMotionMobility, . microsoftProtect
loginGroupOrDomain String Группа входа или домен, если для типа подключения задано значение Dell SonicWALL Mobile Connection. Наследуется от appleVpnConfiguration
role String Роль, если для типа подключения задано значение Pulse Secure. Наследуется от appleVpnConfiguration
Realm String Область, когда для типа подключения задано значение Pulse Secure. Наследуется от appleVpnConfiguration
Сервера vpnServer VPN-сервер в сети. Убедитесь, что конечные пользователи могут получить доступ к этому сетевому расположению. Наследуется от appleVpnConfiguration
идентификатор String Идентификатор, предоставленный поставщиком VPN, если для типа подключения задано значение Custom VPN. Например: Cisco AnyConnect использует идентификатор формы com.cisco.anyconnect.applevpn.plugin, унаследованный от appleVpnConfiguration.
Customdata Коллекция keyValue Пользовательские данные, если для типа подключения задано значение Custom VPN. Используйте это поле, чтобы включить функции, не поддерживаемые Intune, но доступные в решении VPN. Обратитесь к поставщику VPN, чтобы узнать, как добавить эти пары "ключ- значение". Эта коллекция может содержать не более 25 элементов. Наследуется от appleVpnConfiguration
customKeyValueData Коллекция keyValuePair Пользовательские данные, если для типа подключения задано значение Custom VPN. Используйте это поле, чтобы включить функции, не поддерживаемые Intune, но доступные в решении VPN. Обратитесь к поставщику VPN, чтобы узнать, как добавить эти пары "ключ- значение". Эта коллекция может содержать не более 25 элементов. Наследуется от appleVpnConfiguration
enableSplitTunneling Логический Отправка всего сетевого трафика через VPN. Наследуется от appleVpnConfiguration
authenticationMethod vpnAuthenticationMethod Метод проверки подлинности для этого VPN-подключения. Наследуется от appleVpnConfiguration. Возможные значения: certificate, usernameAndPassword, sharedSecret, derivedCredential, azureAD.
enablePerApp Логический Если для этого параметра задано значение true, Per-App полезные данные VPN, которые в дальнейшем могут быть связаны с приложениями, которые могут активировать эту связь VPN на устройстве iOS конечного пользователя. Наследуется от appleVpnConfiguration
safariDomains Коллекция строк Домены Safari, если этот параметр VPN для каждого приложения включен. Помимо приложений, связанных с этим VPN, указанные здесь домены Safari также смогут активировать это VPN-подключение. Наследуется от appleVpnConfiguration
onDemandRules коллекция vpnOnDemandRule Правила по запросу. Эта коллекция может содержать не более 500 элементов. Наследуется от appleVpnConfiguration
providerType vpnProviderType Тип поставщика для VPN для каждого приложения. Наследуется от appleVpnConfiguration. Возможные значения: notConfigured, appProxy, packetTunnel.
associatedDomains Коллекция строк Связанные домены, унаследованные от appleVpnConfiguration
исключенные домены Коллекция строк Домены, доступ к которым осуществляется через общедоступный Интернет, а не через VPN, даже если vpn для каждого приложения активируется Наследуется от appleVpnConfiguration
disableOnDemandUserOverride Логический Переключение, чтобы запретить пользователю отключить автоматический VPN в приложении "Параметры", наследуемом от appleVpnConfiguration
disconnectOnIdle Логический Следует ли отключиться после простоя подключения по запросу Наследуется от appleVpnConfiguration
disconnectOnIdleTimerInSeconds Int32 Продолжительность ожидания в секундах перед отключением подключения по запросу. Допустимые значения от 0 до 65535 Наследуется от appleVpnConfiguration
proxyServer vpnProxyServer Прокси-сервер. Наследуется от appleVpnConfiguration
optInToDeviceIdSharing Логический Opt-In предоставления идентификатора устройства сторонним VPN-клиентам для использования во время проверки управления доступом к сети. Наследуется от appleVpnConfiguration
userDomain String Только Zscaler. Введите статический домен, чтобы предварительно заполнить поле входа в приложение Zscaler. Если этот параметр оставить пустым, вместо него будет использоваться домен Azure Active Directory пользователя.
strictEnforcement Логический Только Zscaler. Блокирует сетевой трафик до тех пор, пока пользователь не войдет в приложение Zscaler. Значение True означает, что трафик заблокирован.
cloudName String Только Zscaler. Облако Zscaler, которому назначен пользователь.
excludeList Коллекция строк Только Zscaler. Список сетевых адресов, которые не отправляются через облако Zscaler.
targetedMobileApps Коллекция appListItem Целевые мобильные приложения. Эта коллекция может содержать не более 500 элементов.
microsoftTunnelSiteId String Идентификатор сайта Microsoft Tunnel.

Отклик

В случае успешного выполнения этот метод возвращает код отклика 201 Created и объект iosVpnConfiguration в теле отклика.

Пример

Запрос

Ниже приведен пример запроса.

POST https://graph.microsoft.com/beta/deviceManagement/deviceConfigurations
Content-type: application/json
Content-length: 3495

{
  "@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/",
      "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,
  "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 201 Created
Content-Type: application/json
Content-Length: 3667

{
  "@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/",
      "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,
  "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"
}