iosVpnConfiguration を作成する

[アーティクル]
10/25/2023

名前空間: microsoft.graph

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

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

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

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

アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

アクセス許可の種類	アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント)	DeviceManagementConfiguration.ReadWrite.All
委任 (個人用 Microsoft アカウント)	サポートされていません。
アプリケーション	DeviceManagementConfiguration.ReadWrite.All

HTTP 要求

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

要求ヘッダー

ヘッダー	値
Authorization	ベアラー {token}。必須です。認証と承認の詳細については、こちらをご覧ください。
承諾	application/json

要求本文

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

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

プロパティ	型	説明
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	ユーザーに表示される接続名。 appleVpnConfiguration から継承
connectionType	appleVpnConnectionType	接続の種類。 appleVpnConfiguration から継承されます。使用可能な値は、`ciscoAnyConnectpulseSecuredellSonicWallMobileConnectf5EdgeClient`、、`checkPointCapsuleVpn`、、`customVpn`、`ciscoIPSec`、、`citrix`、 `paloAltoGlobalProtectalwaysOnmicrosoftTunnelnetMotionMobilityciscoAnyConnectV2f5Access2018microsoftProtectzscalerPrivateAccesscitrixSsopaloAltoGlobalProtectV2ikEv2`です。
loginGroupOrDomain	String	接続の種類が Dell SonicWALL Mobile Connection に設定されている場合のログイングループまたはドメイン。 appleVpnConfiguration から継承
role	String	接続の種類が Pulse Secure に設定されている場合のロール。 appleVpnConfiguration から継承
王国	String	接続の種類が Pulse Secure に設定されている場合の領域。 appleVpnConfiguration から継承
サーバー	vpnServer	ネットワーク上の VPN サーバー。エンドユーザーがこのネットワークの場所にアクセスできることを確認します。 appleVpnConfiguration から継承
識別子	String	接続の種類がカスタム VPN に設定されている場合に、VPN ベンダーによって提供される識別子。例: Cisco AnyConnect は、appleVpnConfiguration から継承された com.cisco.anyconnect.applevpn.plugin という形式の識別子を使用します
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 iOS デバイスでこの VPN コネシトンをトリガーできるアプリに関連付けることができる VPN ペイロードが作成されます。 appleVpnConfiguration から継承
safariDomains	String collection	アプリごとのこの VPN 設定が有効になっている場合の Safari ドメイン。この VPN に関連付けられているアプリに加えて、ここで指定した Safari ドメインもこの VPN 接続をトリガーできます。 appleVpnConfiguration から継承
onDemandRules	vpnOnDemandRule コレクション	オンデマンドルール。このコレクションには、最大で 500 個の要素を含めることができます。 appleVpnConfiguration から継承
providerType	vpnProviderType	アプリごとの VPN のプロバイダーの種類。 appleVpnConfiguration から継承されます。可能な値は `notConfigured`、`appProxy`、`packetTunnel` です。
associatedDomains	String collection	appleVpnConfiguration から継承された関連ドメイン
excludedDomains	String collection	アプリごとの VPN がアクティブ化されている場合でも、VPN ではなくパブリックインターネット経由でアクセスされるドメイン appleVpnConfiguration から継承
disableOnDemandUserOverride	ブール型	AppleVpnConfiguration から継承された設定アプリでユーザーが自動 VPN を無効にできないように切り替える
disconnectOnIdle	ブール型	オンデマンド接続アイドル後に切断するかどうか appleVpnConfiguration から継承
disconnectOnIdleTimerInSeconds	Int32	オンデマンド接続を切断するまでの待機時間 (秒単位)。有効な値 0 から 65535 appleVpnConfiguration から継承
proxyServer	vpnProxyServer	プロキシサーバー。 appleVpnConfiguration から継承
optInToDeviceIdSharing	ブール型	ネットワークアクセス制御の検証中に使用するために、デバイスの ID をサードパーティの vpn クライアントに共有する Opt-In。 appleVpnConfiguration から継承
userDomain	String	Zscaler のみ。 Zscaler アプリでログインフィールドに事前設定する静的ドメインを入力します。空のままにすると、代わりにユーザーの Azure Active Directory ドメインが使用されます。
strictEnforcement	ブール型	Zscaler のみ。ユーザーが Zscaler アプリにサインインするまで、ネットワークトラフィックをブロックします。 "True" は、トラフィックがブロックされていることを意味します。
cloudName	String	Zscaler のみ。ユーザーが割り当てられている Zscaler クラウド。
excludeList	String collection	Zscaler のみ。 Zscaler クラウドを介して送信されないネットワークアドレスの一覧。
targetedMobileApps	appListItem コレクション	対象となるモバイルアプリ。このコレクションには、最大で 500 個の要素を含めることができます。
microsoftTunnelSiteId	String	Microsoft Tunnel サイト ID。

応答

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