Items - Create GraphQLApi

Servicio:: GraphQLApi

Versión de la API:: v1

Crea una API para el elemento GraphQL en el área de trabajo especificada.

Esta API admite operaciones de larga duración (LRO).

Para crear un elemento de GraphQLApi con una definición pública, consulte Definición de GraphQLApi.

Permisos

El autor de la llamada debe tener un rol de área de trabajo colaborador .

Ámbitos delegados necesarios

GraphQLApi.ReadWrite.All o Item.ReadWrite.All

Limitaciones

Para crear un GraphQLApi, el área de trabajo debe estar en una capacidad de Fabric compatible. Para obtener más información, consulte: tipos de licencia de Microsoft Fabric.

Identidades admitidas de Microsoft Entra

Esta API admite las identidades de Microsoft enumeradas en esta sección.

Identidad	Apoyo
Usuario	Sí
de entidad de servicio y identidades administradas	Sí

Interfaz

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
workspaceId	path	True	string (uuid)	Identificador del área de trabajo.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
displayName	True	string	El nombre para mostrar de la API para GraphQL. El nombre para mostrar debe seguir las reglas de nomenclatura según el tipo de elemento.
definition		GraphQLApiPublicDefinition	La API para la definición pública de GraphQL.
description		string	Descripción de la API para GraphQL. La longitud máxima es de 256 caracteres.
folderId		string (uuid)	Identificador de carpeta. Si no se especifica o null, la API para GraphQL se crea con el área de trabajo como carpeta.

Respuestas

Nombre	Tipo	Description
201 Created	GraphQLApi	Creado correctamente
202 Accepted		Solicitud aceptada, aprovisionamiento de GraphQLApi en curso. Encabezados Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Códigos de error comunes: InvalidItemType: el tipo de elemento no es válido ItemDisplayNameAlreadyInUse: ya se usa el nombre para mostrar del elemento. CorruptedPayload: la carga proporcionada está dañada. WorkspaceItemsLimitExceeded: se superó el límite de elementos del área de trabajo.

Nombre

Tipo

Description

201 Created

GraphQLApi

Creado correctamente

202 Accepted

Solicitud aceptada, aprovisionamiento de GraphQLApi en curso.

Encabezados

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

Other Status Codes

ErrorResponse

Códigos de error comunes:

InvalidItemType: el tipo de elemento no es válido
ItemDisplayNameAlreadyInUse: ya se usa el nombre para mostrar del elemento.
CorruptedPayload: la carga proporcionada está dañada.
WorkspaceItemsLimitExceeded: se superó el límite de elementos del área de trabajo.

Ejemplos

Create a API for GraphQL example

Create a GraphQLApi with public definition example

Create a API for GraphQL example

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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"
}

status code:: 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

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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"
}

status code:: 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

Definiciones

Nombre	Description
CreateGraphQLApiRequest	Cree la API para la carga de solicitud de GraphQL.
ErrorRelatedResource	Objeto de detalles del recurso relacionado con el error.
ErrorResponse	Respuesta de error.
ErrorResponseDetails	Detalles de la respuesta de error.
GraphQLApi	Una API para el elemento GraphQL.
GraphQLApiPublicDefinition	API para el objeto de definición pública de GraphQL. Para crear la definición, consulte Definición de GraphQLApi.
GraphQLApiPublicDefinitionPart	API para el objeto de elemento de definición de GraphQL.
ItemTag	Representa una etiqueta aplicada en un elemento.
ItemType	Tipo del elemento. Se pueden agregar tipos de elementos adicionales a lo largo del tiempo.
PayloadType	Tipo de la carga de la parte de definición. Se pueden agregar tipos de carga adicionales a lo largo del tiempo.

CreateGraphQLApiRequest

Objeto

Cree la API para la carga de solicitud de GraphQL.

Nombre	Tipo	Description
definition	GraphQLApiPublicDefinition	La API para la definición pública de GraphQL.
description	string	Descripción de la API para GraphQL. La longitud máxima es de 256 caracteres.
displayName	string	El nombre para mostrar de la API para GraphQL. El nombre para mostrar debe seguir las reglas de nomenclatura según el tipo de elemento.
folderId	string (uuid)	Identificador de carpeta. Si no se especifica o null, la API para GraphQL se crea con el área de trabajo como carpeta.

ErrorRelatedResource

Objeto

Objeto de detalles del recurso relacionado con el error.

Nombre	Tipo	Description
resourceId	string	Identificador de recurso implicado en el error.
resourceType	string	Tipo del recurso implicado en el error.

ErrorResponse

Objeto

Respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message	string	Representación legible del error.
moreDetails	ErrorResponseDetails[]	Lista de detalles de error adicionales.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.
requestId	string	Identificador de la solicitud asociada al error.

ErrorResponseDetails

Objeto

Detalles de la respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message	string	Representación legible del error.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.

GraphQLApi

Objeto

Una API para el elemento GraphQL.

Nombre	Tipo	Description
description	string	Descripción del elemento.
displayName	string	Nombre para mostrar del elemento.
folderId	string (uuid)	Identificador de carpeta.
id	string (uuid)	Identificador del elemento.
tags	ItemTag[]	Lista de etiquetas aplicadas.
type	ItemType	Tipo de elemento.
workspaceId	string (uuid)	Identificador del área de trabajo.

GraphQLApiPublicDefinition

Objeto

API para el objeto de definición pública de GraphQL. Para crear la definición, consulte Definición de GraphQLApi.

Nombre	Tipo	Description
format	string	Formato de la definición de elemento.
parts	GraphQLApiPublicDefinitionPart[]	Lista de elementos de definición.

GraphQLApiPublicDefinitionPart

Objeto

API para el objeto de elemento de definición de GraphQL.

Nombre	Tipo	Description
path	string	Ruta de acceso del elemento de definición de API para GraphQL.
payload	string	La api para la carga del elemento de definición de GraphQL.
payloadType	PayloadType	Tipo de carga.

ItemTag

Objeto

Representa una etiqueta aplicada en un elemento.

Nombre	Tipo	Description
displayName	string	Nombre de la etiqueta.
id	string (uuid)	Identificador de etiqueta.

ItemType

Enumeración

Tipo del elemento. Se pueden agregar tipos de elementos adicionales a lo largo del tiempo.

Valor	Description
Dashboard	Panel de PowerBI.
Report	Informe de PowerBI.
SemanticModel	Modelo semántico de PowerBI.
PaginatedReport	Informe paginado de PowerBI.
Datamart	Datamart de PowerBI.
Lakehouse	Una casa de lago.
Eventhouse	Un centro de eventos.
Environment	Un entorno.
KQLDatabase	Una base de datos KQL.
KQLQueryset	Un conjunto de consultas KQL.
KQLDashboard	Un panel de KQL.
DataPipeline	Una canalización de datos.
Notebook	Un cuaderno.
SparkJobDefinition	Una definición de trabajo de Spark.
MLExperiment	Un experimento de aprendizaje automático.
MLModel	Un modelo de aprendizaje automático.
Warehouse	Un almacén.
Eventstream	Una secuencia de eventos.
SQLEndpoint	Un punto de conexión de SQL.
MirroredWarehouse	Un almacén reflejado.
MirroredDatabase	Una base de datos reflejada.
Reflex	Un reflejo.
GraphQLApi	Una API para el elemento GraphQL.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	A SQLDatabase.
CopyJob	Un trabajo de copia.
VariableLibrary	A VariableLibrary.
Dataflow	Flujo de datos.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Una instantánea de almacenamiento.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Un flujo de Digital Twin Builder.
MirroredAzureDatabricksCatalog	Un catálogo de Azure Databricks reflejado.
Map	Un mapa.
AnomalyDetector	An Anomaly Detector.
UserDataFunction	Una función de datos de usuario.
GraphModel	Un GraphModel.
GraphQuerySet	Un conjunto de consultas de Graph.
SnowflakeDatabase	Una base de datos de Snowflake para almacenar tablas de Cosmos creadas a partir de la cuenta de Snowflake.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	Una base de datos de Cosmos DB.

PayloadType

Enumeración

Tipo de la carga de la parte de definición. Se pueden agregar tipos de carga adicionales a lo largo del tiempo.

Valor	Description
InlineBase64	Base 64 insertada.

Compartir a través de

Items - Create GraphQLApi

Permisos

Ámbitos delegados necesarios

Limitaciones

Identidades admitidas de Microsoft Entra

Interfaz

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Ejemplos

Create a API for GraphQL example

Solicitud de ejemplo

Respuesta de muestra

Create a GraphQLApi with public definition example

Solicitud de ejemplo

Respuesta de muestra

Definiciones

CreateGraphQLApiRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GraphQLApi

GraphQLApiPublicDefinition

GraphQLApiPublicDefinitionPart

ItemTag

ItemType

PayloadType