Edit

Share via

Items - Get Connection String

Service:
Warehouse
API Version:
v1

Returns the SQL connection string of the specified warehouse.

Permissions

The caller must have read permissions for the warehouse. The caller must have viewer or higher workspace role.

Required Delegated Scopes

Warehouse.Read.All or Warehouse.ReadWrite.All or Item.Read.All or Item.ReadWrite.All

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity Support
User Yes
Service principal and Managed identities Yes

Interface

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

URI Parameters

Name In Required Type Description
warehouseId
 path True

string (uuid)

The warehouse ID.
workspaceId
 path True

string (uuid)

The workspace ID.
guestTenantId
 query

string (uuid)

The guest tenant ID if the end user's tenant is different from the warehouse tenant.
privateLinkType
 query

PrivateLinkType

Indicates the type of private link this connection string uses. Additional privateLinkType types may be added over time.

Responses

Name Type Description
200 OK

ConnectionStringResponse

Request completed successfully.
Other Status Codes

ErrorResponse

Common error codes:

  • ItemNotFound - The requested item was not found.

  • InvalidGuestTenantId - The provided guest tenant ID does not exist.

Examples

Get connection string example

Sample request

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

Sample response

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

Definitions

Name Description
ConnectionStringResponse

The SQL connection string for the workspace containing this warehouse.
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.
PrivateLinkType

Indicates the type of private link this connection string uses. Additional privateLinkType types may be added over time.

ConnectionStringResponse

Object

The SQL connection string for the workspace containing this warehouse.

Name Type Description
connectionString

string

The SQL connection string for the workspace containing this warehouse.

ErrorRelatedResource

Object

The error related resource details object.

Name Type Description
resourceId

string

The resource ID that's involved in the error.
resourceType

string

The type of the resource that's involved in the error.

ErrorResponse

Object

The error response.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message

string

A human readable representation of the error.
moreDetails

ErrorResponseDetails[]

List of additional error details.
relatedResource

ErrorRelatedResource

The error related resource details.
requestId

string

ID of the request associated with the error.

ErrorResponseDetails

Object

The error response details.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message

string

A human readable representation of the error.
relatedResource

ErrorRelatedResource

The error related resource details.

PrivateLinkType

Enumeration

Indicates the type of private link this connection string uses. Additional privateLinkType types may be added over time.

Value Description
None

No private link (default).
Workspace

Workspace private Link.