Items - Get Connection String

Layanan:

Warehouse

Versi API:

v1

Mengembalikan string koneksi SQL dari gudang yang ditentukan.

Permissions

Pemanggil harus memiliki izin baca untuk gudang. Pemanggil harus memiliki peran penampil atau ruang kerja yang lebih tinggi.

Cakupan yang Didelegasikan yang Diperlukan

Warehouse.Read.All atau Warehouse.ReadWrite.All atau Item.Read.All atau Item.ReadWrite.All

Identitas yang didukung Microsoft Entra

API ini mendukung identitas Microsoft yang tercantum di bagian ini.

Identitas	Support
Pengguna	Yes
Perwakilan layanan dan Identitas terkelola	Yes

Antarmuka

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/warehouses/{warehouseId}/connectionString

Dengan parameter opsional:

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
warehouseId	path	True	string (uuid)	ID gudang.
workspaceId	path	True	string (uuid)	ID ruang kerja.
guestTenantId	query		string (uuid)	ID penyewa tamu jika penyewa pengguna akhir berbeda dari penyewa gudang.
privateLinkType	query		PrivateLinkType	Menunjukkan jenis tautan privat yang digunakan string koneksi ini. Jenis tambahan privateLinkType dapat ditambahkan dari waktu ke waktu.

Respons

Nama	Jenis	Deskripsi
200 OK	ConnectionStringResponse	Permintaan berhasil diselesaikan.
429 Too Many Requests	ErrorResponse	Batas tarif layanan terlampaui. Server mengembalikan header yang Retry-After menunjukkan, dalam detik, berapa lama klien harus menunggu sebelum mengirim permintaan tambahan. Header Retry-After: integer
Other Status Codes	ErrorResponse	Kode kesalahan umum: ItemNotFound - Item yang diminta tidak ditemukan. InvalidGuestTenantId - ID penyewa tamu yang disediakan tidak ada.

Contoh

Get connection string example

Permintaan sampel

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

Respon sampel

Kode status:

200

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

Definisi

Nama	Deskripsi
ConnectionStringResponse	String koneksi SQL untuk ruang kerja yang berisi gudang ini.
ErrorRelatedResource	Objek detail sumber daya terkait kesalahan.
ErrorResponse	Respons kesalahan.
ErrorResponseDetails	Detail respons kesalahan.
PrivateLinkType	Menunjukkan jenis tautan privat yang digunakan string koneksi ini. Jenis tambahan privateLinkType dapat ditambahkan dari waktu ke waktu.

ConnectionStringResponse

Objek

String koneksi SQL untuk ruang kerja yang berisi gudang ini.

Nama	Jenis	Deskripsi
connectionString	string	String koneksi SQL untuk ruang kerja yang berisi gudang ini.

ErrorRelatedResource

Objek

Objek detail sumber daya terkait kesalahan.

Nama	Jenis	Deskripsi
resourceId	string	ID sumber daya yang terlibat dalam kesalahan.
resourceType	string	Jenis sumber daya yang terlibat dalam kesalahan.

ErrorResponse

Objek

Respons kesalahan.

Nama	Jenis	Deskripsi
errorCode	string	Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.
isRetriable	boolean	Jika benar, permintaan dapat dicoba kembali. Retry-After Gunakan header respons untuk menentukan penundaan, jika tersedia.
message	string	Representasi kesalahan yang dapat dibaca manusia.
moreDetails	ErrorResponseDetails[]	Daftar detail kesalahan tambahan.
relatedResource	ErrorRelatedResource	Detail sumber daya terkait kesalahan.
requestId	string (uuid)	ID permintaan yang terkait dengan kesalahan.

ErrorResponseDetails

Objek

Detail respons kesalahan.

Nama	Jenis	Deskripsi
errorCode	string	Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.
message	string	Representasi kesalahan yang dapat dibaca manusia.
relatedResource	ErrorRelatedResource	Detail sumber daya terkait kesalahan.

PrivateLinkType

Enumerasi

Menunjukkan jenis tautan privat yang digunakan string koneksi ini. Jenis tambahan privateLinkType dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
None	Tidak ada tautan privat (default).
Workspace	Tautan privat ruang kerja.