Windows10VpnConfiguration を更新する

[アーティクル]
02/11/2024

名前空間: microsoft.graph

大事な： /beta バージョンの Microsoft Graph API は変更される可能性があります。運用環境での使用はサポートされていません。

注:Intune 用 Microsoft Graph API には、テナントの有効な Intune ライセンスが必要です。

windows10VpnConfiguration オブジェクトのプロパティを更新します。

この API は、次の国内クラウド展開で使用できます。

グローバルサービス	米国政府機関 L4	米国政府機関 L5 (DOD)	21Vianet が運営する中国
✅	✅	✅	✅

アクセス許可

この 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

要求本文

要求本文で、 windows10VpnConfiguration オブジェクトの JSON 表現を指定します。

次の表は、 windows10VpnConfiguration を作成するときに必要なプロパティを示しています。

プロパティ	型	説明
id	String	エンティティのキー。 deviceConfiguration から継承します
lastModifiedDateTime	DateTimeOffset	オブジェクトの最終更新の DateTime。 deviceConfiguration から継承します
roleScopeTagIds	String collection	このエンティティインスタンスのスコープタグの一覧。 deviceConfiguration から継承します
supportsScopeTags	ブール型	基になるデバイス構成がスコープタグの割り当てをサポートするかどうかを示します。 ScopeTags プロパティへの割り当ては、この値が false であり、スコープ付きユーザーにエンティティが表示されない場合は許可されません。これは Silverlight で作成されたレガシポリシーに対して発生し、Azure Portal でポリシーを削除して再作成することで解決できます。このプロパティは読み取り専用です。 deviceConfiguration から継承します
deviceManagementApplicabilityRuleOsEdition	deviceManagementApplicabilityRuleOsEdition	このポリシーの OS エディションの適用性。 deviceConfiguration から継承します
deviceManagementApplicabilityRuleOsVersion	deviceManagementApplicabilityRuleOsVersion	このポリシーの OS バージョンの適用規則。 deviceConfiguration から継承します
deviceManagementApplicabilityRuleDeviceMode	deviceManagementApplicabilityRuleDeviceMode	このポリシーのデバイスモードの適用規則。 deviceConfiguration から継承します
createdDateTime	DateTimeOffset	オブジェクトが作成された DateTime。 deviceConfiguration から継承します
description	String	管理者が指定した、デバイス構成についての説明。 deviceConfiguration から継承します
displayName	String	管理者が指定した、デバイス構成の名前。 deviceConfiguration から継承します
version	Int32	デバイス構成のバージョン。 deviceConfiguration から継承します
connectionName	String	ユーザーに表示される接続名。 windowsVpnConfiguration から継承
サーバー	vpnServer コレクション	ネットワーク上の VPN サーバーの一覧。エンドユーザーがこれらのネットワークの場所にアクセスできることを確認します。このコレクションには、最大で 500 個の要素を含めることができます。 windowsVpnConfiguration から継承
customXml	バイナリ	VPN 接続を構成するカスタム XML コマンド。 (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	ブール型	内部 DNS で IP アドレス登録を有効にします。
dnsSuffixes	String collection	DNS 検索リストに追加する DNS サフィックスを指定して、短い名前を適切にルーティングします。
microsoftTunnelSiteId	String	VPN プロファイルに関連付けられている Microsoft Tunnel サイトの ID。
authenticationMethod	windows10VpnAuthenticationMethod	認証方法。使用可能な値: `certificate`、`usernameAndPassword`、`customEapXml`、`derivedCredential`。
rememberUserCredentials	ブール型	ユーザーの資格情報を記憶します。
enableConditionalAccess	ブール型	条件付きアクセスを有効にします。
enableSingleSignOnWithAlternateCertificate	ブール型	代替証明書でシングルサインオン (SSO) を有効にします。
singleSignOnEku	extendedKeyUsage	シングルサインオン拡張キー使用法 (EKU)。
singleSignOnIssuerHash	String	シングルサインオン発行者ハッシュ。
eapXml	バイナリ	拡張認証プロトコル (EAP) XML。 (UTF8 でエンコードされたバイト配列)
proxyServer	windows10VpnProxyServer	プロキシサーバー。
associatedApps	windows10AssociatedApps コレクション	関連付けられているアプリ。このコレクションには、最大で 10000 個の要素を含めることができます。
onlyAssociatedAppsCanUseConnection	ブール型	接続 (アプリごとの VPN) を使用できるのは、関連付けられているアプリのみです。
windowsInformationProtectionDomain	String	この接続に関連付ける Windows Information Protection (WIP) ドメイン。
trafficRules	vpnTrafficRule コレクション	トラフィックルール。このコレクションには、最大で 1000 個の要素を含めることができます。
ルート	vpnRoute コレクション	ルート (サードパーティプロバイダーの場合は省略可能)。このコレクションには、最大で 1000 個の要素を含めることができます。
dnsRules	vpnDnsRule コレクション	DNS ルール。このコレクションには、最大で 1000 個の要素を含めることができます。
trustedNetworkDomains	String collection	信頼されたネットワークドメイン
cryptographySuite	cryptographySuite	Windows10 以降の IKEv2 VPN の暗号化スイートのセキュリティ設定

応答

成功した場合、このメソッドは 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"
  }
}