Published - Get Settings

Dienst:: DataAgent

API-Version:: v1

Gibt die veröffentlichten Einstellungen für den angegebenen DataAgent zurück.

Hinweis

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

Berechtigungen

Der Aufrufer muss über Leseberechtigungen für den DataAgent verfügen.

Erforderliche delegierte Zugriffsbereiche

Item.Read.All oder Item.ReadWrite.All oder DataAgent.Read.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

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataAgents/{dataAgentId}/settings

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
dataAgentId	path	True	string (uuid)	Die DataAgent-ID.
workspaceId	path	True	string (uuid)	Die Arbeitsbereichs-ID.

Antworten

Name Typ Beschreibung

200 OK

Name	Typ	Beschreibung
200 OK	DataAgentSettingsResponse	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.

DataAgentSettingsResponse

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.

Beispiele

Get published DataAgent settings example

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "aiInstructions": "Always respond in English. Be concise."
}

Definitionen

Name	Beschreibung
DataAgentSettingsResponse	Die DataAgent-Einstellungen.
ErrorRelatedResource	Das Objekt der fehlerbezogenen Ressourcendetails.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.

DataAgentSettingsResponse

Objekt

Die DataAgent-Einstellungen.

Name	Typ	Beschreibung
aiInstructions	string	Benutzerdefinierte KI-Systemaufforderung für dataAgent.

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.