通过

Items - Get Connection String

服务:
Warehouse
API 版本:
v1

返回指定仓库的 SQL 连接字符串。

Permissions

调用方必须具有仓库的 读取 权限。 调用方必须具有 查看器 或更高的工作区角色。

所需的委派范围

Warehouse.Read.All 或 Warehouse.ReadWrite.All 或 Item.Read.All 或 Item.ReadWrite.All

Microsoft Entra 支持的标识

此 API 支持本节中列出的Microsoft 标识 。

身份 Support
用户 是的
服务主体 和 托管标识 是的

接口

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/warehouses/{warehouseId}/connectionString
具有可选参数: 
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/warehouses/{warehouseId}/connectionString?guestTenantId={guestTenantId}&privateLinkType={privateLinkType}

URI 参数

名称 在 必需 类型 说明
warehouseId
 path True

string (uuid)

仓库 ID。
workspaceId
 path True

string (uuid)

工作区 ID。
guestTenantId
 query

string (uuid)

如果最终用户的租户不同于仓库租户，则来宾租户 ID。
privateLinkType
 query

PrivateLinkType

指示此连接字符串使用的专用链接的类型。 可能会随着时间的推移添加其他 privateLinkType 类型。

响应

名称 类型 说明
200 OK

ConnectionStringResponse

请求成功完成。
Other Status Codes

ErrorResponse

常见错误代码：

  • ItemNotFound - 找不到请求的项目。

  • InvalidGuestTenantId - 提供的来宾租户 ID 不存在。

示例

Get connection string example

示例请求

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

示例响应

状态代码:
200 
{
  "connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m-jh0bi.zcf.datawarehouse.fabric.microsoft.com"
}

定义

名称 说明
ConnectionStringResponse

包含此仓库的工作区的 SQL 连接字符串。
ErrorRelatedResource

与错误相关的资源详细信息对象。
ErrorResponse

错误响应。
ErrorResponseDetails

错误响应详细信息。
PrivateLinkType

指示此连接字符串使用的专用链接的类型。 可能会随着时间的推移添加其他 privateLinkType 类型。

ConnectionStringResponse

Object

包含此仓库的工作区的 SQL 连接字符串。

名称 类型 说明
connectionString

string

包含此仓库的工作区的 SQL 连接字符串。

ErrorRelatedResource

Object

与错误相关的资源详细信息对象。

名称 类型 说明
resourceId

string

错误中涉及的资源 ID。
resourceType

string

错误中涉及的资源的类型。

ErrorResponse

Object

错误响应。

名称 类型 说明
errorCode

string

提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message

string

错误的人工可读表示形式。
moreDetails

ErrorResponseDetails[]

其他错误详细信息的列表。
relatedResource

ErrorRelatedResource

与错误相关的资源详细信息。
requestId

string

与错误关联的请求的 ID。

ErrorResponseDetails

Object

错误响应详细信息。

名称 类型 说明
errorCode

string

提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message

string

错误的人工可读表示形式。
relatedResource

ErrorRelatedResource

与错误相关的资源详细信息。

PrivateLinkType

枚举

指示此连接字符串使用的专用链接的类型。 可能会随着时间的推移添加其他 privateLinkType 类型。

值 说明
None

无专用链接（默认值）。
Workspace

工作区专用链接。