Items - Get Connection String

サービス:

SQLEndpoint

API バージョン:

v1

指定したウェアハウスの SQL 接続文字列を返します。

Permissions

呼び出し元には、ウェアハウスの 読み取り アクセス許可が必要です。 呼び出し元には、 ビューアー 以上のワークスペース ロールが必要です。

必要な委任されたスコープ

SqlEndpoint.Read.All または SqlEndpoint.ReadWrite.All または Item.Read.All または Item.ReadWrite.All

Microsoft Entra でサポートされている ID

この API では、このセクションに記載されている Microsoft ID が サポートされます。

アイデンティティ	Support
User	イエス
サービス プリンシパル と マネージド ID	イエス

インターフェイス

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

省略可能なパラメーターを含む:

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

URI パラメーター

名前	/	必須	型	説明
sqlEndpointId	path	True	string (uuid)	SQL エンドポイント ID。
workspaceId	path	True	string (uuid)	ワークスペース ID。
guestTenantId	query		string (uuid)	エンド ユーザーのテナントが SQL エンドポイントのテナントと異なる場合のゲスト テナント ID。
privateLinkType	query		PrivateLinkType	この接続文字列で使用されるプライベート リンクの種類を示します。 追加の privateLinkType 型は、時間の経過と同時に追加される場合があります。

応答

名前	型	説明
200 OK	ConnectionStringResponse	要求は正常に完了しました。
Other Status Codes	ErrorResponse	一般的なエラー コード: ItemNotFound - 要求された項目が見つかりませんでした。 InvalidGuestTenantId - 指定された ID が存在しません。

例

Get connection string example

要求のサンプル

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

応答のサンプル

状態コード:

200

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

定義

名前	説明
ConnectionStringResponse	この SQL エンドポイントを含むワークスペースの SQL 接続文字列。
ErrorRelatedResource	エラー関連のリソース詳細オブジェクト。
ErrorResponse	エラー応答。
ErrorResponseDetails	エラー応答の詳細。
PrivateLinkType	この接続文字列で使用されるプライベート リンクの種類を示します。 追加の privateLinkType 型は、時間の経過と同時に追加される場合があります。

ConnectionStringResponse

Object

この SQL エンドポイントを含むワークスペースの SQL 接続文字列。

名前	型	説明
connectionString	string	この SQL エンドポイントを含むワークスペースの 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	ワークスペースのプライベート リンク。