AndroidVpnConfiguration の更新Update androidVpnConfiguration

重要: ベータ版の Microsoft Graph Api は変更される可能性があります。運用環境での使用はサポートされていません。Important: Microsoft Graph APIs under the /beta version are subject to change; production use is not supported.

注: Microsoft Graph API for Intune では、テナントに対してアクティブな intune ライセンスが必要です。Note: The Microsoft Graph API for Intune requires an active Intune license for the tenant.

Androidvpnconfigurationオブジェクトのプロパティを更新します。Update the properties of a androidVpnConfiguration object.

前提条件Prerequisites

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

アクセス許可の種類Permission type アクセス許可 (特権の大きいものから小さいものへ)Permissions (from most to least privileged)
委任 (職場または学校のアカウント)Delegated (work or school account) DeviceManagementConfiguration.ReadWrite.AllDeviceManagementConfiguration.ReadWrite.All
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) サポートされていません。Not supported.
アプリケーションApplication DeviceManagementConfiguration.ReadWrite.AllDeviceManagementConfiguration.ReadWrite.All

HTTP 要求HTTP Request

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

要求ヘッダーRequest headers

ヘッダーHeader Value
AuthorizationAuthorization ベアラー <トークン> が必要です。Bearer <token> Required.
承諾Accept application/jsonapplication/json

要求本文Request body

要求本文で、 Androidvpnconfigurationオブジェクトの JSON 表記を指定します。In the request body, supply a JSON representation for the androidVpnConfiguration object.

次の表に、 Androidvpnconfigurationの作成時に必要なプロパティを示します。The following table shows the properties that are required when you create the androidVpnConfiguration.

プロパティProperty Type 説明Description
idid 文字列String エンティティのキー。Key of the entity. deviceConfiguration から継承しますInherited from deviceConfiguration
lastModifiedDateTimelastModifiedDateTime DateTimeOffsetDateTimeOffset オブジェクトの最終更新の DateTime。DateTime the object was last modified. deviceConfiguration から継承しますInherited from deviceConfiguration
roleScopeTagIdsroleScopeTagIds String コレクションString collection このエンティティインスタンスの範囲タグのリスト。List of Scope Tags for this Entity instance. deviceConfiguration から継承しますInherited from deviceConfiguration
supportsScopeTagssupportsScopeTags ブール値Boolean 基になるデバイス構成がスコープタグの割り当てをサポートしているかどうかを示します。Indicates whether or not the underlying Device Configuration supports the assignment of scope tags. この値が false である場合、ScopeTags プロパティへの割り当ては許可されません。エンティティは、スコープを持つユーザーには表示されません。Assigning to the ScopeTags property is not allowed when this value is false and entities will not be visible to scoped users. これは Silverlight で作成された従来のポリシーに対して実行され、Azure ポータルでポリシーを削除して再作成することによって解決できます。This occurs for Legacy policies created in Silverlight and can be resolved by deleting and recreating the policy in the Azure Portal. このプロパティに値を設定するには、 SetExtrusionDirection メソッドを適用します。This property is read-only. deviceConfiguration から継承しますInherited from deviceConfiguration
deviceManagementApplicabilityRuleOsEditiondeviceManagementApplicabilityRuleOsEdition deviceManagementApplicabilityRuleOsEditiondeviceManagementApplicabilityRuleOsEdition このポリシーの OS エディションの適用。The OS edition applicability for this Policy. deviceConfiguration から継承しますInherited from deviceConfiguration
deviceManagementApplicabilityRuleOsVersiondeviceManagementApplicabilityRuleOsVersion deviceManagementApplicabilityRuleOsVersiondeviceManagementApplicabilityRuleOsVersion このポリシーの OS バージョン適用ルール。The OS version applicability rule for this Policy. deviceConfiguration から継承しますInherited from deviceConfiguration
deviceManagementApplicabilityRuleDeviceModedeviceManagementApplicabilityRuleDeviceMode deviceManagementApplicabilityRuleDeviceModedeviceManagementApplicabilityRuleDeviceMode このポリシーのデバイスモード適用ルール。The device mode applicability rule for this Policy. deviceConfiguration から継承しますInherited from deviceConfiguration
createdDateTimecreatedDateTime DateTimeOffsetDateTimeOffset オブジェクトが作成された DateTime。DateTime the object was created. deviceConfiguration から継承しますInherited from deviceConfiguration
説明description StringString 管理者が指定した、デバイス構成についての説明。Admin provided description of the Device Configuration. deviceConfiguration から継承しますInherited from deviceConfiguration
displayNamedisplayName StringString 管理者が指定した、デバイス構成の名前。Admin provided name of the device configuration. deviceConfiguration から継承しますInherited from deviceConfiguration
versionversion Int32Int32 デバイス構成のバージョン。Version of the device configuration. deviceConfiguration から継承しますInherited from deviceConfiguration
connectionNameconnectionName StringString ユーザーに表示される接続名。Connection name displayed to the user.
connectionTypeconnectionType androidVpnConnectionTypeandroidVpnConnectionType 接続の種類。Connection type. 使用可能な値: ciscoAnyConnectpulseSecuref5EdgeClientdellSonicWallMobileConnectcheckPointCapsuleVpncitrixPossible values are: ciscoAnyConnect, pulseSecure, f5EdgeClient, dellSonicWallMobileConnect, checkPointCapsuleVpn, citrix.
rolerole StringString 接続の種類がパルス Secure に設定されている場合の役割。Role when connection type is set to Pulse Secure.
領域realm StringString 接続の種類がパルス Secure に設定されている場合の領域。Realm when connection type is set to Pulse Secure.
サーバservers vpnServerコレクションvpnServer collection ネットワーク上の VPN サーバーの一覧。List of VPN Servers on the network. エンドユーザーがこれらのネットワークの場所にアクセスできることを確認します。Make sure end users can access these network locations. このコレクションには、最大で 500 個の要素を含めることができます。This collection can contain a maximum of 500 elements.
デジタルfingerprint StringString フィンガープリントは、VPN サーバーが信頼できることを確認するために使用される文字列です。これは、接続の種類が [チェックポイントカプセル VPN] の場合にのみ適用されます。Fingerprint is a string that will be used to verify the VPN server can be trusted, which is only applicable when connection type is Check Point Capsule VPN.
customDatacustomData keyvalue コレクションkeyValue collection 接続の種類が Citrix に設定されている場合のカスタムデータ。Custom data when connection type is set to Citrix. このコレクションには、最大25個の要素を含めることができます。This collection can contain a maximum of 25 elements.
customKeyValueDatacustomKeyValueData keyValuePair コレクションkeyValuePair collection 接続の種類が Citrix に設定されている場合のカスタムデータ。Custom data when connection type is set to Citrix. このコレクションには、最大25個の要素を含めることができます。This collection can contain a maximum of 25 elements.
authenticationMethodauthenticationMethod vpnAuthenticationMethodvpnAuthenticationMethod 認証方法。Authentication method. 可能な値は、certificateusernameAndPasswordsharedSecretderivedCredential です。Possible values are: certificate, usernameAndPassword, sharedSecret, derivedCredential.

応答Response

成功した場合、このメソッド200 OKは応答コードと、応答本文で更新されたAndroidvpnconfigurationオブジェクトを返します。If successful, this method returns a 200 OK response code and an updated androidVpnConfiguration object in the response body.

Example

要求Request

以下は、要求の例です。Here is an example of the request.

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

{
  "@odata.type": "#microsoft.graph.androidVpnConfiguration",
  "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",
  "role": "Role value",
  "realm": "Realm value",
  "servers": [
    {
      "@odata.type": "microsoft.graph.vpnServer",
      "description": "Description value",
      "address": "Address value",
      "isDefaultServer": true
    }
  ],
  "fingerprint": "Fingerprint 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"
    }
  ],
  "authenticationMethod": "usernameAndPassword"
}

応答Response

以下は、応答の例です。注:簡潔にするために、ここに示す応答オブジェクトは切り詰められている場合があります。すべてのプロパティは実際の呼び出しから返されます。Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

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

{
  "@odata.type": "#microsoft.graph.androidVpnConfiguration",
  "id": "d4c48852-8852-d4c4-5288-c4d45288c4d4",
  "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",
  "role": "Role value",
  "realm": "Realm value",
  "servers": [
    {
      "@odata.type": "microsoft.graph.vpnServer",
      "description": "Description value",
      "address": "Address value",
      "isDefaultServer": true
    }
  ],
  "fingerprint": "Fingerprint 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"
    }
  ],
  "authenticationMethod": "usernameAndPassword"
}