Edit

Share via

Items - Bind Semantic Model Connection

Service:
SemanticModel
API Version:
v1

Binds a semantic model data source reference to a data connection.
This API can also be used to unbind data source references.

Permissions

The caller must be the owner of the semantic model.

Limitations

This API does not support bulk operations. To bind multiple data source references of a semantic model, the user must submit multiple bindConnection requests.

Required Delegated Scopes

SemanticModel.ReadWrite.All or Item.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

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/semanticModels/{semanticModelId}/bindConnection

URI Parameters

Name In Required Type Description
semanticModelId
 path True

string (uuid)

The semantic model ID.
workspaceId
 path True

string (uuid)

The workspace ID.

Request Body

Name Required Type Description
connectionBinding True

ConnectionBinding

The details of the connection binding.

Responses

Name Type Description
200 OK

Request completed successfully.
Other Status Codes

ErrorResponse

Common error codes:

  • ItemNotFound - The requested semantic model was not found.

  • InvalidRequest - Invalid bind semantic model connection request.

Examples

Bind a semantic model connection example
Unbind a semantic model connection example

Bind a semantic model connection example

Sample request

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/semanticModels/cfafbeb1-8037-4d0c-896e-a46fb27ff229/bindConnection

{
  "connectionBinding": {
    "id": "0b9af1bd-e974-4893-8947-d89d5a560385",
    "connectivityType": "OnPremisesDataGateway",
    "connectionDetails": {
      "type": "SQL",
      "path": "contoso.database.windows.net;sales"
    }
  }
}

Sample response

Status code:
200

Unbind a semantic model connection example

Sample request

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/semanticModels/cfafbeb1-8037-4d0c-896e-a46fb27ff229/bindConnection

{
  "connectionBinding": {
    "connectivityType": "None",
    "connectionDetails": {
      "type": "SQL",
      "path": "contoso.database.windows.net;sales"
    }
  }
}

Sample response

Status code:
200

Definitions

Name Description
BindSemanticModelConnectionRequest

The payload of a bindConnection request to bind a data source reference of a semantic model to a data connection.
ConnectionBinding

The details of the connection binding.
ConnectivityType

The connectivity type of the connection. Additional connectivity 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.

BindSemanticModelConnectionRequest

Object

The payload of a bindConnection request to bind a data source reference of a semantic model to a data connection.

Name Type Description
connectionBinding

ConnectionBinding

The details of the connection binding.

ConnectionBinding

Object

The details of the connection binding.

Name Type Description
connectionDetails

ListConnectionDetails

The connection details of the connection.
connectivityType

ConnectivityType

The connectivity type of the connection.
id

string (uuid)

The object ID of the connection.

ConnectivityType

Enumeration

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

Value Description
ShareableCloud

The connection connects through the cloud and can be shared with others.
PersonalCloud

The connection connects through the cloud and cannot be shared with others.
OnPremisesGateway

The connection connects through an on-premises data gateway.
OnPremisesGatewayPersonal

The connection connects through a personal on-premises data gateway.
VirtualNetworkGateway

The connection connects through a virtual network data gateway.
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

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.