Connections - List Connections

服务:: Core

API 版本:: v1

返回用户有权访问的本地、虚拟网络和云连接的列表。

Permissions

调用方必须具有连接权限。

所需的委派范围

Connection.Read.All 或 Connection.ReadWrite.All

Microsoft Entra 支持的标识

此 API 支持本节中列出的Microsoft 标识。

Identity	Support
User	Yes
服务主体和托管标识	Yes

Interface

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

具有可选参数:

GET https://api.fabric.microsoft.com/v1/connections?continuationToken={continuationToken}

URI 参数

名称	在	必需	类型	说明
continuationToken	query		string	用于检索下一页结果的令牌。

响应

名称	类型	说明
200 OK	ListConnectionsResponse	OK. 作成功。
Other Status Codes	ErrorResponse	常见错误代码： UnknownError - 发生错误。

名称

类型

说明

200 OK

ListConnectionsResponse

OK. 作成功。

Other Status Codes

ErrorResponse

常见错误代码：

UnknownError - 发生错误。

示例

Example

示例请求

HTTP

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

示例响应

状态代码:: 200

{
  "value": [
    {
      "id": "6952a7b2-aea3-414f-9d85-6c0fe5d34539",
      "displayName": "ContosoConnection1",
      "connectivityType": "ShareableCloud",
      "connectionDetails": {
        "type": "Web",
        "path": "https://www.contoso.com"
      },
      "privacyLevel": "Public",
      "credentialDetails": {
        "credentialType": "Anonymous",
        "singleSignOnType": "None",
        "connectionEncryption": "NotEncrypted",
        "skipTestConnection": false
      }
    },
    {
      "id": "f6a39b76-9816-4e4b-b93a-f42e405017b7",
      "displayName": "ContosoConnection2",
      "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": "Any",
        "skipTestConnection": false
      }
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/connections?continuationToken=LDEsMTAwMDAwLDA%3D"
}

定义

名称	说明
ConnectionEncryption	连接的连接加密类型。可能会随着时间的推移添加其他连接加密值。
ConnectivityType	连接的连接类型。可能会随着时间的推移添加其他连接类型。
CredentialType	连接的凭据类型。可能会随着时间的推移添加其他凭据类型。
ErrorRelatedResource	与错误相关的资源详细信息对象。
ErrorResponse	错误响应。
ErrorResponseDetails	错误响应详细信息。
ListConnectionDetails	列表作的连接详细信息输出。
ListConnectionsResponse
ListCredentialDetails	提取连接时返回的凭据详细信息。
OnPremisesGatewayConnection	通过本地数据网关连接的连接。
OnPremisesGatewayPersonalConnection	通过个人本地数据网关连接的连接。
PersonalCloudConnection	通过云连接且无法共享的连接。
PrivacyLevel	连接的隐私级别设置。可能会随着时间的推移添加其他隐私级别。
ShareableCloudConnection	通过云连接的连接。
SingleSignOnType	连接的单一登录类型。可能会随着时间的推移添加其他单一登录类型。
VirtualNetworkGatewayConnection	通过虚拟网络数据网关连接的连接。

ConnectionEncryption

枚举

连接的连接加密类型。可能会随着时间的推移添加其他连接加密值。

值	说明
Encrypted	连接尝试是使用加密连接进行的。
Any	首先使用加密连接进行连接尝试，如果失败，则回退到未加密的连接。
NotEncrypted	连接尝试是使用未加密的连接进行的。

ConnectivityType

枚举

连接的连接类型。可能会随着时间的推移添加其他连接类型。

值	说明
ShareableCloud	连接通过云进行连接，可与其他人共享。
PersonalCloud	连接通过云进行连接，无法与他人共享。
OnPremisesGateway	连接通过本地数据网关进行连接。
OnPremisesGatewayPersonal	连接通过个人本地数据网关进行连接。
VirtualNetworkGateway	连接通过虚拟网络数据网关进行连接。
Automatic	连接使用隐式数据连接通过云进行连接。此选项仅适用于使用单一 Sign-On（SSO）的特定方案。”
None	连接未绑定

CredentialType

枚举

连接的凭据类型。可能会随着时间的推移添加其他凭据类型。

值	说明
Windows	连接使用 Windows 身份验证进行连接。仅支持本地网关。
Anonymous	连接使用匿名身份验证进行连接。
Basic	连接使用基本身份验证进行连接。
Key	连接使用密钥身份验证进行连接。
OAuth2	连接使用 OAuth 2.0 身份验证进行连接。
WindowsWithoutImpersonation	连接使用 Windows（没有模拟选项）身份验证进行连接。仅支持本地网关（个人模式）。
SharedAccessSignature	连接使用共享访问签名（SAS）身份验证进行连接。
ServicePrincipal	连接使用服务主体身份验证进行连接。
WorkspaceIdentity	连接使用工作区标识身份验证进行连接。

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	与错误相关的资源详细信息。

ListConnectionDetails

Object

列表作的连接详细信息输出。

名称	类型	说明
path	string	连接的路径。
type	string	连接的类型。

ListConnectionsResponse

Object

名称	类型	说明
continuationToken	string	下一个结果集批处理的令牌。如果没有更多记录，则会从响应中删除该记录。
continuationUri	string	下一个结果集批处理的 URI。如果没有更多记录，则会从响应中删除该记录。
value	Connection[]: OnPremisesGatewayConnection[] OnPremisesGatewayPersonalConnection[] PersonalCloudConnection[] ShareableCloudConnection[] VirtualNetworkGatewayConnection[]	返回的连接列表。

ListCredentialDetails

Object

提取连接时返回的凭据详细信息。

名称	类型	说明
connectionEncryption	ConnectionEncryption	测试连接期间使用的连接加密设置。
credentialType	CredentialType	连接的凭据类型。
singleSignOnType	SingleSignOnType	连接的单一登录类型。
skipTestConnection	boolean	连接是否应在创建和更新期间跳过测试连接。 True - 跳过测试连接，False - 请勿跳过测试连接。

OnPremisesGatewayConnection

Object

通过本地数据网关连接的连接。

名称	类型	说明
connectionDetails	ListConnectionDetails	连接的连接详细信息。
connectivityType	string: OnPremisesGateway	连接的连接类型。
credentialDetails	ListCredentialDetails	连接的凭据详细信息。
displayName	string	连接的显示名称。
gatewayId	string (uuid)	连接的网关对象 ID。
id	string (uuid)	连接的对象 ID。
privacyLevel	PrivacyLevel	连接的隐私级别。

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	可以将文件、Internet 连接和工作簿数据设置为公共数据。数据可以折叠到其他连接。可见性可供所有人使用。

ShareableCloudConnection

Object

通过云连接的连接。

名称	类型	说明
allowConnectionUsageInGateway	boolean	允许将此连接与本地数据网关或 VNet 数据网关一起使用。
connectionDetails	ListConnectionDetails	连接的连接详细信息。
connectivityType	string: ShareableCloud	连接的连接类型。
credentialDetails	ListCredentialDetails	连接的凭据详细信息。
displayName	string	连接的显示名称。
id	string (uuid)	连接的对象 ID。
privacyLevel	PrivacyLevel	连接的隐私级别。

SingleSignOnType

枚举

连接的单一登录类型。可能会随着时间的推移添加其他单一登录类型。

值	说明
None	连接不使用单一登录进行连接。
Kerberos	连接使用 Kerberos 单一登录进行连接。
MicrosoftEntraID	连接使用 Microsoft Entra ID 单一登录进行连接。
SecurityAssertionMarkupLanguage	连接使用安全断言标记语言（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	连接的隐私级别。