Items - Update SQL Database Definition

Überschreibt die Definition für die angegebene SQL-Datenbank.
Diese API unterstützt LRO-.

Das Aktualisieren der SQL-Datenbankdefinition wirkt sich nicht auf die Vertraulichkeitsbezeichnung aus.

Erlaubnisse

Der Aufrufer muss Über Lese- und Schreibberechtigungen für die SQL-Datenbank verfügen.

Erforderliche delegierte Zugriffsbereiche

SQLDatabase.ReadWrite.All oder Item.ReadWrite.All

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identity Support
Benutzer Ja
Service Principal und Verwaltete Identitäten Ja

Schnittstelle

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
sqlDatabaseId
path True

string (uuid)

Die SQL-Datenbank-ID.

workspaceId
path True

string (uuid)

Die Arbeitsbereichs-ID.

updateMetadata
query

boolean

Wenn sie auf "true" festgelegt ist und die SQL database.platform-Datei als Teil der Definition bereitgestellt wird, werden die Metadaten des Elements mithilfe der Metadaten in der SQL database.platform-Datei aktualisiert.

Anforderungstext

Name Erforderlich Typ Beschreibung
definition True

SQLDatabaseDefinition

Das öffentliche SQL-Datenbankdefinitionsobjekt. Weitere Informationen zur Struktur der SQL-Datenbankdefinition finden Sie in diesem Artikel .

Antworten

Name Typ Beschreibung
200 OK

Der Auftrag wurde erfolgreich abgeschlossen.

202 Accepted

Anforderung angenommen. Die Updatedefinition wird ausgeführt.

Header

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
429 Too Many Requests

ErrorResponse

Der Dienstratenlimit wurde überschritten. Der Server gibt einen Retry-After Header zurück, der in Sekunden angibt, wie lange der Client warten muss, bevor zusätzliche Anforderungen gesendet werden.

Header

Retry-After: integer

Other Status Codes

ErrorResponse

Häufige Fehlercodes:

  • OperationNotSupportedForItem – Vorgang für angefordertes Element nicht unterstützt.

  • CorruptedPayload – Die bereitgestellte Nutzlast ist beschädigt.

Beispiele

Update a SQL database public definition example

Beispielanforderung

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/sqlDatabases/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
ErrorParameter

Ein strukturierter Parameter, der zusätzlichen computerlesbaren Kontext zu einem Fehler bereitstellt.

ErrorRelatedResource

Das Objekt der fehlerbezogenen Ressourcendetails.

ErrorResponse

Die Fehlerantwort.

ErrorResponseDetails

Die Fehlerantwortdetails.

PayloadType

Der Typ der Definitionsteilnutzlast. Zusätzliche Nutzlasttypen können im Laufe der Zeit hinzugefügt werden.

SQLDatabaseDefinition

Das öffentliche SQL-Datenbankdefinitionsobjekt. Weitere Informationen zur Struktur der SQL-Datenbankdefinition finden Sie in diesem Artikel .

SQLDatabasePublicDefinitionPart

SQL-Datenbankdefinitionsteilobjekt.

UpdateSQLDatabaseDefinitionRequest

Aktualisieren sie die Nutzlast der öffentlichen Definitionsanforderung der SQL-Datenbank.

ErrorParameter

Ein strukturierter Parameter, der zusätzlichen computerlesbaren Kontext zu einem Fehler bereitstellt.

Name Typ Beschreibung
message

string

Eine lesbare Beschreibung der Bedeutung des Parameters.

name

string

Die Parameterkennung.

value

string

Der übergebene Wert

ErrorRelatedResource

Das Objekt der fehlerbezogenen Ressourcendetails.

Name Typ Beschreibung
resourceId

string

Die Ressourcen-ID, die an dem Fehler beteiligt ist.

resourceType

string

Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Die Fehlerantwort.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.

isRetriable

boolean

Wenn true, kann die Anforderung wiederholt werden. Verwenden Sie den Retry-After Antwortheader, um die Verzögerung zu ermitteln, falls verfügbar.

message

string

Eine menschenlesbare Darstellung des Fehlers.

moreDetails

ErrorResponseDetails[]

Liste der zusätzlichen Fehlerdetails.

parameters

ErrorParameter[]

Strukturierte Parameter, die zusätzlichen maschinenlesbaren Kontext zu dem Fehler bereitstellen.

relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.

requestId

string (uuid)

ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Die Fehlerantwortdetails.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.

message

string

Eine menschenlesbare Darstellung des Fehlers.

parameters

ErrorParameter[]

Strukturierte Parameter, die zusätzlichen maschinenlesbaren Kontext zu dem Fehler bereitstellen.

relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.

PayloadType

Der Typ der Definitionsteilnutzlast. Zusätzliche Nutzlasttypen können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
InlineBase64

Inlinebasis 64.

SQLDatabaseDefinition

Das öffentliche SQL-Datenbankdefinitionsobjekt. Weitere Informationen zur Struktur der SQL-Datenbankdefinition finden Sie in diesem Artikel .

Name Typ Beschreibung
format

string

Das Format der SQL-Datenbankdefinition. Unterstütztes Format: dacpac und sqlproj. Wenn kein Format bereitgestellt wird, dacpac wird dieses verwendet.

parts

SQLDatabasePublicDefinitionPart[]

Eine Liste der Definitionsteile.

SQLDatabasePublicDefinitionPart

SQL-Datenbankdefinitionsteilobjekt.

Name Typ Beschreibung
path

string

Der Teilpfad der öffentlichen SQL-Datenbankdefinition. Unterstützte SQL-Datenbankinhaltserweiterungen: .dacpac für dacpac das Format; .sqlproj, .sql für sqlproj das Format.

payload

string

Die Nutzlast des öffentlichen SQL-Datenbankdefinitionsteils.

payloadType

PayloadType

Der Nutzlasttyp.

UpdateSQLDatabaseDefinitionRequest

Aktualisieren sie die Nutzlast der öffentlichen Definitionsanforderung der SQL-Datenbank.

Name Typ Beschreibung
definition

SQLDatabaseDefinition

Das öffentliche SQL-Datenbankdefinitionsobjekt. Weitere Informationen zur Struktur der SQL-Datenbankdefinition finden Sie in diesem Artikel .