Items - Get SQL Database Definition
Returnerer den angitte fellesdefinisjonen for SQL-databasen.
Denne API-en støtter langvarige operasjoner (LRO).
Når du får den offentlige definisjonen for en SQL-database, er ikke følsomhetsetiketten en del av definisjonen.
Tillatelser
Innringeren må ha lese- og skrivetillatelser for SQL-databasen.
Nødvendige delegerte omfang
SQLDatabase.ReadWrite.All eller Item.ReadWrite.All
Begrensninger
Hvis du vil hente definisjonen av et SQL-databaseelement som er beskyttet av en kryptert følsomhetsetikett, må innringeren ha tilstrekkelige bruksrettigheter til å fjerne etiketten, som konfigurert i Microsoft Purview.
Microsoft Entra-støttede identiteter
Denne API-en støtter Microsoft -identiteter oppført i denne delen.
| Identitet | Kundestøtte |
|---|---|
| User | Ja |
| tjenestekontohaver og administrerte identiteter | Ja |
Grensesnitt
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-parametere
| Name | I | Obligatorisk | Type | Beskrivelse |
|---|---|---|---|---|
|
sql
|
path | True |
string (uuid) |
SQL-database-ID-en. |
|
workspace
|
path | True |
string (uuid) |
Arbeidsområde-ID-en. |
|
format
|
query |
string |
Formatet for den offentlige SQL-databasens definisjon. Støttet format: |
Svar
| Name | Type | Beskrivelse |
|---|---|---|
| 200 OK |
Forespørselen er fullført. |
|
| 202 Accepted |
Forespørselen er godtatt. Henting av definisjonen pågår. Overskrifter
|
|
| 429 Too Many Requests |
Grensen for tjenestesats ble overskredet. Serveren returnerer en Overskrifter Retry-After: integer |
|
| Other Status Codes |
Vanlige feilkoder:
|
Eksempler
Get a Digital Twin Builder Flow public definition example
Eksempelforespørsel
POST https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/sqlDatabases/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/getDefinition
Eksempelsvar
{
"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
Definisjoner
| Name | Beskrivelse |
|---|---|
|
Error |
En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil. |
|
Error |
Objektet for feilrelaterte ressursdetaljer. |
|
Error |
Feilsvaret. |
|
Error |
Feilsvardetaljene. |
|
Payload |
Typen nyttelast for definisjonsdelen. Flere nyttelasttyper kan legges til over tid. |
|
SQLDatabase |
Det offentlige sql-databasedefinisjonsobjektet. Se denne artikkelen for mer informasjon om strukturen i SQL-databasedefinisjonen. |
|
SQLDatabase |
Det offentlige definisjonssvaret for SQL-databasen. |
|
SQLDatabase |
SQL-databasedefinisjonsdelobjekt. |
ErrorParameter
En strukturert parameter som gir ekstra maskinlesbar kontekst om en feil.
| Name | Type | Beskrivelse |
|---|---|---|
| message |
string |
En lesbar beskrivelse av parameterens betydning. |
| name |
string |
Parameteridentifikatoren. |
| value |
string |
Parameterverdien. |
ErrorRelatedResource
Objektet for feilrelaterte ressursdetaljer.
| Name | Type | Beskrivelse |
|---|---|---|
| resourceId |
string |
Ressurs-ID-en som er involvert i feilen. |
| resourceType |
string |
Typen ressurs som er involvert i feilen. |
ErrorResponse
Feilsvaret.
| Name | Type | Beskrivelse |
|---|---|---|
| errorCode |
string |
En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne. |
| isRetriable |
boolean |
Når sann, kan forespørselen prøves på nytt.
|
| message |
string |
En menneskelig lesbar representasjon av feilen. |
| moreDetails |
Liste over flere feildetaljer. |
|
| parameters |
Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen. |
|
| relatedResource |
Feilrelaterte ressursdetaljer. |
|
| requestId |
string (uuid) |
ID for forespørselen som er knyttet til feilen. |
ErrorResponseDetails
Feilsvardetaljene.
| Name | Type | Beskrivelse |
|---|---|---|
| errorCode |
string |
En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne. |
| message |
string |
En menneskelig lesbar representasjon av feilen. |
| parameters |
Strukturerte parametere som gir ekstra maskinlesbar kontekst om feilen. |
|
| relatedResource |
Feilrelaterte ressursdetaljer. |
PayloadType
Typen nyttelast for definisjonsdelen. Flere nyttelasttyper kan legges til over tid.
| Verdi | Beskrivelse |
|---|---|
| InlineBase64 |
Innebygd grunntall 64. |
SQLDatabaseDefinition
Det offentlige sql-databasedefinisjonsobjektet. Se denne artikkelen for mer informasjon om strukturen i SQL-databasedefinisjonen.
| Name | Type | Beskrivelse |
|---|---|---|
| format |
string |
Formatet for SQL-databasedefinisjonen. Støttet format: |
| parts |
En liste over definisjonsdeler. |
SQLDatabaseDefinitionResponse
Det offentlige definisjonssvaret for SQL-databasen.
| Name | Type | Beskrivelse |
|---|---|---|
| definition |
Det offentlige sql-databasedefinisjonsobjektet. Se denne artikkelen for mer informasjon om strukturen i SQL-databasedefinisjonen. |
SQLDatabasePublicDefinitionPart
SQL-databasedefinisjonsdelobjekt.
| Name | Type | Beskrivelse |
|---|---|---|
| path |
string |
Den offentlige definisjonsdelbanen for SQL-databasen. Støttede innholdsutvidelser for SQL-database: |
| payload |
string |
Den offentlige definisjonsdelen for SQL-databasen. |
| payloadType |
Nyttelasttypen. |