Connections - Create Connection

Служба:: Core

Версия API:: v1

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

Permissions

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

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

Connection.ReadWrite.All

Поддерживаемые удостоверения Microsoft Entra

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

Identity	Support
User	Yes
субъекта-службы и управляемых удостоверений	Yes

Interface

POST https://api.fabric.microsoft.com/v1/connections

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

Текст запроса может быть таким:

Имя	Описание
CreateCloudConnectionRequest
CreateOnPremisesConnectionRequest
CreateVirtualNetworkGatewayConnectionRequest

CreateCloudConnectionRequest

Имя	Обязательно	Тип	Описание
connectionDetails	True	CreateConnectionDetails	Сведения о подключении.
connectivityType	True	string: ShareableCloud	Тип подключения.
credentialDetails	True	CreateCredentialDetails	Сведения о учетных данных подключения.
displayName	True	string	Отображаемое имя подключения. Максимальная длина — 200 символов.
allowConnectionUsageInGateway		boolean	Разрешите этому подключению использовать локальные шлюзы данных или шлюзы данных виртуальной сети.
allowUsageInUserControlledCode		boolean	Разрешить использование этого подключения с элементами, разрешающими управляемый пользователем код, например Notebook
privacyLevel		PrivacyLevel	(Необязательно) Уровень конфиденциальности подключения. Если значение не передается, оно имеет значение "Организация".

CreateOnPremisesConnectionRequest

Имя	Обязательно	Тип	Описание
connectionDetails	True	CreateConnectionDetails	Сведения о подключении.
connectivityType	True	string: OnPremisesGateway	Тип подключения.
credentialDetails	True	CreateOnPremisesCredentialDetails	Сведения о учетных данных подключения.
displayName	True	string	Отображаемое имя подключения. Максимальная длина — 200 символов.
gatewayId	True	string (uuid)	Идентификатор объекта основного шлюза локального шлюза, в который создается подключение.
privacyLevel		PrivacyLevel	(Необязательно) Уровень конфиденциальности подключения. Если значение не передается, оно имеет значение "Организация".

CreateVirtualNetworkGatewayConnectionRequest

Имя	Обязательно	Тип	Описание
connectionDetails	True	CreateConnectionDetails	Сведения о подключении.
connectivityType	True	string: VirtualNetworkGateway	Тип подключения.
credentialDetails	True	CreateCredentialDetails	Сведения о учетных данных подключения.
displayName	True	string	Отображаемое имя подключения. Максимальная длина — 200 символов.
gatewayId	True	string (uuid)	Идентификатор объекта шлюза виртуальной сети, в который создается подключение.
privacyLevel		PrivacyLevel	(Необязательно) Уровень конфиденциальности подключения. Если значение не передается, оно имеет значение "Организация".

Ответы

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

201 Created

Имя	Тип	Описание
201 Created	Connection: ShareableCloudConnection PersonalCloudConnection OnPremisesGatewayConnection OnPremisesGatewayPersonalConnection VirtualNetworkGatewayConnection	Created. Операция прошла успешно.
429 Too Many Requests	ErrorResponse	Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий `Retry-After` в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов. Заголовки Retry-After: integer
Other Status Codes	ErrorResponse	Распространенные коды ошибок: DuplicateConnectionName — имя подключения уже используется. InvalidConnectionDetails — предоставленные входные данные ConnectionDetails недопустимы. InvalidCredentialDetails — предоставленные входные данные CredentialDetails недопустимы. Неверныеcredentials — не удалось установить подключение с помощью входных данных учетных данных. CreateGatewayConnectionFailed — не удалось создать подключение шлюза.

Connection:

ShareableCloudConnection
PersonalCloudConnection
OnPremisesGatewayConnection
OnPremisesGatewayPersonalConnection
VirtualNetworkGatewayConnection

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

429 Too Many Requests

ErrorResponse

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

Заголовки

Retry-After: integer

Other Status Codes

ErrorResponse

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

DuplicateConnectionName — имя подключения уже используется.
InvalidConnectionDetails — предоставленные входные данные ConnectionDetails недопустимы.
InvalidCredentialDetails — предоставленные входные данные CredentialDetails недопустимы.
Неверныеcredentials — не удалось установить подключение с помощью входных данных учетных данных.
CreateGatewayConnectionFailed — не удалось создать подключение шлюза.

Примеры

Cloud example

Cloud example with KeyPair credentials

On-premises gateway example

Virtual network gateway example

Cloud example

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

HTTP

POST https://api.fabric.microsoft.com/v1/connections

{
  "connectivityType": "ShareableCloud",
  "displayName": "ContosoCloudConnection",
  "connectionDetails": {
    "type": "SQL",
    "creationMethod": "SQL",
    "parameters": [
      {
        "dataType": "Text",
        "name": "server",
        "value": "contoso.database.windows.net"
      },
      {
        "dataType": "Text",
        "name": "database",
        "value": "sales"
      }
    ]
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false,
    "credentials": {
      "credentialType": "Basic",
      "username": "admin",
      "passwordReference": {
        "connectionId": "4399ab2c-7551-4c0e-8aa7-18fc2f217626",
        "secretName": "some-secret"
      }
    }
  },
  "allowUsageInUserControlledCode": true
}

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

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

{
  "allowUsageInUserControlledCode": true,
  "id": "eeec9a3a-6ef5-4e2b-bb6a-0060bd2f0172",
  "displayName": "ContosoCloudConnection",
  "connectivityType": "ShareableCloud",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;sales"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "Basic",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false
  }
}

Cloud example with KeyPair credentials

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

HTTP

POST https://api.fabric.microsoft.com/v1/connections

{
  "connectivityType": "ShareableCloud",
  "displayName": "SnowflakeCloudConnection",
  "connectionDetails": {
    "type": "SQL",
    "creationMethod": "SQL",
    "parameters": [
      {
        "dataType": "Text",
        "name": "server",
        "value": "contoso.database.windows.net"
      },
      {
        "dataType": "Text",
        "name": "warehouse",
        "value": "snowflake-warehouse"
      }
    ]
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false,
    "credentials": {
      "credentialType": "KeyPair",
      "identifier": "admin",
      "privateKey": "-----BEGIN ENCRYPTED PRIVATE KEY-----\\nMIIEvQIBADANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQ...\\n-----END ENCRYPTED PRIVATE KEY-----",
      "passphrase": "********"
    }
  }
}

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

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

{
  "id": "eeec9a3a-6ef5-4e2b-bb6a-0060bd2f0172",
  "displayName": "ContosoCloudConnection",
  "connectivityType": "ShareableCloud",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;snowflake-warehouse"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "KeyPair",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false
  }
}

On-premises gateway example

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

HTTP

POST https://api.fabric.microsoft.com/v1/connections

{
  "connectivityType": "OnPremisesGateway",
  "gatewayId": "93491300-cfbd-402f-bf17-9ace59a92354",
  "displayName": "ContosoOnPremisesConnection",
  "connectionDetails": {
    "type": "SQL",
    "creationMethod": "SQL",
    "parameters": [
      {
        "dataType": "Text",
        "name": "server",
        "value": "contoso.database.windows.net"
      },
      {
        "dataType": "Text",
        "name": "database",
        "value": "sales"
      }
    ]
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false,
    "credentials": {
      "credentialType": "Windows",
      "values": [
        {
          "gatewayId": "93491300-cfbd-402f-bf17-9ace59a92354",
          "encryptedCredentials": "************************************"
        },
        {
          "gatewayId": "55226bab-5024-4b72-9716-6dc8ef3a97fe",
          "encryptedCredentials": "************************************"
        }
      ]
    }
  }
}

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

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

{
  "id": "eeec9a3a-6ef5-4e2b-bb6a-0060bd2f0172",
  "displayName": "ContosoOnPremisesConnection",
  "gatewayId": "93491300-cfbd-402f-bf17-9ace59a92354",
  "connectivityType": "OnPremisesGateway",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;sales"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "Basic",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false
  }
}

Virtual network gateway example

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

HTTP

POST https://api.fabric.microsoft.com/v1/connections

{
  "connectivityType": "VirtualNetworkGateway",
  "gatewayId": "93491300-cfbd-402f-bf17-9ace59a92354",
  "displayName": "ContosoVirtualNetworkGatewayConnection",
  "connectionDetails": {
    "type": "SQL",
    "creationMethod": "SQL",
    "parameters": [
      {
        "dataType": "Text",
        "name": "server",
        "value": "contoso.database.windows.net"
      },
      {
        "dataType": "Text",
        "name": "database",
        "value": "sales"
      }
    ]
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "singleSignOnType": "None",
    "connectionEncryption": "Encrypted",
    "skipTestConnection": false,
    "credentials": {
      "credentialType": "Basic",
      "username": "admin",
      "password": "*********"
    }
  }
}

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

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

{
  "id": "eeec9a3a-6ef5-4e2b-bb6a-0060bd2f0172",
  "displayName": "ContosoVirtualNetworkGatewayConnection",
  "gatewayId": "93491300-cfbd-402f-bf17-9ace59a92354",
  "connectivityType": "VirtualNetworkGateway",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;sales"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "Basic",
    "singleSignOnType": "None",
    "connectionEncryption": "Encrypted",
    "skipTestConnection": false
  }
}

Определения

Имя	Описание
AnonymousCredentials	Учетные данные для Анонимного типа учетных данных.
BasicCredentials	Учетные данные для Basic CredentialType.
ConnectionDetailsBooleanParameter	ConnectionDetailsParameter для логического типа данных.
ConnectionDetailsDateParameter	ConnectionDetailsParameter для даты dataType.
ConnectionDetailsDateTimeParameter	ConnectionDetailsParameter для dateTime dataType.
ConnectionDetailsDateTimeZoneParameter	ConnectionDetailsParameter для dateTimeZone dataType.
ConnectionDetailsDurationParameter	ConnectionDetailsParameter для длительности dataType.
ConnectionDetailsNumberParameter	ConnectionDetailsParameter для number dataType.
ConnectionDetailsTextParameter	ConnectionDetailsParameter для текстового типа данных.
ConnectionDetailsTimeParameter	ConnectionDetailsParameter для типа данных времени.
ConnectionEncryption	Тип шифрования подключения. С течением времени могут добавляться дополнительные значения шифрования подключений.
ConnectivityType	Тип подключения. С течением времени могут добавляться дополнительные типы подключений.
CreateCloudConnectionRequest
CreateConnectionDetails	Входные данные сведений о подключении для операций создания.
CreateCredentialDetails	Входные данные учетных данных для создания подключения.
CreateOnPremisesConnectionRequest
CreateOnPremisesCredentialDetails	Входные данные учетных данных для создания подключения к локальному шлюзу.
CreateVirtualNetworkGatewayConnectionRequest
CredentialType	Тип учетных данных подключения. С течением времени могут добавляться дополнительные типы учетных данных.
DataType	Тип данных значения параметра создания подключения. С течением времени могут добавляться дополнительные значения типов данных.
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
KeyCredentials	Учетные данные для Key CredentialType.
KeyPairCredentials	Учетные данные для KeyPair CredentialType.
KeyVaultSecretReference	Ссылка на секрет, хранящийся в Azure Key Vault.
ListConnectionDetails	Выходные данные сведений о подключении для операций списка.
ListCredentialDetails	Сведения о учетных данных, возвращаемые при получении подключения.
OnPremisesCredentialEntry	Идентификатор шлюза и зашифрованные сериализованные учетные данные.
OnPremisesGatewayConnection	Подключение, которое подключается через локальный шлюз данных.
OnPremisesGatewayCredentials	Учетные данные для проверки подлинности через локальный шлюз.
OnPremisesGatewayPersonalConnection	Подключение, которое подключается через личный локальный шлюз данных.
PersonalCloudConnection	Подключение, которое подключается через облако и не может быть общим.
PrivacyLevel	Параметр уровня конфиденциальности подключения. С течением времени могут добавляться дополнительные уровни конфиденциальности.
ServicePrincipalCredentials	Учетные данные для ServicePrincipal CredentialType.
ShareableCloudConnection	Подключение, которое подключается через облако.
SharedAccessSignatureCredentials	Учетные данные для SharedAccessSignature CredentialType.
SingleSignOnType	Тип единого входа подключения. С течением времени могут добавляться дополнительные типы единого входа.
VirtualNetworkGatewayConnection	Подключение, которое подключается через шлюз данных виртуальной сети.
WindowsCredentials	Учетные данные для Windows CredentialType.
WindowsWithoutImpersonationCredentials	Учетные данные для Учетных данных WindowsWithoutImpersonation CredentialType.
WorkspaceIdentityCredentials	Учетные данные для WorkspaceIdentity CredentialType.

AnonymousCredentials

Объект

Учетные данные для Анонимного типа учетных данных.

Имя	Тип	Описание
credentialType	string: Anonymous	Тип учетных данных подключения.

BasicCredentials

Объект

Учетные данные для Basic CredentialType.

Имя	Тип	Описание
credentialType	string: Basic	Тип учетных данных подключения.
password	string	Пароль. Используйте пароль или парольReference. Вы не можете использовать оба одновременно
passwordReference	KeyVaultSecretReference	Ссылка на пароль, хранящийся в Azure Key Vault. Используйте пароль или парольReference. Вы не можете использовать оба одновременно.
username	string	Имя пользователя.

ConnectionDetailsBooleanParameter

Объект

ConnectionDetailsParameter для логического типа данных.

Имя	Тип	Описание
dataType	string: Boolean	Тип данных параметра.
name	string	Имя параметра.
value	boolean	Логическое значение.

ConnectionDetailsDateParameter

Объект

ConnectionDetailsParameter для даты dataType.

Имя	Тип	Описание
dataType	string: Date	Тип данных параметра.
name	string	Имя параметра.
value	string (date)	Значение даты с использованием формата YYYY-MM-DD.

ConnectionDetailsDateTimeParameter

Объект

ConnectionDetailsParameter для dateTime dataType.

Имя	Тип	Описание
dataType	string: DateTime	Тип данных параметра.
name	string	Имя параметра.
value	string (date-time)	Значение даты и времени с использованием YYYY-MM-DDTHH:mm:ss. Формат FFFZ.

ConnectionDetailsDateTimeZoneParameter

Объект

ConnectionDetailsParameter для dateTimeZone dataType.

Имя	Тип	Описание
dataType	string: DateTimeZone	Тип данных параметра.
name	string	Имя параметра.
value	string (date-time-offset)	Значение часового пояса даты с использованием YYYY-MM-DDTHH:mm:ss. Формат FFF±hh:mm.

ConnectionDetailsDurationParameter

Объект

ConnectionDetailsParameter для длительности dataType.

Имя	Тип	Описание
dataType	string: Duration	Тип данных параметра.
name	string	Имя параметра.
value	string (time-span)	Значение длительности с использованием формата [-]P(n)DT(n)H(n)M(n)S. Например, P3DT4H30M10S (в течение 3 дней, 4 часа, 30 минут и 10 секунд).

ConnectionDetailsNumberParameter

Объект

ConnectionDetailsParameter для number dataType.

Имя	Тип	Описание
dataType	string: Number	Тип данных параметра.
name	string	Имя параметра.
value	number	Значение числа.

ConnectionDetailsTextParameter

Объект

ConnectionDetailsParameter для текстового типа данных.

Имя	Тип	Описание
dataType	string: Text	Тип данных параметра.
name	string	Имя параметра.
value	string	Текстовое значение.

ConnectionDetailsTimeParameter

Объект

ConnectionDetailsParameter для типа данных времени.

Имя	Тип	Описание
dataType	string: Time	Тип данных параметра.
name	string	Имя параметра.
value	string (time)	Значение времени с помощью HH:mm:ss. Формат FFFZ.

ConnectionEncryption

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

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

Значение	Описание
Encrypted	Попытка подключения выполняется с помощью зашифрованного подключения.
Any	Сначала попытка подключения выполняется с помощью зашифрованного подключения, а затем возвращается к незашифрованным подключениям, если не удалось.
NotEncrypted	Попытка подключения выполняется с помощью незашифрованного подключения.

ConnectivityType

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

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

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

CreateCloudConnectionRequest

Объект

Имя	Тип	Default value	Описание
allowConnectionUsageInGateway	boolean		Разрешите этому подключению использовать локальные шлюзы данных или шлюзы данных виртуальной сети.
allowUsageInUserControlledCode	boolean	False	Разрешить использование этого подключения с элементами, разрешающими управляемый пользователем код, например Notebook
connectionDetails	CreateConnectionDetails		Сведения о подключении.
connectivityType	string: ShareableCloud		Тип подключения.
credentialDetails	CreateCredentialDetails		Сведения о учетных данных подключения.
displayName	string		Отображаемое имя подключения. Максимальная длина — 200 символов.
privacyLevel	PrivacyLevel		(Необязательно) Уровень конфиденциальности подключения. Если значение не передается, оно имеет значение "Организация".

CreateConnectionDetails

Объект

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

Имя	Тип	Описание
creationMethod	string	Метод создания, используемый для создания соединения. Для списка методов создания используйте API ListSupportedConnectionTypes .
parameters	ConnectionDetailsParameter[]: ConnectionDetailsBooleanParameter[] ConnectionDetailsDateParameter[] ConnectionDetailsDateTimeParameter[] ConnectionDetailsDateTimeZoneParameter[] ConnectionDetailsDurationParameter[] ConnectionDetailsNumberParameter[] ConnectionDetailsTextParameter[] ConnectionDetailsTimeParameter[]	Список параметров подключения. Для списка параметров для каждого метода создания используйте API ListSupportedConnectionTypes .
type	string	Тип подключения.

CreateCredentialDetails

Объект

Входные данные учетных данных для создания подключения.

Имя	Тип	Описание
connectionEncryption	ConnectionEncryption	(Необязательно) Параметр шифрования подключения, используемый во время тестового подключения. Если значение не передается, подключение не шифруется.
credentials	Credentials: AnonymousCredentials BasicCredentials KeyCredentials KeyPairCredentials ServicePrincipalCredentials SharedAccessSignatureCredentials WindowsCredentials WindowsWithoutImpersonationCredentials WorkspaceIdentityCredentials	Учетные данные подключения.
singleSignOnType	SingleSignOnType	(Необязательно) Тип единого входа подключения. Если значение не передается, подключение не использует единый вход.
skipTestConnection	boolean	Следует ли пропустить тестовое подключение во время создания и обновления. True. Пропустить тестовое подключение, false — не пропускайте тестовое подключение. Если значение не передается, оно имеет значение False.

CreateOnPremisesConnectionRequest

Объект

Имя	Тип	Описание
connectionDetails	CreateConnectionDetails	Сведения о подключении.
connectivityType	string: OnPremisesGateway	Тип подключения.
credentialDetails	CreateOnPremisesCredentialDetails	Сведения о учетных данных подключения.
displayName	string	Отображаемое имя подключения. Максимальная длина — 200 символов.
gatewayId	string (uuid)	Идентификатор объекта основного шлюза локального шлюза, в который создается подключение.
privacyLevel	PrivacyLevel	(Необязательно) Уровень конфиденциальности подключения. Если значение не передается, оно имеет значение "Организация".

CreateOnPremisesCredentialDetails

Объект

Входные данные учетных данных для создания подключения к локальному шлюзу.

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

CreateVirtualNetworkGatewayConnectionRequest

Объект

Имя	Тип	Описание
connectionDetails	CreateConnectionDetails	Сведения о подключении.
connectivityType	string: VirtualNetworkGateway	Тип подключения.
credentialDetails	CreateCredentialDetails	Сведения о учетных данных подключения.
displayName	string	Отображаемое имя подключения. Максимальная длина — 200 символов.
gatewayId	string (uuid)	Идентификатор объекта шлюза виртуальной сети, в который создается подключение.
privacyLevel	PrivacyLevel	(Необязательно) Уровень конфиденциальности подключения. Если значение не передается, оно имеет значение "Организация".

CredentialType

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

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

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

DataType

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

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

Значение	Описание
Text	Используйте текст в качестве входного значения параметра.
Number	Используйте число в качестве входного значения параметра (целочисленное или плавающее запятое).
Boolean	Используйте логическое значение в качестве входного значения параметра. False — значение равно false, true — значение равно true.
Duration	Используйте длительность в качестве входного значения параметра, используя формат [-]P(n)DT(n)H(n)M(n)S. Например, P3DT4H30M10S (в течение 3 дней, 4 часа, 30 минут и 10 секунд).
Date	Используйте дату в качестве входного значения параметра, используя формат YYYY-MM-DD.
DateTime	Используйте время даты в качестве входного значения параметра с помощью YYYY-MM-DDTHH:mm:ss. Формат FFFZ.
DateTimeZone	Используйте часовой пояс даты в качестве входного значения параметра с помощью YYYY-MM-DDTHH:mm:ss. Формат FFF±hh:mm.
Time	Используйте время в качестве входного значения параметра с помощью HH:mm:ss. Формат FFFZ.

ErrorRelatedResource

Объект

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

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

ErrorResponse

Объект

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

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

ErrorResponseDetails

Объект

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

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

KeyCredentials

Объект

Учетные данные для Key CredentialType.

Имя	Тип	Описание
credentialType	string: Key	Тип учетных данных подключения.
key	string	Ключ. Используйте ключ или ключReference. Вы не можете использовать оба одновременно.
keyReference	KeyVaultSecretReference	Ссылка на ключ, хранящийся в Azure Key Vault. Используйте ключ или ключReference. Вы не можете использовать оба одновременно.

KeyPairCredentials

Объект

Учетные данные для KeyPair CredentialType.

Имя	Тип	Описание
credentialType	string: KeyPair	Тип учетных данных подключения.
identifier	string	Идентификатор ключа.
passphrase	string	Парольная фраза для закрытого ключа, если закрытый ключ зашифрован.
privateKey	string	Закрытый ключ на основе стандарта PKCS #8.

KeyVaultSecretReference

Объект

Ссылка на секрет, хранящийся в Azure Key Vault.

Имя	Тип	Описание
connectionId	string (uuid)	Идентификатор подключения подключения Key Vault.
secretName	string	Имя секрета в Key Vault.
version	string	Версия секрета в Key Vault.

ListConnectionDetails

Объект

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

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

ListCredentialDetails

Объект

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

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

OnPremisesCredentialEntry

Объект

Идентификатор шлюза и зашифрованные сериализованные учетные данные.

Имя	Тип	Описание
encryptedCredentials	string	Зашифрованный сериализованный .json списка пар значений имен. Имя — это имя учетных данных, а значение — это значение учетных данных. Шифрование выполняется с помощью алгоритма шифрования Rivest-Shamir-Adleman (RSA) с открытым ключом локального шлюза.
gatewayId	string (uuid)	Идентификатор объекта шлюза.

OnPremisesGatewayConnection

Объект

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

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

OnPremisesGatewayCredentials

Объект

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

Имя	Тип	Описание
credentialType	CredentialType	Тип учетных данных подключения.
values	OnPremisesCredentialEntry[]	Полезные данные учетных данных для отправки в локальный шлюз.

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	Для файлов, подключений к Интернету и данных книги можно задать общедоступные. Данные могут сложиться в другие подключения. Видимость доступна всем пользователям.

ServicePrincipalCredentials

Объект

Учетные данные для ServicePrincipal CredentialType.

Имя	Тип	Описание
credentialType	string: ServicePrincipal	Тип учетных данных подключения.
servicePrincipalClientId	string (uuid)	Идентификатор клиента субъекта-службы.
servicePrincipalSecret	string	Секрет субъекта-службы. Используйте servicePrincipalSecret или servicePrincipalSecretReference. Вы не можете использовать оба одновременно.
servicePrincipalSecretReference	KeyVaultSecretReference	Ссылка на секрет субъекта-службы, хранящийся в Azure Key Vault. Используйте servicePrincipalSecret или servicePrincipalSecretReference. Вы не можете использовать оба одновременно.
tenantId	string (uuid)	Идентификатор клиента субъекта-службы.

ShareableCloudConnection

Объект

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

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

SharedAccessSignatureCredentials

Объект

Учетные данные для SharedAccessSignature CredentialType.

Имя	Тип	Описание
credentialType	string: SharedAccessSignature	Тип учетных данных подключения.
token	string	Маркер. Используйте маркер или маркерReference. Вы не можете использовать оба одновременно.
tokenReference	KeyVaultSecretReference	Ссылка на токен, хранящийся в Azure Key Vault. Используйте маркер или маркерReference. Вы не можете использовать оба одновременно.

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	Уровень конфиденциальности подключения.

WindowsCredentials

Объект

Учетные данные для Windows CredentialType.

Имя	Тип	Описание
credentialType	string: Windows	Тип учетных данных подключения.
password	string	Пароль.
username	string	Имя пользователя.

WindowsWithoutImpersonationCredentials

Объект

Учетные данные для Учетных данных WindowsWithoutImpersonation CredentialType.

Имя	Тип	Описание
credentialType	string: WindowsWithoutImpersonation	Тип учетных данных подключения.

WorkspaceIdentityCredentials

Объект

Учетные данные для WorkspaceIdentity CredentialType.

Имя	Тип	Описание
credentialType	string: WorkspaceIdentity	Тип учетных данных подключения.