Items - Get SQL Database Definition

Service:: SQLDatabase

Versione API:: v1

Restituisce la definizione pubblica del database SQL specificata.
Questa API supporta operazioni con esecuzione prolungata (LRO).

Quando si ottiene la definizione pubblica di un database SQL, l'etichetta di riservatezza non fa parte della definizione.

Permissions

Il chiamante deve disporre delle autorizzazioni di lettura e scrittura per il database SQL.

Ambiti delegati obbligatori

SQLDatabase.ReadWrite.All o Item.ReadWrite.All

Limitations

Per recuperare la definizione di un elemento di database SQL protetto da un'etichetta di riservatezza crittografata, il chiamante deve disporre di diritti di utilizzo sufficienti per rimuovere l'etichetta, come configurato in Microsoft Purview.

Identità supportate da Microsoft Entra

Questa API supporta le identità di Microsoft elencate in questa sezione.

Identità	Support
User	Yes
Principale del servizio e Identità gestite	Yes

Interfaccia

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sqlDatabases/{sqlDatabaseId}/getDefinition

Con parametri facoltativi:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sqlDatabases/{sqlDatabaseId}/getDefinition?format={format}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
sqlDatabaseId	path	True	string (uuid)	ID del database SQL.
workspaceId	path	True	string (uuid)	L’ID dell’area di lavoro.
format	query		string	Formato della definizione pubblica del database SQL. Formato supportato: `dacpac` e `sqlproj`. Se non viene fornito alcun formato, `dacpac` viene utilizzato .

Risposte

Nome	Tipo	Descrizione
200 OK	SQLDatabaseDefinitionResponse	Richiesta completata correttamente.
202 Accepted		Richiesta accettata. Il recupero della definizione è in corso. Intestazioni Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	È stato superato il limite di velocità del servizio. Il server restituisce un'intestazione `Retry-After` che indica, in secondi, per quanto tempo il client deve attendere prima di inviare richieste aggiuntive. Intestazioni Retry-After: integer
Other Status Codes	ErrorResponse	Codici di errore comuni: OperationNotSupportedForItem: operazione non supportata per l'elemento richiesto.

Esempio

Get a Digital Twin Builder Flow public definition example

Esempio di richiesta

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/sqlDatabases/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/getDefinition

Risposta di esempio

Codice di stato:: 200

{
  "definition": {
    "parts": [
      {
        "path": "definition.dacpac",
        "payload": "ew0KICAibGFrZWhvdXNlSWQiOiAiYjliNWQzNmYtNDQ0NS00MDNiLWFjODctMDE2YjFjZDIwMjExIg0KfQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Codice di stato:: 202

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

Definizioni

Nome	Descrizione
ErrorParameter	Parametro strutturato che fornisce un contesto aggiuntivo leggibile dal computer relativo a un errore.
ErrorRelatedResource	Oggetto dettagli risorsa correlato all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
PayloadType	Tipo del payload della parte di definizione. È possibile aggiungere altri tipi di payload nel tempo.
SQLDatabaseDefinition	Oggetto definizione pubblica del database SQL. Per altre informazioni sulla struttura della definizione del database SQL, vedere questo articolo .
SQLDatabaseDefinitionResponse	Risposta alla definizione pubblica del database SQL.
SQLDatabasePublicDefinitionPart	Oggetto parte definizione database SQL.

ErrorParameter

Oggetto

Parametro strutturato che fornisce un contesto aggiuntivo leggibile dal computer relativo a un errore.

Nome	Tipo	Descrizione
message	string	Descrizione leggibile del significato del parametro.
name	string	L'identificatore dei parametri.
value	string	Valore del parametro.

ErrorRelatedResource

Oggetto

Oggetto dettagli risorsa correlato all'errore.

Nome	Tipo	Descrizione
resourceId	string	ID risorsa coinvolto nell'errore.
resourceType	string	Tipo della risorsa coinvolta nell'errore.

ErrorResponse

Oggetto

Risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
isRetriable	boolean	Se true, la richiesta può essere ritentata. Usare l'intestazione della `Retry-After` risposta per determinare il ritardo, se disponibile.
message	string	Rappresentazione leggibile dell'errore.
moreDetails	ErrorResponseDetails[]	Elenco di dettagli aggiuntivi sull'errore.
parameters	ErrorParameter[]	Parametri strutturati che forniscono un contesto aggiuntivo leggibile dal computer sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.
requestId	string (uuid)	ID della richiesta associata all'errore.

ErrorResponseDetails

Oggetto

Dettagli della risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
parameters	ErrorParameter[]	Parametri strutturati che forniscono un contesto aggiuntivo leggibile dal computer sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.

PayloadType

Enumerazione

Tipo del payload della parte di definizione. È possibile aggiungere altri tipi di payload nel tempo.

Valore	Descrizione
InlineBase64	Inline Base 64.

SQLDatabaseDefinition

Oggetto

Oggetto definizione pubblica del database SQL. Per altre informazioni sulla struttura della definizione del database SQL, vedere questo articolo .

Nome	Tipo	Descrizione
format	string	Formato della definizione del database SQL. Formato supportato: `dacpac` e `sqlproj`. Se non viene fornito alcun formato, `dacpac` viene utilizzato .
parts	SQLDatabasePublicDefinitionPart[]	Elenco di parti di definizione.

SQLDatabaseDefinitionResponse

Oggetto

Risposta alla definizione pubblica del database SQL.

Nome	Tipo	Descrizione
definition	SQLDatabaseDefinition	Oggetto definizione pubblica del database SQL. Per altre informazioni sulla struttura della definizione del database SQL, vedere questo articolo .

SQLDatabasePublicDefinitionPart

Oggetto

Oggetto parte definizione database SQL.

Nome	Tipo	Descrizione
path	string	Percorso della parte relativa alla definizione pubblica del database SQL. Estensioni del contenuto del database SQL supportate: `.dacpac` per `dacpac` il formato; `.sqlproj`, `.sql` per il `sqlproj` formato.
payload	string	Payload della parte della definizione pubblica del database SQL.
payloadType	PayloadType	Tipo di payload.