Обновление windows10VpnConfiguration

Статья
04/17/2024

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

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

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

Обновите свойства объекта windows10VpnConfiguration .

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

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

Разрешения

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

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

HTTP-запрос

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

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

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

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

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

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

Свойство	Тип	Описание
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	Имя подключения, отображаемое для пользователя. Наследуется от windowsVpnConfiguration
Серверов	Коллекция vpnServer	Список VPN-серверов в сети. Убедитесь, что конечные пользователи могут получить доступ к этим сетевым расположениям. Эта коллекция может содержать не более 500 элементов. Наследуется от windowsVpnConfiguration
customXml	В двоичном формате	Пользовательские команды XML, которые настраивают VPN-подключение. (массив байтов в кодировке UTF8) Наследуется от windowsVpnConfiguration
profileTarget	windows10VpnProfileTarget	Тип целевого объекта профиля. Возможные значения: `user`, `device`, `autoPilotDevice`.
connectionType	windows10VpnConnectionType	Тип подключения. Возможные значения: `pulseSecure`, `f5EdgeClient`, `dellSonicWallMobileConnect`, `checkPointCapsuleVpn`, `automatic`, `ikEv2`, `l2tp`, `pptp`, `citrix`, `paloAltoGlobalProtect`, `ciscoAnyConnect`, `unknownFutureValue`, `microsoftTunnel`.
enableSplitTunneling	Логический	Включите раздельное туннелирование.
enableAlwaysOn	Логический	Включите режим Always On.
enableDeviceTunnel	Логический	Включение туннеля устройства.
enableDnsRegistration	Логический	Включите регистрацию IP-адресов с помощью внутренней службы DNS.
dnsSuffixes	Коллекция строк	Укажите DNS-суффиксы, чтобы добавить их в список поиска DNS, чтобы правильно маршрутизировать короткие имена.
microsoftTunnelSiteId	String	Идентификатор сайта Microsoft Tunnel, связанного с профилем VPN.
authenticationMethod	windows10VpnAuthenticationMethod	Метод проверки подлинности. Возможные значения: `certificate`, `usernameAndPassword`, `customEapXml`, `derivedCredential`.
rememberUserCredentials	Логический	Запомните учетные данные пользователя.
enableConditionalAccess	Логический	Включите условный доступ.
enableSingleSignOnWithAlternateCertificate	Логический	Включите единый вход (SSO) с альтернативным сертификатом.
singleSignOnEku	extendedKeyUsage	Единый вход с расширенным использованием ключей (EKU).
singleSignOnIssuerHash	String	Хэш издателя единого входа.
eapXml	В двоичном формате	XML-код протокола расширенной проверки подлинности (EAP). (массив байтов в кодировке UTF8).
proxyServer	windows10VpnProxyServer	Прокси-сервер.
associatedApps	коллекция windows10AssociatedApps	Связанные приложения. Эта коллекция может содержать не более 10 000 элементов.
OnlyAssociatedAppsCanUseConnection	Логический	Только связанные приложения могут использовать подключение (VPN для каждого приложения).
windowsInformationProtectionDomain	String	Windows Information Protection домен (WIP) для связывания с этим подключением.
trafficRules	коллекция vpnTrafficRule	Правила дорожного движения. Эта коллекция может содержать не более 1000 элементов.
Маршруты	Коллекция vpnRoute	Маршруты (необязательно для сторонних поставщиков). Эта коллекция может содержать не более 1000 элементов.
dnsRules	коллекция vpnDnsRule	Правила DNS. Эта коллекция может содержать не более 1000 элементов.
trustedNetworkDomains	Коллекция строк	Домены доверенных сетей
cryptographySuite	cryptographySuite	Параметры безопасности пакета шифрования для VPN IKEv2 в Windows10 и более поздних версиях

Отклик

В случае успешного выполнения этот метод возвращает код отклика 200 OK и обновленный объект windows10VpnConfiguration в тексте отклика.

Пример

Запрос

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

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

{
  "@odata.type": "#microsoft.graph.windows10VpnConfiguration",
  "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",
  "servers": [
    {
      "@odata.type": "microsoft.graph.vpnServer",
      "description": "Description value",
      "address": "Address value",
      "isDefaultServer": true
    }
  ],
  "customXml": "Y3VzdG9tWG1s",
  "profileTarget": "device",
  "connectionType": "f5EdgeClient",
  "enableSplitTunneling": true,
  "enableAlwaysOn": true,
  "enableDeviceTunnel": true,
  "enableDnsRegistration": true,
  "dnsSuffixes": [
    "Dns Suffixes value"
  ],
  "microsoftTunnelSiteId": "Microsoft Tunnel Site Id value",
  "authenticationMethod": "usernameAndPassword",
  "rememberUserCredentials": true,
  "enableConditionalAccess": true,
  "enableSingleSignOnWithAlternateCertificate": true,
  "singleSignOnEku": {
    "@odata.type": "microsoft.graph.extendedKeyUsage",
    "name": "Name value",
    "objectIdentifier": "Object Identifier value"
  },
  "singleSignOnIssuerHash": "Single Sign On Issuer Hash value",
  "eapXml": "ZWFwWG1s",
  "proxyServer": {
    "@odata.type": "microsoft.graph.windows10VpnProxyServer",
    "automaticConfigurationScriptUrl": "https://example.com/automaticConfigurationScriptUrl/",
    "address": "Address value",
    "port": 4,
    "bypassProxyServerForLocalAddress": true
  },
  "associatedApps": [
    {
      "@odata.type": "microsoft.graph.windows10AssociatedApps",
      "appType": "universal",
      "identifier": "Identifier value"
    }
  ],
  "onlyAssociatedAppsCanUseConnection": true,
  "windowsInformationProtectionDomain": "Windows Information Protection Domain value",
  "trafficRules": [
    {
      "@odata.type": "microsoft.graph.vpnTrafficRule",
      "name": "Name value",
      "protocols": 9,
      "localPortRanges": [
        {
          "@odata.type": "microsoft.graph.numberRange",
          "lowerNumber": 11,
          "upperNumber": 11
        }
      ],
      "remotePortRanges": [
        {
          "@odata.type": "microsoft.graph.numberRange",
          "lowerNumber": 11,
          "upperNumber": 11
        }
      ],
      "localAddressRanges": [
        {
          "@odata.type": "microsoft.graph.iPv4Range",
          "lowerAddress": "Lower Address value",
          "upperAddress": "Upper Address value"
        }
      ],
      "remoteAddressRanges": [
        {
          "@odata.type": "microsoft.graph.iPv4Range",
          "lowerAddress": "Lower Address value",
          "upperAddress": "Upper Address value"
        }
      ],
      "appId": "App Id value",
      "appType": "desktop",
      "routingPolicyType": "splitTunnel",
      "claims": "Claims value",
      "vpnTrafficDirection": "inbound"
    }
  ],
  "routes": [
    {
      "@odata.type": "microsoft.graph.vpnRoute",
      "destinationPrefix": "Destination Prefix value",
      "prefixSize": 10
    }
  ],
  "dnsRules": [
    {
      "@odata.type": "microsoft.graph.vpnDnsRule",
      "name": "Name value",
      "servers": [
        "Servers value"
      ],
      "proxyServerUri": "Proxy Server Uri value",
      "autoTrigger": true,
      "persistent": true
    }
  ],
  "trustedNetworkDomains": [
    "Trusted Network Domains value"
  ],
  "cryptographySuite": {
    "@odata.type": "microsoft.graph.cryptographySuite",
    "encryptionMethod": "des",
    "integrityCheckMethod": "sha1_96",
    "dhGroup": "group2",
    "cipherTransformConstants": "des",
    "authenticationTransformConstants": "sha1_96",
    "pfsGroup": "pfs2"
  }
}

Отклик

Ниже приведен пример отклика. Примечание. Представленный здесь объект отклика может быть усечен для краткости. При фактическом вызове будут возвращены все свойства.

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

{
  "@odata.type": "#microsoft.graph.windows10VpnConfiguration",
  "id": "c23c9727-9727-c23c-2797-3cc227973cc2",
  "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",
  "servers": [
    {
      "@odata.type": "microsoft.graph.vpnServer",
      "description": "Description value",
      "address": "Address value",
      "isDefaultServer": true
    }
  ],
  "customXml": "Y3VzdG9tWG1s",
  "profileTarget": "device",
  "connectionType": "f5EdgeClient",
  "enableSplitTunneling": true,
  "enableAlwaysOn": true,
  "enableDeviceTunnel": true,
  "enableDnsRegistration": true,
  "dnsSuffixes": [
    "Dns Suffixes value"
  ],
  "microsoftTunnelSiteId": "Microsoft Tunnel Site Id value",
  "authenticationMethod": "usernameAndPassword",
  "rememberUserCredentials": true,
  "enableConditionalAccess": true,
  "enableSingleSignOnWithAlternateCertificate": true,
  "singleSignOnEku": {
    "@odata.type": "microsoft.graph.extendedKeyUsage",
    "name": "Name value",
    "objectIdentifier": "Object Identifier value"
  },
  "singleSignOnIssuerHash": "Single Sign On Issuer Hash value",
  "eapXml": "ZWFwWG1s",
  "proxyServer": {
    "@odata.type": "microsoft.graph.windows10VpnProxyServer",
    "automaticConfigurationScriptUrl": "https://example.com/automaticConfigurationScriptUrl/",
    "address": "Address value",
    "port": 4,
    "bypassProxyServerForLocalAddress": true
  },
  "associatedApps": [
    {
      "@odata.type": "microsoft.graph.windows10AssociatedApps",
      "appType": "universal",
      "identifier": "Identifier value"
    }
  ],
  "onlyAssociatedAppsCanUseConnection": true,
  "windowsInformationProtectionDomain": "Windows Information Protection Domain value",
  "trafficRules": [
    {
      "@odata.type": "microsoft.graph.vpnTrafficRule",
      "name": "Name value",
      "protocols": 9,
      "localPortRanges": [
        {
          "@odata.type": "microsoft.graph.numberRange",
          "lowerNumber": 11,
          "upperNumber": 11
        }
      ],
      "remotePortRanges": [
        {
          "@odata.type": "microsoft.graph.numberRange",
          "lowerNumber": 11,
          "upperNumber": 11
        }
      ],
      "localAddressRanges": [
        {
          "@odata.type": "microsoft.graph.iPv4Range",
          "lowerAddress": "Lower Address value",
          "upperAddress": "Upper Address value"
        }
      ],
      "remoteAddressRanges": [
        {
          "@odata.type": "microsoft.graph.iPv4Range",
          "lowerAddress": "Lower Address value",
          "upperAddress": "Upper Address value"
        }
      ],
      "appId": "App Id value",
      "appType": "desktop",
      "routingPolicyType": "splitTunnel",
      "claims": "Claims value",
      "vpnTrafficDirection": "inbound"
    }
  ],
  "routes": [
    {
      "@odata.type": "microsoft.graph.vpnRoute",
      "destinationPrefix": "Destination Prefix value",
      "prefixSize": 10
    }
  ],
  "dnsRules": [
    {
      "@odata.type": "microsoft.graph.vpnDnsRule",
      "name": "Name value",
      "servers": [
        "Servers value"
      ],
      "proxyServerUri": "Proxy Server Uri value",
      "autoTrigger": true,
      "persistent": true
    }
  ],
  "trustedNetworkDomains": [
    "Trusted Network Domains value"
  ],
  "cryptographySuite": {
    "@odata.type": "microsoft.graph.cryptographySuite",
    "encryptionMethod": "des",
    "integrityCheckMethod": "sha1_96",
    "dhGroup": "group2",
    "cipherTransformConstants": "des",
    "authenticationTransformConstants": "sha1_96",
    "pfsGroup": "pfs2"
  }
}

Share via

Обновление windows10VpnConfiguration

Разрешения

HTTP-запрос

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

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

Отклик

Пример

Запрос

Отклик

Обратная связь

Обратная связь

Дополнительные ресурсы