Items - Create Data Agent

Dienst:: DataAgent

API-Version:: v1

Erstellt einen DataAgent im angegebenen Arbeitsbereich.
Diese API unterstützt LRO-. Informationen zum Erstellen von DataAgent mit einer öffentlichen Definition finden Sie im Artikel "DataAgent ".

Erlaubnisse

Der Aufrufer muss über eine Rolle des Mitwirkenden-Arbeitsbereichs verfügen.

Erforderliche delegierte Bereiche

Item.ReadWrite.All

Einschränkungen

Zum Erstellen eines DataAgent muss sich der Arbeitsbereich auf einer unterstützten Fabric Kapazität befindet. Weitere Informationen finden Sie unter: Microsoft Fabric Lizenztypen.

Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft identities.

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

Schnittstelle

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataAgents

URI-Parameter

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

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
displayName	True	string	Der Name des DataAgent-Anzeigenamens. Der Anzeigename muss den Benennungsregeln entsprechend dem Elementtyp entsprechen.
definition		DataAgentPublicDefinition	Die öffentliche DataAgent-Definition.
description		string	Die DataAgent-Beschreibung. Die maximale Länge beträgt 256 Zeichen.
folderId		string (uuid)	Die Ordner-ID. Wenn sie nicht angegeben oder null ist, wird der DataAgent mit dem Arbeitsbereich als Ordner erstellt.
sensitivityLabelSettings		SensitivityLabelSettings	Die Vertraulichkeitsbezeichnungseinstellungen für dataAgent.

Antworten

Name	Typ	Beschreibung
201 Created	DataAgent	Erfolgreich erstellt
202 Accepted		Anforderung angenommen, DataAgent-Bereitstellung wird ausgeführt. Header Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Der Dienstratengrenzwert 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: InvalidItemType – Elementtyp ist ungültig. ItemDisplayNameAlreadyInUse - Der Anzeigename des Elements wird bereits verwendet. CorruptedPayload – Die bereitgestellte Nutzlast ist beschädigt. WorkspaceItemsLimitExceededed – Grenzwert für Arbeitsbereichselemente wurde überschritten.

Beispiele

Create a DataAgent example

Create a DataAgent with public definition example

Create a DataAgent example

Beispielanforderung

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/dataAgents

{
  "displayName": "DataAgent 1",
  "description": "A DataAgent description."
}

Beispiel für eine Antwort

Statuscode:: 201

{
  "displayName": "DataAgent 1",
  "description": "A DataAgent description.",
  "type": "DataAgent",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715",
  "sensitivityLabel": {
    "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
  }
}

Statuscode:: 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

Create a DataAgent with public definition example

Beispielanforderung

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/dataAgents

{
  "displayName": "DataAgent 1",
  "description": "A DataAgent description.",
  "definition": {
    "parts": [
      {
        "path": "Files/Config/data_agent.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Files/Config/draft/lakehouse-SampleLakehouse/datasource.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Files/Config/draft/lakehouse-SampleLakehouse/fewshots.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Files/Config/published/lakehouse-SampleLakehouse/datasource.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Files/Config/published/lakehouse-SampleLakehouse/fewshots.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Files/Config/draft/stage_config.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Files/Config/published/stage_config.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Files/Config/publish_info.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Beispiel für eine Antwort

Statuscode:: 201

{
  "displayName": "DataAgent 1",
  "description": "A DataAgent description.",
  "type": "DataAgent",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715",
  "sensitivityLabel": {
    "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
  }
}

Statuscode:: 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

Definitionen

Name	Beschreibung
CreateDataAgentRequest	Erstellen Sie die Datenagent-Anforderungsnutzlast.
DataAgent	Ein DataAgent-Objekt.
DataAgentPublicDefinition	Öffentliches DataAgent-Definitionsobjekt. Weitere Informationen zur Struktur der DataAgent-Definition finden Sie in diesem Artikel .
DataAgentPublicDefinitionPart	DataAgent-Definitionsteilobjekt.
EntireTenantPrincipal	Stellt einen Mandantenprinzipal dar.
ErrorRelatedResource	Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
GroupDetails	Gruppieren Sie bestimmte Details. Gilt, wenn der Prinzipaltyp `Group`ist.
GroupPrincipal	Steht für eine Sicherheitsgruppe.
GroupType	Der Typ der Gruppe. Weitere Gruppentypen können im Laufe der Zeit hinzugefügt werden.
ItemTag	Stellt ein Tag dar, das auf ein Element angewendet wird.
ItemType	Der Typ des Elements Zusätzliche Elementtypen können im Laufe der Zeit hinzugefügt werden.
PayloadType	Der Typ der Definitionsteilnutzlast. Zusätzliche Nutzlasttypen können im Laufe der Zeit hinzugefügt werden.
PrincipalType	Der Typ des Prinzipals. Im Laufe der Zeit können zusätzliche Prinzipaltypen hinzugefügt werden.
SensitivityLabel	Stellt eine Vertraulichkeitsbezeichnung dar, die auf ein Element angewendet wird.
SensitivityLabelApplyStrategy	Die Strategie für die Anwendung der Vertraulichkeitsbezeichnung. Der Standardwert ist ApplyOrFail. Zusätzliche Typen können im Laufe der Zeit hinzugefügt werden.
SensitivityLabelSettings	Die Einstellungen für Vertraulichkeitsbezeichnungen.
ServicePrincipalDetails	Spezifische Details des Dienstprinzipals. Gilt, wenn der Prinzipaltyp `ServicePrincipal`ist.
ServicePrincipalPrincipal	Stellt einen Microsoft Entra Dienstprinzipal dar.
ServicePrincipalProfileDetails	Dienstprinzipalprofildetails. Gilt, wenn der Prinzipaltyp `ServicePrincipalProfile`ist.
ServicePrincipalProfilePrincipal	Stellt ein Dienstprinzipalprofil dar.
UserDetails	Spezifische Details des Benutzerprinzipals. Gilt, wenn der Prinzipaltyp `User`ist.
UserPrincipal	Stellt einen Microsoft Entra Benutzerprinzipal dar.

CreateDataAgentRequest

Objekt

Erstellen Sie die Datenagent-Anforderungsnutzlast.

Name	Typ	Beschreibung
definition	DataAgentPublicDefinition	Die öffentliche DataAgent-Definition.
description	string	Die DataAgent-Beschreibung. Die maximale Länge beträgt 256 Zeichen.
displayName	string	Der Name des DataAgent-Anzeigenamens. Der Anzeigename muss den Benennungsregeln entsprechend dem Elementtyp entsprechen.
folderId	string (uuid)	Die Ordner-ID. Wenn sie nicht angegeben oder null ist, wird der DataAgent mit dem Arbeitsbereich als Ordner erstellt.
sensitivityLabelSettings	SensitivityLabelSettings	Die Vertraulichkeitsbezeichnungseinstellungen für dataAgent.

DataAgent

Objekt

Ein DataAgent-Objekt.

Name	Typ	Beschreibung
defaultIdentity	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Die Standardidentität des Elements.
description	string	Die Elementbeschreibung.
displayName	string	Der Anzeigename des Elements.
folderId	string (uuid)	Die Ordner-ID.
id	string (uuid)	Die Element-ID.
sensitivityLabel	SensitivityLabel	Die Vertraulichkeitsbezeichnung des Elements.
tags	ItemTag[]	Liste der angewendeten Tags.
type	ItemType	Der Elementtyp.
workspaceId	string (uuid)	Die Arbeitsbereichs-ID.

DataAgentPublicDefinition

Objekt

Öffentliches DataAgent-Definitionsobjekt. Weitere Informationen zur Struktur der DataAgent-Definition finden Sie in diesem Artikel .

Name	Typ	Beschreibung
parts	DataAgentPublicDefinitionPart[]	Eine Liste der Definitionsteile.

DataAgentPublicDefinitionPart

Objekt

DataAgent-Definitionsteilobjekt.

Name	Typ	Beschreibung
path	string	Der Pfad des öffentlichen DataAgent-Definitionsteils.
payload	string	Die Nutzlast des öffentlichen DataAgent-Definitionsteils.
payloadType	PayloadType	Der Nutzlasttyp.

EntireTenantPrincipal

Objekt

Stellt einen Mandantenprinzipal dar.

Name	Typ	Beschreibung
displayName	string	Der Anzeigename des Prinzipals.
id	string (uuid)	Die ID des Prinzipals.
type	string: EntireTenant	Der Typ des Prinzipals. Im Laufe der Zeit können zusätzliche Prinzipaltypen hinzugefügt werden.

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

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.
message	string	Eine lesbare 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 lesbare Darstellung des Fehlers.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.

GroupDetails

Objekt

Gruppieren Sie bestimmte Details. Gilt, wenn der Prinzipaltyp Groupist.

Name	Typ	Beschreibung
groupType	GroupType	Der Typ der Gruppe. Weitere Gruppentypen können im Laufe der Zeit hinzugefügt werden.

GroupPrincipal

Objekt

Steht für eine Sicherheitsgruppe.

Name	Typ	Beschreibung
displayName	string	Der Anzeigename des Prinzipals.
groupDetails	GroupDetails	Gruppieren Sie bestimmte Details. Gilt, wenn der Prinzipaltyp `Group`ist.
id	string (uuid)	Die ID des Prinzipals.
type	string: Group	Der Typ des Prinzipals. Im Laufe der Zeit können zusätzliche Prinzipaltypen hinzugefügt werden.

GroupType

Enumeration

Der Typ der Gruppe. Weitere Gruppentypen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
Unknown	Der Prinzipalgruppentyp ist unbekannt.
SecurityGroup	Prinzipal ist eine Sicherheitsgruppe.
DistributionList	Prinzipal ist eine Verteilerliste.

ItemTag

Objekt

Stellt ein Tag dar, das auf ein Element angewendet wird.

Name	Typ	Beschreibung
displayName	string	Der Name des Tags.
id	string (uuid)	Die Tag-ID.

ItemType

Enumeration

Der Typ des Elements Zusätzliche Elementtypen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
Dashboard	PowerBI-Dashboard.
Report	PowerBI-Bericht.
SemanticModel	PowerBI-Semantikmodell.
PaginatedReport	PowerBI-Paginated-Bericht.
Datamart	PowerBI datamart.
Lakehouse	Ein Seehaus.
Eventhouse	Ein Eventhouse.
Environment	Eine Umgebung.
KQLDatabase	Eine KQL-Datenbank.
KQLQueryset	Ein KQL-Abfrageset.
KQLDashboard	Ein KQL-Dashboard.
DataPipeline	Eine Datenpipeline.
Notebook	Ein Notebook
SparkJobDefinition	Eine Sparkauftragsdefinition.
MLExperiment	Ein Machine Learning-Experiment.
MLModel	Ein Machine Learning-Modell.
Warehouse	Ein Lagerhaus.
Eventstream	Ein Event-Stream.
SQLEndpoint	Ein SQL-Endpunkt.
MirroredWarehouse	Ein gespiegeltes Lager.
MirroredDatabase	Eine gespiegelte Datenbank.
Reflex	Ein Reflex.
GraphQLApi	Eine API für GraphQL-Element.
MountedDataFactory	Eine MountedDataFactory.
SQLDatabase	Eine SQLDatabase.
CopyJob	Ein Kopierauftrag.
VariableLibrary	Eine VariableLibrary.
Dataflow	Ein Datenfluss.
ApacheAirflowJob	Ein ApacheAirflowJob.
WarehouseSnapshot	Eine Warehouse-Momentaufnahme.
DigitalTwinBuilder	Ein DigitalTwinBuilder.
DigitalTwinBuilderFlow	Ein Digital Twin Builder Flow.
MirroredAzureDatabricksCatalog	Ein gespiegelter Azure Databricks-Katalog.
Map	Eine Karte.
AnomalyDetector	Anomaliedetektor.
UserDataFunction	Eine Benutzerdatenfunktion.
GraphModel	Ein GraphModel.
GraphQuerySet	Ein Graph QuerySet.
SnowflakeDatabase	Eine Snowflake-Datenbank zum Speichern von Iceberg-Tabellen, die aus dem Snowflake-Konto erstellt wurden.
OperationsAgent	Ein OperationsAgent.
CosmosDBDatabase	Eine Cosmos DB-Datenbank.
Ontology	Eine Ontologie.
EventSchemaSet	Ein EventSchemaSet.
DataAgent	Ein DataAgent.

PayloadType

Enumeration

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

Wert	Beschreibung
InlineBase64	Inlinebasis 64.

PrincipalType

Enumeration

Der Typ des Prinzipals. Im Laufe der Zeit können zusätzliche Prinzipaltypen hinzugefügt werden.

Wert	Beschreibung
User	Prinzipal ist ein Microsoft Entra Benutzerprinzipal.
ServicePrincipal	Prinzipal ist ein Microsoft Entra Dienstprinzipal.
Group	Prinzipal ist eine Sicherheitsgruppe.
ServicePrincipalProfile	Prinzipal ist ein Dienstprinzipalprofil.
EntireTenant	Prinzipal stellt alle Mandantenbenutzer dar.

SensitivityLabel

Objekt

Stellt eine Vertraulichkeitsbezeichnung dar, die auf ein Element angewendet wird.

Name	Typ	Beschreibung
id	string (uuid)	Die Vertraulichkeitsbezeichnungs-ID.

SensitivityLabelApplyStrategy

Enumeration

Die Strategie für die Anwendung der Vertraulichkeitsbezeichnung. Der Standardwert ist ApplyOrFail. Zusätzliche Typen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
ApplyOrFail	Wenden Sie die Vertraulichkeitsbezeichnung an, oder schlagen Sie den Vorgang fehl, wenn er nicht angewendet werden kann.
Ignore	Ignorieren Sie die Vertraulichkeitsbezeichnung, wenn sie nicht angewendet werden kann, und fahren Sie mit dem Vorgang fort, ohne die Bezeichnung anzuwenden.

SensitivityLabelSettings

Objekt

Die Einstellungen für Vertraulichkeitsbezeichnungen.

Name	Typ	Beschreibung
labelId	string (uuid)	Die Vertraulichkeitsbezeichnungs-ID.
sensitivityLabelApplyStrategy	SensitivityLabelApplyStrategy	Die Strategie für die Anwendung der Vertraulichkeitsbezeichnung.

ServicePrincipalDetails

Objekt

Spezifische Details des Dienstprinzipals. Gilt, wenn der Prinzipaltyp ServicePrincipalist.

Name	Typ	Beschreibung
aadAppId	string (uuid)	Die Microsoft Entra AppId des Dienstprinzipals.

ServicePrincipalPrincipal

Objekt

Stellt einen Microsoft Entra Dienstprinzipal dar.

Name	Typ	Beschreibung
displayName	string	Der Anzeigename des Prinzipals.
id	string (uuid)	Die ID des Prinzipals.
servicePrincipalDetails	ServicePrincipalDetails	Spezifische Details des Dienstprinzipals. Gilt, wenn der Prinzipaltyp `ServicePrincipal`ist.
type	string: ServicePrincipal	Der Typ des Prinzipals. Im Laufe der Zeit können zusätzliche Prinzipaltypen hinzugefügt werden.

ServicePrincipalProfileDetails

Objekt

Dienstprinzipalprofildetails. Gilt, wenn der Prinzipaltyp ServicePrincipalProfileist.

Name	Typ	Beschreibung
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Der übergeordnete Prinzipal des Dienstprinzipals.

ServicePrincipalProfilePrincipal

Objekt

Stellt ein Dienstprinzipalprofil dar.

Name	Typ	Beschreibung
displayName	string	Der Anzeigename des Prinzipals.
id	string (uuid)	Die ID des Prinzipals.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Dienstprinzipalprofildetails. Gilt, wenn der Prinzipaltyp `ServicePrincipalProfile`ist.
type	string: ServicePrincipalProfile	Der Typ des Prinzipals. Im Laufe der Zeit können zusätzliche Prinzipaltypen hinzugefügt werden.

UserDetails

Objekt

Spezifische Details des Benutzerprinzipals. Gilt, wenn der Prinzipaltyp Userist.

Name	Typ	Beschreibung
userPrincipalName	string	Der Benutzerprinzipalname.

UserPrincipal

Objekt

Stellt einen Microsoft Entra Benutzerprinzipal dar.

Name	Typ	Beschreibung
displayName	string	Der Anzeigename des Prinzipals.
id	string (uuid)	Die ID des Prinzipals.
type	string: User	Der Typ des Prinzipals. Im Laufe der Zeit können zusätzliche Prinzipaltypen hinzugefügt werden.
userDetails	UserDetails	Spezifische Details des Benutzerprinzipals. Gilt, wenn der Prinzipaltyp `User`ist.

Freigeben über

Items - Create Data Agent

Erlaubnisse

Erforderliche delegierte Bereiche

Einschränkungen

Microsoft Entra unterstützte Identitäten

Schnittstelle

URI-Parameter

Anforderungstext

Antworten

Beispiele

Create a DataAgent example

Beispielanforderung

Beispiel für eine Antwort

Create a DataAgent with public definition example

Beispielanforderung

Beispiel für eine Antwort

Definitionen

CreateDataAgentRequest

DataAgent

DataAgentPublicDefinition

DataAgentPublicDefinitionPart

EntireTenantPrincipal

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupPrincipal

GroupType

ItemTag

ItemType

PayloadType

PrincipalType

SensitivityLabel

SensitivityLabelApplyStrategy

SensitivityLabelSettings

ServicePrincipalDetails

ServicePrincipalPrincipal

ServicePrincipalProfileDetails

ServicePrincipalProfilePrincipal

UserDetails

UserPrincipal