Items - Create GraphQLApi

Служба:: GraphQLApi

Версия API:: v1

Создает API для элемента GraphQL в указанной рабочей области.

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

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

Разрешения

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

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

GraphQLApi.ReadWrite.All или Item.ReadWrite.All

Ограничения

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

Поддерживаемые удостоверения Microsoft Entra

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

Тождество	Поддержка
Пользователь	Да
субъекта-службы и управляемых удостоверений	Да

Интерфейс

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

Параметры URI

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

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

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

Ответы

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

Имя

Тип

Описание

201 Created

GraphQLApi

Успешно создано

202 Accepted

Запрос принят, подготовка GraphQLApi выполняется.

Заголовки

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

Распространенные коды ошибок:

InvalidItemType — тип элемента недопустим
ItemDisplayNameAlreadyInUse — отображаемое имя элемента уже используется.
Поврежденный Payload — предоставленные полезные данные повреждены.
WorkspaceItemsLimitExceed — превышено ограничение элемента рабочей области.

Примеры

Create a API for GraphQL example

Create a GraphQLApi with public definition example

Create a API for GraphQL example

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

HTTP

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

{
  "displayName": "GraphQL 1",
  "description": "An API for GraphQL item description."
}

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

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

{
  "displayName": "GraphQL 1",
  "description": "An API for GraphQL item description.",
  "type": "GraphQLApi",
  "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 GraphQLApi with public definition example

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

HTTP

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

{
  "displayName": "GraphQLApi 1",
  "description": "An API for GraphQL item description.",
  "definition": {
    "format": "GraphQLApiV1",
    "parts": [
      {
        "path": "graphql-definition.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

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

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

{
  "displayName": "GraphQLApi 1",
  "description": "An API for GraphQL item description.",
  "type": "GraphQLApi",
  "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

Определения

Имя	Описание
CreateGraphQLApiRequest	Создание полезных данных api для запросов GraphQL.
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
GraphQLApi	API для элемента GraphQL.
GraphQLApiPublicDefinition	API для объекта общедоступного определения GraphQL. Чтобы создать определение, см. определение GraphQLApi.
GraphQLApiPublicDefinitionPart	Объект части определения GraphQL для API.
ItemTag	Представляет тег, примененный к элементу.
ItemType	Тип элемента. С течением времени могут добавляться дополнительные типы элементов.
PayloadType	Тип полезных данных части определения. С течением времени могут добавляться дополнительные типы полезных данных.

CreateGraphQLApiRequest

Объект

Создание полезных данных api для запросов GraphQL.

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

ErrorRelatedResource

Объект

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

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

ErrorResponse

Объект

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

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

ErrorResponseDetails

Объект

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

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

GraphQLApi

Объект

API для элемента GraphQL.

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

GraphQLApiPublicDefinition

Объект

API для объекта общедоступного определения GraphQL. Чтобы создать определение, см. определение GraphQLApi.

Имя	Тип	Описание
format	string	Формат определения элемента.
parts	GraphQLApiPublicDefinitionPart[]	Список частей определения.

GraphQLApiPublicDefinitionPart

Объект

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

Имя	Тип	Описание
path	string	Путь к части определения Api для GraphQL.
payload	string	Полезные данные API для определения GraphQL.
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.

PayloadType

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

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

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

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

Items - Create GraphQLApi

Разрешения

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

Ограничения

Поддерживаемые удостоверения Microsoft Entra

Интерфейс

Параметры URI

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

Ответы

Примеры

Create a API for GraphQL example

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

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

Create a GraphQLApi with public definition example

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

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

Определения

CreateGraphQLApiRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GraphQLApi

GraphQLApiPublicDefinition

GraphQLApiPublicDefinitionPart

ItemTag

ItemType

PayloadType