Connections - Get Connection

Service:: Core

API Version:: v1

Get connection by ID.

Permissions

The caller must have permission for the connection or admin permission for the gateway of the connection.

Required Delegated Scopes

Connection.Read.All or Connection.ReadWrite.All

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity	Support
User	Yes
Service principal and Managed identities	Yes

Interface

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

URI Parameters

Name	In	Required	Type	Description
connectionId	path	True	string (uuid)	The ID of the connection.

Responses

Name	Type	Description
200 OK	Connection	OK. The operation was successful.
Other Status Codes	ErrorResponse	Common error codes: EntityNotFound - The requested resource could not be found.

Name

Type

Description

200 OK

Connection

OK. The operation was successful.

Other Status Codes

ErrorResponse

Common error codes:

EntityNotFound - The requested resource could not be found.

Examples

Example

Sample request

HTTP

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

Sample response

Status code:: 200

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

Definitions

Name	Description
Connection
ConnectionEncryption	The connection encryption type of the connection. Additional connection encryption values may be added over time.
ConnectivityType	The connectivity type of the connection. Additional connectivity types may be added over time.
CredentialType	The credential type of the connection. Additional credential types may be added over time.
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
ListConnectionDetails	The connection details output for list operations.
ListCredentialDetails	The credential details returned when fetching a connection.
PrivacyLevel	The privacy level setting of the connection. Additional privacy levels may be added over time.
SingleSignOnType	The single sign-on type of the connection. Additional single sign on types may be added over time.

Connection

Object

Name	Type	Description
connectionDetails	ListConnectionDetails	The connection details of the connection.
connectivityType	ConnectivityType	The connectivity type of the connection.
credentialDetails	ListCredentialDetails	The credential details of the connection.
displayName	string	The display name of the connection.
gatewayId	string (uuid)	The gateway object ID of the connection.
id	string (uuid)	The object ID of the connection.
privacyLevel	PrivacyLevel	The privacy level of the connection.

ConnectionEncryption

Enumeration

The connection encryption type of the connection. Additional connection encryption values may be added over time.

Value	Description
Any	The connection attempt is first made using an encrypted connection, then falls back to unencrypted connection if unsuccessful.
Encrypted	The connection attempt is made using an encrypted connection.
NotEncrypted	The connection attempt is made using an unencrypted connection.

ConnectivityType

Enumeration

The connectivity type of the connection. Additional connectivity types may be added over time.

Value	Description
Automatic	The connection connects through the cloud using an implicit data connection. This option is only available for specific scenarios like semantic models that use Single Sign-On (SSO).”
None	The connection is not bound
OnPremisesGateway	The connection connects through an on-premises data gateway.
OnPremisesGatewayPersonal	The connection connects through a personal on-premises data gateway.
PersonalCloud	The connection connects through the cloud and cannot be shared with others.
ShareableCloud	The connection connects through the cloud and can be shared with others.
VirtualNetworkGateway	The connection connects through a virtual network data gateway.

CredentialType

Enumeration

The credential type of the connection. Additional credential types may be added over time.

Value	Description
Anonymous	Connection uses anonymous authentication to connect.
Basic	Connection uses basic authentication to connect.
Key	Connection uses key authentication to connect.
OAuth2	Connection uses OAuth 2.0 authentication to connect.
ServicePrincipal	Connection uses service principal authentication to connect.
SharedAccessSignature	Connection uses shared access signature (SAS) authentication to connect.
Windows	Connection uses Windows authentication to connect. Only supported for on-premises gateways.
WindowsWithoutImpersonation	Connection uses Windows (without the option for impersonation) authentication to connect. Only supported for on-premises gateways (personal mode).
WorkspaceIdentity	Connection uses workspace identity authentication to connect.

ErrorRelatedResource

Object

The error related resource details object.

Name	Type	Description
resourceId	string	The resource ID that's involved in the error.
resourceType	string	The type of the resource that's involved in the error.

ErrorResponse

Object

The error response.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
moreDetails	ErrorResponseDetails[]	List of additional error details.
relatedResource	ErrorRelatedResource	The error related resource details.
requestId	string	ID of the request associated with the error.

ErrorResponseDetails

Object

The error response details.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
relatedResource	ErrorRelatedResource	The error related resource details.

ListConnectionDetails

Object

The connection details output for list operations.

Name	Type	Description
path	string	The path of the connection.
type	string	The type of the connection.

ListCredentialDetails

Object

The credential details returned when fetching a connection.

Name	Type	Description
connectionEncryption	ConnectionEncryption	The connection encryption setting that is used during the test connection.
credentialType	CredentialType	The credential type of the connection.
singleSignOnType	SingleSignOnType	The single sign-on type of the connection.
skipTestConnection	boolean	Whether the connection should skip the test connection during creation and update. True - Skip the test connection, False - Do not skip the test connection.

PrivacyLevel

Enumeration

The privacy level setting of the connection. Additional privacy levels may be added over time.

Value	Description
None	No privacy level setting is configured.
Organizational	Connections set to organizational can fold in to private and other organizational connections. They can't fold in to public connections. Visibility is set to a trusted group.
Private	Connections set to private contain sensitive or confidential information. Visibility can be restricted to authorized users. Data from a private connection won't fold in to other connections, including other private connections.
Public	Files, internet connections, and workbook data can be set to public. Data can fold in to other connections. Visibility is available to everyone.

SingleSignOnType

Enumeration

The single sign-on type of the connection. Additional single sign on types may be added over time.

Value	Description
Kerberos	Connection uses Kerberos single sign-on to connect.
KerberosDirectQueryAndRefresh	Connection uses Kerberos DirectQuery and Refresh single sign-on to connect.
MicrosoftEntraID	Connection uses Microsoft Entra ID single sign-on to connect.
None	Connection does not use single sign-on to connect.
SecurityAssertionMarkupLanguage	Connection uses Security Assertion Markup Language (SAML) single sign-on to connect.

Share via

Connections - Get Connection

Permissions

Required Delegated Scopes

Microsoft Entra supported identities

Interface

URI Parameters

Responses

Examples

Example

Sample request

Sample response

Definitions

Connection

ConnectionEncryption

ConnectivityType

CredentialType

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ListConnectionDetails

ListCredentialDetails

PrivacyLevel

SingleSignOnType