Items - Create GraphQLApi

Serviço:: GraphQLApi

Versão da API:: v1

Cria uma API para o item GraphQL no espaço de trabalho especificado.

Esta API suporta operações de longa duração (LRO).

Para criar o item GraphQLApi com uma definição pública, consulte a definição de GraphQLApi.

Permissões

O chamador deve ter uma função de espaço de trabalho de colaborador .

Escopos delegados necessários

GraphQLApi.ReadWrite.All ou Item.ReadWrite.All

Limitações

Para criar um GraphQLApi, o espaço de trabalho deve estar em uma capacidade de malha suportada. Para obter mais informações, consulte: Tipos de licença do Microsoft Fabric.

Identidades suportadas pelo Microsoft Entra

Esta API suporta as identidades do Microsoft listadas nesta secção.

Identidade	Suporte
Utilizador	Sim
da entidade de serviço e identidades gerenciadas	Sim

Interfaz

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
workspaceId	path	True	string (uuid)	O ID do espaço de trabalho.

Corpo do Pedido

Name	Necessário	Tipo	Description
displayName	True	string	O nome de exibição da API para GraphQL. O nome para exibição deve seguir regras de nomenclatura de acordo com o tipo de item.
definition		GraphQLApiPublicDefinition	A definição pública da API para GraphQL.
description		string	A descrição da API para GraphQL. O comprimento máximo é de 256 caracteres.
folderId		string (uuid)	O ID da pasta. Se não especificado ou nulo, a API para GraphQL é criada com o espaço de trabalho como sua pasta.

Respostas

Name	Tipo	Description
201 Created	GraphQLApi	Criado com sucesso
202 Accepted		Pedido aceite, provisionamento GraphQLApi em curso. Cabeçalhos Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de erro comuns: InvalidItemType - O tipo de item é inválido ItemDisplayNameAlreadyInUse - O nome de exibição do item já é usado. CorruptedPayload - A carga fornecida está corrompida. WorkspaceItemsLimitExceeded - Limite de itens do espaço de trabalho excedido.

Name

Tipo

Description

201 Created

GraphQLApi

Criado com sucesso

202 Accepted

Pedido aceite, provisionamento GraphQLApi em curso.

Cabeçalhos

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

Other Status Codes

ErrorResponse

Códigos de erro comuns:

InvalidItemType - O tipo de item é inválido
ItemDisplayNameAlreadyInUse - O nome de exibição do item já é usado.
CorruptedPayload - A carga fornecida está corrompida.
WorkspaceItemsLimitExceeded - Limite de itens do espaço de trabalho excedido.

Exemplos

Create a API for GraphQL example

Create a GraphQLApi with public definition example

Create a API for GraphQL example

Pedido de amostra

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

Resposta da amostra

Código de estado:: 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"
}

Código de estado:: 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

Pedido de amostra

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

Resposta da amostra

Código de estado:: 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"
}

Código de estado:: 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

Definições

Name	Description
CreateGraphQLApiRequest	Crie uma API para a carga útil de solicitação do GraphQL.
ErrorRelatedResource	O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
GraphQLApi	Uma API para o item GraphQL.
GraphQLApiPublicDefinition	API para objeto de definição pública GraphQL. Para criar a definição, consulte Definição GraphQLApi.
GraphQLApiPublicDefinitionPart	API para objeto de parte de definição do GraphQL.
ItemTag	Representa uma tag aplicada em um item.
ItemType	O tipo do item. Tipos de itens adicionais podem ser adicionados ao longo do tempo.
PayloadType	O tipo de carga útil da peça de definição. Ao longo do tempo, podem ser adicionados tipos de carga útil adicionais.

CreateGraphQLApiRequest

Object

Crie uma API para a carga útil de solicitação do GraphQL.

Name	Tipo	Description
definition	GraphQLApiPublicDefinition	A definição pública da API para GraphQL.
description	string	A descrição da API para GraphQL. O comprimento máximo é de 256 caracteres.
displayName	string	O nome de exibição da API para GraphQL. O nome para exibição deve seguir regras de nomenclatura de acordo com o tipo de item.
folderId	string (uuid)	O ID da pasta. Se não especificado ou nulo, a API para GraphQL é criada com o espaço de trabalho como sua pasta.

ErrorRelatedResource

Object

O objeto de detalhes do recurso relacionado ao erro.

Name	Tipo	Description
resourceId	string	A ID do recurso envolvida no erro.
resourceType	string	O tipo de recurso envolvido no erro.

ErrorResponse

Object

A resposta de erro.

Name	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível por humanos do erro.
moreDetails	ErrorResponseDetails[]	Lista de detalhes de erro adicionais.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionados ao erro.
requestId	string	ID da solicitação associada ao erro.

ErrorResponseDetails

Object

Os detalhes da resposta de erro.

Name	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível por humanos do erro.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionados ao erro.

GraphQLApi

Object

Uma API para o item GraphQL.

Name	Tipo	Description
description	string	A descrição do item.
displayName	string	O nome de exibição do item.
folderId	string (uuid)	O ID da pasta.
id	string (uuid)	O ID do item.
tags	ItemTag[]	Lista de tags aplicadas.
type	ItemType	O tipo de item.
workspaceId	string (uuid)	O ID do espaço de trabalho.

GraphQLApiPublicDefinition

Object

API para objeto de definição pública GraphQL. Para criar a definição, consulte Definição GraphQLApi.

Name	Tipo	Description
format	string	O formato da definição do item.
parts	GraphQLApiPublicDefinitionPart[]	Uma lista de partes de definição.

GraphQLApiPublicDefinitionPart

Object

API para objeto de parte de definição do GraphQL.

Name	Tipo	Description
path	string	O caminho da parte de definição da API para GraphQL.
payload	string	A API para a carga útil parcial de definição do GraphQL.
payloadType	PayloadType	O tipo de carga útil.

ItemTag

Object

Representa uma tag aplicada em um item.

Name	Tipo	Description
displayName	string	O nome da tag.
id	string (uuid)	O ID da tag.

ItemType

Enumeração

O tipo do item. Tipos de itens adicionais podem ser adicionados ao longo do tempo.

Valor	Description
Dashboard	Painel do PowerBI.
Report	Relatório do PowerBI.
SemanticModel	Modelo semântico do PowerBI.
PaginatedReport	Relatório paginado do PowerBI.
Datamart	Datamart do PowerBI.
Lakehouse	Uma casa no lago.
Eventhouse	Uma casa de eventos.
Environment	Um ambiente.
KQLDatabase	Um banco de dados KQL.
KQLQueryset	Um conjunto de consultas KQL.
KQLDashboard	Um painel KQL.
DataPipeline	Um pipeline de dados.
Notebook	Um caderno.
SparkJobDefinition	Uma definição de trabalho de faísca.
MLExperiment	Uma experiência de aprendizagem automática.
MLModel	Um modelo de aprendizagem automática.
Warehouse	Um armazém.
Eventstream	Um fluxo de eventos.
SQLEndpoint	Um ponto de extremidade SQL.
MirroredWarehouse	Um armazém espelhado.
MirroredDatabase	Um banco de dados espelhado.
Reflex	Um reflexo.
GraphQLApi	Uma API para o item GraphQL.
MountedDataFactory	Um MountedDataFactory.
SQLDatabase	Um SQLDatabase.
CopyJob	Um trabalho de cópia.
VariableLibrary	Uma VariableLibrary.
Dataflow	Um fluxo de dados.
ApacheAirflowJob	Um ApacheAirflowJob.
WarehouseSnapshot	Um instantâneo do Warehouse.
DigitalTwinBuilder	Um DigitalTwinBuilder.
DigitalTwinBuilderFlow	Um fluxo de construtor de gêmeos digitais.
MirroredAzureDatabricksCatalog	Um catálogo de databricks azure espelhado.
Map	Um mapa.
AnomalyDetector	Um detetor de anomalias.
UserDataFunction	Uma função de dados do usuário.
GraphModel	Um GraphModel.
GraphQuerySet	Um Graph QuerySet.
SnowflakeDatabase	Uma base de dados Snowflake para armazenar tabelas Iceberg criadas a partir da conta Snowflake.
OperationsAgent	Um Agente de Operações.
CosmosDBDatabase	Uma base de dados Cosmos DB.
Ontology	Uma ontologia.

PayloadType

Enumeração

O tipo de carga útil da peça de definição. Ao longo do tempo, podem ser adicionados tipos de carga útil adicionais.

Valor	Description
InlineBase64	Base em linha 64.

Partilhar via

Items - Create GraphQLApi

Permissões

Escopos delegados necessários

Limitações

Identidades suportadas pelo Microsoft Entra

Interfaz

Parâmetros do URI

Corpo do Pedido

Respostas

Exemplos

Create a API for GraphQL example

Pedido de amostra

Resposta da amostra

Create a GraphQLApi with public definition example

Pedido de amostra

Resposta da amostra

Definições

CreateGraphQLApiRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GraphQLApi

GraphQLApiPublicDefinition

GraphQLApiPublicDefinitionPart

ItemTag

ItemType

PayloadType