Staging - Create Datasource

Usługa:: DataAgent

Wersja interfejsu API:: v1

Tworzy źródło danych w środowisku przejściowym określonego agenta DataAgent.

Note

Zarządzanie konfiguracją agenta danych jest obecnie dostępne w wersji zapoznawczej (dowiedz się więcej).

Ten interfejs API obsługuje długotrwałych operacji (LRO).

Ta operacja tworzy źródło danych dla istniejącego elementu Fabric.

Uprawnienia

Obiekt wywołujący musi mieć uprawnienia do odczytu i zapisu dla agenta DataAgent.

Wymagane zakresy delegowane

Item.ReadWrite.All lub DataAgent.ReadWrite.All

Tożsamości obsługiwane przez Microsoft Entra

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

Identity	Support
User	Tak
Główne usługi i Tożsamości zarządzane	Tak

Interfejs

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
dataAgentId	path	True	string (uuid)	Identyfikator agenta danych.
workspaceId	path	True	string (uuid)	Identyfikator przestrzeni roboczej.

Treść żądania

Nazwa	Wymagane	Typ	Opis
type	True	DatasourceType	Typ źródła danych do utworzenia.
itemReference		ItemReferenceById	Odwołanie do elementu według obiektu ID.
lakehouseReference		ItemReferenceById	Odwołanie do elementu według obiektu ID.

Odpowiedzi

Nazwa	Typ	Opis
201 Created	DataAgentDatasourceResponse: FabricItemDatasource LakehouseTablesDatasource	Pomyślnie utworzono.
202 Accepted		Żądanie zaakceptowane, aprowizowanie źródła danych w toku. Nagłówki Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący `Retry-After` w sekundach, jak długo klient musi czekać przed wysłaniem dodatkowych żądań. Nagłówki Retry-After: integer
Other Status Codes	ErrorResponse	Typowe kody błędów: ItemNotFound — żądany element nie został znaleziony InvalidRequest — nieprawidłowe żądanie EntityConflict — operacja tworzenia jest już w toku dla tego źródła danych

Przykłady

Create staging DataAgent datasource example

Create staging DataAgent warehouse datasource example

Create staging DataAgent datasource example

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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"
  }
}

Kod stanu:: 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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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"
}

Kod stanu:: 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

Definicje

Nazwa	Opis
CreateDataAgentDatasourceRequest	Utwórz ładunek żądania źródła danych DataAgent.
DataAgentSupportedItemType	Obsługiwany typ elementu Fabric dla `FabricItem` źródła danych. Wartości używają nazw elementów publikowanych Fabric. Dodatkowe typy DataAgentSupportedItemType można dodawać z upływem czasu.
DatasourceType	Typ źródła danych. Dodatkowe typy DatasourceType można dodawać z upływem czasu.
ErrorRelatedResource	Obiekt szczegółowych informacji o zasobie związanym z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.
FabricItemDatasource	Źródło danych DataAgent wspierane przez element Fabric.
ItemReferenceById	Odwołanie do elementu według obiektu ID.
ItemReferenceByVariable	Odwołanie do elementu według zmiennej.
ItemReferenceType	Typ odwołania do elementu. Dodatkowe typy `ItemReferenceType` można dodawać w czasie.
LakehouseTablesDatasource	Źródło danych DataAgent korzystające z magazynu typu lakehouse w trybie tylko w tabelach.

CreateDataAgentDatasourceRequest

Objekt

Utwórz ładunek żądania źródła danych DataAgent.

Nazwa	Typ	Opis
itemReference	ItemReferenceById	Odwołanie do elementu według obiektu ID.
lakehouseReference	ItemReferenceById	Odwołanie do elementu według obiektu ID.
type	DatasourceType	Typ źródła danych do utworzenia.

DataAgentSupportedItemType

Wyliczenie

Obsługiwany typ elementu Fabric dla FabricItem źródła danych. Wartości używają nazw elementów publikowanych Fabric. Dodatkowe typy DataAgentSupportedItemType można dodawać z upływem czasu.

Wartość	Opis
Report	Power BI raport.
SemanticModel	Power BI semantyczny model.
Lakehouse	Jezioro.
KQLDatabase	Baza danych KQL.
Warehouse	Magazyn.
MirroredDatabase	Dublowana baza danych.
MirroredAzureDatabricksCatalog	Dublowany wykaz Azure Databricks.
GraphModel	Model grafu.
SQLDatabase	Baza danych SQL.
Ontology	Ontologia.

DatasourceType

Wyliczenie

Typ źródła danych. Dodatkowe typy DatasourceType można dodawać z upływem czasu.

Wartość	Opis
FabricItem	Źródło danych wspierane przez obsługiwany element Fabric.
LakehouseTables	Źródło danych wspierane przez usługę Lakehouse w trybie tylko do tabel.

ErrorRelatedResource

Objekt

Obiekt szczegółowych informacji o zasobie związanym z błędem.

Nazwa	Typ	Opis
resourceId	string	Identyfikator zasobu powiązany z błędem.
resourceType	string	Typ zasobu powiązanego z błędem.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
isRetriable	boolean	Jeśli to prawda, żądanie można ponowić. Użyj nagłówka `Retry-After` odpowiedzi, aby określić opóźnienie, jeśli jest dostępne.
message	string	Czytelna reprezentacja błędu przez człowieka.
moreDetails	ErrorResponseDetails[]	Lista dodatkowych szczegółów błędu.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.
requestId	string (uuid)	Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwa	Typ	Opis
errorCode	string	Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message	string	Czytelna reprezentacja błędu przez człowieka.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.

FabricItemDatasource

Objekt

Źródło danych DataAgent wspierane przez element Fabric.

Nazwa	Typ	Opis
description	string	Opis źródła danych.
displayName	string	Nazwa wyświetlana źródła danych.
fabricItemType	DataAgentSupportedItemType	Typ elementu Fabric źródła danych.
id	string (uuid)	Identyfikator źródła danych.
instructions	string	Niestandardowe instrukcje dotyczące sztucznej inteligencji specyficzne dla tego źródła danych.
itemReference	ItemReference: ItemReferenceById ItemReferenceByVariable	Obiekt odwołania do elementu.
type	string: FabricItem	Typ źródła danych.

ItemReferenceById

Objekt

Odwołanie do elementu według obiektu ID.

Nazwa	Typ	Opis
itemId	string (uuid)	Identyfikator elementu.
referenceType	string: ById	Typ odwołania do elementu.
workspaceId	string (uuid)	Identyfikator obszaru roboczego elementu.

ItemReferenceByVariable

Objekt

Odwołanie do elementu według zmiennej.

Nazwa	Typ	Opis
referenceType	string: ByVariable	Typ odwołania do elementu.
variableReference	string	Ciąg odwołania do zmiennej, który określa bibliotekę zmiennych i nazwę zmiennej w niej. Format: `$(/**/_VarLibrary_/_VarName_)` dla biblioteki zmiennych o nazwie VarLibrary i zmiennej o nazwie VarName.

ItemReferenceType

Wyliczenie

Typ odwołania do elementu. Dodatkowe typy ItemReferenceType można dodawać w czasie.

Wartość	Opis
ById	Element jest przywołyyny przez jego identyfikator.
ByVariable	Element jest przywołyyny przez zmienną.

LakehouseTablesDatasource

Objekt

Źródło danych DataAgent korzystające z magazynu typu lakehouse w trybie tylko w tabelach.

Nazwa	Typ	Opis
description	string	Opis źródła danych.
displayName	string	Nazwa wyświetlana źródła danych.
id	string (uuid)	Identyfikator źródła danych.
instructions	string	Niestandardowe instrukcje dotyczące sztucznej inteligencji specyficzne dla tego źródła danych.
lakehouseReference	ItemReference: ItemReferenceById ItemReferenceByVariable	Obiekt odwołania do elementu.
type	string: LakehouseTables	Typ źródła danych.