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

Si crea una conexión de puerta de enlace, el autor de la llamada debe tener permisos para la puerta de enlace.
El administrador de Fabric debe tener permiso concedido a las entidades de servicio. Para obtener más información, consulte: Las entidades de servicio pueden crear áreas de trabajo, conexiones e canalizaciones de implementación.

Á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
CreateStreamingVirtualNetworkGatewayConnectionRequest	Crea una conexión que se conecta a través de una puerta de enlace de datos de red virtual de streaming.
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.
allowUsageInUserControlledCode		boolean	Permitir que esta conexión se use con elementos que permitan código controlado por el usuario, como Notebook
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".

CreateStreamingVirtualNetworkGatewayConnectionRequest

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

Nombre	Requerido	Tipo	Description
connectionDetails	True	CreateConnectionDetails	Detalles de conexión de la conexión.
connectivityType	True	string: StreamingVirtualNetworkGateway	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 de streaming 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

Nombre	Tipo	Description
201 Created	Connection: ShareableCloudConnection PersonalCloudConnection OnPremisesGatewayConnection OnPremisesGatewayPersonalConnection VirtualNetworkGatewayConnection StreamingVirtualNetworkGatewayConnection	Created. La operación se realizó correctamente.
429 Too Many Requests	ErrorResponse	Se superó el límite de frecuencia de servicio. El servidor devuelve un `Retry-After` encabezado que indica, en segundos, cuánto tiempo debe esperar el cliente antes de enviar solicitudes adicionales. Encabezados Retry-After: integer
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.

Connection:

ShareableCloudConnection
PersonalCloudConnection
OnPremisesGatewayConnection
OnPremisesGatewayPersonalConnection
VirtualNetworkGatewayConnection
StreamingVirtualNetworkGatewayConnection

Created. La operación se realizó correctamente.

429 Too Many Requests

ErrorResponse

Se superó el límite de frecuencia de servicio. El servidor devuelve un Retry-After encabezado que indica, en segundos, cuánto tiempo debe esperar el cliente antes de enviar solicitudes adicionales.

Encabezados

Retry-After: integer

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

Cloud example with KeyPair credentials

On-premises gateway example

Streaming virtual network gateway example

Virtual network gateway example

Cloud example

Solicitud de ejemplo

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
}

Respuesta de muestra

status code:: 201

{
  "allowUsageInUserControlledCode": true,
  "id": "eeec9a3a-6ef5-4e2b-bb6a-0060bd2f0172",
  "gatewayId": "8f72eea3-d989-4a5a-aeed-02b3aaa2ddd0",
  "displayName": "ContosoCloudConnection",
  "connectivityType": "ShareableCloud",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;sales"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "Basic",
    "singleSignOnType": "None",
    "connectionEncryption": "NotEncrypted",
    "skipTestConnection": false
  },
  "connectionRecency": {
    "createdDateTime": "2023-05-23T16:22:20Z"
  },
  "myRole": "Owner"
}

Cloud example with KeyPair credentials

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 201

{
  "id": "eeec9a3a-6ef5-4e2b-bb6a-0060bd2f0172",
  "gatewayId": "8f72eea3-d989-4a5a-aeed-02b3aaa2ddd0",
  "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
  },
  "connectionRecency": {
    "createdDateTime": "2023-05-23T16:22:20Z"
  },
  "myRole": "Owner"
}

On-premises gateway example

Solicitud de ejemplo

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

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
  },
  "connectionRecency": {
    "createdDateTime": "2023-05-23T16:22:20Z"
  },
  "myRole": "Owner"
}

Streaming virtual network gateway example

Solicitud de ejemplo

HTTP

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

{
  "connectivityType": "StreamingVirtualNetworkGateway",
  "gatewayId": "93491300-cfbd-402f-bf17-9ace59a92354",
  "displayName": "ContosoStreamingVirtualNetworkGatewayConnection",
  "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": "ContosoStreamingVirtualNetworkGatewayConnection",
  "gatewayId": "93491300-cfbd-402f-bf17-9ace59a92354",
  "connectivityType": "StreamingVirtualNetworkGateway",
  "connectionDetails": {
    "type": "SQL",
    "path": "contoso.database.windows.net;sales"
  },
  "privacyLevel": "Organizational",
  "credentialDetails": {
    "credentialType": "Basic",
    "singleSignOnType": "None",
    "connectionEncryption": "Encrypted",
    "skipTestConnection": false
  },
  "myRole": "Owner"
}

Virtual network gateway example

Solicitud de ejemplo

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

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
  },
  "connectionRecency": {
    "createdDateTime": "2023-05-23T16:22:20Z"
  },
  "myRole": "Owner"
}

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.
ConnectionRecency	Representa los detalles de recency sobre la conexión.
ConnectionRole	Un rol de conexión. Se pueden agregar roles 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.
CreateStreamingVirtualNetworkGatewayConnectionRequest	Crea una conexión que se conecta a través de una puerta de enlace de datos de red virtual de streaming.
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.
ErrorParameter	Parámetro estructurado que proporciona contexto legible por máquina adicional sobre un error.
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.
KeyPairCredentials	Credenciales para KeyPair CredentialType.
KeyVaultSecretReference	Referencia a un secreto almacenado en Azure Key Vault.
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.
StreamingVirtualNetworkGatewayConnection	Una conexión que se conecta a través de una puerta de enlace de datos de red virtual de streaming.
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

Objeto

Credenciales para CredentialType anónimo.

Nombre	Tipo	Description
credentialType	string: Anonymous	Tipo de credencial de la conexión.

BasicCredentials

Objeto

Credenciales para CredentialType básico.

Nombre	Tipo	Description
credentialType	string: Basic	Tipo de credencial de la conexión.
password	string	La contraseña. Use password o passwordReference. No se pueden usar ambas al mismo tiempo
passwordReference	KeyVaultSecretReference	Referencia a una contraseña almacenada en Azure Key Vault. Use password o passwordReference. No puede usar ambos al mismo tiempo.
username	string	El nombre de usuario.

ConnectionDetailsBooleanParameter

Objeto

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

Objeto

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

Objeto

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

Objeto

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

Objeto

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

Objeto

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

Objeto

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

Objeto

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.

ConnectionRecency

Objeto

Representa los detalles de recency sobre la conexión.

Nombre	Tipo	Description
createdDateTime	string (date-time)	Marca de tiempo en la que se creó la conexión en UTC, utilizando el formato AAAA-MM-DDTHH:mm:ssZ.
lastBoundDateTime	string (date-time)	Marca de tiempo en la que la conexión se enlazaba más recientemente a cualquier elemento en UTC, usando el formato AAAA-MM-DDTHH:mm:ssZ.
lastCredentialUsedDateTime	string (date-time)	Marca de tiempo en la que las credenciales de conexión se usaron más recientemente en UTC, con el formato AAAA-MM-DDTHH:mm:ssZ.
myLastBoundDateTime	string (date-time)	Marca de tiempo en la que la conexión se ha enlazado más recientemente a cualquier elemento por parte del usuario que realiza la llamada en UTC, utilizando el formato AAAA-MM-DDTHH:mm:ssZ.
myLastCredentialUsedDateTime	string (date-time)	Marca de tiempo en la que el usuario que realiza la llamada usó las credenciales de conexión más recientemente en FORMATO UTC, utilizando el formato AAAA-MM-DDTHH:mm:ssZ.

ConnectionRole

Enumeración

Un rol de conexión. Se pueden agregar roles de conexión adicionales a lo largo del tiempo.

Valor	Description
User	Habilita el acceso de usuario para la conexión.
UserWithReshare	Permite al usuario volver a compartir el acceso para la conexión.
Owner	Habilita el acceso de propiedad para la conexión.
PendingOwner	La propiedad de la conexión aún no es efectiva; la entidad de seguridad debe actualizar las credenciales de conexión (mediante Update Connection API) para que sea eficaz.

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.
StreamingVirtualNetworkGateway	La conexión se conecta a través de una puerta de enlace de datos de red virtual de streaming.
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

Objeto

Nombre	Tipo	Valor predeterminado	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.
allowUsageInUserControlledCode	boolean	False	Permitir que esta conexión se use con elementos que permitan código controlado por el usuario, como Notebook
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

Objeto

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[]: ConnectionDetailsBooleanParameter[] ConnectionDetailsDateParameter[] ConnectionDetailsDateTimeParameter[] ConnectionDetailsDateTimeZoneParameter[] ConnectionDetailsDurationParameter[] ConnectionDetailsNumberParameter[] ConnectionDetailsTextParameter[] ConnectionDetailsTimeParameter[]	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

Objeto

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: AnonymousCredentials BasicCredentials KeyCredentials KeyPairCredentials ServicePrincipalCredentials SharedAccessSignatureCredentials WindowsCredentials WindowsWithoutImpersonationCredentials WorkspaceIdentityCredentials	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

Objeto

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

Objeto

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

CreateStreamingVirtualNetworkGatewayConnectionRequest

Objeto

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

Nombre	Tipo	Description
connectionDetails	CreateConnectionDetails	Detalles de conexión de la conexión.
connectivityType	string: StreamingVirtualNetworkGateway	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 de streaming 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

Objeto

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.
KeyPair	La conexión usa la autenticación de par de claves 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.

ErrorParameter

Objeto

Parámetro estructurado que proporciona contexto legible por máquina adicional sobre un error.

Nombre	Tipo	Description
message	string	Descripción legible del significado del parámetro.
name	string	El identificador de parámetros.
value	string	Es el valor del parámetro.

ErrorRelatedResource

Objeto

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

Objeto

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.
isRetriable	boolean	Cuando es true, se puede reintentar la solicitud. Use el `Retry-After` encabezado de respuesta para determinar el retraso, si está disponible.
message	string	Representación legible del error.
moreDetails	ErrorResponseDetails[]	Lista de detalles de error adicionales.
parameters	ErrorParameter[]	Parámetros estructurados que proporcionan contexto legible por máquina adicional sobre el error.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.
requestId	string (uuid)	Identificador de la solicitud asociada al error.

ErrorResponseDetails

Objeto

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.
parameters	ErrorParameter[]	Parámetros estructurados que proporcionan contexto legible por máquina adicional sobre el error.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.

KeyCredentials

Objeto

Credenciales para Key CredentialType.

Nombre	Tipo	Description
credentialType	string: Key	Tipo de credencial de la conexión.
key	string	La llave. Use key o keyReference. No puede usar ambos al mismo tiempo.
keyReference	KeyVaultSecretReference	Referencia a una clave almacenada en Azure Key Vault. Use key o keyReference. No puede usar ambos al mismo tiempo.

KeyPairCredentials

Objeto

Credenciales para KeyPair CredentialType.

Nombre	Tipo	Description
credentialType	string: KeyPair	Tipo de credencial de la conexión.
identifier	string	Identificador de la clave.
passphrase	string	Frase de contraseña para la clave privada si la clave privada está cifrada.
privateKey	string	Clave privada basada en el estándar PKCS #8.

KeyVaultSecretReference

Objeto

Referencia a un secreto almacenado en Azure Key Vault.

Nombre	Tipo	Description
connectionId	string (uuid)	Identificador de conexión de la conexión de Key Vault.
secretName	string	Nombre del secreto en Key Vault.
version	string	Versión del secreto en Key Vault.

ListConnectionDetails

Objeto

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

Objeto

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

Objeto

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

Objeto

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.
connectionRecency	ConnectionRecency	Detalles de la recencia sobre 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 de objeto de puerta de enlace a través del cual se realiza la conexión. En el caso de las conexiones en la nube, se trata del identificador de puerta de enlace virtual.
id	string (uuid)	Identificador de objeto de la conexión.
myRole	ConnectionRole	Rol efectivo de la entidad de llamada en la conexión. Cuando la entidad de seguridad forma parte de varios grupos de seguridad con distintos roles, se devuelve el rol más alto. Si la entidad de seguridad no tiene ningún rol en la conexión, esta propiedad no se devuelve.
privacyLevel	PrivacyLevel	Nivel de privacidad de la conexión.

OnPremisesGatewayCredentials

Objeto

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

Objeto

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.
connectionRecency	ConnectionRecency	Detalles de la recencia sobre 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 de objeto de puerta de enlace a través del cual se realiza la conexión. En el caso de las conexiones en la nube, se trata del identificador de puerta de enlace virtual.
id	string (uuid)	Identificador de objeto de la conexión.
myRole	ConnectionRole	Rol efectivo de la entidad de llamada en la conexión. Cuando la entidad de seguridad forma parte de varios grupos de seguridad con distintos roles, se devuelve el rol más alto. Si la entidad de seguridad no tiene ningún rol en la conexión, esta propiedad no se devuelve.
privacyLevel	PrivacyLevel	Nivel de privacidad de la conexión.

PersonalCloudConnection

Objeto

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.
connectionRecency	ConnectionRecency	Detalles de la recencia sobre 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.
gatewayId	string (uuid)	Identificador de objeto de puerta de enlace a través del cual se realiza la conexión. En el caso de las conexiones en la nube, se trata del identificador de puerta de enlace virtual.
id	string (uuid)	Identificador de objeto de la conexión.
myRole	ConnectionRole	Rol efectivo de la entidad de llamada en la conexión. Cuando la entidad de seguridad forma parte de varios grupos de seguridad con distintos roles, se devuelve el rol más alto. Si la entidad de seguridad no tiene ningún rol en la conexión, esta propiedad no se devuelve.
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

Objeto

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. Use servicePrincipalSecret o servicePrincipalSecretReference. No puede usar ambos al mismo tiempo.
servicePrincipalSecretReference	KeyVaultSecretReference	Referencia a un secreto de entidad de servicio almacenado en Azure Key Vault. Use servicePrincipalSecret o servicePrincipalSecretReference. No puede usar ambos al mismo tiempo.
tenantId	string (uuid)	Identificador de inquilino de la entidad de servicio.

ShareableCloudConnection

Objeto

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.
allowUsageInUserControlledCode	boolean	Permitir que esta conexión se use con elementos que permitan código controlado por el usuario, como Notebook.
connectionDetails	ListConnectionDetails	Detalles de conexión de la conexión.
connectionRecency	ConnectionRecency	Detalles de la recencia sobre 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.
gatewayId	string (uuid)	Identificador de objeto de puerta de enlace a través del cual se realiza la conexión. En el caso de las conexiones en la nube, se trata del identificador de puerta de enlace virtual.
id	string (uuid)	Identificador de objeto de la conexión.
myRole	ConnectionRole	Rol efectivo de la entidad de llamada en la conexión. Cuando la entidad de seguridad forma parte de varios grupos de seguridad con distintos roles, se devuelve el rol más alto. Si la entidad de seguridad no tiene ningún rol en la conexión, esta propiedad no se devuelve.
privacyLevel	PrivacyLevel	Nivel de privacidad de la conexión.

SharedAccessSignatureCredentials

Objeto

Credenciales para SharedAccessSignature CredentialType.

Nombre	Tipo	Description
credentialType	string: SharedAccessSignature	Tipo de credencial de la conexión.
token	string	El token. Use token o tokenReference. No puede usar ambos al mismo tiempo.
tokenReference	KeyVaultSecretReference	Referencia a un token almacenado en Azure Key Vault. Use token o tokenReference. No puede usar ambos al mismo tiempo.

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.

StreamingVirtualNetworkGatewayConnection

Objeto

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

Nombre	Tipo	Description
connectionDetails	ListConnectionDetails	Detalles de conexión de la conexión.
connectionRecency	ConnectionRecency	Detalles de la recencia sobre la conexión.
connectivityType	string: StreamingVirtualNetworkGateway	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.
myRole	ConnectionRole	Rol efectivo de la entidad de llamada en la conexión. Cuando la entidad de seguridad forma parte de varios grupos de seguridad con distintos roles, se devuelve el rol más alto. Si la entidad de seguridad no tiene ningún rol en la conexión, esta propiedad no se devuelve.
privacyLevel	PrivacyLevel	Nivel de privacidad de la conexión.

VirtualNetworkGatewayConnection

Objeto

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.
connectionRecency	ConnectionRecency	Detalles de la recencia sobre 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 de objeto de puerta de enlace a través del cual se realiza la conexión. En el caso de las conexiones en la nube, se trata del identificador de puerta de enlace virtual.
id	string (uuid)	Identificador de objeto de la conexión.
myRole	ConnectionRole	Rol efectivo de la entidad de llamada en la conexión. Cuando la entidad de seguridad forma parte de varios grupos de seguridad con distintos roles, se devuelve el rol más alto. Si la entidad de seguridad no tiene ningún rol en la conexión, esta propiedad no se devuelve.
privacyLevel	PrivacyLevel	Nivel de privacidad de la conexión.

WindowsCredentials

Objeto

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

Objeto

Credenciales para WindowsWithoutImpersonation CredentialType.

Nombre	Tipo	Description
credentialType	string: WindowsWithoutImpersonation	Tipo de credencial de la conexión.

WorkspaceIdentityCredentials

Objeto

Credenciales para WorkspaceIdentity CredentialType.

Nombre	Tipo	Description
credentialType	string: WorkspaceIdentity	Tipo de credencial de la conexión.