Connections - Get Connection

回傳指定的連線。

Note

Fabric 租戶管理員連線管理目前處於預覽階段(了解更多)。

Permissions

呼叫端必須是網狀架構系統管理員,或使用服務主體進行驗證。

必要的委派範圍

Tenant.Read.All 或 Tenant.ReadWrite.All

Limitations

None.

Microsoft Entra 支援的身份識別

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

Identity Support
使用者 Yes
服務主體 和 受控識別 Yes

Interface

GET https://api.fabric.microsoft.com/v1/admin/connections/{connectionId}

URI 參數

名稱 位於 必要 類型 Description
connectionId
path True

string (uuid)

連線ID。

回覆

名稱 類型 Description
200 OK Connection:

OK. 作業成功。

429 Too Many Requests

ErrorResponse

服務費率上限被超標。 伺服器會回傳一個 Retry-After 標頭,以秒數表示客戶端在發送額外請求前必須等待多久。

標題

Retry-After: integer

Other Status Codes

ErrorResponse

常見的錯誤碼:

  • EntityNotFound - 找不到要求的資源。

範例

Get connection as admin example

範例要求

GET https://api.fabric.microsoft.com/v1/admin/connections/f6a39b76-9816-4e4b-b93a-f42e405017b7

範例回覆

{
  "id": "f6a39b76-9816-4e4b-b93a-f42e405017b7",
  "displayName": "ContosoConnection",
  "gatewayId": "58376c10-5f61-4024-887e-748df4beae45",
  "connectivityType": "OnPremisesGateway",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;sales"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "Basic",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false
  }
}

定義

名稱 Description
ConnectionEncryption

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

ConnectionRecency

代表該連結的最新細節。

ConnectionRole

一個連結角色。 可能會隨著時間新增其他連線角色。

ConnectivityType

連線的連線類型。 隨著時間的推移,可能會添加其他連接類型。

CredentialType

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

ErrorParameter

一個結構化參數,提供關於錯誤的額外機器可讀上下文。

ErrorRelatedResource

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

ErrorResponse

錯誤回應。

ErrorResponseDetails

錯誤回應的細節。

ListConnectionDetails

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

ListCredentialDetails

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

OnPremisesGatewayConnection

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

OnPremisesGatewayPersonalConnection

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

PersonalCloudConnection

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

PrivacyLevel

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

ShareableCloudConnection

透過雲端連線的連線。

SingleSignOnType

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

StreamingVirtualNetworkGatewayConnection

一個透過串流虛擬網路資料閘道連接的連線。

VirtualNetworkGatewayConnection

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

ConnectionEncryption

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

值 Description
Encrypted

線上嘗試是使用加密的連線進行。

Any

第一次使用加密連線進行連線嘗試,如果失敗,則會回復為未加密的連線。

NotEncrypted

使用未加密的連線進行連線嘗試。

ConnectionRecency

代表該連結的最新細節。

名稱 類型 Description
createdDateTime

string (date-time)

連線建立的時間戳記為 UTC,格式為 YYYY-MM-DDTHH:mm:ssZ。

lastBoundDateTime

string (date-time)

連線最近綁定到任何 UTC 項目的時間戳,使用 YYYY-MM-DDTHH:mm:ssZ 格式。

lastCredentialUsedDateTime

string (date-time)

連線憑證最近一次在UTC使用的時間戳,格式為YYYY-MM-DDTHH:mm:ssZ格式。

myLastBoundDateTime

string (date-time)

連線最近一次被呼叫使用者以 UTC 綁定到任何項目的時間戳,格式為 YYYY-MM-DDTHH:mm:ssZ。

myLastCredentialUsedDateTime

string (date-time)

連線憑證最近一次被呼叫使用者使用的時間戳(UTC),格式為 YYYY-MM-DDTHH:mm:ssZ。

ConnectionRole

一個連結角色。 可能會隨著時間新增其他連線角色。

值 Description
User

啟用連線的用戶存取權。

UserWithReshare

讓用戶能夠重新共享連線的存取權。

Owner

啟用連線的擁有權存取。

PendingOwner

該連接所有權尚未生效;主體必須透過更新連線憑證(使用 Update Connection API)來使其有效。

ConnectivityType

連線的連線類型。 隨著時間的推移,可能會添加其他連接類型。

值 Description
ShareableCloud

連線透過雲端連接,可以與他人共用。

PersonalCloud

連線透過雲端連接,無法與他人共用。

OnPremisesGateway

連線會透過內部部署資料閘道連線。

OnPremisesGatewayPersonal

連線會透過個人內部部署資料閘道連線。

VirtualNetworkGateway

連線會透過虛擬網路資料閘道連線。

StreamingVirtualNetworkGateway

連線透過串流虛擬網路資料閘道連接。

Automatic

連線使用隱含資料連線透過雲端連線。 此選項僅適用於特定場景,例如使用單一 Sign-On (SSO) 的語義模型。

None

連線未繫結

CredentialType

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

值 Description
Windows

聯機會使用 Windows 驗證進行連線。 僅支援內部部署閘道。

Anonymous

聯機會使用匿名驗證進行連線。

Basic

聯機會使用基本身份驗證進行連線。

Key

聯機會使用金鑰驗證進行連線。

OAuth2

聯機會使用 OAuth 2.0 驗證進行連線。

WindowsWithoutImpersonation

聯機會使用 Windows(沒有仿真的選項)驗證進行連線。 僅支持內部部署閘道 (個人模式)。

SharedAccessSignature

聯機會使用共用存取簽章 (SAS) 驗證進行連線。

ServicePrincipal

聯機會使用服務主體驗證進行連線。

WorkspaceIdentity

聯機會使用工作區身分識別驗證進行連線。

KeyPair

連線使用金鑰對認證來連接。

ErrorParameter

一個結構化參數,提供關於錯誤的額外機器可讀上下文。

名稱 類型 Description
message

string

一個人類可讀的參數意義描述。

name

string

參數識別碼。

value

string

這是參數值。

ErrorRelatedResource

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

名稱 類型 Description
resourceId

string

發生錯誤的資源識別碼。

resourceType

string

發生錯誤的資源類型。

ErrorResponse

錯誤回應。

名稱 類型 Description
errorCode

string

提供錯誤狀況相關信息的特定標識碼,允許服務與其使用者之間的標準化通訊。

isRetriable

boolean

若屬實,請求可重新嘗試。 如果有延遲,請使用 Retry-After 回應標頭來判斷延遲。

message

string

以人類可讀格式呈現的錯誤訊息。

moreDetails

ErrorResponseDetails[]

其他錯誤詳情的清單。

parameters

ErrorParameter[]

結構化參數提供更多機器可讀的錯誤上下文。

relatedResource

ErrorRelatedResource

與錯誤相關的資源詳情。

requestId

string (uuid)

與錯誤相關聯的要求識別碼。

ErrorResponseDetails

錯誤回應的細節。

名稱 類型 Description
errorCode

string

提供錯誤狀況相關信息的特定標識碼,允許服務與其使用者之間的標準化通訊。

message

string

以人類可讀格式呈現的錯誤訊息。

parameters

ErrorParameter[]

結構化參數提供更多機器可讀的錯誤上下文。

relatedResource

ErrorRelatedResource

與錯誤相關的資源詳情。

ListConnectionDetails

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

名稱 類型 Description
path

string

連線的路徑。

type

string

連接的型別。

ListCredentialDetails

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

名稱 類型 Description
connectionEncryption

ConnectionEncryption

測試連接期間所使用的連線加密設定。

credentialType

CredentialType

連接的認證類型。

singleSignOnType

SingleSignOnType

線上的單一登錄類型。

skipTestConnection

boolean

連接是否應該在建立和更新期間略過測試連線。 True - 略過測試連線,False - 不要略過測試連線。

OnPremisesGatewayConnection

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

名稱 類型 Description
connectionDetails

ListConnectionDetails

連線的連線詳細資料。

connectionRecency

ConnectionRecency

最近關係的細節。

connectivityType string:

OnPremisesGateway

連線的連線類型。

credentialDetails

ListCredentialDetails

線上認證詳細數據。

displayName

string

連接的顯示名稱。

gatewayId

string (uuid)

連接所透過的閘道物件 ID。 對於雲端連線,這是虛擬閘道 ID。

id

string (uuid)

連接的物件識別碼。

myRole

ConnectionRole

來電負責人在連線中扮演的有效角色。 當主體同時屬於多個具有不同角色的安全群組時,會回傳最高的角色。 若委託人在連接中沒有角色,該屬性不會被歸還。

privacyLevel

PrivacyLevel

線上的隱私權層級。

OnPremisesGatewayPersonalConnection

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

名稱 類型 Description
connectionDetails

ListConnectionDetails

連線的連線詳細資料。

connectionRecency

ConnectionRecency

最近關係的細節。

connectivityType string:

OnPremisesGatewayPersonal

連線的連線類型。

credentialDetails

ListCredentialDetails

線上認證詳細數據。

displayName

string

連接的顯示名稱。

gatewayId

string (uuid)

連接所透過的閘道物件 ID。 對於雲端連線,這是虛擬閘道 ID。

id

string (uuid)

連接的物件識別碼。

myRole

ConnectionRole

來電負責人在連線中扮演的有效角色。 當主體同時屬於多個具有不同角色的安全群組時,會回傳最高的角色。 若委託人在連接中沒有角色,該屬性不會被歸還。

privacyLevel

PrivacyLevel

線上的隱私權層級。

PersonalCloudConnection

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

名稱 類型 Description
allowConnectionUsageInGateway

boolean

允許此連線與內部部署數據閘道或 VNet 數據閘道搭配使用。

connectionDetails

ListConnectionDetails

連線的連線詳細資料。

connectionRecency

ConnectionRecency

最近關係的細節。

connectivityType string:

PersonalCloud

連線的連線類型。

credentialDetails

ListCredentialDetails

線上認證詳細數據。

displayName

string

連接的顯示名稱。

gatewayId

string (uuid)

連接所透過的閘道物件 ID。 對於雲端連線,這是虛擬閘道 ID。

id

string (uuid)

連接的物件識別碼。

myRole

ConnectionRole

來電負責人在連線中扮演的有效角色。 當主體同時屬於多個具有不同角色的安全群組時,會回傳最高的角色。 若委託人在連接中沒有角色,該屬性不會被歸還。

privacyLevel

PrivacyLevel

線上的隱私權層級。

PrivacyLevel

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

值 Description
None

未設定隱私權等級設定。

Private

設定為私人的連線包含敏感性或機密資訊。 可見性可限制於授權使用者。 私人連線的數據不會折疊至其他連線,包括其他私人連線。

Organizational

設定為組織的連線可以折疊為私人和其他組織連線。 它們無法折疊至公用連線。 可見性設定為可信群組。

Public

檔案、因特網連線和活頁簿數據可以設定為公用。 數據可以折疊至其他連接。 能見度對所有人開放。

ShareableCloudConnection

透過雲端連線的連線。

名稱 類型 Description
allowConnectionUsageInGateway

boolean

允許此連線與內部部署數據閘道或 VNet 數據閘道搭配使用。

allowUsageInUserControlledCode

boolean

允許此連線與允許使用者控制程式碼的項目(如 Notebook)一起使用。

connectionDetails

ListConnectionDetails

連線的連線詳細資料。

connectionRecency

ConnectionRecency

最近關係的細節。

connectivityType string:

ShareableCloud

連線的連線類型。

credentialDetails

ListCredentialDetails

線上認證詳細數據。

displayName

string

連接的顯示名稱。

gatewayId

string (uuid)

連接所透過的閘道物件 ID。 對於雲端連線,這是虛擬閘道 ID。

id

string (uuid)

連接的物件識別碼。

myRole

ConnectionRole

來電負責人在連線中扮演的有效角色。 當主體同時屬於多個具有不同角色的安全群組時,會回傳最高的角色。 若委託人在連接中沒有角色,該屬性不會被歸還。

privacyLevel

PrivacyLevel

線上的隱私權層級。

SingleSignOnType

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

值 Description
None

線上不會使用單一登錄進行連線。

Kerberos

聯機會使用 Kerberos 單一登錄進行連線。

MicrosoftEntraID

聯機會使用 Microsoft Entra ID 單一登錄進行連線。

SecurityAssertionMarkupLanguage

聯機會使用安全性判斷提示標記語言 (SAML) 單一登錄進行連線。

KerberosDirectQueryAndRefresh

聯機會使用 Kerberos DirectQuery 和 Refresh 單一登錄進行連線。

StreamingVirtualNetworkGatewayConnection

一個透過串流虛擬網路資料閘道連接的連線。

名稱 類型 Description
connectionDetails

ListConnectionDetails

連線的連線詳細資料。

connectionRecency

ConnectionRecency

最近關係的細節。

connectivityType string:

StreamingVirtualNetworkGateway

連線的連線類型。

credentialDetails

ListCredentialDetails

線上認證詳細數據。

displayName

string

連接的顯示名稱。

gatewayId

string (uuid)

連接的閘道物件識別碼。

id

string (uuid)

連接的物件識別碼。

myRole

ConnectionRole

來電負責人在連線中扮演的有效角色。 當主體同時屬於多個具有不同角色的安全群組時,會回傳最高的角色。 若委託人在連接中沒有角色,該屬性不會被歸還。

privacyLevel

PrivacyLevel

線上的隱私權層級。

VirtualNetworkGatewayConnection

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

名稱 類型 Description
connectionDetails

ListConnectionDetails

連線的連線詳細資料。

connectionRecency

ConnectionRecency

最近關係的細節。

connectivityType string:

VirtualNetworkGateway

連線的連線類型。

credentialDetails

ListCredentialDetails

線上認證詳細數據。

displayName

string

連接的顯示名稱。

gatewayId

string (uuid)

連接所透過的閘道物件 ID。 對於雲端連線,這是虛擬閘道 ID。

id

string (uuid)

連接的物件識別碼。

myRole

ConnectionRole

來電負責人在連線中扮演的有效角色。 當主體同時屬於多個具有不同角色的安全群組時,會回傳最高的角色。 若委託人在連接中沒有角色,該屬性不會被歸還。

privacyLevel

PrivacyLevel

線上的隱私權層級。