Items - Create Graph Model

Služba:: GraphModel

Verzia rozhrania API:: v1

Vytvorí GraphModel v zadanom pracovnom priestore.

Poznámka

Položka GraphModel je momentálne v režime ukážky (ďalšie informácie).

Toto rozhranie API podporuje dlhotrvajúce operácie (LRO).

Ak chcete vytvoriť model GraphModel s verejnou definíciou, pozrite si článok GraphModel .

Povolenia

Volajúci musí mať rolu pracovného priestoru prispievateľa .

Povinné delegované rozsahy

Item.ReadWrite.All

Obmedzenia

Ak chcete vytvoriť model GraphModel, pracovný priestor musí byť v podporovanej kapacite Fabric. Ďalšie informácie nájdete v téme: Microsoft Fabric typy licencií.

podporované identity Microsoft Entra

Toto rozhranie API podporuje Microsoft identity uvedené v tejto časti.

Identita	Podpora
User	Áno
Objekt služby a spravované identity	Áno

Rozhranie

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

Parametre URI

Meno	V	Povinné	Typ	Description
workspaceId	path	True	string (uuid)	ID pracovného priestoru.

Text požiadavky

Meno	Povinné	Typ	Description
displayName	True	string	Zobrazovaný názov GraphModel. Zobrazovaný názov musí postupovať podľa pravidiel pomenovania podľa typu položky.
definition		GraphModelPublicDefinition	Verejná definícia GraphModel.
description		string	Popis GraphModel. Maximálna dĺžka je 256 znakov.
folderId		string (uuid)	ID priečinka. Ak parameter nie je zadaný alebo má hodnotu null, vytvorí sa GraphModel s pracovným priestorom ako priečinkom.
sensitivityLabelSettings		SensitivityLabelSettings	Nastavenia označenia citlivosti pre model GraphModel.

Odpovede

Meno	Typ	Description
201 Created	GraphModel	Úspešne vytvorené
202 Accepted		Prebieha poskytovanie prostriedkov GraphModel. Hlavičky Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Prekročil sa limit rýchlosti služby. Server vráti hlavičku `Retry-After` v sekundách, ako dlho musí klient počkať, kým odošle ďalšie požiadavky. Hlavičky Retry-After: integer
Other Status Codes	ErrorResponse	Bežné kódy chýb: InvalidItemType – typ položky je neplatný ItemDisplayNameAlreadyInUse – zobrazovaný názov položky sa už používa. CorruptedPayload – poskytnutá údajová časť je poškodená. Limit položiek pracovného priestoruItemsLimitExceeded – limit položiek pracovného priestoru bol prekročený.

Príklady

Create a GraphModel example

Create a GraphModel with public definition example

Create a GraphModel example

Vzorová požiadavka

HTTP

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

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

Vzorová odpoveď

Kód stavu:: 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"
  }
}

Kód stavu:: 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

Vzorová požiadavka

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

Vzorová odpoveď

Kód stavu:: 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"
  }
}

Kód stavu:: 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

Definície

Meno	Description
CreateGraphModelRequest	Vytvorenie údajovej časti požiadavky GraphModel.
EntireTenantPrincipal	Predstavuje objekt nájomníka
ErrorParameter	Štruktúrovaný parameter poskytujúci ďalší strojovo čitateľný kontext o chybe.
ErrorRelatedResource	Objekt s podrobnosťami o zdroji súvisiacej s chybou.
ErrorResponse	Odpoveď na chybu.
ErrorResponseDetails	Podrobnosti o chybovej odpovedi.
GraphModel	Objekt GraphModel.
GraphModelDefinitionFormat	Formát definície modelu grafu. V priebehu času je možné pridať ďalšie typy #D0.
GraphModelPublicDefinition	Objekt verejnej definície GraphModel. V tomto článku nájdete ďalšie podrobnosti o štruktúre definície GraphModel.
GraphModelPublicDefinitionPart	Časť objektu definície GraphModel.
GroupDetails	Podrobnosti špecifické pre skupinu. Platí, ak je `Group`typ objektu .
GroupPrincipal	Predstavuje skupinu zabezpečenia.
GroupType	Typ skupiny. V priebehu času je možné pridať ďalšie typy skupín.
ItemTag	Predstavuje značku použitú na položke.
ItemType	Typ položky. V priebehu času je možné pridať ďalšie typy položiek.
PayloadType	Typ údajovej časti definície. V priebehu času je možné pridať ďalšie typy údajovej časti.
PrincipalType	Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.
SensitivityLabel	Predstavuje označenie citlivosti použité na položku.
SensitivityLabelApplyStrategy	Stratégia používania označenia citlivosti. Predvolená hodnota je ApplyOrFail. V priebehu času je možné pridať ďalšie typy.
SensitivityLabelSettings	Nastavenia označenia citlivosti.
ServicePrincipalDetails	Konkrétne podrobnosti objektu služby. Platí, ak je `ServicePrincipal`typ objektu .
ServicePrincipalPrincipal	Predstavuje Microsoft Entra objekt služby.
ServicePrincipalProfileDetails	Podrobnosti o profile objektu služby. Platí, ak je `ServicePrincipalProfile`typ objektu .
ServicePrincipalProfilePrincipal	Predstavuje profil objektu služby.
UserDetails	Konkrétne podrobnosti o objekte používateľa. Platí, ak je `User`typ objektu .
UserPrincipal	Predstavuje Microsoft Entra hlavného používateľa.

CreateGraphModelRequest

Object

Vytvorenie údajovej časti požiadavky GraphModel.

Meno	Typ	Description
definition	GraphModelPublicDefinition	Verejná definícia GraphModel.
description	string	Popis GraphModel. Maximálna dĺžka je 256 znakov.
displayName	string	Zobrazovaný názov GraphModel. Zobrazovaný názov musí postupovať podľa pravidiel pomenovania podľa typu položky.
folderId	string (uuid)	ID priečinka. Ak parameter nie je zadaný alebo má hodnotu null, vytvorí sa GraphModel s pracovným priestorom ako priečinkom.
sensitivityLabelSettings	SensitivityLabelSettings	Nastavenia označenia citlivosti pre model GraphModel.

EntireTenantPrincipal

Object

Predstavuje objekt nájomníka

Meno	Typ	Description
displayName	string	Zobrazovaný názov objektu.
id	string (uuid)	ID objektu.
type	string: EntireTenant	Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.

ErrorParameter

Object

Štruktúrovaný parameter poskytujúci ďalší strojovo čitateľný kontext o chybe.

Meno	Typ	Description
message	string	Popis významu parametra čitateľný ľuďmi.
name	string	Identifikátor parametra.
value	string	Hodnota parametra.

ErrorRelatedResource

Object

Objekt s podrobnosťami o zdroji súvisiacej s chybou.

Meno	Typ	Description
resourceId	string	ID prostriedku, ktoré je súčasťou chyby.
resourceType	string	Typ prostriedku, ktorý je zapojený do chyby.

ErrorResponse

Object

Odpoveď na chybu.

Meno	Typ	Description
errorCode	string	Konkrétny identifikátor, ktorý poskytuje informácie o chybovej podmienke a umožňuje štandardizovanú komunikáciu medzi našou službou a používateľmi.
isRetriable	boolean	Ak je hodnota true, žiadosť sa môže zopakovať. `Retry-After` Ak je k dispozícii, oneskorenie môžete určiť pomocou hlavičky odpovede.
message	string	Zobrazenie chyby čitateľné ľuďmi.
moreDetails	ErrorResponseDetails[]	Zoznam ďalších podrobností o chybe.
parameters	ErrorParameter[]	Štruktúrované parametre poskytujúce ďalší strojovo čitateľný kontext o chybe.
relatedResource	ErrorRelatedResource	Podrobnosti o zdrojoch súvisiacich s chybou.
requestId	string (uuid)	ID požiadavky súvisiacej s chybou.

ErrorResponseDetails

Object

Podrobnosti o chybovej odpovedi.

Meno	Typ	Description
errorCode	string	Konkrétny identifikátor, ktorý poskytuje informácie o chybovej podmienke a umožňuje štandardizovanú komunikáciu medzi našou službou a používateľmi.
message	string	Zobrazenie chyby čitateľné ľuďmi.
parameters	ErrorParameter[]	Štruktúrované parametre poskytujúce ďalší strojovo čitateľný kontext o chybe.
relatedResource	ErrorRelatedResource	Podrobnosti o zdrojoch súvisiacich s chybou.

GraphModel

Object

Objekt GraphModel.

Meno	Typ	Description
defaultIdentity	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Predvolená identita položky.
description	string	Popis položky.
displayName	string	Zobrazovaný názov položky.
folderId	string (uuid)	ID priečinka.
id	string (uuid)	ID položky.
logicalId	string (uuid)	Logický identifikátor položky. Zodpovedajúce inštancie položiek zdieľajú rovnaké logické ID. Hodnota je null, keď nebolo priradené žiadne logické ID.
sensitivityLabel	SensitivityLabel	Označenie citlivosti položky.
tags	ItemTag[]	Zoznam použitých značiek.
type	ItemType	Typ položky.
workspaceId	string (uuid)	ID pracovného priestoru.

GraphModelDefinitionFormat

Enumerácia

Formát definície modelu grafu. V priebehu času je možné pridať ďalšie typy #D0.

Hodnota	Description
json	Formát JSON pre verejnú definíciu GraphModel, špeciálne navrhnutú na podporu scenárov CI/CD v Fabric.

GraphModelPublicDefinition

Object

Objekt verejnej definície GraphModel. V tomto článku nájdete ďalšie podrobnosti o štruktúre definície GraphModel.

Meno	Typ	Description
format	GraphModelDefinitionFormat	Formát definície modelu grafu. V priebehu času je možné pridať ďalšie typy #D0.
parts	GraphModelPublicDefinitionPart[]	Zoznam častí definície.

GraphModelPublicDefinitionPart

Object

Časť objektu definície GraphModel.

Meno	Typ	Description
path	string	Cesta k verejnej definícii GraphModel.
payload	string	Časť údajovej časti služby GraphModel – verejná definícia.
payloadType	PayloadType	Typ údajovej časti.

GroupDetails

Object

Podrobnosti špecifické pre skupinu. Platí, ak je Grouptyp objektu .

Meno	Typ	Description
groupType	GroupType	Typ skupiny. V priebehu času je možné pridať ďalšie typy skupín.

GroupPrincipal

Object

Predstavuje skupinu zabezpečenia.

Meno	Typ	Description
displayName	string	Zobrazovaný názov objektu.
groupDetails	GroupDetails	Podrobnosti špecifické pre skupinu. Platí, ak je `Group`typ objektu .
id	string (uuid)	ID objektu.
type	string: Group	Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.

GroupType

Enumerácia

Typ skupiny. V priebehu času je možné pridať ďalšie typy skupín.

Hodnota	Description
Unknown	Typ hlavnej skupiny nie je známy.
SecurityGroup	Principal je skupina zabezpečenia.
DistributionList	Principal je distribučný zoznam.

ItemTag

Object

Predstavuje značku použitú na položke.

Meno	Typ	Description
displayName	string	Názov značky.
id	string (uuid)	ID značky.

ItemType

Enumerácia

Typ položky. V priebehu času je možné pridať ďalšie typy položiek.

Hodnota	Description
Dashboard	Tabuľa služby PowerBI.
Report	Zostava PowerBI.
SemanticModel	Sémantický model PowerBI.
PaginatedReport	Stránkovaná zostava služby PowerBI.
Datamart	Údajový diagram služby PowerBI.
Lakehouse	Jazero.
Eventhouse	Eventhouse.
Environment	Prostredie.
KQLDatabase	Databáza KQL.
KQLQueryset	Množina dotazov KQL.
KQLDashboard	Tabuľa KQL.
DataPipeline	Kanál údajov.
Notebook	Poznámkový blok.
SparkJobDefinition	Definícia úlohy iskry.
MLExperiment	Experiment strojového učenia.
MLModel	Model strojového učenia.
Warehouse	Sklad.
Eventstream	Udalosť eventstream.
SQLEndpoint	Koncový bod SQL.
MirroredWarehouse	Zrkadlový sklad.
MirroredDatabase	Zrkadlová databáza.
Reflex	A Reflex.
GraphQLApi	Rozhranie API pre položku GraphQL.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	Databáza SQLDatabase.
CopyJob	Kopírovať úlohu.
VariableLibrary	A VariableLibrary.
Dataflow	Tok údajov.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Snímka skladu.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Digitálny postup Twin Buildera.
MirroredAzureDatabricksCatalog	Zrkadlový katalóg Azure databricks.
Map	Mapa.
AnomalyDetector	Detektor anomálií.
UserDataFunction	Funkcia user data function.
GraphModel	A GraphModel.
GraphQuerySet	Množina dotazov Graphu.
SnowflakeDatabase	Databáza Snowflake na ukladanie tabuliek ľadovec vytvorených z konta Snowflake.
OperationsAgent	OperationsAgent (Operácia).
CosmosDBDatabase	Databáza Cosmos DB.
Ontology	Ontológia.
EventSchemaSet	Množina schém udalosti.
DataAgent	DataAgent (Údajovýgens).
MirroredCatalog	Zrkadlovýcatalog.
AppBackend	An AppBackend.
OrgApp	Aplikácia organizácie.
OrgAppAudience	Publikum aplikácií organizácie.
DataBuildToolJob	A DataBuildToolJob.
AzureDatabricksStorage	Úložný priestor podložený OneLakeom pre Azure Databricks.
Plan	Plán.

PayloadType

Enumerácia

Typ údajovej časti definície. V priebehu času je možné pridať ďalšie typy údajovej časti.

Hodnota	Description
InlineBase64	Inline Base 64.

PrincipalType

Enumerácia

Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.

Hodnota	Description
User	Principal je Microsoft Entra objektom používateľa.
ServicePrincipal	Principal je Microsoft Entra objekt služby.
Group	Principal je skupina zabezpečenia.
ServicePrincipalProfile	Principal je profil objektu služby.
EntireTenant	Možnosť Principal predstavuje všetkých používateľov nájomníka.

SensitivityLabel

Object

Predstavuje označenie citlivosti použité na položku.

Meno	Typ	Description
id	string (uuid)	ID označenia citlivosti.

SensitivityLabelApplyStrategy

Enumerácia

Stratégia používania označenia citlivosti. Predvolená hodnota je ApplyOrFail. V priebehu času je možné pridať ďalšie typy.

Hodnota	Description
ApplyOrFail	Použite označenie citlivosti alebo zlyhajte operáciu, ak sa nedá použiť.
Ignore	Ignorujte označenie citlivosti, ak ho nie je možné použiť a pokračovať s operáciou bez použitia označenia.

SensitivityLabelSettings

Object

Nastavenia označenia citlivosti.

Meno	Typ	Description
labelId	string (uuid)	ID označenia citlivosti.
sensitivityLabelApplyStrategy	SensitivityLabelApplyStrategy	Stratégia používania označenia citlivosti.

ServicePrincipalDetails

Object

Konkrétne podrobnosti objektu služby. Platí, ak je ServicePrincipaltyp objektu .

Meno	Typ	Description
aadAppId	string (uuid)	Microsoft Entra id objektu služby.

ServicePrincipalPrincipal

Object

Predstavuje Microsoft Entra objekt služby.

Meno	Typ	Description
displayName	string	Zobrazovaný názov objektu.
id	string (uuid)	ID objektu.
servicePrincipalDetails	ServicePrincipalDetails	Konkrétne podrobnosti objektu služby. Platí, ak je `ServicePrincipal`typ objektu .
type	string: ServicePrincipal	Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.

ServicePrincipalProfileDetails

Object

Podrobnosti o profile objektu služby. Platí, ak je ServicePrincipalProfiletyp objektu .

Meno	Typ	Description
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Nadradený objekt profilu služby.

ServicePrincipalProfilePrincipal

Object

Predstavuje profil objektu služby.

Meno	Typ	Description
displayName	string	Zobrazovaný názov objektu.
id	string (uuid)	ID objektu.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Podrobnosti o profile objektu služby. Platí, ak je `ServicePrincipalProfile`typ objektu .
type	string: ServicePrincipalProfile	Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.

UserDetails

Object

Konkrétne podrobnosti o objekte používateľa. Platí, ak je Usertyp objektu .

Meno	Typ	Description
userPrincipalName	string	Hlavné meno používateľa.

UserPrincipal

Object

Predstavuje Microsoft Entra hlavného používateľa.

Meno	Typ	Description
displayName	string	Zobrazovaný názov objektu.
id	string (uuid)	ID objektu.
type	string: User	Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.
userDetails	UserDetails	Konkrétne podrobnosti o objekte používateľa. Platí, ak je `User`typ objektu .