Items - Get Connection String

Servicio:: Warehouse

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

Warehouse.Read.All o Warehouse.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}/warehouses/{warehouseId}/connectionString

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
warehouseId	path	True	string (uuid)	Identificador del almacén.
workspaceId	path	True	string (uuid)	Identificador del área de trabajo.
guestTenantId	query		string (uuid)	Identificador de inquilino de invitado si el inquilino del usuario final es diferente del inquilino de almacenamiento.
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

Nombre	Tipo	Description
200 OK	ConnectionStringResponse	Solicitud completada 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: ItemNotFound: no se encontró el elemento solicitado. InvalidGuestTenantId: el identificador de inquilino de invitado proporcionado no existe.

ConnectionStringResponse

Solicitud completada 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:

ItemNotFound: no se encontró el elemento solicitado.
InvalidGuestTenantId: el identificador de inquilino de invitado 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/warehouses/5b218778-e7a5-4d73-8187-f10824047715/connectionString?guestTenantId=6e335e92-a2a2-4b5a-970a-bd6a89fbb765

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

Objeto

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

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

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.

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.