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

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

ListConnectionsResponse

OK. Операция прошла успешно.

429 Too Many Requests

ErrorResponse

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

Заголовки

Retry-After: integer

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 (единый вход).
None	Подключение не привязано

CredentialType

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

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

Значение	Описание
Windows	Подключение использует проверку подлинности Windows для подключения. Поддерживается только для локальных шлюзов.
Anonymous	Подключение использует анонимную проверку подлинности для подключения.
Basic	Подключение использует обычную проверку подлинности для подключения.
Key	Подключение использует проверку подлинности ключа для подключения.
OAuth2	Подключение использует проверку подлинности OAuth 2.0 для подключения.
WindowsWithoutImpersonation	Подключение использует Windows (без возможности олицетворения) для подключения. Поддерживается только для локальных шлюзов (персональный режим).
SharedAccessSignature	Подключение использует проверку подлинности подписанного URL-адреса (SAS) для подключения.
ServicePrincipal	Подключение использует проверку подлинности субъекта-службы для подключения.
WorkspaceIdentity	Подключение использует проверку подлинности удостоверения рабочей области для подключения.
KeyPair	Подключение использует проверку подлинности пары ключей для подключения.

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	Тип подключения.

ListConnectionsResponse

Объект

Имя	Тип	Описание
continuationToken	string	Маркер для следующего пакета результирующих наборов. Если больше записей нет, он удаляется из ответа.
continuationUri	string	Универсальный код ресурса (URI) следующего пакета результирующих наборов. Если больше записей нет, он удаляется из ответа.
value	Connection[]: OnPremisesGatewayConnection[] OnPremisesGatewayPersonalConnection[] PersonalCloudConnection[] ShareableCloudConnection[] VirtualNetworkGatewayConnection[]	Список возвращенных подключений.

ListCredentialDetails

Объект

Сведения о учетных данных, возвращаемые при получении подключения.

Имя	Тип	Описание
connectionEncryption	ConnectionEncryption	Параметр шифрования подключения, используемый во время тестового подключения.
credentialType	CredentialType	Тип учетных данных подключения.
singleSignOnType	SingleSignOnType	Тип единого входа подключения.
skipTestConnection	boolean	Следует ли пропустить тестовое подключение во время создания и обновления. True. Пропустить тестовое подключение, false — не пропускайте тестовое подключение.

OnPremisesGatewayConnection

Объект

Подключение, которое подключается через локальный шлюз данных.

Имя	Тип	Описание
connectionDetails	ListConnectionDetails	Сведения о подключении.
connectivityType	string: OnPremisesGateway	Тип подключения.
credentialDetails	ListCredentialDetails	Сведения о учетных данных подключения.
displayName	string	Отображаемое имя подключения.
gatewayId	string (uuid)	Идентификатор объекта шлюза подключения.
id	string (uuid)	Идентификатор объекта подключения.
privacyLevel	PrivacyLevel	Уровень конфиденциальности подключения.

OnPremisesGatewayPersonalConnection

Объект

Подключение, которое подключается через личный локальный шлюз данных.

Имя	Тип	Описание
connectionDetails	ListConnectionDetails	Сведения о подключении.
connectivityType	string: OnPremisesGatewayPersonal	Тип подключения.
credentialDetails	ListCredentialDetails	Сведения о учетных данных подключения.
displayName	string	Отображаемое имя подключения.
gatewayId	string (uuid)	Идентификатор объекта шлюза подключения.
id	string (uuid)	Идентификатор объекта подключения.
privacyLevel	PrivacyLevel	Уровень конфиденциальности подключения.

PersonalCloudConnection

Объект

Подключение, которое подключается через облако и не может быть общим.

Имя	Тип	Описание
allowConnectionUsageInGateway	boolean	Разрешите этому подключению использовать локальные шлюзы данных или шлюзы данных виртуальной сети.
connectionDetails	ListConnectionDetails	Сведения о подключении.
connectivityType	string: PersonalCloud	Тип подключения.
credentialDetails	ListCredentialDetails	Сведения о учетных данных подключения.
displayName	string	Отображаемое имя подключения.
id	string (uuid)	Идентификатор объекта подключения.
privacyLevel	PrivacyLevel	Уровень конфиденциальности подключения.

PrivacyLevel

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

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

Значение	Описание
None	Параметр уровня конфиденциальности не настроен.
Private	Подключения, заданные как частные, содержат конфиденциальную или конфиденциальную информацию. Видимость может быть ограничена авторизованными пользователями. Данные из частного подключения не сворачиваться на другие подключения, включая другие частные подключения.
Organizational	Подключения, установленные для организации, могут сложиться в частные и другие подключения организации. Они не могут сворачиваться в общедоступные подключения. Видимость имеет значение доверенной группы.
Public	Для файлов, подключений к Интернету и данных книги можно задать общедоступные. Данные могут сложиться в другие подключения. Видимость доступна всем пользователям.

ShareableCloudConnection

Объект

Подключение, которое подключается через облако.

Имя	Тип	Описание
allowConnectionUsageInGateway	boolean	Разрешите этому подключению использовать локальные шлюзы данных или шлюзы данных виртуальной сети.
allowUsageInUserControlledCode	boolean	Разрешите этому подключению использовать элементы, разрешающие управляемый пользователем код, например Notebook.
connectionDetails	ListConnectionDetails	Сведения о подключении.
connectivityType	string: ShareableCloud	Тип подключения.
credentialDetails	ListCredentialDetails	Сведения о учетных данных подключения.
displayName	string	Отображаемое имя подключения.
id	string (uuid)	Идентификатор объекта подключения.
privacyLevel	PrivacyLevel	Уровень конфиденциальности подключения.

SingleSignOnType

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

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

Значение	Описание
None	Подключение не использует единый вход для подключения.
Kerberos	Подключение использует единый вход Kerberos для подключения.
MicrosoftEntraID	Подключение использует единый вход Microsoft Entra ID для подключения.
SecurityAssertionMarkupLanguage	Подключение использует единый вход на языке разметки утверждений безопасности (SAML) для подключения.
KerberosDirectQueryAndRefresh	Для подключения подключение используется Kerberos DirectQuery и Обновление единого входа.

VirtualNetworkGatewayConnection

Объект

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

Имя	Тип	Описание
connectionDetails	ListConnectionDetails	Сведения о подключении.
connectivityType	string: VirtualNetworkGateway	Тип подключения.
credentialDetails	ListCredentialDetails	Сведения о учетных данных подключения.
displayName	string	Отображаемое имя подключения.
gatewayId	string (uuid)	Идентификатор объекта шлюза подключения.
id	string (uuid)	Идентификатор объекта подключения.
privacyLevel	PrivacyLevel	Уровень конфиденциальности подключения.