Items - Create Graph Model

Layanan:: GraphModel

Versi API:: v1

Membuat GraphModel di ruang kerja yang ditentukan.

Nota

Item GraphModel saat ini dalam Pratinjau (pelajari lebih lanjut).

API ini mendukung operasi jangka panjang (LRO).

Untuk membuat GraphModel dengan definisi publik, lihat artikel GraphModel .

Permissions

Pemanggil harus memiliki peran ruang kerja kontributor .

Cakupan yang Didelegasikan yang Diperlukan

Item.ReadWrite.All

Keterbatasan

Untuk membuat GraphModel, ruang kerja harus berada pada kapasitas Fabric yang didukung. Untuk informasi selengkapnya, lihat: jenis lisensi Microsoft Fabric.

Microsoft Entra identitas yang didukung

API ini mendukung Microsoft identities yang tercantum di bagian ini.

Identitas	Support
Pengguna	Yes
Prinsipal Layanan dan Identitas Terkelola	Yes

Antarmuka

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
workspaceId	path	True	string (uuid)	ID ruangkerja.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
displayName	True	string	Nama tampilan GraphModel. Nama tampilan harus mengikuti aturan penamaan sesuai dengan jenis item.
definition		GraphModelPublicDefinition	Definisi publik GraphModel.
description		string	Deskripsi GraphModel. Panjang maksimum adalah 256 karakter.
folderId		string (uuid)	ID folder. Jika tidak ditentukan atau null, GraphModel dibuat dengan ruang kerja sebagai foldernya.
sensitivityLabelSettings		SensitivityLabelSettings	Pengaturan label sensitivitas untuk GraphModel.

Respons

Nama	Jenis	Deskripsi
201 Created	GraphModel	Berhasil dibuat
202 Accepted		Permintaan diterima, provisi GraphModel sedang berlangsung. Header Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Batas tarif layanan terlampaui. Server mengembalikan header yang `Retry-After` menunjukkan, dalam detik, berapa lama klien harus menunggu sebelum mengirim permintaan tambahan. Header Retry-After: integer
Other Status Codes	ErrorResponse	Kode kesalahan umum: InvalidItemType - Tipe item tidak valid ItemDisplayNameAlreadyInUse - Nama tampilan item sudah digunakan. CorruptedPayload - Payload yang disediakan rusak. WorkspaceItemsLimitExceeded - Batas item ruang kerja terlampaui.

Contoh

Create a GraphModel example

Create a GraphModel with public definition example

Create a GraphModel example

Permintaan sampel

HTTP

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

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

Respon sampel

Kode status:: 201

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

Kode status:: 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 GraphModel with public definition example

Permintaan sampel

HTTP

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

{
  "displayName": "GraphModel 1",
  "description": "A GraphModel description.",
  "definition": {
    "format": "json",
    "parts": [
      {
        "path": "graphType.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "graphDefinition.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "dataSources.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "stylingConfiguration.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Respon sampel

Kode status:: 201

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

Kode status:: 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

Definisi

Nama	Deskripsi
CreateGraphModelRequest	Buat payload permintaan GraphModel.
EntireTenantPrincipal	Mewakili perwakilan penyewa
ErrorRelatedResource	Objek detail sumber daya terkait kesalahan.
ErrorResponse	Respons kesalahan.
ErrorResponseDetails	Detail respons kesalahan.
GraphModel	Objek GraphModel.
GraphModelDefinitionFormat	Format definisi model grafik. Jenis `format` tambahan dapat ditambahkan dari waktu ke waktu.
GraphModelPublicDefinition	Objek definisi publik GraphModel. Lihat artikel ini untuk detail selengkapnya tentang struktur definisi GraphModel.
GraphModelPublicDefinitionPart	Objek bagian definisi GraphModel.
GroupDetails	Mengelompokkan detail spesifik. Berlaku ketika jenis utama `Group`.
GroupPrincipal	Mewakili grup keamanan.
GroupType	Jenis grup. Jenis grup tambahan dapat ditambahkan dari waktu ke waktu.
ItemTag	Mewakili tag yang diterapkan pada item.
ItemType	Jenis item. Jenis item tambahan dapat ditambahkan dari waktu ke waktu.
PayloadType	Jenis payload bagian definisi. Jenis payload tambahan dapat ditambahkan dari waktu ke waktu.
PrincipalType	Jenis prinsipal. Jenis utama tambahan dapat ditambahkan dari waktu ke waktu.
SensitivityLabel	Mewakili label sensitivitas yang diterapkan ke item.
SensitivityLabelApplyStrategy	Strategi untuk menerapkan label sensitivitas. Nilai defaultnya adalah ApplyOrFail. Jenis tambahan dapat ditambahkan dari waktu ke waktu.
SensitivityLabelSettings	Pengaturan label sensitivitas.
ServicePrincipalDetails	Detail spesifik perwakilan layanan. Berlaku ketika jenis utama `ServicePrincipal`.
ServicePrincipalPrincipal	Mewakili perwakilan layanan Microsoft Entra.
ServicePrincipalProfileDetails	Detail profil perwakilan layanan. Berlaku ketika jenis utama `ServicePrincipalProfile`.
ServicePrincipalProfilePrincipal	Mewakili profil perwakilan layanan.
UserDetails	Detail spesifik perwakilan pengguna. Berlaku ketika jenis utama `User`.
UserPrincipal	Mewakili prinsipal pengguna Microsoft Entra.

CreateGraphModelRequest

Objek

Buat payload permintaan GraphModel.

Nama	Jenis	Deskripsi
definition	GraphModelPublicDefinition	Definisi publik GraphModel.
description	string	Deskripsi GraphModel. Panjang maksimum adalah 256 karakter.
displayName	string	Nama tampilan GraphModel. Nama tampilan harus mengikuti aturan penamaan sesuai dengan jenis item.
folderId	string (uuid)	ID folder. Jika tidak ditentukan atau null, GraphModel dibuat dengan ruang kerja sebagai foldernya.
sensitivityLabelSettings	SensitivityLabelSettings	Pengaturan label sensitivitas untuk GraphModel.

EntireTenantPrincipal

Objek

Mewakili perwakilan penyewa

Nama	Jenis	Deskripsi
displayName	string	Nama tampilan utama.
id	string (uuid)	Id utama.
type	string: EntireTenant	Jenis prinsipal. Jenis utama tambahan dapat ditambahkan dari waktu ke waktu.

ErrorRelatedResource

Objek

Objek detail sumber daya terkait kesalahan.

Nama	Jenis	Deskripsi
resourceId	string	ID sumber daya yang terlibat dalam kesalahan.
resourceType	string	Jenis sumber daya yang terlibat dalam kesalahan.

ErrorResponse

Objek

Respons kesalahan.

Nama	Jenis	Deskripsi
errorCode	string	Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.
isRetriable	boolean	Jika benar, permintaan dapat dicoba kembali. `Retry-After` Gunakan header respons untuk menentukan penundaan, jika tersedia.
message	string	Representasi kesalahan yang dapat dibaca manusia.
moreDetails	ErrorResponseDetails[]	Daftar detail kesalahan tambahan.
relatedResource	ErrorRelatedResource	Detail sumber daya terkait kesalahan.
requestId	string (uuid)	ID permintaan yang terkait dengan kesalahan.

ErrorResponseDetails

Objek

Detail respons kesalahan.

Nama	Jenis	Deskripsi
errorCode	string	Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.
message	string	Representasi kesalahan yang dapat dibaca manusia.
relatedResource	ErrorRelatedResource	Detail sumber daya terkait kesalahan.

GraphModel

Objek

Objek GraphModel.

Nama	Jenis	Deskripsi
defaultIdentity	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Identitas default item.
description	string	Deskripsi item.
displayName	string	Nama tampilan item.
folderId	string (uuid)	ID folder.
id	string (uuid)	ID item.
sensitivityLabel	SensitivityLabel	Label sensitivitas item.
tags	ItemTag[]	Daftar tag yang diterapkan.
type	ItemType	Jenis item.
workspaceId	string (uuid)	ID ruangkerja.

GraphModelDefinitionFormat

Enumerasi

Format definisi model grafik. Jenis format tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
json	Format JSON untuk definisi publik GraphModel, dirancang khusus untuk mendukung skenario CI/CD dalam Fabric.

GraphModelPublicDefinition

Objek

Objek definisi publik GraphModel. Lihat artikel ini untuk detail selengkapnya tentang struktur definisi GraphModel.

Nama	Jenis	Deskripsi
format	GraphModelDefinitionFormat	Format definisi model grafik. Jenis `format` tambahan dapat ditambahkan dari waktu ke waktu.
parts	GraphModelPublicDefinitionPart[]	Daftar bagian definisi.

GraphModelPublicDefinitionPart

Objek

Objek bagian definisi GraphModel.

Nama	Jenis	Deskripsi
path	string	Jalur bagian definisi publik GraphModel.
payload	string	Payload bagian definisi publik GraphModel.
payloadType	PayloadType	Jenis payload.

GroupDetails

Objek

Mengelompokkan detail spesifik. Berlaku ketika jenis utama Group.

Nama	Jenis	Deskripsi
groupType	GroupType	Jenis grup. Jenis grup tambahan dapat ditambahkan dari waktu ke waktu.

GroupPrincipal

Objek

Mewakili grup keamanan.

Nama	Jenis	Deskripsi
displayName	string	Nama tampilan utama.
groupDetails	GroupDetails	Mengelompokkan detail spesifik. Berlaku ketika jenis utama `Group`.
id	string (uuid)	Id utama.
type	string: Group	Jenis prinsipal. Jenis utama tambahan dapat ditambahkan dari waktu ke waktu.

GroupType

Enumerasi

Jenis grup. Jenis grup tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
Unknown	Jenis grup utama tidak diketahui.
SecurityGroup	Prinsipal adalah kelompok keamanan.
DistributionList	Prinsipal adalah daftar distribusi.

ItemTag

Objek

Mewakili tag yang diterapkan pada item.

Nama	Jenis	Deskripsi
displayName	string	Nama dari tag.
id	string (uuid)	ID tag.

ItemType

Enumerasi

Jenis item. Jenis item tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
Dashboard	Dasbor PowerBI.
Report	Laporan PowerBI.
SemanticModel	Model semantik PowerBI.
PaginatedReport	Laporan paginasi PowerBI.
Datamart	Datamart PowerBI.
Lakehouse	Sebuah lakehouse.
Eventhouse	Sebuah rumah acara.
Environment	Lingkungan.
KQLDatabase	Database KQL.
KQLQueryset	Set kueri KQL.
KQLDashboard	Dasbor KQL.
DataPipeline	Alur data.
Notebook	Buku catatan.
SparkJobDefinition	Definisi pekerjaan spark.
MLExperiment	Eksperimen pembelajaran mesin.
MLModel	Model pembelajaran mesin.
Warehouse	Sebuah gudang.
Eventstream	Eventstream.
SQLEndpoint	Titik akhir SQL.
MirroredWarehouse	Sebuah gudang cermin.
MirroredDatabase	Database cermin.
Reflex	Sebuah Refleks.
GraphQLApi	API untuk item GraphQL.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	Sebuah SQLDatabase.
CopyJob	Pekerjaan Penyalinan.
VariableLibrary	VariabelLibrary.
Dataflow	Aliran Data.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Rekam jepret gudang.
DigitalTwinBuilder	Sebuah DigitalTwinBuilder.
DigitalTwinBuilderFlow	Alur Pembangun Kembar Digital.
MirroredAzureDatabricksCatalog	Katalog azure databricks cermin.
Map	Peta.
AnomalyDetector	Detektor Anomali.
UserDataFunction	Fungsi data pengguna.
GraphModel	Sebuah GraphModel.
GraphQuerySet	A Graph QuerySet.
SnowflakeDatabase	Snowflake Database untuk menyimpan tabel Iceberg yang dibuat dari akun Snowflake.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	Database Cosmos DB.
Ontology	Ontologi.
EventSchemaSet	An EventSchemaSet.
DataAgent	A DataAgent.
MirroredCatalog	A MirroredCatalog.
AppBackend	An AppBackend.

PayloadType

Enumerasi

Jenis payload bagian definisi. Jenis payload tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
InlineBase64	Dasar Sebaris 64.

PrincipalType

Enumerasi

Jenis prinsipal. Jenis utama tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
User	Prinsipal adalah prinsipal pengguna Microsoft Entra.
ServicePrincipal	Perwakilan adalah perwakilan layanan Microsoft Entra.
Group	Prinsipal adalah kelompok keamanan.
ServicePrincipalProfile	Perwakilan adalah profil perwakilan layanan.
EntireTenant	Perwakilan mewakili semua pengguna penyewa.

SensitivityLabel

Objek

Mewakili label sensitivitas yang diterapkan ke item.

Nama	Jenis	Deskripsi
id	string (uuid)	ID label sensitivitas.

SensitivityLabelApplyStrategy

Enumerasi

Strategi untuk menerapkan label sensitivitas. Nilai defaultnya adalah ApplyOrFail. Jenis tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
ApplyOrFail	Terapkan label sensitivitas atau gagal operasi jika tidak dapat diterapkan.
Ignore	Abaikan label sensitivitas jika tidak dapat diterapkan dan lanjutkan dengan operasi tanpa menerapkan label.

SensitivityLabelSettings

Objek

Pengaturan label sensitivitas.

Nama	Jenis	Deskripsi
labelId	string (uuid)	ID label sensitivitas.
sensitivityLabelApplyStrategy	SensitivityLabelApplyStrategy	Strategi untuk menerapkan label sensitivitas.

ServicePrincipalDetails

Objek

Detail spesifik perwakilan layanan. Berlaku ketika jenis utama ServicePrincipal.

Nama	Jenis	Deskripsi
aadAppId	string (uuid)	AppId Microsoft Entra perwakilan layanan.

ServicePrincipalPrincipal

Objek

Mewakili perwakilan layanan Microsoft Entra.

Nama	Jenis	Deskripsi
displayName	string	Nama tampilan utama.
id	string (uuid)	Id utama.
servicePrincipalDetails	ServicePrincipalDetails	Detail spesifik perwakilan layanan. Berlaku ketika jenis utama `ServicePrincipal`.
type	string: ServicePrincipal	Jenis prinsipal. Jenis utama tambahan dapat ditambahkan dari waktu ke waktu.

ServicePrincipalProfileDetails

Objek

Detail profil perwakilan layanan. Berlaku ketika jenis utama ServicePrincipalProfile.

Nama	Jenis	Deskripsi
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Perwakilan induk profil perwakilan layanan.

ServicePrincipalProfilePrincipal

Objek

Mewakili profil perwakilan layanan.

Nama	Jenis	Deskripsi
displayName	string	Nama tampilan utama.
id	string (uuid)	Id utama.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Detail profil perwakilan layanan. Berlaku ketika jenis utama `ServicePrincipalProfile`.
type	string: ServicePrincipalProfile	Jenis prinsipal. Jenis utama tambahan dapat ditambahkan dari waktu ke waktu.

UserDetails

Objek

Detail spesifik perwakilan pengguna. Berlaku ketika jenis utama User.

Nama	Jenis	Deskripsi
userPrincipalName	string	Nama prinsipal pengguna.

UserPrincipal

Objek

Mewakili prinsipal pengguna Microsoft Entra.

Nama	Jenis	Deskripsi
displayName	string	Nama tampilan utama.
id	string (uuid)	Id utama.
type	string: User	Jenis prinsipal. Jenis utama tambahan dapat ditambahkan dari waktu ke waktu.
userDetails	UserDetails	Detail spesifik perwakilan pengguna. Berlaku ketika jenis utama `User`.