Items - Create Graph Model

Служба:: GraphModel

Версия API:: v1

Создает GraphModel в указанной рабочей области.

Замечание

Элемент GraphModel в настоящее время находится в предварительной версии (дополнительные сведения).

Этот API поддерживает длительные операции (LRO).

Чтобы создать GraphModel с открытым определением, ознакомьтесь со статьей GraphModel .

Permissions

Вызывающий объект должен иметь роль рабочей области участника .

Обязательные делегированные области

Item.ReadWrite.All

Ограничения

Чтобы создать GraphModel, рабочая область должна находиться в поддерживаемой емкости Fabric. Дополнительные сведения см. в статье типов лицензий Microsoft Fabric.

Идентификаторы, поддерживаемые Microsoft Entra

Этот API поддерживает идентичности Microsoft, перечисленные в этом разделе.

Идентичность	Support
User	Да
Представитель службы и управляемые удостоверения	нет

Интерфейс

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
workspaceId	path	True	string (uuid)	Идентификатор рабочей области.

Текст запроса

Имя	Обязательно	Тип	Описание
displayName	True	string	Отображаемое имя GraphModel. Отображаемое имя должно соответствовать правилам именования в соответствии с типом элемента.
definition		GraphModelPublicDefinition	Общедоступное определение GraphModel.
description		string	Описание GraphModel. Максимальная длина составляет 256 символов.
folderId		string (uuid)	Идентификатор папки. Если не указано или не задано значение NULL, GraphModel создается с рабочей областью в качестве папки.

Ответы

Имя	Тип	Описание
201 Created	GraphModel	Успешно создано
202 Accepted		Запрос принят, подготовка GraphModel выполняется. Заголовки Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий `Retry-After` в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов. Заголовки Retry-After: integer
Other Status Codes	ErrorResponse	Распространенные коды ошибок: InvalidItemType — тип элемента недопустим ItemDisplayNameAlreadyInUse — отображаемое имя элемента уже используется. Поврежденный Payload — предоставленные полезные данные повреждены. WorkspaceItemsLimitExceed — превышено ограничение элемента рабочей области.

Примеры

Create a GraphModel example

Create a GraphModel with public definition example

Create a GraphModel example

Образец запроса

HTTP

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

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

Пример ответа

Код состояния:: 201

{
  "displayName": "GraphModel 1",
  "description": "A GraphModel description.",
  "type": "GraphModel",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Код состояния:: 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

Образец запроса

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

Пример ответа

Код состояния:: 201

{
  "displayName": "GraphModel 1",
  "description": "A GraphModel description.",
  "type": "GraphModel",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}

Код состояния:: 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

Определения

Имя	Описание
CreateGraphModelRequest	Создайте полезные данные запроса GraphModel.
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
GraphModel	Объект GraphModel.
GraphModelDefinitionFormat	Формат определения элемента. С течением времени могут добавляться дополнительные `format` типы.
GraphModelPublicDefinition	Объект общедоступного определения GraphModel. Дополнительные сведения о создании общедоступного определения GraphModel см. в этой статье .
GraphModelPublicDefinitionPart	Объект части определения GraphModel.
ItemTag	Представляет тег, примененный к элементу.
ItemType	Тип элемента. С течением времени могут добавляться дополнительные типы элементов.
PayloadType	Тип полезных данных части определения. С течением времени могут добавляться дополнительные типы полезных данных.

CreateGraphModelRequest

Объект

Создайте полезные данные запроса GraphModel.

Имя	Тип	Описание
definition	GraphModelPublicDefinition	Общедоступное определение GraphModel.
description	string	Описание GraphModel. Максимальная длина составляет 256 символов.
displayName	string	Отображаемое имя GraphModel. Отображаемое имя должно соответствовать правилам именования в соответствии с типом элемента.
folderId	string (uuid)	Идентификатор папки. Если не указано или не задано значение NULL, GraphModel создается с рабочей областью в качестве папки.

ErrorRelatedResource

Объект

Объект сведений об ошибках, связанных с ресурсом.

Имя	Тип	Описание
resourceId	string	Идентификатор ресурса, участвующий в ошибке.
resourceType	string	Тип ресурса, который участвует в ошибке.

ErrorResponse

Объект

Ответ на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
moreDetails	ErrorResponseDetails[]	Список дополнительных сведений об ошибке.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.
requestId	string (uuid)	Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Объект

Сведения об ответе на ошибку.

Имя	Тип	Описание
errorCode	string	Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message	string	Удобочитаемое представление ошибки.
relatedResource	ErrorRelatedResource	Сведения об ошибках, связанных с ресурсом.

GraphModel

Объект

Объект GraphModel.

Имя	Тип	Описание
description	string	Описание элемента.
displayName	string	Отображаемое имя элемента.
folderId	string (uuid)	Идентификатор папки.
id	string (uuid)	Идентификатор элемента.
tags	ItemTag[]	Список примененных тегов.
type	ItemType	Тип элемента.
workspaceId	string (uuid)	Идентификатор рабочей области.

GraphModelDefinitionFormat

Перечисление

Формат определения элемента. С течением времени могут добавляться дополнительные format типы.

Значение	Описание
json	Формат JSON для общедоступного определения GraphModel, специально предназначенный для поддержки сценариев CI/CD в Fabric.

GraphModelPublicDefinition

Объект

Объект общедоступного определения GraphModel. Дополнительные сведения о создании общедоступного определения GraphModel см. в этой статье .

Имя	Тип	Описание
format	GraphModelDefinitionFormat	Формат определения элемента. С течением времени могут добавляться дополнительные `format` типы.
parts	GraphModelPublicDefinitionPart[]	Список частей определения.

GraphModelPublicDefinitionPart

Объект

Объект части определения GraphModel.

Имя	Тип	Описание
path	string	Путь к части общедоступного определения GraphModel.
payload	string	Полезные данные общедоступного определения GraphModel.
payloadType	PayloadType	Тип полезных данных.

ItemTag

Объект

Представляет тег, примененный к элементу.

Имя	Тип	Описание
displayName	string	Имя тега.
id	string (uuid)	Идентификатор тега.

ItemType

Перечисление

Тип элемента. С течением времени могут добавляться дополнительные типы элементов.

Значение	Описание
Dashboard	Панель мониторинга PowerBI.
Report	Отчет PowerBI.
SemanticModel	Семантическая модель PowerBI.
PaginatedReport	Отчет с разбивкой на страницы PowerBI.
Datamart	Datamart PowerBI.
Lakehouse	Озеро.
Eventhouse	Хранилище событий.
Environment	Среда.
KQLDatabase	База данных KQL.
KQLQueryset	Набор запросов KQL.
KQLDashboard	Панель мониторинга KQL.
DataPipeline	Конвейер данных.
Notebook	Записная книжка.
SparkJobDefinition	Определение задания Spark.
MLExperiment	Эксперимент машинного обучения.
MLModel	Модель машинного обучения.
Warehouse	Склад.
Eventstream	Поток событий.
SQLEndpoint	Конечная точка SQL.
MirroredWarehouse	Зеркальный склад.
MirroredDatabase	Зеркальная база данных.
Reflex	Рефлекс.
GraphQLApi	API для элемента GraphQL.
MountedDataFactory	ПодключеннаяdataFactory.
SQLDatabase	База данных SQLDatabase.
CopyJob	Задание копирования.
VariableLibrary	ПеременнаяLibrary.
Dataflow	Поток данных.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Моментальный снимок хранилища.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Поток Конструктора цифровых двойников.
MirroredAzureDatabricksCatalog	Зеркальный каталог azure databricks.
Map	Карта.
AnomalyDetector	Детектор аномалий.
UserDataFunction	Функция данных пользователя.
GraphModel	A GraphModel.
GraphQuerySet	Набор запросов Graph.
SnowflakeDatabase	База данных Snowflake для хранения таблиц Iceberg, созданных из учетной записи Snowflake.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	База данных Cosmos DB.
Ontology	An Ontology.
EventSchemaSet	An EventSchemaSet.
DataAgent	A DataAgent.

PayloadType

Перечисление

Тип полезных данных части определения. С течением времени могут добавляться дополнительные типы полезных данных.

Значение	Описание
InlineBase64	Встроенная база 64.

Поделиться через

Items - Create Graph Model

Permissions

Обязательные делегированные области

Ограничения

Идентификаторы, поддерживаемые Microsoft Entra

Интерфейс

Параметры URI

Текст запроса

Ответы

Примеры

Create a GraphModel example

Образец запроса

Пример ответа

Create a GraphModel with public definition example

Образец запроса

Пример ответа

Определения

CreateGraphModelRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GraphModel

GraphModelDefinitionFormat

GraphModelPublicDefinition

GraphModelPublicDefinitionPart

ItemTag

ItemType

PayloadType