Items - Create Data Agent

Hizmet:
DataAgent
API Sürümü:
v1

Belirtilen çalışma alanında bir DataAgent oluşturur.
Bu API, uzun süre çalışan işlemleri (LRO)destekler. Genel bir tanım ile DataAgent oluşturmak için DataAgent makalesine bakın.

Permissions

Çağıranın katkıda bulunan çalışma alanı rolü olmalıdır.

Gerekli Temsilci Kapsamları

Item.ReadWrite.All

Sınırlamalar

  • DataAgent oluşturmak için çalışma alanının desteklenen bir Fabric kapasitesinde olması gerekir. Daha fazla bilgi için bkz. Microsoft Fabric lisans türleri.

Desteklenen kimlikleri Microsoft Entra

Bu API, bu bölümde listelenen Microsoft identities destekler.

Kimlik Support
User Evet
Hizmet sorumlusu ve yönetilen kimlikler Evet

Arayüz

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

URI Parametreleri

Name İçinde Gerekli Tür Description
workspaceId
 path True

string (uuid)

Çalışma alanı kimliği.

İstek Gövdesi

Name Gerekli Tür Description
displayName True

string

DataAgent görünen adı. Görünen ad, öğe türüne göre adlandırma kurallarına uymalıdır.
definition

DataAgentPublicDefinition

DataAgent genel tanımı.
description

string

DataAgent açıklaması. Uzunluk üst sınırı 256 karakterdir.
folderId

string (uuid)

Klasör kimliği. Belirtilmezse veya null ise DataAgent, çalışma alanı klasörü olarak oluşturulur.
sensitivityLabelSettings

SensitivityLabelSettings

DataAgent için duyarlılık etiketi ayarları.

Yanıtlar

Name Tür Description
201 Created

DataAgent

Başarıyla oluşturuldu
202 Accepted

İstek kabul edildi, DataAgent sağlama devam ediyor.

Üst Bilgiler

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
429 Too Many Requests

ErrorResponse

Hizmet fiyatı sınırı aşıldı. Sunucu, istemcinin ek istek göndermeden önce ne kadar beklemesi gerektiğini saniye cinsinden belirten bir Retry-After üst bilgi döndürür.

Üst Bilgiler

Retry-After: integer
Other Status Codes

ErrorResponse

Yaygın hata kodları:

  • InvalidItemType - Öğe türü geçersiz

  • ItemDisplayNameAlreadyInUse - Öğe görünen adı zaten kullanılıyor.

  • BozukPayload - Sağlanan yük bozuk.

  • WorkspaceItemsLimitExceeded - Çalışma alanı öğe sınırı aşıldı.

Örnekler

Create a DataAgent example
Create a DataAgent with public definition example

Create a DataAgent example

Örnek isteği

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

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

Örnek yanıt

Durum kodu:
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"
  }
}
Durum kodu:
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

Örnek isteği

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

Örnek yanıt

Durum kodu:
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"
  }
}
Durum kodu:
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

Tanımlar

Name Description
CreateDataAgentRequest

DataAgent istek yükü oluşturun.
DataAgent

DataAgent nesnesi.
DataAgentProperties

DataAgent özellikleri.
DataAgentPublicDefinition

DataAgent genel tanım nesnesi. DataAgent tanımının yapısı hakkında daha fazla bilgi için bu makaleye bakın.
DataAgentPublicDefinitionPart

DataAgent tanımı parça nesnesi.
EntireTenantPrincipal

Kiracı sorumlusunu temsil eder
ErrorRelatedResource

Hatayla ilgili kaynak ayrıntıları nesnesi.
ErrorResponse

Hata yanıtı.
ErrorResponseDetails

Hata yanıtı ayrıntıları.
GroupDetails

Belirli ayrıntıları gruplandırma. Sorumlu türü Groupolduğunda geçerlidir.
GroupPrincipal

Bir güvenlik grubunu temsil eder.
GroupType

Grubun türü. Zaman içinde ek grup türleri eklenebilir.
ItemTag

Bir öğeye uygulanan etiketi temsil eder.
ItemType

Öğenin türü. Zaman içinde ek öğe türleri eklenebilir.
PayloadType

Tanım parçası yükünün türü. Zaman içinde ek yük türleri eklenebilir.
PrincipalType

Sorumlunun türü. Zaman içinde ek sorumlu türleri eklenebilir.
SensitivityLabel

Bir öğeye uygulanan duyarlılık etiketini temsil eder.
SensitivityLabelApplyStrategy

Duyarlılık etiketini uygulama stratejisi. Varsayılan değer ApplyOrFail'dir. Zaman içinde ek türler eklenebilir.
SensitivityLabelSettings

Duyarlılık etiketi ayarları.
ServicePrincipalDetails

Hizmet sorumlusuna özgü ayrıntılar. Sorumlu türü ServicePrincipalolduğunda geçerlidir.
ServicePrincipalPrincipal

Microsoft Entra hizmet sorumlusunu temsil eder.
ServicePrincipalProfileDetails

Hizmet sorumlusu profili ayrıntıları. Sorumlu türü ServicePrincipalProfileolduğunda geçerlidir.
ServicePrincipalProfilePrincipal

Hizmet sorumlusu profilini temsil eder.
UserDetails

Kullanıcı sorumlusuna özgü ayrıntılar. Sorumlu türü Userolduğunda geçerlidir.
UserPrincipal

Microsoft Entra kullanıcı sorumlusunu temsil eder.

CreateDataAgentRequest

Nesne

DataAgent istek yükü oluşturun.

Name Tür Description
definition

DataAgentPublicDefinition

DataAgent genel tanımı.
description

string

DataAgent açıklaması. Uzunluk üst sınırı 256 karakterdir.
displayName

string

DataAgent görünen adı. Görünen ad, öğe türüne göre adlandırma kurallarına uymalıdır.
folderId

string (uuid)

Klasör kimliği. Belirtilmezse veya null ise DataAgent, çalışma alanı klasörü olarak oluşturulur.
sensitivityLabelSettings

SensitivityLabelSettings

DataAgent için duyarlılık etiketi ayarları.

DataAgent

Nesne

DataAgent nesnesi.

Name Tür Description
defaultIdentity Principal:

Öğenin varsayılan kimliği.
description

string

Öğe açıklaması.
displayName

string

Öğenin görünen adı.
folderId

string (uuid)

Klasör kimliği.
id

string (uuid)

Öğe kimliği.
properties

DataAgentProperties

DataAgent özellikleri.
sensitivityLabel

SensitivityLabel

Öğe duyarlılığı etiketi.
tags

ItemTag[]

Uygulanan etiketlerin listesi.
type

ItemType

Öğe türü.
workspaceId

string (uuid)

Çalışma alanı kimliği.

DataAgentProperties

Nesne

DataAgent özellikleri.

Name Tür Description
publishedDescription

string

DataAgent'ın yayımlanan açıklaması. Bu açıklama, aracı diğer deneyimlerde göründüğünde bağlam sağlar. DataAgent yayımlandığında ayarlanır ve yayımlanmamış dataagent için döndürülemez.

DataAgentPublicDefinition

Nesne

DataAgent genel tanım nesnesi. DataAgent tanımının yapısı hakkında daha fazla bilgi için bu makaleye bakın.

Name Tür Description
format

string

Veri aracısı tanımının biçimi.
parts

DataAgentPublicDefinitionPart[]

Tanım bölümlerinin listesi.

DataAgentPublicDefinitionPart

Nesne

DataAgent tanımı parça nesnesi.

Name Tür Description
path

string

DataAgent genel tanımı bölüm yolu.
payload

string

DataAgent genel tanımı parça yükü.
payloadType

PayloadType

Yük türü.

EntireTenantPrincipal

Nesne

Kiracı sorumlusunu temsil eder

Name Tür Description
displayName

string

Sorumlunun görünen adı.
id

string (uuid)

Sorumlunun kimliği.
type string:

EntireTenant

Sorumlunun türü. Zaman içinde ek sorumlu türleri eklenebilir.

ErrorRelatedResource

Nesne

Hatayla ilgili kaynak ayrıntıları nesnesi.

Name Tür Description
resourceId

string

Hataya dahil olan kaynak kimliği.
resourceType

string

Hataya dahil olan kaynağın türü.

ErrorResponse

Nesne

Hata yanıtı.

Name Tür Description
errorCode

string

Hizmetimiz ve kullanıcıları arasında standartlaştırılmış iletişime olanak sağlayan bir hata koşulu hakkında bilgi sağlayan belirli bir tanımlayıcı.
isRetriable

boolean

True olduğunda istek yeniden denenebilir. Varsa gecikmeyi Retry-After belirlemek için yanıt üst bilgisini kullanın.
message

string

Hatanın okunabilir bir gösterimi.
moreDetails

ErrorResponseDetails[]

Ek hata ayrıntılarının listesi.
relatedResource

ErrorRelatedResource

Hatayla ilgili kaynak ayrıntıları.
requestId

string (uuid)

Hatayla ilişkili isteğin kimliği.

ErrorResponseDetails

Nesne

Hata yanıtı ayrıntıları.

Name Tür Description
errorCode

string

Hizmetimiz ve kullanıcıları arasında standartlaştırılmış iletişime olanak sağlayan bir hata koşulu hakkında bilgi sağlayan belirli bir tanımlayıcı.
message

string

Hatanın okunabilir bir gösterimi.
relatedResource

ErrorRelatedResource

Hatayla ilgili kaynak ayrıntıları.

GroupDetails

Nesne

Belirli ayrıntıları gruplandırma. Sorumlu türü Groupolduğunda geçerlidir.

Name Tür Description
groupType

GroupType

Grubun türü. Zaman içinde ek grup türleri eklenebilir.

GroupPrincipal

Nesne

Bir güvenlik grubunu temsil eder.

Name Tür Description
displayName

string

Sorumlunun görünen adı.
groupDetails

GroupDetails

Belirli ayrıntıları gruplandırma. Sorumlu türü Groupolduğunda geçerlidir.
id

string (uuid)

Sorumlunun kimliği.
type string:

Group

Sorumlunun türü. Zaman içinde ek sorumlu türleri eklenebilir.

GroupType

Numaralandırma

Grubun türü. Zaman içinde ek grup türleri eklenebilir.

Değer Description
Unknown

Asıl grup türü bilinmiyor.
SecurityGroup

Sorumlu bir güvenlik grubudur.
DistributionList

Sorumlu bir dağıtım listesidir.

ItemTag

Nesne

Bir öğeye uygulanan etiketi temsil eder.

Name Tür Description
displayName

string

Etiketin adı.
id

string (uuid)

Etiket kimliği.

ItemType

Numaralandırma

Öğenin türü. Zaman içinde ek öğe türleri eklenebilir.

Değer Description
Dashboard

PowerBI panosu.
Report

PowerBI raporu.
SemanticModel

PowerBI anlam modeli.
PaginatedReport

PowerBI sayfalandırılmış raporu.
Datamart

PowerBI datamart.
Lakehouse

Göl evi.
Eventhouse

Bir olay evi.
Environment

Bir ortam.
KQLDatabase

KQL veritabanı.
KQLQueryset

KQL sorgu kümesi.
KQLDashboard

KQL panosu.
DataPipeline

Veri işlem hattı.
Notebook

Bir not defteri.
SparkJobDefinition

Spark iş tanımı.
MLExperiment

Makine öğrenmesi denemesi.
MLModel

Makine öğrenmesi modeli.
Warehouse

Bir depo.
Eventstream

Bir olay akışı.
SQLEndpoint

Bir SQL uç noktası.
MirroredWarehouse

Aynalı bir depo.
MirroredDatabase

Yansıtılmış veritabanı.
Reflex

Bir refleks.
GraphQLApi

GraphQL öğesi için bir API.
MountedDataFactory

Bir MountedDataFactory.
SQLDatabase

A SQLDatabase.
CopyJob

Kopyalama işi.
VariableLibrary

Bir VariableLibrary.
Dataflow

Veri akışı.
ApacheAirflowJob

An ApacheAirflowJob.
WarehouseSnapshot

Ambar anlık görüntüsü.
DigitalTwinBuilder

A DigitalTwinBuilder.
DigitalTwinBuilderFlow

Dijital İkiz Oluşturucu Akışı.
MirroredAzureDatabricksCatalog

Yansıtılmış azure databricks kataloğu.
Map

Bir harita.
AnomalyDetector

Anomali Algılayıcısı.
UserDataFunction

Kullanıcı Verileri İşlevi.
GraphModel

A GraphModel.
GraphQuerySet

A Graph QuerySet.
SnowflakeDatabase

Snowflake hesabından oluşturulan Iceberg tablolarını depolamak için bir Snowflake Veritabanı.
OperationsAgent

A OperationsAgent.
CosmosDBDatabase

Cosmos DB Veritabanı.
Ontology

Bir Ontoloji.
EventSchemaSet

Bir EventSchemaSet.
DataAgent

A DataAgent.
MirroredCatalog

A MirroredCatalog.
AppBackend

An AppBackend.
OrgApp

Kuruluş uygulaması.
OrgAppAudience

Kuruluş Uygulaması Hedef Kitlesi.
DataBuildToolJob

A DataBuildToolJob.
AzureDatabricksStorage

Azure Databricks için OneLake destekli bir depolama öğesi.

PayloadType

Numaralandırma

Tanım parçası yükünün türü. Zaman içinde ek yük türleri eklenebilir.

Değer Description
InlineBase64

Satır içi Temel 64.

PrincipalType

Numaralandırma

Sorumlunun türü. Zaman içinde ek sorumlu türleri eklenebilir.

Değer Description
User

Sorumlu, Microsoft Entra kullanıcı sorumlusudur.
ServicePrincipal

Sorumlu bir Microsoft Entra hizmet sorumlusudur.
Group

Sorumlu bir güvenlik grubudur.
ServicePrincipalProfile

Sorumlu bir hizmet sorumlusu profilidir.
EntireTenant

Sorumlu, tüm kiracı kullanıcılarını temsil eder.

SensitivityLabel

Nesne

Bir öğeye uygulanan duyarlılık etiketini temsil eder.

Name Tür Description
id

string (uuid)

Duyarlılık etiketi kimliği.

SensitivityLabelApplyStrategy

Numaralandırma

Duyarlılık etiketini uygulama stratejisi. Varsayılan değer ApplyOrFail'dir. Zaman içinde ek türler eklenebilir.

Değer Description
ApplyOrFail

Duyarlılık etiketini uygulayın veya uygulanamıyorsa işlem başarısız olur.
Ignore

Uygulanamıyorsa duyarlılık etiketini yoksayın ve etiketi uygulamadan işleme devam edin.

SensitivityLabelSettings

Nesne

Duyarlılık etiketi ayarları.

Name Tür Description
labelId

string (uuid)

Duyarlılık etiketi kimliği.
sensitivityLabelApplyStrategy

SensitivityLabelApplyStrategy

Duyarlılık etiketini uygulama stratejisi.

ServicePrincipalDetails

Nesne

Hizmet sorumlusuna özgü ayrıntılar. Sorumlu türü ServicePrincipalolduğunda geçerlidir.

Name Tür Description
aadAppId

string (uuid)

Hizmet sorumlusunun Microsoft Entra AppId değeri.

ServicePrincipalPrincipal

Nesne

Microsoft Entra hizmet sorumlusunu temsil eder.

Name Tür Description
displayName

string

Sorumlunun görünen adı.
id

string (uuid)

Sorumlunun kimliği.
servicePrincipalDetails

ServicePrincipalDetails

Hizmet sorumlusuna özgü ayrıntılar. Sorumlu türü ServicePrincipalolduğunda geçerlidir.
type string:

ServicePrincipal

Sorumlunun türü. Zaman içinde ek sorumlu türleri eklenebilir.

ServicePrincipalProfileDetails

Nesne

Hizmet sorumlusu profili ayrıntıları. Sorumlu türü ServicePrincipalProfileolduğunda geçerlidir.

Name Tür Description
parentPrincipal Principal:

Hizmet sorumlusu profilinin üst sorumlusu.

ServicePrincipalProfilePrincipal

Nesne

Hizmet sorumlusu profilini temsil eder.

Name Tür Description
displayName

string

Sorumlunun görünen adı.
id

string (uuid)

Sorumlunun kimliği.
servicePrincipalProfileDetails

ServicePrincipalProfileDetails

Hizmet sorumlusu profili ayrıntıları. Sorumlu türü ServicePrincipalProfileolduğunda geçerlidir.
type string:

ServicePrincipalProfile

Sorumlunun türü. Zaman içinde ek sorumlu türleri eklenebilir.

UserDetails

Nesne

Kullanıcı sorumlusuna özgü ayrıntılar. Sorumlu türü Userolduğunda geçerlidir.

Name Tür Description
userPrincipalName

string

Kullanıcı asıl adı.

UserPrincipal

Nesne

Microsoft Entra kullanıcı sorumlusunu temsil eder.

Name Tür Description
displayName

string

Sorumlunun görünen adı.
id

string (uuid)

Sorumlunun kimliği.
type string:

User

Sorumlunun türü. Zaman içinde ek sorumlu türleri eklenebilir.
userDetails

UserDetails

Kullanıcı sorumlusuna özgü ayrıntılar. Sorumlu türü Userolduğunda geçerlidir.