iosikEv2VpnConfiguration を更新する

名前空間: microsoft.graph

重要: Microsoft Graph /beta バージョンの API は変更される場合があります。実稼働での使用はサポートされていません。

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

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

前提条件

この 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 ベアラー <トークン> が必要です。
承諾 application/json

要求本文

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

次の表に 、iosikEv2VpnConfiguration を作成するときに必要なプロパティを示します

プロパティ 説明
id String エンティティのキー。 deviceConfiguration から継承します
lastModifiedDateTime DateTimeOffset オブジェクトの最終更新の DateTime。 deviceConfiguration から継承します
roleScopeTagIds String collection この Entity インスタンスのスコープ タグの一覧。 deviceConfiguration から継承します
supportsScopeTags Boolean 基になるデバイス構成がスコープ タグの割り当てをサポートするかどうかを示します。 ScopeTags プロパティへの割り当ては、この値が false で、エンティティがスコープ付きユーザーに表示されない場合は許可されません。 これは Silverlight で作成された従来のポリシーで発生し、Azure Portal でポリシーを削除して再作成することで解決できます。 このプロパティに値を設定するには、 SetExtrusionDirection メソッドを適用します。 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 ユーザーに表示される接続名。 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 Mobile Connection に設定されている場合のログイン グループまたはドメイン。 appleVpnConfiguration から継承
role String 接続の種類が [Pulse Secure] に設定されている場合の役割。 appleVpnConfiguration から継承
realm 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 から継承されます。 可能な値は、certificateusernameAndPasswordsharedSecretderivedCredentialazureAD です。
enablePerApp ブール値 これを true に設定すると、Per-App VPN ペイロードが作成され、後でエンド ユーザーの iOS デバイスでこの VPN conneciton をトリガーできるアプリに関連付けることができます。 appleVpnConfiguration から継承
safariDomains String collection アプリごとのこの VPN 設定が有効な場合の Safari ドメイン。 この VPN に関連付けられたアプリに加えて、ここで指定した Safari ドメインでもこの VPN 接続をトリガーできます。 appleVpnConfiguration から継承
onDemandRules vpnOnDemandRule コレクション オンデマンド ルール。 このコレクションには、最大で 500 個の要素を含めることができます。 appleVpnConfiguration から継承
providerType vpnProviderType アプリごとの VPN のプロバイダーの種類。 appleVpnConfiguration から継承されます。 可能な値は、notConfiguredappProxypacketTunnel です。
associatedDomains String collection 関連付けられたドメイン appleVpnConfiguration から継承
excludedDomains String collection アプリごとの VPN がアクティブ化されている場合でも、VPN 経由ではなくパブリック インターネット経由でアクセスされるドメイン appleVpnConfigurationから継承
disableOnDemandUserOverride ブール値 トグルを切り替え、ユーザーが appleVpnConfiguration から継承設定アプリで自動VPN を無効にしな
disconnectOnIdle Boolean オンデマンド接続アイドル後に切断するかどうかappleVpnConfigurationから継承
disconnectOnIdleTimerInSeconds Int32 オンデマンド接続を切断するまでの待機時間 (秒)。 有効な値 0 ~ 65535 appleVpnConfigurationから継承
proxyServer vpnProxyServer プロキシ サーバー。 appleVpnConfiguration から継承
optInToDeviceIdSharing ブール値 Opt-Inアクセス制御の検証中に使用するために、デバイスの ID をサードパーティの VPN クライアントに共有する方法について説明します。 appleVpnConfiguration から継承
userDomain String Zscaler のみ。 Zscaler アプリでログイン フィールドに事前設定する静的ドメインを入力します。 これが空の場合は、ユーザーのドメインAzure Active Directory使用されます。 iosVpnConfiguration から継承
strictEnforcement Boolean Zscaler のみ。 ユーザーが Zscaler アプリにサインインするまで、ネットワーク トラフィックをブロックします。 "True" は、トラフィックがブロックされるという意味です。 iosVpnConfiguration から継承
cloudName String Zscaler のみ。 ユーザーが割り当てられている Zscaler クラウド。 iosVpnConfiguration から継承
excludeList String collection Zscaler のみ。 Zscaler クラウド経由で送信されないネットワーク アドレスの一覧。 iosVpnConfiguration から継承
targetedMobileApps appListItem コレクション 対象のモバイル アプリ。 このコレクションには、最大で 500 個の要素を含めることができます。 iosVpnConfiguration から継承
microsoftTunnelSiteId String Microsoft Tunnel ID。 iosVpnConfiguration から継承
childSecurityAssociationParameters iosVpnSecurityAssociationParameters 子セキュリティ関連付けパラメーター
clientAuthenticationType vpnClientAuthenticationType VPN クライアントが使用するクライアント認証の種類。 可能な値は、userAuthenticationdeviceAuthentication です。
deadPeerDetectionRate vpnDeadPeerDetectionRate ピア接続がまだアクティブかどうかを確認する頻度を決定します。 . 使用可能な値: mediumnonelowhigh
disableMobilityAndMultihoming Boolean MOBIKE を無効にする
disableRedirect ブール値 リダイレクトを無効にする
enableCertificateRevocationCheck ブール値 ベスト エオ努力の失効チェックを有効にする。サーバー応答のタイムアウトによってエラーが発生しない
enableEAP Boolean EAP のみ認証を有効にする
enablePerfectForwardSecrecy Boolean 完全前方秘密 (PFS) を有効にする。
enableUseInternalSubnetAttributes Boolean [内部サブネット属性の使用] を有効にする。
localIdentifier vpnLocalIdentifier VPN 経由で接続しようとしているクライアントを識別する方法。 . 可能な値は、deviceFQDNemptyclientCertificateSubjectName です。
remoteIdentifier String IKEv2 サーバーのアドレス。 FQDN、UserFQDN、ネットワーク アドレス、または ASN1DN である必要があります。
securityAssociationParameters iosVpnSecurityAssociationParameters セキュリティ関連付けパラメーター
serverCertificateCommonName String サーバー認証で使用される IKEv2 サーバー証明書の共通名
serverCertificateIssuerCommonName String Issuer 認証で使用される IKEv2 Server 証明書発行者の共通名
serverCertificateType vpnServerCertificateType VPN サーバーが認証のために VPN クライアントに提示する証明書の種類。 使用可能な値: rsaecdsa256ecdsa384ecdsa521
sharedSecret String 共有シークレット認証が選択されている場合に使用する
tlsMaximumVersion String EAP-TLS 認証で使用する最大 TLS バージョン
tlsMinimumVersion String EAP-TLS 認証で使用する最小 TLS バージョン
allowDefaultSecurityAssociationParameters Boolean 明示的に指定しない限り、すべてのパラメーターをデバイスの既定に設定することで、セキュリティ関連付けパラメーターの使用を許可します。
allowDefaultChildSecurityAssociationParameters ブール値 明示的に指定しない限り、すべてのパラメーターをデバイスの既定に設定することで、子セキュリティ関連付けパラメーターを使用できます。
alwaysOnConfiguration appleVpnAlwaysOnConfiguration AlwaysOn 構成
enableAlwaysOnConfiguration Boolean Always on VPN が有効かどうかを判断します。
mtuSizeInBytes Int32 最大伝送単位。 有効な値 1280 ~ 1400

応答

成功した場合、このメソッドは応答コードと、応答本文で更新された 200 OK iosikEv2VpnConfiguration オブジェクトを返します。

要求

以下は、要求の例です。

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

{
  "@odata.type": "#microsoft.graph.iosikEv2VpnConfiguration",
  "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",
  "childSecurityAssociationParameters": {
    "@odata.type": "microsoft.graph.iosVpnSecurityAssociationParameters",
    "securityEncryptionAlgorithm": "des",
    "securityIntegrityAlgorithm": "sha1_96",
    "securityDiffieHellmanGroup": 10,
    "lifetimeInMinutes": 1
  },
  "clientAuthenticationType": "deviceAuthentication",
  "deadPeerDetectionRate": "none",
  "disableMobilityAndMultihoming": true,
  "disableRedirect": true,
  "enableCertificateRevocationCheck": true,
  "enableEAP": true,
  "enablePerfectForwardSecrecy": true,
  "enableUseInternalSubnetAttributes": true,
  "localIdentifier": "empty",
  "remoteIdentifier": "Remote Identifier value",
  "securityAssociationParameters": {
    "@odata.type": "microsoft.graph.iosVpnSecurityAssociationParameters",
    "securityEncryptionAlgorithm": "des",
    "securityIntegrityAlgorithm": "sha1_96",
    "securityDiffieHellmanGroup": 10,
    "lifetimeInMinutes": 1
  },
  "serverCertificateCommonName": "Server Certificate Common Name value",
  "serverCertificateIssuerCommonName": "Server Certificate Issuer Common Name value",
  "serverCertificateType": "ecdsa256",
  "sharedSecret": "Shared Secret value",
  "tlsMaximumVersion": "Tls Maximum Version value",
  "tlsMinimumVersion": "Tls Minimum Version value",
  "allowDefaultSecurityAssociationParameters": true,
  "allowDefaultChildSecurityAssociationParameters": true,
  "alwaysOnConfiguration": {
    "@odata.type": "microsoft.graph.appleVpnAlwaysOnConfiguration",
    "tunnelConfiguration": "cellular",
    "userToggleEnabled": true,
    "voicemailExceptionAction": "allowTrafficOutside",
    "airPrintExceptionAction": "allowTrafficOutside",
    "cellularExceptionAction": "allowTrafficOutside",
    "allowAllCaptiveNetworkPlugins": true,
    "allowedCaptiveNetworkPlugins": {
      "@odata.type": "microsoft.graph.specifiedCaptiveNetworkPlugins",
      "allowedBundleIdentifiers": [
        "Allowed Bundle Identifiers value"
      ]
    },
    "allowCaptiveWebSheet": true,
    "natKeepAliveIntervalInSeconds": 13,
    "natKeepAliveOffloadEnable": true
  },
  "enableAlwaysOnConfiguration": true,
  "mtuSizeInBytes": 14
}

応答

以下は、応答の例です。注:簡潔にするために、ここに示す応答オブジェクトは切り詰められている場合があります。すべてのプロパティは実際の呼び出しから返されます。

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

{
  "@odata.type": "#microsoft.graph.iosikEv2VpnConfiguration",
  "id": "b87b0327-0327-b87b-2703-7bb827037bb8",
  "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",
  "childSecurityAssociationParameters": {
    "@odata.type": "microsoft.graph.iosVpnSecurityAssociationParameters",
    "securityEncryptionAlgorithm": "des",
    "securityIntegrityAlgorithm": "sha1_96",
    "securityDiffieHellmanGroup": 10,
    "lifetimeInMinutes": 1
  },
  "clientAuthenticationType": "deviceAuthentication",
  "deadPeerDetectionRate": "none",
  "disableMobilityAndMultihoming": true,
  "disableRedirect": true,
  "enableCertificateRevocationCheck": true,
  "enableEAP": true,
  "enablePerfectForwardSecrecy": true,
  "enableUseInternalSubnetAttributes": true,
  "localIdentifier": "empty",
  "remoteIdentifier": "Remote Identifier value",
  "securityAssociationParameters": {
    "@odata.type": "microsoft.graph.iosVpnSecurityAssociationParameters",
    "securityEncryptionAlgorithm": "des",
    "securityIntegrityAlgorithm": "sha1_96",
    "securityDiffieHellmanGroup": 10,
    "lifetimeInMinutes": 1
  },
  "serverCertificateCommonName": "Server Certificate Common Name value",
  "serverCertificateIssuerCommonName": "Server Certificate Issuer Common Name value",
  "serverCertificateType": "ecdsa256",
  "sharedSecret": "Shared Secret value",
  "tlsMaximumVersion": "Tls Maximum Version value",
  "tlsMinimumVersion": "Tls Minimum Version value",
  "allowDefaultSecurityAssociationParameters": true,
  "allowDefaultChildSecurityAssociationParameters": true,
  "alwaysOnConfiguration": {
    "@odata.type": "microsoft.graph.appleVpnAlwaysOnConfiguration",
    "tunnelConfiguration": "cellular",
    "userToggleEnabled": true,
    "voicemailExceptionAction": "allowTrafficOutside",
    "airPrintExceptionAction": "allowTrafficOutside",
    "cellularExceptionAction": "allowTrafficOutside",
    "allowAllCaptiveNetworkPlugins": true,
    "allowedCaptiveNetworkPlugins": {
      "@odata.type": "microsoft.graph.specifiedCaptiveNetworkPlugins",
      "allowedBundleIdentifiers": [
        "Allowed Bundle Identifiers value"
      ]
    },
    "allowCaptiveWebSheet": true,
    "natKeepAliveIntervalInSeconds": 13,
    "natKeepAliveOffloadEnable": true
  },
  "enableAlwaysOnConfiguration": true,
  "mtuSizeInBytes": 14
}