Connections - Create Connection

服務:: Core

API 版本:: v1

建立連接。
若要加密認證，請參閱以程式設計方式設定認證。

Permissions

如果建立網關聯機，呼叫端必須具有閘道的許可權。
服務主體必須具有網狀架構系統管理員授與的許可權。如需詳細資訊，請參閱：服務主體可以建立工作區、連線和部署管線。

必要的委派範圍

Connection.ReadWrite.All

Microsoft Entra 支援的身分識別

此 API 支援本節中列出的Microsoft 身分識別。

Identity	Support
User	Yes
服務主體和受控識別	Yes

Interface

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

要求本文

要求主體可以是下列其中一項：

名稱	Description
CreateCloudConnectionRequest
CreateOnPremisesConnectionRequest
CreateVirtualNetworkGatewayConnectionRequest

CreateCloudConnectionRequest

名稱	必要	類型	Description
connectionDetails	True	CreateConnectionDetails	線上的連線詳細數據。
connectivityType	True	string: ShareableCloud	連接的連線類型。
credentialDetails	True	CreateCredentialDetails	線上認證詳細數據。
displayName	True	string	連接的顯示名稱。長度上限為 200 個字元。
allowConnectionUsageInGateway		boolean	允許此連線與內部部署數據閘道或 VNet 數據閘道搭配使用。
privacyLevel		PrivacyLevel	（選擇性）線上的隱私權層級。未傳遞任何值時，這會設定為「組織」。

CreateOnPremisesConnectionRequest

名稱	必要	類型	Description
connectionDetails	True	CreateConnectionDetails	線上的連線詳細數據。
connectivityType	True	string: OnPremisesGateway	連接的連線類型。
credentialDetails	True	CreateOnPremisesCredentialDetails	線上認證詳細數據。
displayName	True	string	連接的顯示名稱。長度上限為 200 個字元。
gatewayId	True	string (uuid)	建立連線之內部部署閘道之主要閘道的物件標識碼。
privacyLevel		PrivacyLevel	（選擇性）線上的隱私權層級。未傳遞任何值時，這會設定為「組織」。

CreateVirtualNetworkGatewayConnectionRequest

名稱	必要	類型	Description
connectionDetails	True	CreateConnectionDetails	線上的連線詳細數據。
connectivityType	True	string: VirtualNetworkGateway	連接的連線類型。
credentialDetails	True	CreateCredentialDetails	線上認證詳細數據。
displayName	True	string	連接的顯示名稱。長度上限為 200 個字元。
gatewayId	True	string (uuid)	建立連線之虛擬網路閘道的物件標識碼。
privacyLevel		PrivacyLevel	（選擇性）線上的隱私權層級。未傳遞任何值時，這會設定為「組織」。

回應

名稱	類型	Description
201 Created	Connection: ShareableCloudConnection PersonalCloudConnection OnPremisesGatewayConnection OnPremisesGatewayPersonalConnection VirtualNetworkGatewayConnection	Created. 作業成功。
Other Status Codes	ErrorResponse	常見的錯誤碼： DuplicateConnectionName - 聯機名稱已在使用中。 InvalidConnectionDetails - 提供的 ConnectionDetails 輸入無效。 InvalidCredentialDetails - 提供的 CredentialDetails 輸入無效。 IncorrectCredentials - 無法使用認證輸入建立連線。 CreateGatewayConnectionFailed - 無法建立網關聯機。

名稱

類型

Description

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
  }
}

定義

名稱	Description
AnonymousCredentials	匿名 CredentialType 的認證。
BasicCredentials	Basic CredentialType 的認證。
ConnectionDetailsBooleanParameter	boolean dataType 的 ConnectionDetailsParameter。
ConnectionDetailsDateParameter	date dataType 的 ConnectionDetailsParameter。
ConnectionDetailsDateTimeParameter	dateTime dataType 的 ConnectionDetailsParameter。
ConnectionDetailsDateTimeZoneParameter	dateTimeZone dataType 的 ConnectionDetailsParameter。
ConnectionDetailsDurationParameter	Duration 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	閘道識別碼及其加密的串行化認證。
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 的認證。

名稱	類型	Description
credentialType	string: Anonymous	連接的認證類型。

BasicCredentials

Object

Basic CredentialType 的認證。

名稱	類型	Description
credentialType	string: Basic	連接的認證類型。
password	string	密碼。
username	string	使用者名稱。

ConnectionDetailsBooleanParameter

Object

boolean dataType 的 ConnectionDetailsParameter。

名稱	類型	Description
dataType	string: Boolean	參數的數據類型。
name	string	參數的名稱。
value	boolean	布爾值。

ConnectionDetailsDateParameter

Object

date dataType 的 ConnectionDetailsParameter。

名稱	類型	Description
dataType	string: Date	參數的數據類型。
name	string	參數的名稱。
value	string (date)	使用YYYY-MM-DD 格式的日期值。

ConnectionDetailsDateTimeParameter

Object

dateTime dataType 的 ConnectionDetailsParameter。

名稱	類型	Description
dataType	string: DateTime	參數的數據類型。
name	string	參數的名稱。
value	string (date-time)	使用YYYY-MM-DDTHH：mm：ss的日期時間值。FFFZ 格式。

ConnectionDetailsDateTimeZoneParameter

Object

dateTimeZone dataType 的 ConnectionDetailsParameter。

名稱	類型	Description
dataType	string: DateTimeZone	參數的數據類型。
name	string	參數的名稱。
value	string (date-time-offset)	使用YYYY-MM-DDTHH：mm：ss的日期時區值。FFF±hh：mm 格式。

ConnectionDetailsDurationParameter

Object

Duration dataType 的 ConnectionDetailsParameter。

名稱	類型	Description
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。

名稱	類型	Description
dataType	string: Number	參數的數據類型。
name	string	參數的名稱。
value	number	數位值。

ConnectionDetailsTextParameter

Object

text dataType 的 ConnectionDetailsParameter。

名稱	類型	Description
dataType	string: Text	參數的數據類型。
name	string	參數的名稱。
value	string	文字值。

ConnectionDetailsTimeParameter

Object

Time dataType 的 ConnectionDetailsParameter。

名稱	類型	Description
dataType	string: Time	參數的數據類型。
name	string	參數的名稱。
value	string (time)	使用 HH：mm：ss 的時間值。FFFZ 格式。

ConnectionEncryption

列舉型別

連接的連線加密類型。可能會隨著時間新增其他連線加密值。

值	Description
Encrypted	線上嘗試是使用加密的連線進行。
Any	第一次使用加密連線進行連線嘗試，如果失敗，則會回復為未加密的連線。
NotEncrypted	使用未加密的連線進行連線嘗試。

ConnectivityType

列舉型別

連接的連線類型。可能會隨著時間新增其他連線類型。

值	Description
ShareableCloud	聯機會透過雲端連線，並可與其他人共用。
PersonalCloud	聯機會透過雲端連線，無法與其他人共用。
OnPremisesGateway	聯機會透過內部部署數據網關聯機。
OnPremisesGatewayPersonal	聯機會透過個人內部部署數據網關聯機。
VirtualNetworkGateway	聯機會透過虛擬網路數據網關聯機。
Automatic	聯機會使用隱含數據連線透過雲端連線。此選項僅適用於使用單一 Sign-On（SSO）的特定案例，例如語意模型。
None	線上未系結

CreateCloudConnectionRequest

Object

名稱	類型	Description
allowConnectionUsageInGateway	boolean	允許此連線與內部部署數據閘道或 VNet 數據閘道搭配使用。
connectionDetails	CreateConnectionDetails	線上的連線詳細數據。
connectivityType	string: ShareableCloud	連接的連線類型。
credentialDetails	CreateCredentialDetails	線上認證詳細數據。
displayName	string	連接的顯示名稱。長度上限為 200 個字元。
privacyLevel	PrivacyLevel	（選擇性）線上的隱私權層級。未傳遞任何值時，這會設定為「組織」。

CreateConnectionDetails

Object

建立作業的連線詳細數據輸入。

名稱	類型	Description
creationMethod	string	用來建立連接的建立方法。如需建立方法的清單，請使用 ListSupportedConnectionTypes API。
parameters	ConnectionDetailsParameter[]: ConnectionDetailsBooleanParameter[] ConnectionDetailsDateParameter[] ConnectionDetailsDateTimeParameter[] ConnectionDetailsDateTimeZoneParameter[] ConnectionDetailsDurationParameter[] ConnectionDetailsNumberParameter[] ConnectionDetailsTextParameter[] ConnectionDetailsTimeParameter[]	連接參數的清單。如需每個建立方法的參數清單，請使用 ListSupportedConnectionTypes API。
type	string	連接的型別。

CreateCredentialDetails

Object

用於建立連線的認證詳細數據輸入。

名稱	類型	Description
connectionEncryption	ConnectionEncryption	（選擇性）測試連接期間所使用的連線加密設定。未傳遞任何值時，不會加密連線。
credentials	Credentials: AnonymousCredentials BasicCredentials KeyCredentials ServicePrincipalCredentials SharedAccessSignatureCredentials WindowsCredentials WindowsWithoutImpersonationCredentials WorkspaceIdentityCredentials	連接的認證。
singleSignOnType	SingleSignOnType	（選擇性）線上的單一登錄類型。未傳遞任何值時，連線不會使用單一登錄。
skipTestConnection	boolean	連接是否應該在建立和更新期間略過測試連線。 True - 略過測試連線，False - 不要略過測試連線。未傳遞任何值時，這會設定為『False』。

CreateOnPremisesConnectionRequest

Object

名稱	類型	Description
connectionDetails	CreateConnectionDetails	線上的連線詳細數據。
connectivityType	string: OnPremisesGateway	連接的連線類型。
credentialDetails	CreateOnPremisesCredentialDetails	線上認證詳細數據。
displayName	string	連接的顯示名稱。長度上限為 200 個字元。
gatewayId	string (uuid)	建立連線之內部部署閘道之主要閘道的物件標識碼。
privacyLevel	PrivacyLevel	（選擇性）線上的隱私權層級。未傳遞任何值時，這會設定為「組織」。

CreateOnPremisesCredentialDetails

Object

用於建立內部部署網關聯機的認證詳細數據輸入。

名稱	類型	Description
connectionEncryption	ConnectionEncryption	（選擇性）測試連接期間所使用的連線加密設定。未傳遞任何值時，不會加密連線。
credentials	OnPremisesGatewayCredentials	連接的認證。
singleSignOnType	SingleSignOnType	（選擇性）線上的單一登錄類型。未傳遞任何值時，連線不會使用單一登錄。
skipTestConnection	boolean	連接是否應該在建立和更新期間略過測試連線。 True - 略過測試連線，False - 不要略過測試連線。未傳遞任何值時，這會設定為『False』。

CreateVirtualNetworkGatewayConnectionRequest

Object

名稱	類型	Description
connectionDetails	CreateConnectionDetails	線上的連線詳細數據。
connectivityType	string: VirtualNetworkGateway	連接的連線類型。
credentialDetails	CreateCredentialDetails	線上認證詳細數據。
displayName	string	連接的顯示名稱。長度上限為 200 個字元。
gatewayId	string (uuid)	建立連線之虛擬網路閘道的物件標識碼。
privacyLevel	PrivacyLevel	（選擇性）線上的隱私權層級。未傳遞任何值時，這會設定為「組織」。

CredentialType

列舉型別

連接的認證類型。可能會隨著時間新增其他認證類型。

值	Description
Windows	聯機會使用 Windows 驗證進行連線。僅支援內部部署閘道。
Anonymous	聯機會使用匿名驗證進行連線。
Basic	聯機會使用基本身份驗證進行連線。
Key	聯機會使用金鑰驗證進行連線。
OAuth2	聯機會使用 OAuth 2.0 驗證進行連線。
WindowsWithoutImpersonation	聯機會使用 Windows（沒有仿真的選項）驗證進行連線。僅支持內部部署閘道（個人模式）。
SharedAccessSignature	聯機會使用共用存取簽章（SAS）驗證進行連線。
ServicePrincipal	聯機會使用服務主體驗證進行連線。
WorkspaceIdentity	聯機會使用工作區身分識別驗證進行連線。

DataType

列舉型別

連接建立參數值的數據類型。可能會隨著時間新增其他數據類型值。

值	Description
Text	使用文字作為參數輸入值。
Number	使用 number 作為參數輸入值（整數或浮點）。
Boolean	使用布爾值作為參數輸入值。 False - 值為 false、True - 值為 true。
Duration	使用 duration 作為參數輸入值，使用 [-]P（n）DT（n）H（n）M（n）S 格式。例如：P3DT4H30M10S（3 天、4 小時、30 分鐘和 10 秒）。
Date	使用 date 作為參數輸入值，使用 YYYY-MM-DD 格式。
DateTime	使用日期時間做為參數輸入值，使用YYYY-MM-DDTHH：mm：ss。FFFZ 格式。
DateTimeZone	使用日期時區做為參數輸入值，使用YYYY-MM-DDTHH：mm：ss。FFF±hh：mm 格式。
Time	使用 hH：mm：ss 作為參數輸入值的時間。FFFZ 格式。

ErrorRelatedResource

Object

錯誤相關的資源詳細資料物件。

名稱	類型	Description
resourceId	string	發生錯誤的資源識別碼。
resourceType	string	發生錯誤的資源類型。

ErrorResponse

Object

錯誤回應。

名稱	類型	Description
errorCode	string	提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
message	string	錯誤的人類可讀取表示法。
moreDetails	ErrorResponseDetails[]	其他錯誤詳細數據的清單。
relatedResource	ErrorRelatedResource	錯誤相關的資源詳細數據。
requestId	string	與錯誤相關聯的要求標識碼。

ErrorResponseDetails

Object

錯誤回應詳細數據。

名稱	類型	Description
errorCode	string	提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
message	string	錯誤的人類可讀取表示法。
relatedResource	ErrorRelatedResource	錯誤相關的資源詳細數據。

KeyCredentials

Object

Key CredentialType 的認證。

名稱	類型	Description
credentialType	string: Key	連接的認證類型。
key	string	索引鍵。

ListConnectionDetails

Object

清單作業的連線詳細資料輸出。

名稱	類型	Description
path	string	連接的路徑。
type	string	連接的型別。

ListCredentialDetails

Object

擷取連線時傳回的認證詳細數據。

名稱	類型	Description
connectionEncryption	ConnectionEncryption	測試連接期間所使用的連線加密設定。
credentialType	CredentialType	連接的認證類型。
singleSignOnType	SingleSignOnType	線上的單一登錄類型。
skipTestConnection	boolean	連接是否應該在建立和更新期間略過測試連線。 True - 略過測試連線，False - 不要略過測試連線。

OnPremisesCredentialEntry

Object

閘道識別碼及其加密的串行化認證。

名稱	類型	Description
encryptedCredentials	string	名稱值組清單的加密串行化 .json。名稱是認證名稱，而值是認證值。加密是使用 Rivest-Shamir-Adleman （RSA）加密演算法搭配內部部署閘道成員的公鑰來執行。
gatewayId	string (uuid)	閘道的物件識別碼。

OnPremisesGatewayConnection

Object

透過內部部署數據網關聯機的連線。

名稱	類型	Description
connectionDetails	ListConnectionDetails	線上的連線詳細數據。
connectivityType	string: OnPremisesGateway	連接的連線類型。
credentialDetails	ListCredentialDetails	線上認證詳細數據。
displayName	string	連接的顯示名稱。
gatewayId	string (uuid)	連接的閘道物件識別碼。
id	string (uuid)	連接的物件識別碼。
privacyLevel	PrivacyLevel	線上的隱私權層級。

OnPremisesGatewayCredentials

Object

透過內部部署閘道進行驗證的認證。

名稱	類型	Description
credentialType	CredentialType	連接的認證類型。
values	OnPremisesCredentialEntry[]	要傳送至內部部署閘道的認證承載。

OnPremisesGatewayPersonalConnection

Object

透過個人內部部署數據網關聯機的連線。

名稱	類型	Description
connectionDetails	ListConnectionDetails	線上的連線詳細數據。
connectivityType	string: OnPremisesGatewayPersonal	連接的連線類型。
credentialDetails	ListCredentialDetails	線上認證詳細數據。
displayName	string	連接的顯示名稱。
gatewayId	string (uuid)	連接的閘道物件識別碼。
id	string (uuid)	連接的物件識別碼。
privacyLevel	PrivacyLevel	線上的隱私權層級。

PersonalCloudConnection

Object

透過雲端連線且無法共享的連線。

名稱	類型	Description
allowConnectionUsageInGateway	boolean	允許此連線與內部部署數據閘道或 VNet 數據閘道搭配使用。
connectionDetails	ListConnectionDetails	線上的連線詳細數據。
connectivityType	string: PersonalCloud	連接的連線類型。
credentialDetails	ListCredentialDetails	線上認證詳細數據。
displayName	string	連接的顯示名稱。
id	string (uuid)	連接的物件識別碼。
privacyLevel	PrivacyLevel	線上的隱私權層級。

PrivacyLevel

列舉型別

線上的隱私權等級設定。可能會隨著時間新增其他隱私權等級。

值	Description
None	未設定隱私權等級設定。
Private	設定為私人的連線包含敏感性或機密資訊。可見度可以限制為授權的使用者。私人連線的數據不會折疊至其他連線，包括其他私人連線。
Organizational	設定為組織的連線可以折疊為私人和其他組織連線。它們無法折疊至公用連線。可見度會設定為信任的群組。
Public	檔案、因特網連線和活頁簿數據可以設定為公用。數據可以折疊至其他連接。每個人都可以使用可見度。

ServicePrincipalCredentials

Object

ServicePrincipal CredentialType 的認證。

名稱	類型	Description
credentialType	string: ServicePrincipal	連接的認證類型。
servicePrincipalClientId	string (uuid)	服務主體的用戶端標識碼。
servicePrincipalSecret	string	服務主體的秘密。
tenantId	string (uuid)	服務主體的租用戶標識碼。

ShareableCloudConnection

Object

透過雲端連線的連線。

名稱	類型	Description
allowConnectionUsageInGateway	boolean	允許此連線與內部部署數據閘道或 VNet 數據閘道搭配使用。
connectionDetails	ListConnectionDetails	線上的連線詳細數據。
connectivityType	string: ShareableCloud	連接的連線類型。
credentialDetails	ListCredentialDetails	線上認證詳細數據。
displayName	string	連接的顯示名稱。
id	string (uuid)	連接的物件識別碼。
privacyLevel	PrivacyLevel	線上的隱私權層級。

SharedAccessSignatureCredentials

Object

SharedAccessSignature CredentialType 的認證。

名稱	類型	Description
credentialType	string: SharedAccessSignature	連接的認證類型。
token	string	語彙基元。

SingleSignOnType

列舉型別

線上的單一登錄類型。可能會隨著時間新增其他單一登錄類型。

值	Description
None	線上不會使用單一登錄進行連線。
Kerberos	聯機會使用 Kerberos 單一登錄進行連線。
MicrosoftEntraID	聯機會使用 Microsoft Entra ID 單一登錄進行連線。
SecurityAssertionMarkupLanguage	聯機會使用安全性判斷提示標記語言（SAML）單一登錄進行連線。
KerberosDirectQueryAndRefresh	聯機會使用 Kerberos DirectQuery 和 Refresh 單一登錄進行連線。

VirtualNetworkGatewayConnection

Object

透過虛擬網路數據網關聯機的連線。

名稱	類型	Description
connectionDetails	ListConnectionDetails	線上的連線詳細數據。
connectivityType	string: VirtualNetworkGateway	連接的連線類型。
credentialDetails	ListCredentialDetails	線上認證詳細數據。
displayName	string	連接的顯示名稱。
gatewayId	string (uuid)	連接的閘道物件識別碼。
id	string (uuid)	連接的物件識別碼。
privacyLevel	PrivacyLevel	線上的隱私權層級。

WindowsCredentials

Object

Windows CredentialType 的認證。

名稱	類型	Description
credentialType	string: Windows	連接的認證類型。
password	string	密碼。
username	string	使用者名稱。

WindowsWithoutImpersonationCredentials

Object

WindowsWithoutImpersonation CredentialType 的認證。

名稱	類型	Description
credentialType	string: WindowsWithoutImpersonation	連接的認證類型。

WorkspaceIdentityCredentials

Object

WorkspaceIdentity CredentialType 的認證。

名稱	類型	Description
credentialType	string: WorkspaceIdentity	連接的認證類型。

共用方式為

Connections - Create Connection

Permissions

必要的委派範圍

Microsoft Entra 支援的身分識別

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