Items - Get SQL Database Definition
Belirtilen SQL veritabanı genel tanımını döndürür.
Bu API, uzun süre çalışan işlemleri (LRO)destekler.
SQL veritabanının genel tanımını aldığınızda duyarlılık etiketi tanımın bir parçası değildir.
Permissions
Çağıranın SQL veritabanı için okuma ve yazma izinlerine sahip olması gerekir.
Gerekli Temsilci Kapsamları
SQLDatabase.ReadWrite.All veya Item.ReadWrite.All
Microsoft Entra destekli kimlikler
Bu API, bu bölümde listelenen Microsoft kimliklerini destekler.
| Kimlik | Support |
|---|---|
| User | Yes |
| Hizmet sorumlusu ve yönetilen kimlikler | Yes |
Arayüz
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sqlDatabases/{sqlDatabaseId}/getDefinition
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sqlDatabases/{sqlDatabaseId}/getDefinition?format={format}
URI Parametreleri
| Name | İçinde | Gerekli | Tür | Description |
|---|---|---|---|---|
|
sql
|
path | True |
string (uuid) |
SQL veritabanı kimliği. |
|
workspace
|
path | True |
string (uuid) |
Çalışma alanı kimliği. |
|
format
|
query |
string |
SQL veritabanı genel tanımının biçimi. |
Yanıtlar
| Name | Tür | Description |
|---|---|---|
| 200 OK |
İstek başarıyla tamamlandı. |
|
| 202 Accepted |
İstek kabul edildi. Tanımı alma işlemi devam ediyor. Üst Bilgiler
|
|
| 429 Too Many Requests |
Hizmet fiyatı sınırı aşıldı. Sunucu, istemcinin ek istek göndermeden önce ne kadar beklemesi gerektiğini saniye cinsinden belirten bir Üst Bilgiler Retry-After: integer |
|
| Other Status Codes |
Yaygın hata kodları:
|
Örnekler
Get a Digital Twin Builder Flow public definition example
Örnek isteği
POST https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/sqlDatabases/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/getDefinition
Örnek yanıt
{
"definition": {
"parts": [
{
"path": "definition.dacpac",
"payload": "ew0KICAibGFrZWhvdXNlSWQiOiAiYjliNWQzNmYtNDQ0NS00MDNiLWFjODctMDE2YjFjZDIwMjExIg0KfQ==",
"payloadType": "InlineBase64"
},
{
"path": ".platform",
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
"payloadType": "InlineBase64"
}
]
}
}
Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30
Tanımlar
| Name | Description |
|---|---|
|
Error |
Hatayla ilgili kaynak ayrıntıları nesnesi. |
|
Error |
Hata yanıtı. |
|
Error |
Hata yanıtı ayrıntıları. |
|
Payload |
Tanım parçası yükünün türü. Zaman içinde ek yük türleri eklenebilir. |
|
SQLDatabase |
SQL veritabanı genel tanım nesnesi. SQL veritabanı tanımının yapısı hakkında daha fazla ayrıntı için bu makaleye bakın. |
|
SQLDatabase |
SQL veritabanı genel tanım yanıtı. |
|
SQLDatabase |
SQL veritabanı tanımı parça nesnesi. |
ErrorRelatedResource
Hatayla ilgili kaynak ayrıntıları nesnesi.
| Name | Tür | Description |
|---|---|---|
| resourceId |
string |
Hataya dahil olan kaynak kimliği. |
| resourceType |
string |
Hataya dahil olan kaynağın türü. |
ErrorResponse
Hata yanıtı.
| Name | Tür | Description |
|---|---|---|
| errorCode |
string |
Hizmetimiz ve kullanıcıları arasında standartlaştırılmış iletişime olanak sağlayan bir hata koşulu hakkında bilgi sağlayan belirli bir tanımlayıcı. |
| isRetriable |
boolean |
True olduğunda istek yeniden denenebilir. Varsa gecikmeyi |
| message |
string |
Hatanın okunabilir bir gösterimi. |
| moreDetails |
Ek hata ayrıntılarının listesi. |
|
| relatedResource |
Hatayla ilgili kaynak ayrıntıları. |
|
| requestId |
string (uuid) |
Hatayla ilişkili isteğin kimliği. |
ErrorResponseDetails
Hata yanıtı ayrıntıları.
| Name | Tür | Description |
|---|---|---|
| errorCode |
string |
Hizmetimiz ve kullanıcıları arasında standartlaştırılmış iletişime olanak sağlayan bir hata koşulu hakkında bilgi sağlayan belirli bir tanımlayıcı. |
| message |
string |
Hatanın okunabilir bir gösterimi. |
| relatedResource |
Hatayla ilgili kaynak ayrıntıları. |
PayloadType
Tanım parçası yükünün türü. Zaman içinde ek yük türleri eklenebilir.
| Değer | Description |
|---|---|
| InlineBase64 |
Satır içi Temel 64. |
SQLDatabaseDefinition
SQL veritabanı genel tanım nesnesi. SQL veritabanı tanımının yapısı hakkında daha fazla ayrıntı için bu makaleye bakın.
| Name | Tür | Description |
|---|---|---|
| format |
string |
SQL veritabanı tanımının biçimi. |
| parts |
Tanım bölümlerinin listesi. |
SQLDatabaseDefinitionResponse
SQL veritabanı genel tanım yanıtı.
| Name | Tür | Description |
|---|---|---|
| definition |
SQL veritabanı genel tanım nesnesi. SQL veritabanı tanımının yapısı hakkında daha fazla ayrıntı için bu makaleye bakın. |
SQLDatabasePublicDefinitionPart
SQL veritabanı tanımı parça nesnesi.
| Name | Tür | Description |
|---|---|---|
| path |
string |
SQL veritabanı genel tanımı bölüm yolu. |
| payload |
string |
SQL veritabanı genel tanımı parça yükü. |
| payloadType |
Yük türü. |