Connections - Create Connection

サービス:: Core

API バージョン:: v1

接続を作成します。
資格情報を暗号化するには、「資格情報をプログラムで構成する」を参照してください。

Permissions

ゲートウェイ接続を作成する場合、呼び出し元にはゲートウェイのアクセス許可が必要です。
サービスプリンシパルには、Fabric 管理者によって付与されたアクセス許可が必要です。詳細については、「サービスプリンシパルはワークスペース、接続、デプロイパイプラインを作成できます。」を参照してください。

必要な委任されたスコープ

Connection.ReadWrite.All

Microsoft Entra でサポートされている ID

この API では、このセクションに記載されている Microsoft ID がサポートされています。

Identity	Support
User	Yes
サービスプリンシパルのとマネージド ID の	Yes

Interface

POST https://api.fabric.microsoft.com/v1/connections

要求本文

要求本文は、次のいずれかの可能性があります。

名前	説明
CreateCloudConnectionRequest
CreateOnPremisesConnectionRequest
CreateVirtualNetworkGatewayConnectionRequest

CreateCloudConnectionRequest

名前	必須	型	説明
connectionDetails	True	CreateConnectionDetails	接続の接続の詳細。
connectivityType	True	string: ShareableCloud	接続の接続の種類。
credentialDetails	True	CreateCredentialDetails	接続の資格情報の詳細。
displayName	True	string	接続の表示名。最大長は 200 文字です。
allowConnectionUsageInGateway		boolean	この接続をオンプレミスのデータゲートウェイまたは VNet データゲートウェイで使用できるようにします。
privacyLevel		PrivacyLevel	(省略可能)接続のプライバシーレベル。値が渡されない場合、これは "組織" に設定されます。

CreateOnPremisesConnectionRequest

名前	必須	型	説明
connectionDetails	True	CreateConnectionDetails	接続の接続の詳細。
connectivityType	True	string: OnPremisesGateway	接続の接続の種類。
credentialDetails	True	CreateOnPremisesCredentialDetails	接続の資格情報の詳細。
displayName	True	string	接続の表示名。最大長は 200 文字です。
gatewayId	True	string (uuid)	接続が作成されるオンプレミスゲートウェイのプライマリゲートウェイのオブジェクト ID。
privacyLevel		PrivacyLevel	(省略可能)接続のプライバシーレベル。値が渡されない場合、これは "組織" に設定されます。

CreateVirtualNetworkGatewayConnectionRequest

名前	必須	型	説明
connectionDetails	True	CreateConnectionDetails	接続の接続の詳細。
connectivityType	True	string: VirtualNetworkGateway	接続の接続の種類。
credentialDetails	True	CreateCredentialDetails	接続の資格情報の詳細。
displayName	True	string	接続の表示名。最大長は 200 文字です。
gatewayId	True	string (uuid)	接続が作成される仮想ネットワークゲートウェイのオブジェクト ID。
privacyLevel		PrivacyLevel	(省略可能)接続のプライバシーレベル。値が渡されない場合、これは "組織" に設定されます。

応答

名前	型	説明
201 Created	Connection: ShareableCloudConnection PersonalCloudConnection OnPremisesGatewayConnection OnPremisesGatewayPersonalConnection VirtualNetworkGatewayConnection	Created. 操作が成功しました。
Other Status Codes	ErrorResponse	一般的なエラーコード: DuplicateConnectionName - 接続名は既に使用されています。 InvalidConnectionDetails - 指定された ConnectionDetails 入力が無効です。 InvalidCredentialDetails - 指定された CredentialDetails 入力が無効です。 IncorrectCredentials - 資格情報入力を使用して接続を確立できませんでした。 CreateGatewayConnectionFailed - ゲートウェイ接続の作成に失敗しました。

名前

型

説明

201 Created

Connection:

ShareableCloudConnection
PersonalCloudConnection
OnPremisesGatewayConnection
OnPremisesGatewayPersonalConnection
VirtualNetworkGatewayConnection

Created. 操作が成功しました。

Other Status Codes

ErrorResponse

一般的なエラーコード:

DuplicateConnectionName - 接続名は既に使用されています。
InvalidConnectionDetails - 指定された ConnectionDetails 入力が無効です。
InvalidCredentialDetails - 指定された CredentialDetails 入力が無効です。
IncorrectCredentials - 資格情報入力を使用して接続を確立できませんでした。
CreateGatewayConnectionFailed - ゲートウェイ接続の作成に失敗しました。

例

Cloud example

On-premises gateway example

Virtual network gateway example

Cloud example

要求のサンプル

HTTP

POST https://api.fabric.microsoft.com/v1/connections

{
  "connectivityType": "ShareableCloud",
  "displayName": "ContosoCloudConnection",
  "connectionDetails": {
    "type": "SQL",
    "creationMethod": "SQL",
    "parameters": [
      {
        "dataType": "Text",
        "name": "server",
        "value": "contoso.database.windows.net"
      },
      {
        "dataType": "Text",
        "name": "database",
        "value": "sales"
      }
    ]
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false,
    "credentials": {
      "credentialType": "Basic",
      "username": "admin",
      "password": "********"
    }
  }
}

応答のサンプル

状態コード:: 201

{
  "id": "eeec9a3a-6ef5-4e2b-bb6a-0060bd2f0172",
  "displayName": "ContosoCloudConnection",
  "connectivityType": "ShareableCloud",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;sales"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "Basic",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false
  }
}

On-premises gateway example

要求のサンプル

HTTP

POST https://api.fabric.microsoft.com/v1/connections

{
  "connectivityType": "OnPremisesGateway",
  "gatewayId": "93491300-cfbd-402f-bf17-9ace59a92354",
  "displayName": "ContosoOnPremisesConnection",
  "connectionDetails": {
    "type": "SQL",
    "creationMethod": "SQL",
    "parameters": [
      {
        "dataType": "Text",
        "name": "server",
        "value": "contoso.database.windows.net"
      },
      {
        "dataType": "Text",
        "name": "database",
        "value": "sales"
      }
    ]
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false,
    "credentials": {
      "credentialType": "Windows",
      "values": [
        {
          "gatewayId": "93491300-cfbd-402f-bf17-9ace59a92354",
          "encryptedCredentials": "************************************"
        },
        {
          "gatewayId": "55226bab-5024-4b72-9716-6dc8ef3a97fe",
          "encryptedCredentials": "************************************"
        }
      ]
    }
  }
}

応答のサンプル

状態コード:: 201

{
  "id": "eeec9a3a-6ef5-4e2b-bb6a-0060bd2f0172",
  "displayName": "ContosoOnPremisesConnection",
  "gatewayId": "93491300-cfbd-402f-bf17-9ace59a92354",
  "connectivityType": "OnPremisesGateway",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;sales"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "Basic",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false
  }
}

Virtual network gateway example

要求のサンプル

HTTP

POST https://api.fabric.microsoft.com/v1/connections

{
  "connectivityType": "VirtualNetworkGateway",
  "gatewayId": "93491300-cfbd-402f-bf17-9ace59a92354",
  "displayName": "ContosoVirtualNetworkGatewayConnection",
  "connectionDetails": {
    "type": "SQL",
    "creationMethod": "SQL",
    "parameters": [
      {
        "dataType": "Text",
        "name": "server",
        "value": "contoso.database.windows.net"
      },
      {
        "dataType": "Text",
        "name": "database",
        "value": "sales"
      }
    ]
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "singleSignOnType": "None",
    "connectionEncryption": "Encrypted",
    "skipTestConnection": false,
    "credentials": {
      "credentialType": "Basic",
      "username": "admin",
      "password": "*********"
    }
  }
}

応答のサンプル

状態コード:: 201

{
  "id": "eeec9a3a-6ef5-4e2b-bb6a-0060bd2f0172",
  "displayName": "ContosoVirtualNetworkGatewayConnection",
  "gatewayId": "93491300-cfbd-402f-bf17-9ace59a92354",
  "connectivityType": "VirtualNetworkGateway",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;sales"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "Basic",
    "singleSignOnType": "None",
    "connectionEncryption": "Encrypted",
    "skipTestConnection": false
  }
}

定義

名前	説明
AnonymousCredentials	匿名 CredentialType の資格情報。
BasicCredentials	Basic CredentialType の資格情報。
ConnectionDetailsBooleanParameter	Boolean dataType の ConnectionDetailsParameter。
ConnectionDetailsDateParameter	date dataType の ConnectionDetailsParameter。
ConnectionDetailsDateTimeParameter	dateTime dataType の ConnectionDetailsParameter。
ConnectionDetailsDateTimeZoneParameter	dateTimeZone dataType の ConnectionDetailsParameter。
ConnectionDetailsDurationParameter	期間 dataType の ConnectionDetailsParameter。
ConnectionDetailsNumberParameter	number dataType の ConnectionDetailsParameter。
ConnectionDetailsTextParameter	Text dataType の ConnectionDetailsParameter。
ConnectionDetailsTimeParameter	Time dataType の ConnectionDetailsParameter。
ConnectionEncryption	接続の暗号化の種類。接続暗号化の値は、時間の経過と同時に追加される場合があります。
ConnectivityType	接続の接続の種類。追加の接続の種類は、時間の経過と同時に追加される場合があります。
CreateCloudConnectionRequest
CreateConnectionDetails	作成操作の接続の詳細入力。
CreateCredentialDetails	接続を作成するための資格情報の詳細入力。
CreateOnPremisesConnectionRequest
CreateOnPremisesCredentialDetails	オンプレミスゲートウェイ接続を作成するための資格情報の詳細入力。
CreateVirtualNetworkGatewayConnectionRequest
CredentialType	接続の資格情報の種類。追加の資格情報の種類は、時間の経過と同時に追加される場合があります。
DataType	接続作成パラメーター値のデータ型。追加のデータ型の値は、時間の経過と同時に追加される場合があります。
ErrorRelatedResource	エラー関連のリソース詳細オブジェクト。
ErrorResponse	エラー応答。
ErrorResponseDetails	エラー応答の詳細。
KeyCredentials	Key CredentialType の資格情報。
ListConnectionDetails	リスト操作の接続の詳細出力。
ListCredentialDetails	接続をフェッチするときに返される資格情報の詳細。
OnPremisesCredentialEntry	ゲートウェイ ID とその暗号化されたシリアル化された資格情報。
OnPremisesGatewayConnection	オンプレミスデータゲートウェイ経由で接続する接続。
OnPremisesGatewayCredentials	オンプレミスゲートウェイを介して認証するための資格情報。
OnPremisesGatewayPersonalConnection	個人のオンプレミスデータゲートウェイを介して接続する接続。
PersonalCloudConnection	クラウド経由で接続され、共有できない接続。
PrivacyLevel	接続のプライバシーレベルの設定。時間の経過と同時に、追加のプライバシーレベルが追加される場合があります。
ServicePrincipalCredentials	ServicePrincipal CredentialType の資格情報。
ShareableCloudConnection	クラウド経由で接続する接続。
SharedAccessSignatureCredentials	SharedAccessSignature CredentialType の資格情報。
SingleSignOnType	接続のシングルサインオンの種類。追加のシングルサインオンの種類は、時間の経過と同時に追加される場合があります。
VirtualNetworkGatewayConnection	仮想ネットワークデータゲートウェイを介して接続する接続。
WindowsCredentials	Windows CredentialType の資格情報。
WindowsWithoutImpersonationCredentials	WindowsWithoutImpersonation CredentialType の資格情報。
WorkspaceIdentityCredentials	WorkspaceIdentity CredentialType の資格情報。

AnonymousCredentials

Object

匿名 CredentialType の資格情報。

名前	型	説明
credentialType	string: Anonymous	接続の資格情報の種類。

BasicCredentials

Object

Basic CredentialType の資格情報。

名前	型	説明
credentialType	string: Basic	接続の資格情報の種類。
password	string	The password.
username	string	The username.

ConnectionDetailsBooleanParameter

Object

Boolean dataType の ConnectionDetailsParameter。

名前	型	説明
dataType	string: Boolean	パラメーターのデータ型。
name	string	パラメーターの名前。
value	boolean	ブール値。

ConnectionDetailsDateParameter

Object

date dataType の ConnectionDetailsParameter。

名前	型	説明
dataType	string: Date	パラメーターのデータ型。
name	string	パラメーターの名前。
value	string (date)	YYYY-MM-DD 形式を使用した日付値。

ConnectionDetailsDateTimeParameter

Object

dateTime dataType の ConnectionDetailsParameter。

名前	型	説明
dataType	string: DateTime	パラメーターのデータ型。
name	string	パラメーターの名前。
value	string (date-time)	YYYY-MM-DDTHH:mm:ss を使用した日付時刻の値。FFFZ 形式。

ConnectionDetailsDateTimeZoneParameter

Object

dateTimeZone dataType の ConnectionDetailsParameter。

名前	型	説明
dataType	string: DateTimeZone	パラメーターのデータ型。
name	string	パラメーターの名前。
value	string (date-time-offset)	YYYY-MM-DDTHH:mm:ss を使用した日付タイムゾーンの値。FFF±h:mm 形式。

ConnectionDetailsDurationParameter

Object

期間 dataType の ConnectionDetailsParameter。

名前	型	説明
dataType	string: Duration	パラメーターのデータ型。
name	string	パラメーターの名前。
value	string (time-span)	[-]P(n)DT(n)H(n)M(n)S 形式を使用する期間の値。例: P3DT4H30M10S (3 日間、4 時間、30 分、10 秒)。

ConnectionDetailsNumberParameter

Object

number dataType の ConnectionDetailsParameter。

名前	型	説明
dataType	string: Number	パラメーターのデータ型。
name	string	パラメーターの名前。
value	number	数値。

ConnectionDetailsTextParameter

Object

Text dataType の ConnectionDetailsParameter。

名前	型	説明
dataType	string: Text	パラメーターのデータ型。
name	string	パラメーターの名前。
value	string	テキスト値。

ConnectionDetailsTimeParameter

Object

Time dataType の ConnectionDetailsParameter。

名前	型	説明
dataType	string: Time	パラメーターのデータ型。
name	string	パラメーターの名前。
value	string (time)	HH:mm:ss を使用した時間値。FFFZ 形式。

ConnectionEncryption

列挙

接続の暗号化の種類。接続暗号化の値は、時間の経過と同時に追加される場合があります。

値	説明
Encrypted	接続の試行は、暗号化された接続を使用して行われます。
Any	接続の試行は、最初に暗号化された接続を使用して行われ、失敗した場合は暗号化されていない接続にフォールバックします。
NotEncrypted	暗号化されていない接続を使用して接続が試行されます。

ConnectivityType

列挙

接続の接続の種類。追加の接続の種類は、時間の経過と同時に追加される場合があります。

値	説明
ShareableCloud	接続はクラウド経由で接続され、他のユーザーと共有できます。
PersonalCloud	接続はクラウド経由で接続され、他のユーザーと共有することはできません。
OnPremisesGateway	接続は、オンプレミスのデータゲートウェイを介して接続します。
OnPremisesGatewayPersonal	接続は、個人用のオンプレミスデータゲートウェイ経由で接続されます。
VirtualNetworkGateway	接続は、仮想ネットワークデータゲートウェイを介して接続します。
Automatic	接続は、暗黙的なデータ接続を使用してクラウド経由で接続します。このオプションは、シングル Sign-On (SSO) を使用するセマンティックモデルなどの特定のシナリオでのみ使用できます。
None	接続がバインドされていません

CreateCloudConnectionRequest

Object

名前	型	説明
allowConnectionUsageInGateway	boolean	この接続をオンプレミスのデータゲートウェイまたは VNet データゲートウェイで使用できるようにします。
connectionDetails	CreateConnectionDetails	接続の接続の詳細。
connectivityType	string: ShareableCloud	接続の接続の種類。
credentialDetails	CreateCredentialDetails	接続の資格情報の詳細。
displayName	string	接続の表示名。最大長は 200 文字です。
privacyLevel	PrivacyLevel	(省略可能)接続のプライバシーレベル。値が渡されない場合、これは "組織" に設定されます。

CreateConnectionDetails

Object

作成操作の接続の詳細入力。

名前	型	説明
creationMethod	string	接続の作成に使用する作成方法。作成方法の一覧には、 ListSupportedConnectionTypes API を使用します。
parameters	ConnectionDetailsParameter[]: ConnectionDetailsBooleanParameter[] ConnectionDetailsDateParameter[] ConnectionDetailsDateTimeParameter[] ConnectionDetailsDateTimeZoneParameter[] ConnectionDetailsDurationParameter[] ConnectionDetailsNumberParameter[] ConnectionDetailsTextParameter[] ConnectionDetailsTimeParameter[]	接続パラメーターの一覧。各作成方法のパラメーターの一覧には、ListSupportedConnectionTypes API を使用します。
type	string	接続の種類。

CreateCredentialDetails

Object

接続を作成するための資格情報の詳細入力。

名前	型	説明
connectionEncryption	ConnectionEncryption	(省略可能)テスト接続中に使用される接続暗号化設定。値が渡されない場合、接続は暗号化されません。
credentials	Credentials: AnonymousCredentials BasicCredentials KeyCredentials ServicePrincipalCredentials SharedAccessSignatureCredentials WindowsCredentials WindowsWithoutImpersonationCredentials WorkspaceIdentityCredentials	接続の資格情報。
singleSignOnType	SingleSignOnType	(省略可能)接続のシングルサインオンの種類。値が渡されない場合、接続ではシングルサインオンは使用されません。
skipTestConnection	boolean	接続の作成時と更新時にテスト接続をスキップする必要があるかどうか。 True - テスト接続をスキップします。False - テスト接続をスキップしないでください。値が渡されない場合、これは 'False' に設定されます。

CreateOnPremisesConnectionRequest

Object

名前	型	説明
connectionDetails	CreateConnectionDetails	接続の接続の詳細。
connectivityType	string: OnPremisesGateway	接続の接続の種類。
credentialDetails	CreateOnPremisesCredentialDetails	接続の資格情報の詳細。
displayName	string	接続の表示名。最大長は 200 文字です。
gatewayId	string (uuid)	接続が作成されるオンプレミスゲートウェイのプライマリゲートウェイのオブジェクト ID。
privacyLevel	PrivacyLevel	(省略可能)接続のプライバシーレベル。値が渡されない場合、これは "組織" に設定されます。

CreateOnPremisesCredentialDetails

Object

オンプレミスゲートウェイ接続を作成するための資格情報の詳細入力。

名前	型	説明
connectionEncryption	ConnectionEncryption	(省略可能)テスト接続中に使用される接続暗号化設定。値が渡されない場合、接続は暗号化されません。
credentials	OnPremisesGatewayCredentials	接続の資格情報。
singleSignOnType	SingleSignOnType	(省略可能)接続のシングルサインオンの種類。値が渡されない場合、接続ではシングルサインオンは使用されません。
skipTestConnection	boolean	接続の作成時と更新時にテスト接続をスキップする必要があるかどうか。 True - テスト接続をスキップします。False - テスト接続をスキップしないでください。値が渡されない場合、これは 'False' に設定されます。

CreateVirtualNetworkGatewayConnectionRequest

Object

名前	型	説明
connectionDetails	CreateConnectionDetails	接続の接続の詳細。
connectivityType	string: VirtualNetworkGateway	接続の接続の種類。
credentialDetails	CreateCredentialDetails	接続の資格情報の詳細。
displayName	string	接続の表示名。最大長は 200 文字です。
gatewayId	string (uuid)	接続が作成される仮想ネットワークゲートウェイのオブジェクト ID。
privacyLevel	PrivacyLevel	(省略可能)接続のプライバシーレベル。値が渡されない場合、これは "組織" に設定されます。

CredentialType

列挙

接続の資格情報の種類。追加の資格情報の種類は、時間の経過と同時に追加される場合があります。

値	説明
Windows	接続では、Windows 認証を使用して接続します。オンプレミスゲートウェイでのみサポートされます。
Anonymous	接続では、匿名認証を使用して接続します。
Basic	接続では、基本認証を使用して接続します。
Key	接続では、キー認証を使用して接続します。
OAuth2	接続では、OAuth 2.0 認証を使用して接続します。
WindowsWithoutImpersonation	接続では、Windows (偽装のオプションなし) 認証を使用して接続します。オンプレミスゲートウェイ (個人用モード) でのみサポートされます。
SharedAccessSignature	接続では、Shared Access Signature (SAS) 認証を使用して接続します。
ServicePrincipal	接続では、サービスプリンシパル認証を使用して接続します。
WorkspaceIdentity	接続では、ワークスペース ID 認証を使用して接続します。

DataType

列挙

接続作成パラメーター値のデータ型。追加のデータ型の値は、時間の経過と同時に追加される場合があります。

値	説明
Text	パラメーター入力値としてテキストを使用します。
Number	パラメーターの入力値として数値 (整数または浮動小数点) を使用します。
Boolean	パラメーター入力値としてブール値を使用します。 False - 値が false、True - 値が true です。
Duration	[-]P(n)DT(n)H(n)M(n)S 形式を使用して、パラメーター入力値として duration を使用します。例: P3DT4H30M10S (3 日間、4 時間、30 分、10 秒)。
Date	YYYY-MM-DD 形式を使用して、パラメーター入力値として日付を使用します。
DateTime	YYYY-MM-DDTHH:mm:ss を使用して、日付時刻をパラメーター入力値として使用します。FFFZ 形式。
DateTimeZone	YYYY-MM-DDTHH:mm:ss を使用して、日付タイムゾーンをパラメーター入力値として使用します。FFF±h:mm 形式。
Time	HH:mm:ss を使用して、パラメーター入力値として時間を使用します。FFFZ 形式。

ErrorRelatedResource

Object

エラー関連のリソース詳細オブジェクト。

名前	型	説明
resourceId	string	エラーに関係するリソース ID。
resourceType	string	エラーに関係するリソースの種類。

ErrorResponse

Object

エラー応答。

名前	型	説明
errorCode	string	エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message	string	エラーの人間が判読できる表現。
moreDetails	ErrorResponseDetails[]	その他のエラーの詳細の一覧。
relatedResource	ErrorRelatedResource	エラー関連のリソースの詳細。
requestId	string	エラーに関連付けられている要求の ID。

ErrorResponseDetails

Object

エラー応答の詳細。

名前	型	説明
errorCode	string	エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message	string	エラーの人間が判読できる表現。
relatedResource	ErrorRelatedResource	エラー関連のリソースの詳細。

KeyCredentials

Object

Key CredentialType の資格情報。

名前	型	説明
credentialType	string: Key	接続の資格情報の種類。
key	string	The key.

ListConnectionDetails

Object

リスト操作の接続の詳細出力。

名前	型	説明
path	string	接続のパス。
type	string	接続の種類。

ListCredentialDetails

Object

接続をフェッチするときに返される資格情報の詳細。

名前	型	説明
connectionEncryption	ConnectionEncryption	テスト接続中に使用される接続暗号化設定。
credentialType	CredentialType	接続の資格情報の種類。
singleSignOnType	SingleSignOnType	接続のシングルサインオンの種類。
skipTestConnection	boolean	接続の作成時と更新時にテスト接続をスキップする必要があるかどうか。 True - テスト接続をスキップします。False - テスト接続をスキップしないでください。

OnPremisesCredentialEntry

Object

ゲートウェイ ID とその暗号化されたシリアル化された資格情報。

名前	型	説明
encryptedCredentials	string	名前と値のペアの一覧の、暗号化されたシリアル化された .json。名前は資格情報の名前で、値は資格情報の値です。暗号化は、オンプレミスゲートウェイメンバーの公開キーを使用して Rivest-Shamir-Adleman (RSA) 暗号化アルゴリズムを使用して実行されます。
gatewayId	string (uuid)	ゲートウェイのオブジェクト ID。

OnPremisesGatewayConnection

Object

オンプレミスデータゲートウェイ経由で接続する接続。

名前	型	説明
connectionDetails	ListConnectionDetails	接続の接続の詳細。
connectivityType	string: OnPremisesGateway	接続の接続の種類。
credentialDetails	ListCredentialDetails	接続の資格情報の詳細。
displayName	string	接続の表示名。
gatewayId	string (uuid)	接続のゲートウェイオブジェクト ID。
id	string (uuid)	接続のオブジェクト ID。
privacyLevel	PrivacyLevel	接続のプライバシーレベル。

OnPremisesGatewayCredentials

Object

オンプレミスゲートウェイを介して認証するための資格情報。

名前	型	説明
credentialType	CredentialType	接続の資格情報の種類。
values	OnPremisesCredentialEntry[]	オンプレミスゲートウェイに送信する資格情報ペイロード。

OnPremisesGatewayPersonalConnection

Object

個人のオンプレミスデータゲートウェイを介して接続する接続。

名前	型	説明
connectionDetails	ListConnectionDetails	接続の接続の詳細。
connectivityType	string: OnPremisesGatewayPersonal	接続の接続の種類。
credentialDetails	ListCredentialDetails	接続の資格情報の詳細。
displayName	string	接続の表示名。
gatewayId	string (uuid)	接続のゲートウェイオブジェクト ID。
id	string (uuid)	接続のオブジェクト ID。
privacyLevel	PrivacyLevel	接続のプライバシーレベル。

PersonalCloudConnection

Object

クラウド経由で接続され、共有できない接続。

名前	型	説明
allowConnectionUsageInGateway	boolean	この接続をオンプレミスのデータゲートウェイまたは VNet データゲートウェイで使用できるようにします。
connectionDetails	ListConnectionDetails	接続の接続の詳細。
connectivityType	string: PersonalCloud	接続の接続の種類。
credentialDetails	ListCredentialDetails	接続の資格情報の詳細。
displayName	string	接続の表示名。
id	string (uuid)	接続のオブジェクト ID。
privacyLevel	PrivacyLevel	接続のプライバシーレベル。

PrivacyLevel

列挙

接続のプライバシーレベルの設定。時間の経過と同時に、追加のプライバシーレベルが追加される場合があります。

値	説明
None	プライバシーレベルの設定は構成されません。
Private	プライベートに設定された接続には、機密情報または機密情報が含まれます。可視性は、承認されたユーザーに制限できます。プライベート接続からのデータは、他のプライベート接続を含む他の接続にフォールインされません。
Organizational	組織に設定された接続は、プライベートやその他の組織の接続に折りたたむことができます。パブリック接続にフォールインすることはできません。可視性は信頼されたグループに設定されます。
Public	ファイル、インターネット接続、ブックデータをパブリックに設定できます。データは他の接続にフォールインできます。可視性は、すべてのユーザーが利用できます。

ServicePrincipalCredentials

Object

ServicePrincipal CredentialType の資格情報。

名前	型	説明
credentialType	string: ServicePrincipal	接続の資格情報の種類。
servicePrincipalClientId	string (uuid)	サービスプリンシパルのクライアント ID。
servicePrincipalSecret	string	サービスプリンシパルのシークレット。
tenantId	string (uuid)	サービスプリンシパルのテナント ID。

ShareableCloudConnection

Object

クラウド経由で接続する接続。

名前	型	説明
allowConnectionUsageInGateway	boolean	この接続をオンプレミスのデータゲートウェイまたは VNet データゲートウェイで使用できるようにします。
connectionDetails	ListConnectionDetails	接続の接続の詳細。
connectivityType	string: ShareableCloud	接続の接続の種類。
credentialDetails	ListCredentialDetails	接続の資格情報の詳細。
displayName	string	接続の表示名。
id	string (uuid)	接続のオブジェクト ID。
privacyLevel	PrivacyLevel	接続のプライバシーレベル。

SharedAccessSignatureCredentials

Object

SharedAccessSignature CredentialType の資格情報。

名前	型	説明
credentialType	string: SharedAccessSignature	接続の資格情報の種類。
token	string	The token.

SingleSignOnType

列挙

接続のシングルサインオンの種類。追加のシングルサインオンの種類は、時間の経過と同時に追加される場合があります。

値	説明
None	接続では、シングルサインオンを使用して接続しません。
Kerberos	接続では、Kerberos シングルサインオンを使用して接続します。
MicrosoftEntraID	接続では、Microsoft Entra ID シングルサインオンを使用して接続します。
SecurityAssertionMarkupLanguage	接続では、Security Assertion Markup Language (SAML) シングルサインオンを使用して接続します。
KerberosDirectQueryAndRefresh	接続では、Kerberos DirectQuery と Refresh シングルサインオンを使用して接続します。

VirtualNetworkGatewayConnection

Object

仮想ネットワークデータゲートウェイを介して接続する接続。

名前	型	説明
connectionDetails	ListConnectionDetails	接続の接続の詳細。
connectivityType	string: VirtualNetworkGateway	接続の接続の種類。
credentialDetails	ListCredentialDetails	接続の資格情報の詳細。
displayName	string	接続の表示名。
gatewayId	string (uuid)	接続のゲートウェイオブジェクト ID。
id	string (uuid)	接続のオブジェクト ID。
privacyLevel	PrivacyLevel	接続のプライバシーレベル。

WindowsCredentials

Object

Windows CredentialType の資格情報。

名前	型	説明
credentialType	string: Windows	接続の資格情報の種類。
password	string	The password.
username	string	The username.

WindowsWithoutImpersonationCredentials

Object

WindowsWithoutImpersonation CredentialType の資格情報。

名前	型	説明
credentialType	string: WindowsWithoutImpersonation	接続の資格情報の種類。

WorkspaceIdentityCredentials

Object

WorkspaceIdentity CredentialType の資格情報。

名前	型	説明
credentialType	string: WorkspaceIdentity	接続の資格情報の種類。

次の方法で共有

Connections - Create Connection

Permissions

必要な委任されたスコープ

Microsoft Entra でサポートされている ID

Interface

要求本文

CreateCloudConnectionRequest

CreateOnPremisesConnectionRequest

CreateVirtualNetworkGatewayConnectionRequest

応答

例

Cloud example

要求のサンプル

応答のサンプル

On-premises gateway example

要求のサンプル

応答のサンプル

Virtual network gateway example

要求のサンプル

応答のサンプル

定義

AnonymousCredentials

BasicCredentials

ConnectionDetailsBooleanParameter

ConnectionDetailsDateParameter

ConnectionDetailsDateTimeParameter

ConnectionDetailsDateTimeZoneParameter

ConnectionDetailsDurationParameter

ConnectionDetailsNumberParameter

ConnectionDetailsTextParameter

ConnectionDetailsTimeParameter

ConnectionEncryption

ConnectivityType

CreateCloudConnectionRequest

CreateConnectionDetails

CreateCredentialDetails

CreateOnPremisesConnectionRequest

CreateOnPremisesCredentialDetails

CreateVirtualNetworkGatewayConnectionRequest

CredentialType

DataType

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

KeyCredentials

ListConnectionDetails

ListCredentialDetails

OnPremisesCredentialEntry

OnPremisesGatewayConnection

OnPremisesGatewayCredentials

OnPremisesGatewayPersonalConnection

PersonalCloudConnection

PrivacyLevel

ServicePrincipalCredentials

ShareableCloudConnection

SharedAccessSignatureCredentials

SingleSignOnType

VirtualNetworkGatewayConnection

WindowsCredentials

WindowsWithoutImpersonationCredentials

WorkspaceIdentityCredentials