Staging - Update Datasource Element

Dienst:
DataAgent
API-Version:
v1

Aktualisiert ein bestimmtes Schemaelement für eine Stagingdatenquelle.

Hinweis

Die Verwaltung der Daten-Agent-Konfiguration befindet sich derzeit in der Vorschau (weitere Informationen).

Wählen/deaktivieren Sie ein Element, oder legen Sie eine benutzerdefinierte Beschreibung fest. Nur bereitgestellte Felder werden aktualisiert.

Berechtigungen

Der Aufrufer muss Lese- und Schreibberechtigungen für den DataAgent besitzen.

Erforderliche delegierte Zugriffsbereiche

Item.ReadWrite.All oder DataAgent.ReadWrite.All

Von Microsoft Entra unterstützte Identitäten

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

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

Schnittstelle

PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataAgents/{dataAgentId}/staging/datasources/{datasourceId}/elements?id={id}

URI-Parameter

Name In Erforderlich Typ Beschreibung
dataAgentId
 path True

string (uuid)

Die DataAgent-ID.
datasourceId
 path True

string (uuid)

Die Datenquellen-ID.
workspaceId
 path True

string (uuid)

Die Arbeitsbereichs-ID.
id
 query True

string

Der Elementbezeichner.

Anforderungstext

Name Typ Beschreibung
description

string

Legen Sie eine benutzerdefinierte Beschreibung für das Element fest.
isSelected

boolean

Wählen Sie das Element aus, oder deaktivieren Sie es. Wenn die Auswahl aufgehoben wird, wird die Elementkonfiguration beibehalten und wiederhergestellt, wenn sie erneut ausgewählt wird.

Antworten

Name Typ Beschreibung
200 OK

DataSourceElement

Der Auftrag wurde erfolgreich abgeschlossen.
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:

  • ItemNotFound – Das angeforderte Element wurde nicht gefunden.

  • InvalidRequest – Ungültige Updateanforderung.

Beispiele

Update staging DataAgent datasource element example

Beispielanforderung

PATCH https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/dataAgents/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/staging/datasources/c1c6d12f-8d2a-4d5b-9ca1-8bb7b42d4a30/elements?id=U2NoZW1hcy9kYm8vVGFibGVzL1RyaXA=

{
  "isSelected": true
}

Beispiel für eine Antwort

Statuscode:
200 
{
  "id": "U2NoZW1hcy9kYm8vVGFibGVzL1RyaXA=",
  "isSelected": true,
  "displayName": "Trip",
  "type": "Table",
  "hasSubElements": true,
  "state": "Available",
  "lastSyncDateTime": "2025-06-15T10:30:00Z"
}

Definitionen

Name Beschreibung
DataSourceElement

Ein Datenquellenschemaelement.
ElementState

Gibt die aktuelle Verfügbarkeit des Elements im Datenquellenschema an. Zusätzliche ElementState-Typen können im Laufe der Zeit hinzugefügt werden.
ElementType

Der öffentliche Typ eines Datenquellenschemaelements. Zusätzliche ElementType-Typen können im Laufe der Zeit hinzugefügt werden.
ErrorRelatedResource

Das Objekt der fehlerbezogenen Ressourcendetails.
ErrorResponse

Die Fehlerantwort.
ErrorResponseDetails

Die Fehlerantwortdetails.
IndexState

Indexstatus für Lakehouse-Dateiverzeichnisse. Zusätzliche IndexState-Typen können im Laufe der Zeit hinzugefügt werden.
UpdateDataSourceElementRequest

Aktualisieren sie die Nutzlast einer Datenquellenelementanforderung. Nur bereitgestellte Felder werden aktualisiert.

DataSourceElement

Objekt

Ein Datenquellenschemaelement.

Name Typ Beschreibung
dataType

string

Datentyp für Spalten (z. B. Int, Zeichenfolge). Nur für Spaltenelemente vorhanden.
description

string

Benutzergruppenbeschreibung des Elements.
displayName

string

Lesbarer Name des Elements.
hasSubElements

boolean

Gibt an, ob dieses Element untergeordnete Elemente enthält, um einen Drilldown ausführen zu können.
id

string

Der Elementbezeichner. Verwenden Sie "rootId", um tiefer in die Schemastruktur einzutauchen.
indexState

IndexState

Indexstatus für Lakehouse-Dateiverzeichnisse.
isSelected

boolean

Gibt an, ob dieses Element für die Verwendung durch den DataAgent ausgewählt ist.
lastSyncDateTime

string

Das letzte Mal, als dieses Element aus dem Datenquellenschema synchronisiert wurde, als ISO 8601-Zeitstempel (z. B. 2025-06-15T10:30:00Z).
state

ElementState

Gibt an, ob das Element im Liveschema vorhanden ist.
type

ElementType

Der Typ des Schemaelements.

ElementState

Enumeration

Gibt die aktuelle Verfügbarkeit des Elements im Datenquellenschema an. Zusätzliche ElementState-Typen können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
Available

Das Element ist im Datenquellenschema verfügbar.
NotAvailable

Das Element wurde zuvor konfiguriert, ist aber nicht mehr im Datenquellenschema verfügbar.
AccessDenied

Das Datenquellenschema konnte nicht gelesen werden, da der Zugriff verweigert wurde.
AccessDeniedOap

Das Datenquellenschema konnte nicht gelesen werden, da der Zugriff durch eine Organisationszugriffsrichtlinie blockiert wird.
DatasourceNotFound

Die Datenquelle konnte nicht gefunden werden.
SchemaUnavailable

Das Datenquellenschema ist zurzeit nicht verfügbar.

ElementType

Enumeration

Der öffentliche Typ eines Datenquellenschemaelements. Zusätzliche ElementType-Typen können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
Root

Das Stammelement einer Datenquellenschemastruktur.
Files

Ein Dateicontainerelement.
Directory

Ein Verzeichniselement.
Schemas

Ein Gruppierungscontainer für Schemaelemente.
Tables

Ein Gruppierungscontainer für Tabellenelemente.
Views

Ein Gruppierungscontainer für Ansichtselemente.
Functions

Ein Gruppierungscontainer für Funktionselemente.
ScalarFunctions

Ein Gruppierungscontainer für skalare Funktionselemente.
TableValuedFunctions

Ein Gruppierungscontainer für Tabellenwert-Funktionselemente.
Shortcuts

Ein Gruppierungscontainer für Verknüpfungselemente.
MaterializedViews

Ein Gruppierungscontainer für materialisierte Ansichtselemente.
Schema

Ein Schemaelement.
Table

Ein Tabellenelement.
ExternalTable

Ein externes Tabellenelement.
MaterializedView

Ein materialisiertes Ansichtselement.
View

Ein Ansichtselement.
Column

Ein Spaltenelement.
Measure

Ein Measureelement.
Function

Ein Funktionselement.
FunctionParameter

Ein Funktionsparameterelement.
FunctionReturnValue

Ein Funktionsrückgabewertelement.
NodeType

Ein Diagrammknotentypelement.
EdgeType

Ein Graph-Randtypelement.
Entity

Ein Ontology-Entitätselement.

ErrorRelatedResource

Objekt

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

Objekt

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.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.
requestId

string (uuid)

ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

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.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.

IndexState

Enumeration

Indexstatus für Lakehouse-Dateiverzeichnisse. Zusätzliche IndexState-Typen können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
Indexed

Das Verzeichnis wurde für die unstrukturierte Suche indiziert.
Indexing

Das Verzeichnis wird derzeit indiziert.
NotIndexed

Das Verzeichnis wurde nicht indiziert.

UpdateDataSourceElementRequest

Objekt

Aktualisieren sie die Nutzlast einer Datenquellenelementanforderung. Nur bereitgestellte Felder werden aktualisiert.

Name Typ Beschreibung
description

string

Legen Sie eine benutzerdefinierte Beschreibung für das Element fest.
isSelected

boolean

Wählen Sie das Element aus, oder deaktivieren Sie es. Wenn die Auswahl aufgehoben wird, wird die Elementkonfiguration beibehalten und wiederhergestellt, wenn sie erneut ausgewählt wird.