Items - Bind Semantic Model Connection

Служба:

SemanticModel

Версия API:

v1

Привязывает ссылку на источник данных семантической модели к подключению к данным.
Этот API также можно использовать для отмены привязки ссылок на источники данных.

Permissions

Вызывающий объект должен быть владельцем семантической модели.

Ограничения

Этот API не поддерживает массовые операции. Чтобы привязать несколько ссылок на источник данных семантической модели, пользователь должен отправить несколько запросов bindConnection.

Обязательные делегированные области

SemanticModel.ReadWrite.All или Item.ReadWrite.All

Идентификаторы, поддерживаемые Microsoft Entra

Этот API поддерживает идентичности Microsoft, перечисленные в этом разделе.

Идентичность	Support
User	Да
Представитель службы и управляемые удостоверения	Да

Интерфейс

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
semanticModelId	path	True	string (uuid)	Идентификатор семантической модели.
workspaceId	path	True	string (uuid)	Идентификатор рабочей области.

Текст запроса

Имя	Обязательно	Тип	Описание
connectionBinding	True	ConnectionBinding	Сведения о привязке подключения.

Ответы

Имя	Тип	Описание
200 OK		Запрос успешно завершен.
429 Too Many Requests	ErrorResponse	Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий Retry-After в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов. Заголовки Retry-After: integer
Other Status Codes	ErrorResponse	Распространенные коды ошибок: ItemNotFound — запрошенная семантическая модель не найдена. InvalidRequest — недопустимый запрос подключения к семантической модели привязки.

Примеры

Bind a semantic model connection example

Unbind a semantic model connection example

Bind a semantic model connection example

Образец запроса

HTTP

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

Пример ответа

Код состояния:

200

Unbind a semantic model connection example

Образец запроса

HTTP

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

Пример ответа

Код состояния:

200

Определения

Имя	Описание
BindSemanticModelConnectionRequest	Полезные данные запроса bindConnection для привязки ссылки на источник данных семантической модели к подключению к данным.
ConnectionBinding	Сведения о привязке подключения.
ConnectivityType	Тип подключения. С течением времени могут добавляться дополнительные типы подключений.
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
ListConnectionDetails	Выходные данные сведений о подключении для операций списка.

BindSemanticModelConnectionRequest

Объект

Полезные данные запроса bindConnection для привязки ссылки на источник данных семантической модели к подключению к данным.

Имя	Тип	Описание
connectionBinding	ConnectionBinding	Сведения о привязке подключения.

ConnectionBinding

Объект

Сведения о привязке подключения.

Имя	Тип	Описание
connectionDetails	ListConnectionDetails	Сведения о подключении.
connectivityType	ConnectivityType	Тип подключения.
id	string (uuid)	Идентификатор объекта подключения.

ConnectivityType

Перечисление

Тип подключения. С течением времени могут добавляться дополнительные типы подключений.

Значение	Описание
ShareableCloud	Подключение подключается через облако и может предоставляться другим пользователям.
PersonalCloud	Подключение подключается через облако и не может быть предоставлен доступ другим пользователям.
OnPremisesGateway	Подключение подключается через локальный шлюз данных.
OnPremisesGatewayPersonal	Подключение подключается через личный локальный шлюз данных.
VirtualNetworkGateway	Подключение подключается через шлюз данных виртуальной сети.
Automatic	Подключение подключается через облако с помощью неявного подключения к данным. Этот параметр доступен только для определенных сценариев, таких как семантические модели, использующие один Sign-On (единый вход).
None	Подключение не привязано

ErrorRelatedResource

Объект

Объект сведений об ошибках, связанных с ресурсом.

Имя	Тип	Описание
resourceId	string	Идентификатор ресурса, участвующий в ошибке.
resourceType	string	Тип ресурса, который участвует в ошибке.

ErrorResponse

Объект

Ответ на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
moreDetails	ErrorResponseDetails[]	Список дополнительных сведений об ошибке.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.
requestId	string (uuid)	Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Объект

Сведения об ответе на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.

ListConnectionDetails

Объект

Выходные данные сведений о подключении для операций списка.

Имя	Тип	Описание
path	string	Путь подключения.
type	string	Тип подключения.