Staging - Update Datasource

Dienst:: DataAgent

API-Version:: v1

Aktualisiert Metadaten für eine bestimmte Stagingdatenquelle des angegebenen DataAgent.

Hinweis

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

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}

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.

Anforderungstext

Name	Typ	Beschreibung
description	string	Die Beschreibung der Datenquelle.
instructions	string	Benutzerdefinierte KI-Anweisungen speziell für diese Datenquelle.

Antworten

Name Typ Beschreibung

200 OK

Name	Typ	Beschreibung
200 OK	DataAgentDatasourceResponse: FabricItemDatasource LakehouseTablesDatasource	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.

DataAgentDatasourceResponse:

FabricItemDatasource
LakehouseTablesDatasource

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 example

Beispielanforderung

HTTP

PATCH https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/dataAgents/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/staging/datasources/70f9282b-1b64-4f08-9e4e-2ab9f0e20e01

{
  "instructions": "Use this for document retrieval queries.",
  "description": "Sales data warehouse with order and customer information."
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "70f9282b-1b64-4f08-9e4e-2ab9f0e20e01",
  "instructions": "Use this for document retrieval queries.",
  "type": "FabricItem",
  "displayName": "SalesWarehouse",
  "description": "Sales data warehouse with order and customer information.",
  "itemReference": {
    "referenceType": "ById",
    "itemId": "01234372-7fd9-44d3-bd75-a2718645a82a",
    "workspaceId": "abdd0d48-2eed-4066-adc4-321a9f6a628e"
  },
  "fabricItemType": "Warehouse"
}

Definitionen

Name	Beschreibung
DataAgentSupportedItemType	Der unterstützte Fabric Elementtyp für eine `FabricItem` Datenquelle. Werte verwenden veröffentlichte Fabric Elementnamen. Zusätzliche DataAgentSupportedItemType-Typen können im Laufe der Zeit hinzugefügt werden.
DatasourceType	Der Datenquellentyp. Zusätzliche DatasourceType-Typen können im Laufe der Zeit hinzugefügt werden.
ErrorRelatedResource	Das Objekt der fehlerbezogenen Ressourcendetails.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
FabricItemDatasource	Eine DataAgent-Datenquelle, die von einem Fabric Element unterstützt wird.
ItemReferenceById	Ein Elementverweis nach ID-Objekt.
ItemReferenceByVariable	Ein Elementverweis nach Variable.
ItemReferenceType	Der Elementverweistyp. Zusätzliche `ItemReferenceType` Typen können im Laufe der Zeit hinzugefügt werden.
LakehouseTablesDatasource	Eine DataAgent-Datenquelle, die ein Seehaus im Nur-Tabellen-Modus verwendet.
UpdateDataAgentDatasourceRequest	Aktualisieren der DataAgent-Anforderungsnutzlast. Nur bereitgestellte Felder werden aktualisiert.

DataAgentSupportedItemType

Enumeration

Der unterstützte Fabric Elementtyp für eine FabricItem Datenquelle. Werte verwenden veröffentlichte Fabric Elementnamen. Zusätzliche DataAgentSupportedItemType-Typen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
Report	Power BI Bericht.
SemanticModel	Power BI semantischen Modell.
Lakehouse	Ein Seehaus.
KQLDatabase	Eine KQL-Datenbank.
Warehouse	Ein Lagerhaus.
MirroredDatabase	Eine gespiegelte Datenbank.
MirroredAzureDatabricksCatalog	Ein gespiegelter Azure Databricks Katalog.
GraphModel	Ein Diagrammmodell.
SQLDatabase	Eine SQL-Datenbank.
Ontology	Eine Ontologie.

DatasourceType

Enumeration

Der Datenquellentyp. Zusätzliche DatasourceType-Typen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
FabricItem	Eine Datenquelle, die von einem unterstützten Fabric Element unterstützt wird.
LakehouseTables	Eine Datenquelle, die von einem Seehaus im Nur-Tabellen-Modus unterstützt wird.

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.

FabricItemDatasource

Objekt

Eine DataAgent-Datenquelle, die von einem Fabric Element unterstützt wird.

Name	Typ	Beschreibung
description	string	Die Beschreibung der Datenquelle.
displayName	string	Der Anzeigename der Datenquelle.
fabricItemType	DataAgentSupportedItemType	Der Fabric Elementtyp der Datenquelle.
id	string (uuid)	Die Datenquellen-ID.
instructions	string	Benutzerdefinierte KI-Anweisungen speziell für diese Datenquelle.
itemReference	ItemReference: ItemReferenceById ItemReferenceByVariable	Ein Elementverweisobjekt.
type	string: FabricItem	Der Datenquellentyp.

ItemReferenceById

Objekt

Ein Elementverweis nach ID-Objekt.

Name	Typ	Beschreibung
itemId	string (uuid)	Die ID des Elements.
referenceType	string: ById	Der Elementverweistyp.
workspaceId	string (uuid)	Die Arbeitsbereichs-ID des Elements.

ItemReferenceByVariable

Objekt

Ein Elementverweis nach Variable.

Name	Typ	Beschreibung
referenceType	string: ByVariable	Der Elementverweistyp.
variableReference	string	Eine Variablenverweiszeichenfolge, die die Variable Library und den Variablennamen darin angibt. Format: `$(/**/_VarLibrary_/_VarName_)` für eine Variable Library namens VarLibrary und eine Variable namens VarName.

ItemReferenceType

Enumeration

Der Elementverweistyp. Zusätzliche ItemReferenceType Typen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
ById	Auf das Element wird anhand seiner ID verwiesen.
ByVariable	Auf das Element wird von einer Variablen verwiesen.

LakehouseTablesDatasource

Objekt

Eine DataAgent-Datenquelle, die ein Seehaus im Nur-Tabellen-Modus verwendet.

Name	Typ	Beschreibung
description	string	Die Beschreibung der Datenquelle.
displayName	string	Der Anzeigename der Datenquelle.
id	string (uuid)	Die Datenquellen-ID.
instructions	string	Benutzerdefinierte KI-Anweisungen speziell für diese Datenquelle.
lakehouseReference	ItemReference: ItemReferenceById ItemReferenceByVariable	Ein Elementverweisobjekt.
type	string: LakehouseTables	Der Datenquellentyp.

UpdateDataAgentDatasourceRequest

Objekt

Aktualisieren der DataAgent-Anforderungsnutzlast. Nur bereitgestellte Felder werden aktualisiert.

Name	Typ	Beschreibung
description	string	Die Beschreibung der Datenquelle.
instructions	string	Benutzerdefinierte KI-Anweisungen speziell für diese Datenquelle.