Items - Create GraphQLApi

Serviço:: GraphQLApi

Versão da API:: v1

Cria uma API para o item GraphQL no workspace especificado.

Essa API dá suporte a LRO (operações de execução longa).

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

Permissões

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

Escopos delegados necessários

GraphQLApi.ReadWrite.All ou Item.ReadWrite.All

Limitações

Para criar um GraphQLApi, o workspace deve estar em uma capacidade do Fabric com suporte. Para obter mais informações, consulte: tipos de licença do Microsoft Fabric.

Identidades com suporte do Microsoft Entra

Esta API dá suporte às identidades do Microsoft listadas nesta seção.

Identidade	Apoio
Utilizador	Sim
entidade de serviço e identidades gerenciadas	Sim

Interfase

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
workspaceId	path	True	string (uuid)	A ID do workspace.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
displayName	True	string	O nome de exibição da API para GraphQL. O nome de 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)	A ID da pasta. Se não for especificado ou nulo, a API para GraphQL será criada com o workspace como sua pasta.

Respostas

Nome	Tipo	Description
201 Created	GraphQLApi	Criado com êxito
202 Accepted		Solicitação aceita, provisionamento graphQLApi em andamento. 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á está sendo usado. CorruptedPayload – O conteúdo fornecido está corrompido. WorkspaceItemsLimitExceeded - Limite de itens do workspace excedido.

Nome

Tipo

Description

201 Created

GraphQLApi

Criado com êxito

202 Accepted

Solicitação aceita, provisionamento graphQLApi em andamento.

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á está sendo usado.
CorruptedPayload – O conteúdo fornecido está corrompido.
WorkspaceItemsLimitExceeded - Limite de itens do workspace excedido.

Exemplos

Create a API for GraphQL example

Create a GraphQLApi with public definition example

Create a API for GraphQL example

Solicitação de exemplo

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 de exemplo

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

Solicitação de exemplo

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 de exemplo

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

Nome	Description
CreateGraphQLApiRequest	Criar conteúdo de solicitação da API para GraphQL.
ErrorRelatedResource	O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
GraphQLApi	Um item de API para GraphQL.
GraphQLApiPublicDefinition	API para objeto de definição pública do GraphQL. Para criar a definição, consulte a definição de GraphQLApi.
GraphQLApiPublicDefinitionPart	Objeto de parte de definição da API para GraphQL.
ItemTag	Representa uma marca aplicada em um item.
ItemType	O tipo do item. Tipos de item adicionais podem ser adicionados ao longo do tempo.
PayloadType	O tipo da carga da parte de definição. Tipos de conteúdo adicionais podem ser adicionados ao longo do tempo.

CreateGraphQLApiRequest

Objeto

Criar conteúdo de solicitação da API para GraphQL.

Nome	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 de exibição deve seguir regras de nomenclatura de acordo com o tipo de item.
folderId	string (uuid)	A ID da pasta. Se não for especificado ou nulo, a API para GraphQL será criada com o workspace como sua pasta.

ErrorRelatedResource

Objeto

O objeto de detalhes do recurso relacionado ao erro.

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

ErrorResponse

Objeto

A resposta de erro.

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

ErrorResponseDetails

Objeto

Os detalhes da resposta de erro.

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

GraphQLApi

Objeto

Um item de API para GraphQL.

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

GraphQLApiPublicDefinition

Objeto

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

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

GraphQLApiPublicDefinitionPart

Objeto

Objeto de parte de definição da API para GraphQL.

Nome	Tipo	Description
path	string	O caminho da parte de definição da API para GraphQL.
payload	string	O conteúdo da parte de definição da API para GraphQL.
payloadType	PayloadType	O tipo de conteúdo.

ItemTag

Objeto

Representa uma marca aplicada em um item.

Nome	Tipo	Description
displayName	string	O nome da marca.
id	string (uuid)	A ID da marca.

ItemType

Enumeração

O tipo do item. Tipos de item 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 bloco de anotações.
SparkJobDefinition	Uma definição de trabalho do Spark.
MLExperiment	Um experimento de aprendizado de máquina.
MLModel	Um modelo de machine learning.
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	Um item de API para GraphQL.
MountedDataFactory	Um MountedDataFactory.
SQLDatabase	Um SQLDatabase.
CopyJob	Um trabalho de cópia.
VariableLibrary	Um VariableLibrary.
Dataflow	Um fluxo de dados.
ApacheAirflowJob	Um ApacheAirflowJob.
WarehouseSnapshot	Um instantâneo do Warehouse.
DigitalTwinBuilder	Um DigitalTwinBuilder.
DigitalTwinBuilderFlow	Um fluxo do Construtor de Gêmeos Digitais.
MirroredAzureDatabricksCatalog	Um catálogo espelhado do Azure Databricks.
Map	Um mapa.
AnomalyDetector	Um Detector de Anomalias.
UserDataFunction	Uma função de dados do usuário.
GraphModel	Um GraphModel.
GraphQuerySet	Um Graph QuerySet.
SnowflakeDatabase	Um Banco de Dados Snowflake para armazenar tabelas iceberg criadas a partir da conta snowflake.
OperationsAgent	Um OperationsAgent.
CosmosDBDatabase	Um banco de dados do Cosmos DB.

PayloadType

Enumeração

O tipo da carga da parte de definição. Tipos de conteúdo adicionais podem ser adicionados ao longo do tempo.

Valor	Description
InlineBase64	Base 64 embutida.

Compartilhar via

Items - Create GraphQLApi

Permissões

Escopos delegados necessários

Limitações

Identidades com suporte do Microsoft Entra

Interfase

Parâmetros de URI

Corpo da solicitação

Respostas

Exemplos

Create a API for GraphQL example

Solicitação de exemplo

Resposta de exemplo

Create a GraphQLApi with public definition example

Solicitação de exemplo

Resposta de exemplo

Definições

CreateGraphQLApiRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GraphQLApi

GraphQLApiPublicDefinition

GraphQLApiPublicDefinitionPart

ItemTag

ItemType

PayloadType