Staging - Create Datasource

Tjeneste:: DataAgent

API-version:: v1

Opretter en datakilde i det midlertidige miljø for den angivne DataAgent.

Bemærk

Administration af konfiguration af Data Agent er i øjeblikket en prøveversion (få mere at vide).

Denne API understøtter LRO-handlinger (Long Running Operations).

Denne handling opretter en datakilde for et eksisterende Fabric element.

Rettigheder

Den person, der ringer op, skal have læse- og skrivetilladelser til DataAgent.

Påkrævede delegerede områder

Item.ReadWrite.All eller DataAgent.ReadWrite.All

Microsoft Entra understøttede identiteter

Denne API understøtter de Microsoft identities, der er angivet i dette afsnit.

Identity	Støtte
Bruger	Ja
tjenesteprincipal og administrerede identiteter	Ja

Grænseflade

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

URI-parametre

Name	I	Påkrævet	Type	Beskrivelse
dataAgentId	path	True	string (uuid)	DataAgent-id'et.
workspaceId	path	True	string (uuid)	Arbejdsområde-id'et.

Brødtekst for anmodning

Name	Påkrævet	Type	Beskrivelse
type	True	DatasourceType	Den datakildetype, der skal oprettes.
itemReference		ItemReferenceById	En elementreference efter id-objekt.
lakehouseReference		ItemReferenceById	En elementreference efter id-objekt.

Svar

Name	Type	Beskrivelse
201 Created	DataAgentDatasourceResponse: FabricItemDatasource LakehouseTablesDatasource	Oprettet.
202 Accepted		Anmodning accepteret, klargøring af datakilde er i gang. Headere Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Grænsen for tjenestetakst blev overskredet. Serveren returnerer en `Retry-After` header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger. Headere Retry-After: integer
Other Status Codes	ErrorResponse	Almindelige fejlkoder: ItemNotFound – Det ønskede element blev ikke fundet InvalidRequest - Ugyldig anmodning EntityConflict – En oprettelseshandling er allerede i gang for denne datakilde

Eksempler

Create staging DataAgent datasource example

Create staging DataAgent warehouse datasource example

Create staging DataAgent datasource example

Eksempelanmodning

HTTP

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

{
  "type": "LakehouseTables",
  "lakehouseReference": {
    "referenceType": "ById",
    "itemId": "b5e7c3a1-2d4f-4890-9a1b-3c5d7e9f0a2b",
    "workspaceId": "e1f2a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b"
  }
}

Eksempelsvar

Statuskode:: 201

{
  "id": "c1c6d12f-8d2a-4d5b-9ca1-8bb7b42d4a30",
  "instructions": "Use this for customer engagement analysis.",
  "type": "LakehouseTables",
  "displayName": "CustomerLakehouse",
  "description": "Customer interaction history and support activity.",
  "lakehouseReference": {
    "referenceType": "ById",
    "itemId": "b5e7c3a1-2d4f-4890-9a1b-3c5d7e9f0a2b",
    "workspaceId": "e1f2a3b4-5c6d-7e8f-9a0b-1c2d3e4f5a6b"
  }
}

Statuskode:: 202

Location: https://api.fabric.microsoft.com/v1/operations/65d59164-2ebd-4cac-9149-55612f8f5bb8
x-ms-operation-id: 65d59164-2ebd-4cac-9149-55612f8f5bb8
Retry-After: 30

Create staging DataAgent warehouse datasource example

Eksempelanmodning

HTTP

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

{
  "type": "FabricItem",
  "itemReference": {
    "referenceType": "ById",
    "itemId": "01234372-7fd9-44d3-bd75-a2718645a82a",
    "workspaceId": "abdd0d48-2eed-4066-adc4-321a9f6a628e"
  }
}

Eksempelsvar

Statuskode:: 201

{
  "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"
}

Statuskode:: 202

Location: https://api.fabric.microsoft.com/v1/operations/91d594a7-e8d7-487f-9dfb-f40f6d3318d2
x-ms-operation-id: 91d594a7-e8d7-487f-9dfb-f40f6d3318d2
Retry-After: 30

Definitioner

Name	Beskrivelse
CreateDataAgentDatasourceRequest	Opret dataAgent-nyttedata for datakildeanmodning.
DataAgentSupportedItemType	Den understøttede Fabric elementtype for en `FabricItem` datakilde. Værdier bruger publicerede Fabric elementnavne. Der kan tilføjes flere DataAgentSupportedItemType-typer over tid.
DatasourceType	Datakildetypen. Der kan tilføjes flere DatasourceType-typer over tid.
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
FabricItemDatasource	En DataAgent-datakilde, der understøttes af et Fabric element.
ItemReferenceById	En elementreference efter id-objekt.
ItemReferenceByVariable	En elementreference efter variabel.
ItemReferenceType	Elementreferencetypen. Der kan tilføjes flere `ItemReferenceType` typer over tid.
LakehouseTablesDatasource	En DataAgent-datakilde, der bruger et lakehouse i tabeltilstand.

CreateDataAgentDatasourceRequest

Objekt

Opret dataAgent-nyttedata for datakildeanmodning.

Name	Type	Beskrivelse
itemReference	ItemReferenceById	En elementreference efter id-objekt.
lakehouseReference	ItemReferenceById	En elementreference efter id-objekt.
type	DatasourceType	Den datakildetype, der skal oprettes.

DataAgentSupportedItemType

Optælling

Den understøttede Fabric elementtype for en FabricItem datakilde. Værdier bruger publicerede Fabric elementnavne. Der kan tilføjes flere DataAgentSupportedItemType-typer over tid.

Værdi	Beskrivelse
Report	Power BI-rapport.
SemanticModel	Power BI semantisk model.
Lakehouse	Et søhus.
KQLDatabase	En KQL-database.
Warehouse	Et lager.
MirroredDatabase	En spejlet database.
MirroredAzureDatabricksCatalog	Et spejlet Azure Databricks katalog.
GraphModel	En grafmodel.
SQLDatabase	En SQL-database.
Ontology	En ontologi.

DatasourceType

Optælling

Datakildetypen. Der kan tilføjes flere DatasourceType-typer over tid.

Værdi	Beskrivelse
FabricItem	En datakilde, der understøttes af et understøttet Fabric element.
LakehouseTables	En datakilde, der understøttes af et lakehouse i tabeltilstand.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Name	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
isRetriable	boolean	Når sand, kan anmodningen prøves igen. Brug svarheaderen `Retry-After` til at bestemme forsinkelsen, hvis den er tilgængelig.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string (uuid)	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

FabricItemDatasource

Objekt

En DataAgent-datakilde, der understøttes af et Fabric element.

Name	Type	Beskrivelse
description	string	Beskrivelsen af datakilden.
displayName	string	Det viste navn på datakilden.
fabricItemType	DataAgentSupportedItemType	Datakildens Fabric elementtype.
id	string (uuid)	Datakilde-id'et.
instructions	string	Brugerdefinerede instruktioner til kunstig intelligens, der er specifikke for denne datakilde.
itemReference	ItemReference: ItemReferenceById ItemReferenceByVariable	Et elementreferenceobjekt.
type	string: FabricItem	Datakildetypen.

ItemReferenceById

Objekt

En elementreference efter id-objekt.

Name	Type	Beskrivelse
itemId	string (uuid)	Id'et for elementet.
referenceType	string: ById	Elementreferencetypen.
workspaceId	string (uuid)	Elementets arbejdsområde-id.

ItemReferenceByVariable

Objekt

En elementreference efter variabel.

Name	Type	Beskrivelse
referenceType	string: ByVariable	Elementreferencetypen.
variableReference	string	En variabelreferencestreng, der angiver variabelbiblioteket og variabelnavnet i det. Format: `$(/**/_VarLibrary_/_VarName_)` for et variabelbibliotek med navnet VarLibrary og en variabel med navnet VarName.

ItemReferenceType

Optælling

Elementreferencetypen. Der kan tilføjes flere ItemReferenceType typer over tid.

Værdi	Beskrivelse
ById	Der refereres til elementet af dets id.
ByVariable	Der refereres til elementet af en variabel.

LakehouseTablesDatasource

Objekt

En DataAgent-datakilde, der bruger et lakehouse i tabeltilstand.

Name	Type	Beskrivelse
description	string	Beskrivelsen af datakilden.
displayName	string	Det viste navn på datakilden.
id	string (uuid)	Datakilde-id'et.
instructions	string	Brugerdefinerede instruktioner til kunstig intelligens, der er specifikke for denne datakilde.
lakehouseReference	ItemReference: ItemReferenceById ItemReferenceByVariable	Et elementreferenceobjekt.
type	string: LakehouseTables	Datakildetypen.