macOSVpnConfiguration の更新

[アーティクル]
09/13/2021

名前空間: microsoft.graph

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

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

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

前提条件

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

要求本文

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

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

プロパティ	型	説明
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 から継承されます。可能な値は、`certificate`、`usernameAndPassword`、`sharedSecret`、`derivedCredential`、`azureAD` です。
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 から継承されます。可能な値は、`notConfigured`、`appProxy`、`packetTunnel` です。
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 から継承

応答

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

例

要求

以下は、要求の例です。

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

{
  "@odata.type": "#microsoft.graph.macOSVpnConfiguration",
  "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
}

応答

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

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

{
  "@odata.type": "#microsoft.graph.macOSVpnConfiguration",
  "id": "8ce00178-0178-8ce0-7801-e08c7801e08c",
  "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
}

macOSVpnConfiguration の更新

前提条件

HTTP 要求

要求ヘッダー

要求本文

応答

例

要求

応答

フィードバック