Compartir a través de

Connections - Create Connection

Servicio:
Core
Versión de la API:
v1

Crea una conexión.
Para cifrar las credenciales, consulte Configuración de credenciales mediante programación.

Permissions

Ámbitos delegados necesarios

Connection.ReadWrite.All

Identidades admitidas de Microsoft Entra

Esta API admite las identidades de Microsoft enumeradas en esta sección.

Identity Support
User Yes
de entidad de servicio y identidades administradas Yes

Interface

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

Cuerpo de la solicitud

El cuerpo de la solicitud puede ser uno de los siguientes:

Nombre Description
CreateCloudConnectionRequest
CreateOnPremisesConnectionRequest
CreateVirtualNetworkGatewayConnectionRequest

CreateCloudConnectionRequest

Nombre Requerido Tipo Description
connectionDetails True

CreateConnectionDetails

Detalles de conexión de la conexión.
connectivityType True string:

ShareableCloud

Tipo de conectividad de la conexión.
credentialDetails True

CreateCredentialDetails

Detalles de credenciales de la conexión.
displayName True

string

Nombre para mostrar de la conexión. La longitud máxima es de 200 caracteres.
allowConnectionUsageInGateway

boolean

Permitir que esta conexión se use con puertas de enlace de datos locales o puertas de enlace de datos de red virtual.
privacyLevel

PrivacyLevel

(Opcional) Nivel de privacidad de la conexión. Cuando no se pasa ningún valor, se establece en "Organizativo".

CreateOnPremisesConnectionRequest

Nombre Requerido Tipo Description
connectionDetails True

CreateConnectionDetails

Detalles de conexión de la conexión.
connectivityType True string:

OnPremisesGateway

Tipo de conectividad de la conexión.
credentialDetails True

CreateOnPremisesCredentialDetails

Detalles de credenciales de la conexión.
displayName True

string

Nombre para mostrar de la conexión. La longitud máxima es de 200 caracteres.
gatewayId True

string (uuid)

Identificador de objeto de la puerta de enlace principal de la puerta de enlace local en la que se crea la conexión.
privacyLevel

PrivacyLevel

(Opcional) Nivel de privacidad de la conexión. Cuando no se pasa ningún valor, se establece en "Organizativo".

CreateVirtualNetworkGatewayConnectionRequest

Nombre Requerido Tipo Description
connectionDetails True

CreateConnectionDetails

Detalles de conexión de la conexión.
connectivityType True string:

VirtualNetworkGateway

Tipo de conectividad de la conexión.
credentialDetails True

CreateCredentialDetails

Detalles de credenciales de la conexión.
displayName True

string

Nombre para mostrar de la conexión. La longitud máxima es de 200 caracteres.
gatewayId True

string (uuid)

Identificador de objeto de la puerta de enlace de red virtual en la que se crea la conexión.
privacyLevel

PrivacyLevel

(Opcional) Nivel de privacidad de la conexión. Cuando no se pasa ningún valor, se establece en "Organizativo".

Respuestas

Nombre Tipo Description
201 Created Connection:

Created. La operación se realizó correctamente.
Other Status Codes

ErrorResponse

Códigos de error comunes:

  • DuplicateConnectionName: el nombre de conexión ya está en uso.

  • InvalidConnectionDetails: la entrada ConnectionDetails proporcionada no es válida.

  • InvalidCredentialDetails: la entrada CredentialDetails proporcionada no es válida.

  • IncorrectoCredentials: no se pudo establecer la conexión mediante la entrada Credenciales.

  • CreateGatewayConnectionFailed: no se pudo crear la conexión de puerta de enlace.

Ejemplos

Cloud example
On-premises gateway example
Virtual network gateway example

Cloud example

Solicitud de ejemplo

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",
      "password": "********"
    }
  }
}

Respuesta de muestra

status code:
201 
{
  "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
  }
}

On-premises gateway example

Solicitud de ejemplo

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": "************************************"
        }
      ]
    }
  }
}

Respuesta de muestra

status code:
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

Solicitud de ejemplo

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

Respuesta de muestra

status code:
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
  }
}

Definiciones

Nombre Description
AnonymousCredentials

Credenciales para CredentialType anónimo.
BasicCredentials

Credenciales para CredentialType básico.
ConnectionDetailsBooleanParameter

ConnectionDetailsParameter para dataType booleano.
ConnectionDetailsDateParameter

ConnectionDetailsParameter para date dataType.
ConnectionDetailsDateTimeParameter

ConnectionDetailsParameter para dataType dateTime.
ConnectionDetailsDateTimeZoneParameter

ConnectionDetailsParameter para dataType dateTimeZone.
ConnectionDetailsDurationParameter

ConnectionDetailsParameter para duration dataType.
ConnectionDetailsNumberParameter

ConnectionDetailsParameter para number dataType.
ConnectionDetailsTextParameter

ConnectionDetailsParameter para text dataType.
ConnectionDetailsTimeParameter

ConnectionDetailsParameter para time dataType.
ConnectionEncryption

Tipo de cifrado de conexión de la conexión. Se pueden agregar valores de cifrado de conexión adicionales a lo largo del tiempo.
ConnectivityType

Tipo de conectividad de la conexión. Se pueden agregar tipos de conectividad adicionales a lo largo del tiempo.
CreateCloudConnectionRequest
CreateConnectionDetails

Entrada de detalles de conexión para las operaciones de creación.
CreateCredentialDetails

Entrada de detalles de credenciales para crear una conexión.
CreateOnPremisesConnectionRequest
CreateOnPremisesCredentialDetails

Entrada de detalles de credenciales para crear una conexión de puerta de enlace local.
CreateVirtualNetworkGatewayConnectionRequest
CredentialType

Tipo de credencial de la conexión. Se pueden agregar tipos de credenciales adicionales a lo largo del tiempo.
DataType

Tipo de datos del valor del parámetro de creación de conexión. Se pueden agregar valores de tipo de datos adicionales a lo largo del tiempo.
ErrorRelatedResource

Objeto de detalles del recurso relacionado con el error.
ErrorResponse

Respuesta de error.
ErrorResponseDetails

Detalles de la respuesta de error.
KeyCredentials

Credenciales para Key CredentialType.
ListConnectionDetails

Salida de detalles de conexión para las operaciones de lista.
ListCredentialDetails

Los detalles de credenciales devueltos al capturar una conexión.
OnPremisesCredentialEntry

Un identificador de puerta de enlace y sus credenciales serializadas cifradas.
OnPremisesGatewayConnection

Una conexión que se conecta a través de la puerta de enlace de datos local.
OnPremisesGatewayCredentials

Credenciales para autenticarse a través de una puerta de enlace local.
OnPremisesGatewayPersonalConnection

Una conexión que se conecta a través de una puerta de enlace de datos local personal.
PersonalCloudConnection

Una conexión que se conecta a través de la nube y no se puede compartir.
PrivacyLevel

Configuración del nivel de privacidad de la conexión. Se pueden agregar niveles de privacidad adicionales a lo largo del tiempo.
ServicePrincipalCredentials

Credenciales para ServicePrincipal CredentialType.
ShareableCloudConnection

Una conexión que se conecta a través de la nube.
SharedAccessSignatureCredentials

Credenciales para SharedAccessSignature CredentialType.
SingleSignOnType

Tipo de inicio de sesión único de la conexión. Se pueden agregar tipos de inicio de sesión único adicionales a lo largo del tiempo.
VirtualNetworkGatewayConnection

Una conexión que se conecta a través de una puerta de enlace de datos de red virtual.
WindowsCredentials

Credenciales de Windows CredentialType.
WindowsWithoutImpersonationCredentials

Credenciales para WindowsWithoutImpersonation CredentialType.
WorkspaceIdentityCredentials

Credenciales para WorkspaceIdentity CredentialType.

AnonymousCredentials

Object

Credenciales para CredentialType anónimo.

Nombre Tipo Description
credentialType string:

Anonymous

Tipo de credencial de la conexión.

BasicCredentials

Object

Credenciales para CredentialType básico.

Nombre Tipo Description
credentialType string:

Basic

Tipo de credencial de la conexión.
password

string

La contraseña.
username

string

El nombre de usuario.

ConnectionDetailsBooleanParameter

Object

ConnectionDetailsParameter para dataType booleano.

Nombre Tipo Description
dataType string:

Boolean

Tipo de datos del parámetro.
name

string

Nombre del parámetro.
value

boolean

Valor booleano.

ConnectionDetailsDateParameter

Object

ConnectionDetailsParameter para date dataType.

Nombre Tipo Description
dataType string:

Date

Tipo de datos del parámetro.
name

string

Nombre del parámetro.
value

string (date)

Valor de fecha que usa el formato aaaa-MM-DD.

ConnectionDetailsDateTimeParameter

Object

ConnectionDetailsParameter para dataType dateTime.

Nombre Tipo Description
dataType string:

DateTime

Tipo de datos del parámetro.
name

string

Nombre del parámetro.
value

string (date-time)

Valor de fecha y hora con AAAA-MM-DDTHH:mm:ss. Formato FFFZ.

ConnectionDetailsDateTimeZoneParameter

Object

ConnectionDetailsParameter para dataType dateTimeZone.

Nombre Tipo Description
dataType string:

DateTimeZone

Tipo de datos del parámetro.
name

string

Nombre del parámetro.
value

string (date-time-offset)

Valor de zona horaria de fecha con AAAA-MM-DDTHH:mm:ss. Formato FFF±hh:mm.

ConnectionDetailsDurationParameter

Object

ConnectionDetailsParameter para duration dataType.

Nombre Tipo Description
dataType string:

Duration

Tipo de datos del parámetro.
name

string

Nombre del parámetro.
value

string (time-span)

El valor de duración con el formato DE DT(n)DT(n)H(n)M(n)S. Por ejemplo: P3DT4H30M10S (durante 3 días, 4 horas, 30 minutos y 10 segundos).

ConnectionDetailsNumberParameter

Object

ConnectionDetailsParameter para number dataType.

Nombre Tipo Description
dataType string:

Number

Tipo de datos del parámetro.
name

string

Nombre del parámetro.
value

number

Valor numérico.

ConnectionDetailsTextParameter

Object

ConnectionDetailsParameter para text dataType.

Nombre Tipo Description
dataType string:

Text

Tipo de datos del parámetro.
name

string

Nombre del parámetro.
value

string

Valor de texto.

ConnectionDetailsTimeParameter

Object

ConnectionDetailsParameter para time dataType.

Nombre Tipo Description
dataType string:

Time

Tipo de datos del parámetro.
name

string

Nombre del parámetro.
value

string (time)

Valor de hora mediante HH:mm:ss. Formato FFFZ.

ConnectionEncryption

Enumeración

Tipo de cifrado de conexión de la conexión. Se pueden agregar valores de cifrado de conexión adicionales a lo largo del tiempo.

Valor Description
Encrypted

El intento de conexión se realiza mediante una conexión cifrada.
Any

El intento de conexión se realiza primero mediante una conexión cifrada y, a continuación, vuelve a la conexión sin cifrar si no se realiza correctamente.
NotEncrypted

El intento de conexión se realiza mediante una conexión sin cifrar.

ConnectivityType

Enumeración

Tipo de conectividad de la conexión. Se pueden agregar tipos de conectividad adicionales a lo largo del tiempo.

Valor Description
ShareableCloud

La conexión se conecta a través de la nube y se puede compartir con otros usuarios.
PersonalCloud

La conexión se conecta a través de la nube y no se puede compartir con otros usuarios.
OnPremisesGateway

La conexión se conecta a través de una puerta de enlace de datos local.
OnPremisesGatewayPersonal

La conexión se conecta a través de una puerta de enlace de datos local personal.
VirtualNetworkGateway

La conexión se conecta a través de una puerta de enlace de datos de red virtual.
Automatic

La conexión se conecta a través de la nube mediante una conexión de datos implícita. Esta opción solo está disponible para escenarios específicos, como modelos semánticos que usan single Sign-On (SSO)."
None

La conexión no está enlazada

CreateCloudConnectionRequest

Object
Nombre Tipo Description
allowConnectionUsageInGateway

boolean

Permitir que esta conexión se use con puertas de enlace de datos locales o puertas de enlace de datos de red virtual.
connectionDetails

CreateConnectionDetails

Detalles de conexión de la conexión.
connectivityType string:

ShareableCloud

Tipo de conectividad de la conexión.
credentialDetails

CreateCredentialDetails

Detalles de credenciales de la conexión.
displayName

string

Nombre para mostrar de la conexión. La longitud máxima es de 200 caracteres.
privacyLevel

PrivacyLevel

(Opcional) Nivel de privacidad de la conexión. Cuando no se pasa ningún valor, se establece en "Organizativo".

CreateConnectionDetails

Object

Entrada de detalles de conexión para las operaciones de creación.

Nombre Tipo Description
creationMethod

string

Método de creación que se usa para crear la conexión. Para obtener una lista de métodos de creación, use listSupportedConnectionTypes API.
parameters ConnectionDetailsParameter[]:

Lista de parámetros de conexión. Para obtener una lista de parámetros para cada método de creación, use listSupportedConnectionTypes API.
type

string

Tipo de la conexión.

CreateCredentialDetails

Object

Entrada de detalles de credenciales para crear una conexión.

Nombre Tipo Description
connectionEncryption

ConnectionEncryption

(Opcional) Configuración de cifrado de conexión que se usa durante la conexión de prueba. Cuando no se pasa ningún valor, la conexión no se cifra.
credentials Credentials:

Credenciales de la conexión.
singleSignOnType

SingleSignOnType

(Opcional) Tipo de inicio de sesión único de la conexión. Cuando no se pasa ningún valor, la conexión no usa el inicio de sesión único.
skipTestConnection

boolean

Si la conexión debe omitir la conexión de prueba durante la creación y actualización. True: omita la conexión de prueba, False: no omita la conexión de prueba. Cuando no se pasa ningún valor, se establece en "False".

CreateOnPremisesConnectionRequest

Object
Nombre Tipo Description
connectionDetails

CreateConnectionDetails

Detalles de conexión de la conexión.
connectivityType string:

OnPremisesGateway

Tipo de conectividad de la conexión.
credentialDetails

CreateOnPremisesCredentialDetails

Detalles de credenciales de la conexión.
displayName

string

Nombre para mostrar de la conexión. La longitud máxima es de 200 caracteres.
gatewayId

string (uuid)

Identificador de objeto de la puerta de enlace principal de la puerta de enlace local en la que se crea la conexión.
privacyLevel

PrivacyLevel

(Opcional) Nivel de privacidad de la conexión. Cuando no se pasa ningún valor, se establece en "Organizativo".

CreateOnPremisesCredentialDetails

Object

Entrada de detalles de credenciales para crear una conexión de puerta de enlace local.

Nombre Tipo Description
connectionEncryption

ConnectionEncryption

(Opcional) Configuración de cifrado de conexión que se usa durante la conexión de prueba. Cuando no se pasa ningún valor, la conexión no se cifra.
credentials

OnPremisesGatewayCredentials

Credenciales de la conexión.
singleSignOnType

SingleSignOnType

(Opcional) Tipo de inicio de sesión único de la conexión. Cuando no se pasa ningún valor, la conexión no usa el inicio de sesión único.
skipTestConnection

boolean

Si la conexión debe omitir la conexión de prueba durante la creación y actualización. True: omita la conexión de prueba, False: no omita la conexión de prueba. Cuando no se pasa ningún valor, se establece en "False".

CreateVirtualNetworkGatewayConnectionRequest

Object
Nombre Tipo Description
connectionDetails

CreateConnectionDetails

Detalles de conexión de la conexión.
connectivityType string:

VirtualNetworkGateway

Tipo de conectividad de la conexión.
credentialDetails

CreateCredentialDetails

Detalles de credenciales de la conexión.
displayName

string

Nombre para mostrar de la conexión. La longitud máxima es de 200 caracteres.
gatewayId

string (uuid)

Identificador de objeto de la puerta de enlace de red virtual en la que se crea la conexión.
privacyLevel

PrivacyLevel

(Opcional) Nivel de privacidad de la conexión. Cuando no se pasa ningún valor, se establece en "Organizativo".

CredentialType

Enumeración

Tipo de credencial de la conexión. Se pueden agregar tipos de credenciales adicionales a lo largo del tiempo.

Valor Description
Windows

La conexión usa la autenticación de Windows para conectarse. Solo se admite para puertas de enlace locales.
Anonymous

La conexión usa la autenticación anónima para conectarse.
Basic

La conexión usa la autenticación básica para conectarse.
Key

La conexión usa la autenticación de clave para conectarse.
OAuth2

La conexión usa la autenticación de OAuth 2.0 para conectarse.
WindowsWithoutImpersonation

La conexión usa Windows (sin la opción de suplantación) para conectarse. Solo se admite para puertas de enlace locales (modo personal).
SharedAccessSignature

La conexión usa la autenticación de firma de acceso compartido (SAS) para conectarse.
ServicePrincipal

La conexión usa la autenticación de entidad de servicio para conectarse.
WorkspaceIdentity

La conexión usa la autenticación de identidad del área de trabajo para conectarse.

DataType

Enumeración

Tipo de datos del valor del parámetro de creación de conexión. Se pueden agregar valores de tipo de datos adicionales a lo largo del tiempo.

Valor Description
Text

Use texto como valor de entrada del parámetro.
Number

Use number como valor de entrada del parámetro (entero o punto flotante).
Boolean

Use booleano como valor de entrada del parámetro. False: el valor es false, True: el valor es true.
Duration

Use la duración como valor de entrada del parámetro, utilizando el formato DESDS .P(n)DT(n)H(n)M(n).S. Por ejemplo: P3DT4H30M10S (durante 3 días, 4 horas, 30 minutos y 10 segundos).
Date

Use date como valor de entrada del parámetro mediante el formato AAAA-MM-DD.
DateTime

Use la fecha y hora como valor de entrada del parámetro, mediante AAAA-MM-DDTHH:mm:ss. Formato FFFZ.
DateTimeZone

Use la zona horaria de fecha como valor de entrada del parámetro, mediante AAAA-MM-DDTHH:mm:ss. Formato FFF±hh:mm.
Time

Use la hora como valor de entrada del parámetro mediante HH:mm:ss. Formato FFFZ.

ErrorRelatedResource

Object

Objeto de detalles del recurso relacionado con el error.

Nombre Tipo Description
resourceId

string

Identificador de recurso implicado en el error.
resourceType

string

Tipo del recurso implicado en el error.

ErrorResponse

Object

Respuesta de error.

Nombre Tipo Description
errorCode

string

Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message

string

Representación legible del error.
moreDetails

ErrorResponseDetails[]

Lista de detalles de error adicionales.
relatedResource

ErrorRelatedResource

Detalles del recurso relacionado con el error.
requestId

string

Identificador de la solicitud asociada al error.

ErrorResponseDetails

Object

Detalles de la respuesta de error.

Nombre Tipo Description
errorCode

string

Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message

string

Representación legible del error.
relatedResource

ErrorRelatedResource

Detalles del recurso relacionado con el error.

KeyCredentials

Object

Credenciales para Key CredentialType.

Nombre Tipo Description
credentialType string:

Key

Tipo de credencial de la conexión.
key

string

La llave.

ListConnectionDetails

Object

Salida de detalles de conexión para las operaciones de lista.

Nombre Tipo Description
path

string

Ruta de acceso de la conexión.
type

string

Tipo de la conexión.

ListCredentialDetails

Object

Los detalles de credenciales devueltos al capturar una conexión.

Nombre Tipo Description
connectionEncryption

ConnectionEncryption

Configuración de cifrado de conexión que se usa durante la conexión de prueba.
credentialType

CredentialType

Tipo de credencial de la conexión.
singleSignOnType

SingleSignOnType

Tipo de inicio de sesión único de la conexión.
skipTestConnection

boolean

Si la conexión debe omitir la conexión de prueba durante la creación y actualización. True: omita la conexión de prueba, False: no omita la conexión de prueba.

OnPremisesCredentialEntry

Object

Un identificador de puerta de enlace y sus credenciales serializadas cifradas.

Nombre Tipo Description
encryptedCredentials

string

El .json serializado cifrado de la lista de pares de valores de nombre. Name es un nombre de credencial y el valor es un valor de credencial. El cifrado se realiza mediante el algoritmo de cifrado Rivest-Shamir-Adleman (RSA) con la clave pública del miembro de puerta de enlace local.
gatewayId

string (uuid)

Identificador de objeto de la puerta de enlace.

OnPremisesGatewayConnection

Object

Una conexión que se conecta a través de la puerta de enlace de datos local.

Nombre Tipo Description
connectionDetails

ListConnectionDetails

Detalles de conexión de la conexión.
connectivityType string:

OnPremisesGateway

Tipo de conectividad de la conexión.
credentialDetails

ListCredentialDetails

Detalles de credenciales de la conexión.
displayName

string

Nombre para mostrar de la conexión.
gatewayId

string (uuid)

Identificador del objeto de puerta de enlace de la conexión.
id

string (uuid)

Identificador de objeto de la conexión.
privacyLevel

PrivacyLevel

Nivel de privacidad de la conexión.

OnPremisesGatewayCredentials

Object

Credenciales para autenticarse a través de una puerta de enlace local.

Nombre Tipo Description
credentialType

CredentialType

Tipo de credencial de la conexión.
values

OnPremisesCredentialEntry[]

Carga de credenciales que se va a enviar a la puerta de enlace local.

OnPremisesGatewayPersonalConnection

Object

Una conexión que se conecta a través de una puerta de enlace de datos local personal.

Nombre Tipo Description
connectionDetails

ListConnectionDetails

Detalles de conexión de la conexión.
connectivityType string:

OnPremisesGatewayPersonal

Tipo de conectividad de la conexión.
credentialDetails

ListCredentialDetails

Detalles de credenciales de la conexión.
displayName

string

Nombre para mostrar de la conexión.
gatewayId

string (uuid)

Identificador del objeto de puerta de enlace de la conexión.
id

string (uuid)

Identificador de objeto de la conexión.
privacyLevel

PrivacyLevel

Nivel de privacidad de la conexión.

PersonalCloudConnection

Object

Una conexión que se conecta a través de la nube y no se puede compartir.

Nombre Tipo Description
allowConnectionUsageInGateway

boolean

Permitir que esta conexión se use con puertas de enlace de datos locales o puertas de enlace de datos de red virtual.
connectionDetails

ListConnectionDetails

Detalles de conexión de la conexión.
connectivityType string:

PersonalCloud

Tipo de conectividad de la conexión.
credentialDetails

ListCredentialDetails

Detalles de credenciales de la conexión.
displayName

string

Nombre para mostrar de la conexión.
id

string (uuid)

Identificador de objeto de la conexión.
privacyLevel

PrivacyLevel

Nivel de privacidad de la conexión.

PrivacyLevel

Enumeración

Configuración del nivel de privacidad de la conexión. Se pueden agregar niveles de privacidad adicionales a lo largo del tiempo.

Valor Description
None

No se ha configurado ninguna configuración de nivel de privacidad.
Private

Las conexiones establecidas en private contienen información confidencial o confidencial. La visibilidad se puede restringir a los usuarios autorizados. Los datos de una conexión privada no se plegarán a otras conexiones, incluidas otras conexiones privadas.
Organizational

Las conexiones establecidas en la organización pueden plegarse a conexiones privadas y otras conexiones organizativas. No se pueden plegar a conexiones públicas. La visibilidad se establece en un grupo de confianza.
Public

Los archivos, las conexiones a Internet y los datos del libro se pueden establecer en público. Los datos se pueden plegar a otras conexiones. La visibilidad está disponible para todos los usuarios.

ServicePrincipalCredentials

Object

Credenciales para ServicePrincipal CredentialType.

Nombre Tipo Description
credentialType string:

ServicePrincipal

Tipo de credencial de la conexión.
servicePrincipalClientId

string (uuid)

Identificador de cliente de la entidad de servicio.
servicePrincipalSecret

string

Secreto de la entidad de servicio.
tenantId

string (uuid)

Identificador de inquilino de la entidad de servicio.

ShareableCloudConnection

Object

Una conexión que se conecta a través de la nube.

Nombre Tipo Description
allowConnectionUsageInGateway

boolean

Permitir que esta conexión se use con puertas de enlace de datos locales o puertas de enlace de datos de red virtual.
connectionDetails

ListConnectionDetails

Detalles de conexión de la conexión.
connectivityType string:

ShareableCloud

Tipo de conectividad de la conexión.
credentialDetails

ListCredentialDetails

Detalles de credenciales de la conexión.
displayName

string

Nombre para mostrar de la conexión.
id

string (uuid)

Identificador de objeto de la conexión.
privacyLevel

PrivacyLevel

Nivel de privacidad de la conexión.

SharedAccessSignatureCredentials

Object

Credenciales para SharedAccessSignature CredentialType.

Nombre Tipo Description
credentialType string:

SharedAccessSignature

Tipo de credencial de la conexión.
token

string

El token.

SingleSignOnType

Enumeración

Tipo de inicio de sesión único de la conexión. Se pueden agregar tipos de inicio de sesión único adicionales a lo largo del tiempo.

Valor Description
None

La conexión no usa el inicio de sesión único para conectarse.
Kerberos

La conexión usa el inicio de sesión único de Kerberos para conectarse.
MicrosoftEntraID

La conexión usa el inicio de sesión único de Microsoft Entra ID para conectarse.
SecurityAssertionMarkupLanguage

Connection usa el inicio de sesión único de Security Assertion Markup Language (SAML) para conectarse.
KerberosDirectQueryAndRefresh

La conexión usa DirectQuery de Kerberos y Refresh inicio de sesión único para conectarse.

VirtualNetworkGatewayConnection

Object

Una conexión que se conecta a través de una puerta de enlace de datos de red virtual.

Nombre Tipo Description
connectionDetails

ListConnectionDetails

Detalles de conexión de la conexión.
connectivityType string:

VirtualNetworkGateway

Tipo de conectividad de la conexión.
credentialDetails

ListCredentialDetails

Detalles de credenciales de la conexión.
displayName

string

Nombre para mostrar de la conexión.
gatewayId

string (uuid)

Identificador del objeto de puerta de enlace de la conexión.
id

string (uuid)

Identificador de objeto de la conexión.
privacyLevel

PrivacyLevel

Nivel de privacidad de la conexión.

WindowsCredentials

Object

Credenciales de Windows CredentialType.

Nombre Tipo Description
credentialType string:

Windows

Tipo de credencial de la conexión.
password

string

La contraseña.
username

string

El nombre de usuario.

WindowsWithoutImpersonationCredentials

Object

Credenciales para WindowsWithoutImpersonation CredentialType.

Nombre Tipo Description
credentialType string:

WindowsWithoutImpersonation

Tipo de credencial de la conexión.

WorkspaceIdentityCredentials

Object

Credenciales para WorkspaceIdentity CredentialType.

Nombre Tipo Description
credentialType string:

WorkspaceIdentity

Tipo de credencial de la conexión.