Items - Create Graph Model

Služba:
GraphModel
Verze rozhraní API:
v1

Vytvoří GraphModel v zadaném pracovním prostoru.

Poznámka:

Položka GraphModel je aktuálně ve verzi Preview (další informace).

Toto rozhraní API podporuje dlouhotrvajících operací (LRO).

Pokud chcete vytvořit GraphModel s veřejnou definicí, přečtěte si článek GraphModel .

Povolení

Volající musí mít roli pracovního prostoru přispěvatele .

Požadované delegovaná rozsahy

Item.ReadWrite.All

Omezení

  • Pokud chcete vytvořit GraphModel, musí být pracovní prostor v podporované kapacitě Fabric. Další informace najdete v tématu: typy licencí Microsoft Fabric.

Microsoft Entra podporované identity

Toto rozhraní API podporuje Microsoft identity uvedené v této části.

Identita Support
Uživatel Ano
Hlavní služba a Spravované identity Ano

Rozhraní

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
workspaceId
 path True

string (uuid)

Identifikátor pracovního prostoru.

Text požadavku

Name Vyžadováno Typ Description
displayName True

string

Zobrazovaný název GraphModel. Zobrazovaný název musí odpovídat pravidlům pojmenování podle typu položky.
definition

GraphModelPublicDefinition

Veřejná definice GraphModel.
description

string

Popis GraphModel. Maximální délka je 256 znaků.
folderId

string (uuid)

ID složky. Pokud není zadána hodnota null nebo hodnota null, vytvoří se GraphModel s pracovním prostorem jako její složkou.
sensitivityLabelSettings

SensitivityLabelSettings

Nastavení popisku citlivosti pro GraphModel.

Odpovědi

Name Typ Description
201 Created

GraphModel

Úspěšně vytvořeno
202 Accepted

Žádost byla přijata, probíhá zřizování GraphModel.

Hlavičky

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

ErrorResponse

Byl překročen limit přenosové rychlosti služby. Server vrátí hlavičku označující Retry-After , jak dlouho musí klient čekat před odesláním dalších požadavků.

Hlavičky

Retry-After: integer
Other Status Codes

ErrorResponse

Běžné kódy chyb:

  • InvalidItemType – Typ položky je neplatný.

  • ItemDisplayNameAlreadyInUse – Zobrazovaný název položky je již použit.

  • Poškozená částPayload – zadanou datovou část je poškozena.

  • WorkspaceItemsLimitExceededed – Došlo k překročení limitu položek pracovního prostoru.

Příklady

Create a GraphModel example
Create a GraphModel with public definition example

Create a GraphModel example

Ukázkový požadavek

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

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

Ukázková odpověď

Stavový kód:
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"
  }
}
Stavový kód:
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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
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"
  }
}
Stavový kód:
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

Definice

Name Description
CreateGraphModelRequest

Vytvoření datové části požadavku GraphModel
EntireTenantPrincipal

Představuje objekt zabezpečení tenanta.
ErrorRelatedResource

Chyba související s objektem podrobností o prostředku.
ErrorResponse

Odpověď na chybu.
ErrorResponseDetails

Podrobnosti o odpovědi na chybu.
GraphModel

Objekt GraphModel.
GraphModelDefinitionFormat

Formát definice grafu modelu V průběhu času je možné přidat další typy format.
GraphModelPublicDefinition

Objekt veřejné definice GraphModel. Další podrobnosti o struktuře definice GraphModel najdete v tomto článku .
GraphModelPublicDefinitionPart

Objekt části definice GraphModel.
GroupDetails

Seskupte konkrétní podrobnosti. Použitelné, pokud je typ objektu zabezpečení Group.
GroupPrincipal

Představuje skupinu zabezpečení.
GroupType

Typ skupiny. V průběhu času je možné přidat další typy skupin.
ItemTag

Představuje značku použitou u položky.
ItemType

Typ položky. V průběhu času je možné přidat další typy položek.
PayloadType

Typ datové části definice. V průběhu času je možné přidat další typy datových částí.
PrincipalType

Typ objektu zabezpečení. V průběhu času je možné přidat další typy objektů zabezpečení.
SensitivityLabel

Představuje popisek citlivosti použitý u položky.
SensitivityLabelApplyStrategy

Strategie použití popisku citlivosti Výchozí hodnota je ApplyOrFail. V průběhu času je možné přidat další typy.
SensitivityLabelSettings

Nastavení popisku citlivosti.
ServicePrincipalDetails

Podrobnosti specifické pro instanční objekt Použitelné, pokud je typ objektu zabezpečení ServicePrincipal.
ServicePrincipalPrincipal

Představuje Microsoft Entra instanční objekt.
ServicePrincipalProfileDetails

Podrobnosti profilu instančního objektu Použitelné, pokud je typ objektu zabezpečení ServicePrincipalProfile.
ServicePrincipalProfilePrincipal

Představuje profil instančního objektu.
UserDetails

Podrobnosti specifické pro objekt zabezpečení uživatele. Použitelné, pokud je typ objektu zabezpečení User.
UserPrincipal

Představuje Microsoft Entra objekt zabezpečení uživatele.

CreateGraphModelRequest

Objekt

Vytvoření datové části požadavku GraphModel

Name Typ Description
definition

GraphModelPublicDefinition

Veřejná definice GraphModel.
description

string

Popis GraphModel. Maximální délka je 256 znaků.
displayName

string

Zobrazovaný název GraphModel. Zobrazovaný název musí odpovídat pravidlům pojmenování podle typu položky.
folderId

string (uuid)

ID složky. Pokud není zadána hodnota null nebo hodnota null, vytvoří se GraphModel s pracovním prostorem jako její složkou.
sensitivityLabelSettings

SensitivityLabelSettings

Nastavení popisku citlivosti pro GraphModel.

EntireTenantPrincipal

Objekt

Představuje objekt zabezpečení tenanta.

Name Typ Description
displayName

string

Zobrazovaný název objektu zabezpečení.
id

string (uuid)

ID objektu zabezpečení.
type string:

EntireTenant

Typ objektu zabezpečení. V průběhu času je možné přidat další typy objektů zabezpečení.

ErrorRelatedResource

Objekt

Chyba související s objektem podrobností o prostředku.

Name Typ Description
resourceId

string

ID prostředku, které je součástí chyby.
resourceType

string

Typ prostředku, který je součástí chyby.

ErrorResponse

Objekt

Odpověď na chybu.

Name Typ Description
errorCode

string

Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
isRetriable

boolean

Pokud je hodnota true, je možné požadavek opakovat. Pomocí hlavičky Retry-After odpovědi určete zpoždění, pokud je k dispozici.
message

string

Lidské čitelné vyjádření chyby.
moreDetails

ErrorResponseDetails[]

Seznam dalších podrobností o chybě
relatedResource

ErrorRelatedResource

Podrobnosti o prostředku souvisejícím s chybou
requestId

string (uuid)

ID požadavku přidruženého k chybě.

ErrorResponseDetails

Objekt

Podrobnosti o odpovědi na chybu.

Name Typ Description
errorCode

string

Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message

string

Lidské čitelné vyjádření chyby.
relatedResource

ErrorRelatedResource

Podrobnosti o prostředku souvisejícím s chybou

GraphModel

Objekt

Objekt GraphModel.

Name Typ Description
defaultIdentity Principal:

Výchozí identita položky
description

string

Popis položky.
displayName

string

Zobrazovaný název položky.
folderId

string (uuid)

ID složky.
id

string (uuid)

ID položky.
sensitivityLabel

SensitivityLabel

Popisek citlivosti položky.
tags

ItemTag[]

Seznam použitých značek
type

ItemType

Typ položky.
workspaceId

string (uuid)

Identifikátor pracovního prostoru.

GraphModelDefinitionFormat

Výčet

Formát definice grafu modelu V průběhu času je možné přidat další typy format.

Hodnota Description
json

Formát JSON pro veřejnou definici GraphModel, speciálně navržený tak, aby podporoval scénáře CI/CD v Fabric.

GraphModelPublicDefinition

Objekt

Objekt veřejné definice GraphModel. Další podrobnosti o struktuře definice GraphModel najdete v tomto článku .

Name Typ Description
format

GraphModelDefinitionFormat

Formát definice grafu modelu V průběhu času je možné přidat další typy format.
parts

GraphModelPublicDefinitionPart[]

Seznam částí definice.

GraphModelPublicDefinitionPart

Objekt

Objekt části definice GraphModel.

Name Typ Description
path

string

Cesta části veřejné definice GraphModel.
payload

string

Datová část veřejné definice GraphModel.
payloadType

PayloadType

Typ datové části.

GroupDetails

Objekt

Seskupte konkrétní podrobnosti. Použitelné, pokud je typ objektu zabezpečení Group.

Name Typ Description
groupType

GroupType

Typ skupiny. V průběhu času je možné přidat další typy skupin.

GroupPrincipal

Objekt

Představuje skupinu zabezpečení.

Name Typ Description
displayName

string

Zobrazovaný název objektu zabezpečení.
groupDetails

GroupDetails

Seskupte konkrétní podrobnosti. Použitelné, pokud je typ objektu zabezpečení Group.
id

string (uuid)

ID objektu zabezpečení.
type string:

Group

Typ objektu zabezpečení. V průběhu času je možné přidat další typy objektů zabezpečení.

GroupType

Výčet

Typ skupiny. V průběhu času je možné přidat další typy skupin.

Hodnota Description
Unknown

Typ hlavní skupiny je neznámý.
SecurityGroup

Objekt zabezpečení je skupina zabezpečení.
DistributionList

Objekt zabezpečení je distribuční seznam.

ItemTag

Objekt

Představuje značku použitou u položky.

Name Typ Description
displayName

string

Název značky.
id

string (uuid)

ID značky.

ItemType

Výčet

Typ položky. V průběhu času je možné přidat další typy položek.

Hodnota Description
Dashboard

Řídicí panel PowerBI
Report

Sestava PowerBI
SemanticModel

Sémantický model PowerBI
PaginatedReport

Stránkovaná sestava PowerBI
Datamart

Datový diagram PowerBI
Lakehouse

Jezero.
Eventhouse

Eventhouse.
Environment

Prostředí.
KQLDatabase

Databáze KQL.
KQLQueryset

Sada dotazů KQL.
KQLDashboard

Řídicí panel KQL.
DataPipeline

Datový kanál.
Notebook

Poznámkový blok.
SparkJobDefinition

Definice úlohy Sparku.
MLExperiment

Experiment strojového učení.
MLModel

Model strojového učení.
Warehouse

Sklad.
Eventstream

Eventstream.
SQLEndpoint

Koncový bod SQL.
MirroredWarehouse

Zrcadlený sklad.
MirroredDatabase

Zrcadlené databáze.
Reflex

A Reflex.
GraphQLApi

Rozhraní API pro položku GraphQL
MountedDataFactory

A MountedDataFactory.
SQLDatabase

Databáze SQLDatabase.
CopyJob

Úloha kopírování.
VariableLibrary

ProměnnáLibrary.
Dataflow

Tok dat.
ApacheAirflowJob

An ApacheAirflowJob.
WarehouseSnapshot

Snímek skladu.
DigitalTwinBuilder

A DigitalTwinBuilder.
DigitalTwinBuilderFlow

Tok digitálního dvojčete.
MirroredAzureDatabricksCatalog

Zrcadlený katalog Azure Databricks.
Map

Mapa.
AnomalyDetector

Detektor anomálií.
UserDataFunction

Funkce uživatelských dat.
GraphModel

A GraphModel.
GraphQuerySet

Sada dotazů grafu.
SnowflakeDatabase

Snowflake Database pro ukládání tabulek Iceberg vytvořených z účtu Snowflake.
OperationsAgent

A OperationsAgent.
CosmosDBDatabase

Databáze Cosmos DB.
Ontology

Ontologie.
EventSchemaSet

An EventSchemaSet.
DataAgent

A DataAgent.
MirroredCatalog

ZrcadlenýCatalog.
AppBackend

An AppBackend.
OrgApp

Aplikace organizace.
OrgAppAudience

Cílová skupina aplikace organizace.
DataBuildToolJob

A DataBuildToolJob.
AzureDatabricksStorage

Položka úložiště založené na OneLake pro Azure Databricks.
Plan

Plán.

PayloadType

Výčet

Typ datové části definice. V průběhu času je možné přidat další typy datových částí.

Hodnota Description
InlineBase64

Vložená základna 64.

PrincipalType

Výčet

Typ objektu zabezpečení. V průběhu času je možné přidat další typy objektů zabezpečení.

Hodnota Description
User

Objekt zabezpečení je Microsoft Entra objekt zabezpečení uživatele.
ServicePrincipal

Instanční objekt je Microsoft Entra instanční objekt.
Group

Objekt zabezpečení je skupina zabezpečení.
ServicePrincipalProfile

Instanční objekt je profil instančního objektu.
EntireTenant

Objekt zabezpečení představuje všechny uživatele tenanta.

SensitivityLabel

Objekt

Představuje popisek citlivosti použitý u položky.

Name Typ Description
id

string (uuid)

ID popisku citlivosti.

SensitivityLabelApplyStrategy

Výčet

Strategie použití popisku citlivosti Výchozí hodnota je ApplyOrFail. V průběhu času je možné přidat další typy.

Hodnota Description
ApplyOrFail

Pokud ho nelze použít, použijte popisek citlivosti nebo operaci selžou.
Ignore

Pokud popisek citlivosti nelze použít, ignorujte ho a pokračujte v operaci bez použití popisku.

SensitivityLabelSettings

Objekt

Nastavení popisku citlivosti.

Name Typ Description
labelId

string (uuid)

ID popisku citlivosti.
sensitivityLabelApplyStrategy

SensitivityLabelApplyStrategy

Strategie použití popisku citlivosti

ServicePrincipalDetails

Objekt

Podrobnosti specifické pro instanční objekt Použitelné, pokud je typ objektu zabezpečení ServicePrincipal.

Name Typ Description
aadAppId

string (uuid)

Instanční objekt Microsoft Entra AppId.

ServicePrincipalPrincipal

Objekt

Představuje Microsoft Entra instanční objekt.

Name Typ Description
displayName

string

Zobrazovaný název objektu zabezpečení.
id

string (uuid)

ID objektu zabezpečení.
servicePrincipalDetails

ServicePrincipalDetails

Podrobnosti specifické pro instanční objekt Použitelné, pokud je typ objektu zabezpečení ServicePrincipal.
type string:

ServicePrincipal

Typ objektu zabezpečení. V průběhu času je možné přidat další typy objektů zabezpečení.

ServicePrincipalProfileDetails

Objekt

Podrobnosti profilu instančního objektu Použitelné, pokud je typ objektu zabezpečení ServicePrincipalProfile.

Name Typ Description
parentPrincipal Principal:

Nadřazený objekt profilu instančního objektu.

ServicePrincipalProfilePrincipal

Objekt

Představuje profil instančního objektu.

Name Typ Description
displayName

string

Zobrazovaný název objektu zabezpečení.
id

string (uuid)

ID objektu zabezpečení.
servicePrincipalProfileDetails

ServicePrincipalProfileDetails

Podrobnosti profilu instančního objektu Použitelné, pokud je typ objektu zabezpečení ServicePrincipalProfile.
type string:

ServicePrincipalProfile

Typ objektu zabezpečení. V průběhu času je možné přidat další typy objektů zabezpečení.

UserDetails

Objekt

Podrobnosti specifické pro objekt zabezpečení uživatele. Použitelné, pokud je typ objektu zabezpečení User.

Name Typ Description
userPrincipalName

string

Jméno hlavního uživatele.

UserPrincipal

Objekt

Představuje Microsoft Entra objekt zabezpečení uživatele.

Name Typ Description
displayName

string

Zobrazovaný název objektu zabezpečení.
id

string (uuid)

ID objektu zabezpečení.
type string:

User

Typ objektu zabezpečení. V průběhu času je možné přidat další typy objektů zabezpečení.
userDetails

UserDetails

Podrobnosti specifické pro objekt zabezpečení uživatele. Použitelné, pokud je typ objektu zabezpečení User.