Items - Get Connection String

Servicio:

SQLEndpoint

Versión de la API:

v1

Devuelve la cadena de conexión SQL del almacén especificado.

Permissions

El autor de la llamada debe tener permisos de lectura para el almacenamiento. El autor de la llamada debe tener un rol de visor o de área de trabajo superior.

Ámbitos delegados necesarios

SqlEndpoint.Read.All o SqlEndpoint.ReadWrite.All o Item.Read.All o Item.ReadWrite.All

Identidades admitidas de Microsoft Entra

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

identidad	Support
Usuario	Sí
Entidad de servicio e identidades administradas	Sí

Interfaz

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sqlEndpoints/{sqlEndpointId}/connectionString

Con parámetros opcionales:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sqlEndpoints/{sqlEndpointId}/connectionString?guestTenantId={guestTenantId}&privateLinkType={privateLinkType}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
sqlEndpointId	path	True	string (uuid)	Identificador del punto de conexión de SQL.
workspaceId	path	True	string (uuid)	Identificador del área de trabajo.
guestTenantId	query		string (uuid)	Identificador de inquilino invitado si el inquilino del usuario final es diferente del inquilino del punto de conexión de SQL.
privateLinkType	query		PrivateLinkType	Indica el tipo de vínculo privado que usa esta cadena de conexión. Se pueden agregar tipos adicionales privateLinkType a lo largo del tiempo.

Respuestas

Nombre	Tipo	Description
200 OK	ConnectionStringResponse	Solicitud completada correctamente.
Other Status Codes	ErrorResponse	Códigos de error comunes: ItemNotFound: no se encontró el elemento solicitado. InvalidGuestTenantId: el identificador proporcionado no existe.

Ejemplos

Get connection string example

Solicitud de ejemplo

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/sqlEndpoints/5b218778-e7a5-4d73-8187-f10824047715/connectionString?guestTenantId=6e335e92-a2a2-4b5a-970a-bd6a89fbb765&privateLinkType=Workspace

Respuesta de muestra

status code:

200

{
  "connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m-jh0bi.zcf.datawarehouse.fabric.microsoft.com"
}

Definiciones

Nombre	Description
ConnectionStringResponse	Cadena de conexión SQL para el área de trabajo que contiene este punto de conexión de SQL.
ErrorRelatedResource	Objeto de detalles del recurso relacionado con el error.
ErrorResponse	Respuesta de error.
ErrorResponseDetails	Detalles de la respuesta de error.
PrivateLinkType	Indica el tipo de vínculo privado que usa esta cadena de conexión. Se pueden agregar tipos adicionales privateLinkType a lo largo del tiempo.

ConnectionStringResponse

Object

Cadena de conexión SQL para el área de trabajo que contiene este punto de conexión de SQL.

Nombre	Tipo	Description
connectionString	string	Cadena de conexión SQL para el área de trabajo que contiene este punto de conexión de SQL.

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.

PrivateLinkType

Enumeración

Indica el tipo de vínculo privado que usa esta cadena de conexión. Se pueden agregar tipos adicionales privateLinkType a lo largo del tiempo.

Valor	Description
None	Sin vínculo privado (valor predeterminado).
Workspace	Vínculo privado del área de trabajo.