Items - List Item Connections

Служба:
Core
Версия API:
v1

Возвращает список подключений, к которым подключен указанный элемент.
Этот API поддерживает разбивки на страницы.

Разрешения

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

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

Для API элементов используются следующие типы областей:

  • Универсальная область: Item.ReadWrite.All
  • Конкретная область: itemType. ReadWrite.All (например: Notebook.ReadWrite.All)

Дополнительные сведения о областях см. в статье "Области".

Ограничения

Этот API блокируется для элемента с защищенной меткой конфиденциальности, если вызывающий объект не имеет прав на использование для удаления метки конфиденциальности.

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

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

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

Интерфейс

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/connections
С использованием необязательных параметров: 
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items/{itemId}/connections?continuationToken={continuationToken}

Параметры URI

Имя В Обязательно Тип Описание
itemId
 path True

string (uuid)

Идентификатор элемента.
workspaceId
 path True

string (uuid)

Идентификатор рабочей области.
continuationToken
 query

string

Маркер получения следующей страницы результатов.

Ответы

Имя Тип Описание
200 OK

ItemConnections

Запрос успешно завершен.
429 Too Many Requests

ErrorResponse

Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий Retry-After в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов.

Заголовки

Retry-After: integer
Other Status Codes

ErrorResponse

Распространенные коды ошибок:

  • ItemNotFound — указывает, что сервер не может найти запрошенный элемент.

Примеры

List item connections - Semantic Model Direct Lake example
List item connections example
List item connections with continuation example

List item connections - Semantic Model Direct Lake example

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

GET https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/connections

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

Код состояния:
200 
{
  "value": [
    {
      "connectivityType": "Automatic",
      "connectionDetails": {
        "type": "SQL",
        "path": "xqoruksalslrtkdxe2bvrlwgsi-5j2iqepw1i3ucdp6bepe62hcii.datawarehouse.fabric.microsoft.com;532183f5-ac60-4d12-0fc5-4094532f14b5"
      }
    }
  ]
}

List item connections example

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

GET https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/connections

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

Код состояния:
200 
{
  "value": [
    {
      "connectivityType": "ShareableCloud",
      "displayName": "ContosoConnection1",
      "id": "6952a7b2-aea3-414f-9d85-6c0fe5d34539",
      "connectionDetails": {
        "type": "Web",
        "path": "https://www.contoso.com"
      }
    },
    {
      "connectivityType": "OnPremisesGateway",
      "displayName": "ContosoConnection2",
      "id": "0b9af1bd-e974-4893-8947-d89d5a560385",
      "gatewayId": "58376c10-5f61-4024-887e-748df4beae45",
      "connectionDetails": {
        "type": "SQL",
        "path": "contoso.database.windows.net;sales"
      }
    }
  ]
}

List item connections with continuation example

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

GET https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/connections

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

Код состояния:
200 
{
  "value": [
    {
      "connectivityType": "Automatic",
      "connectionDetails": {
        "type": "SQL",
        "path": "xqoruksalslrtkdxe2bvrlwgsi-5j2iqepw1i3ucdp6bepe62hcii.datawarehouse.fabric.microsoft.com;532183f5-ac60-4d12-0fc5-4094532f14b5"
      }
    }
  ]
}

Определения

Имя Описание
ConnectivityType

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

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

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

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

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

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

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

ItemConnection

Объект
Имя Тип Описание
connectionDetails

ListConnectionDetails

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

ConnectivityType

Тип подключения.
displayName

string

Отображаемое имя подключения. Максимальная длина — 200 символов.
gatewayId

string (uuid)

Идентификатор объекта шлюза подключения.
id

string (uuid)

Идентификатор объекта подключения.

ItemConnections

Объект
Имя Тип Описание
continuationToken

string

Маркер для следующего пакета результирующих наборов. Если больше записей нет, он удаляется из ответа.
continuationUri

string

Универсальный код ресурса (URI) следующего пакета результирующих наборов. Если больше записей нет, он удаляется из ответа.
value

ItemConnection[]

Список подключений к элементам

ListConnectionDetails

Объект

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

Имя Тип Описание
path

string

Путь подключения.
type

string

Тип подключения.