Compartir a través de


Items - Create Graph Model

Crea un GraphModel en el área de trabajo especificada.

Nota:

El elemento GraphModel se encuentra actualmente en versión preliminar (más información).

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

Para crear GraphModel con una definición pública, consulte el artículo GraphModel .

Permissions

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

Ámbitos delegados necesarios

Item.ReadWrite.All

Limitaciones

Identidades admitidas de Microsoft Entra

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

identidad Support
Usuario
Entidad de servicio e Identidades administradas No

Interfaz

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
workspaceId
path True

string (uuid)

El identificador del área de trabajo.

Cuerpo de la solicitud

Nombre Requerido Tipo Description
displayName True

string

Nombre para mostrar de GraphModel. El nombre para mostrar debe seguir las reglas de nomenclatura según el tipo de elemento.

definition

GraphModelPublicDefinition

Definición pública de GraphModel.

description

string

Descripción de GraphModel. La longitud máxima es de 256 caracteres.

folderId

string (uuid)

Identificador de carpeta. Si no se especifica o null, GraphModel se crea con el área de trabajo como carpeta.

Respuestas

Nombre Tipo Description
201 Created

GraphModel

Creado correctamente

202 Accepted

Solicitud aceptada, aprovisionamiento de GraphModel en curso.

Encabezados

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
429 Too Many Requests

ErrorResponse

Se superó el límite de frecuencia de servicio. El servidor devuelve un Retry-After encabezado que indica, en segundos, cuánto tiempo debe esperar el cliente antes de enviar solicitudes adicionales.

Encabezados

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 GraphModel example
Create a GraphModel with public definition example

Create a GraphModel example

Solicitud de ejemplo

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

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

Respuesta de muestra

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

Solicitud de ejemplo

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

Respuesta de muestra

{
  "displayName": "GraphModel 1",
  "description": "A GraphModel description.",
  "type": "GraphModel",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}
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
CreateGraphModelRequest

Cree una carga de solicitud de GraphModel.

ErrorRelatedResource

Objeto de detalles del recurso relacionado con el error.

ErrorResponse

Respuesta de error.

ErrorResponseDetails

Detalles de la respuesta de error.

GraphModel

Objeto GraphModel.

GraphModelDefinitionFormat

Formato de la definición de elemento. Se pueden agregar tipos de format adicionales a lo largo del tiempo.

GraphModelPublicDefinition

Objeto de definición pública de GraphModel. Consulte este artículo para obtener más información sobre cómo crear una definición pública de GraphModel.

GraphModelPublicDefinitionPart

Objeto de parte de definición de GraphModel.

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.

CreateGraphModelRequest

Cree una carga de solicitud de GraphModel.

Nombre Tipo Description
definition

GraphModelPublicDefinition

Definición pública de GraphModel.

description

string

Descripción de GraphModel. La longitud máxima es de 256 caracteres.

displayName

string

Nombre para mostrar de GraphModel. 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, GraphModel se crea con el área de trabajo como carpeta.

ErrorRelatedResource

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

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 (uuid)

Identificador de la solicitud asociada al error.

ErrorResponseDetails

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.

GraphModel

Objeto GraphModel.

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)

El identificador del área de trabajo.

GraphModelDefinitionFormat

Formato de la definición de elemento. Se pueden agregar tipos de format adicionales a lo largo del tiempo.

Valor Description
json

Formato JSON para la definición pública de GraphModel, diseñado específicamente para admitir escenarios de CI/CD en Fabric.

GraphModelPublicDefinition

Objeto de definición pública de GraphModel. Consulte este artículo para obtener más información sobre cómo crear una definición pública de GraphModel.

Nombre Tipo Description
format

GraphModelDefinitionFormat

Formato de la definición de elemento. Se pueden agregar tipos de format adicionales a lo largo del tiempo.

parts

GraphModelPublicDefinitionPart[]

Lista de elementos de definición.

GraphModelPublicDefinitionPart

Objeto de parte de definición de GraphModel.

Nombre Tipo Description
path

string

Ruta de acceso de elemento de definición pública de GraphModel.

payload

string

Carga del elemento de definición pública de GraphModel.

payloadType

PayloadType

Tipo de carga útil.

ItemTag

Representa una etiqueta aplicada en un elemento.

Nombre Tipo Description
displayName

string

Nombre de la etiqueta.

id

string (uuid)

Identificador de etiqueta.

ItemType

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.

Ontology

Una ontología.

EventSchemaSet

An EventSchemaSet.

DataAgent

A DataAgent.

PayloadType

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.