Partilhar via


Items - Create Graph Model

Cria um GraphModel no espaço de trabalho especificado.

Observação

O item GraphModel está atualmente em Pré-visualização (saiba mais).

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

Para criar GraphModel com uma definição pública, consulte o artigo GraphModel .

Permissions

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

Escopos delegados necessários

Item.ReadWrite.All

Limitações

Identidades suportadas pela Microsoft Entra

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

Identidade Support
User Yes
Entidade de serviço e identidades geridas Yes

Interfaz

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

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 GraphModel. O nome para exibição deve seguir regras de nomenclatura de acordo com o tipo de item.

definition

GraphModelPublicDefinition

A definição pública do GraphModel.

description

string

A descrição do GraphModel. O comprimento máximo é de 256 caracteres.

folderId

string (uuid)

O ID da pasta. Se não especificado ou nulo, o GraphModel é criado com o espaço de trabalho como sua pasta.

sensitivityLabelSettings

SensitivityLabelSettings

As definições de etiquetas de sensibilidade para o GraphModel.

Respostas

Name Tipo Description
201 Created

GraphModel

Criado com sucesso

202 Accepted

Pedido aceite, provisionamento GraphModel em curso.

Cabeçalhos

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

ErrorResponse

O limite de tarifa de serviço foi ultrapassado. O servidor devolve um Retry-After cabeçalho que indica, em segundos, quanto tempo o cliente deve esperar antes de enviar pedidos adicionais.

Cabeçalhos

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

Create a GraphModel example

Pedido de amostra

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

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

Resposta da amostra

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

Pedido de amostra

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

Resposta da amostra

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

Crie a carga útil de solicitação do GraphModel.

ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.

ErrorResponse

A resposta de erro.

ErrorResponseDetails

Os detalhes da resposta de erro.

GraphModel

Um objeto GraphModel.

GraphModelDefinitionFormat

O formato da definição do item. Tipos de format adicionais podem ser adicionados ao longo do tempo.

GraphModelPublicDefinition

Objeto de definição pública GraphModel. Consulte este artigo para obter mais detalhes sobre como criar uma definição pública GraphModel.

GraphModelPublicDefinitionPart

Objeto de parte de definição GraphModel.

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.

SensitivityLabel

Representa uma etiqueta de sensibilidade aplicada a um item.

SensitivityLabelApplyStrategy

A estratégia para aplicar o rótulo de sensibilidade. O valor padrão é ApplyOrFail. Tipos adicionais podem ser adicionados ao longo do tempo.

SensitivityLabelSettings

As definições da etiqueta de sensibilidade.

CreateGraphModelRequest

Crie a carga útil de solicitação do GraphModel.

Name Tipo Description
definition

GraphModelPublicDefinition

A definição pública do GraphModel.

description

string

A descrição do GraphModel. O comprimento máximo é de 256 caracteres.

displayName

string

O nome de exibição GraphModel. 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, o GraphModel é criado com o espaço de trabalho como sua pasta.

sensitivityLabelSettings

SensitivityLabelSettings

As definições de etiquetas de sensibilidade para o GraphModel.

ErrorRelatedResource

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

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

ID da solicitação associada ao erro.

ErrorResponseDetails

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.

GraphModel

Um objeto GraphModel.

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.

sensitivityLabel

SensitivityLabel

A etiqueta de sensibilidade do item.

tags

ItemTag[]

Lista de tags aplicadas.

type

ItemType

O tipo de item.

workspaceId

string (uuid)

O ID do espaço de trabalho.

GraphModelDefinitionFormat

O formato da definição do item. Tipos de format adicionais podem ser adicionados ao longo do tempo.

Valor Description
json

Formato JSON para a definição pública GraphModel, projetado especificamente para suportar cenários de CI/CD na malha.

GraphModelPublicDefinition

Objeto de definição pública GraphModel. Consulte este artigo para obter mais detalhes sobre como criar uma definição pública GraphModel.

Name Tipo Description
format

GraphModelDefinitionFormat

O formato da definição do item. Tipos de format adicionais podem ser adicionados ao longo do tempo.

parts

GraphModelPublicDefinitionPart[]

Uma lista de partes de definição.

GraphModelPublicDefinitionPart

Objeto de parte de definição GraphModel.

Name Tipo Description
path

string

O caminho da parte de definição pública GraphModel.

payload

string

A carga útil da parte de definição pública do GraphModel.

payloadType

PayloadType

O tipo de carga útil.

ItemTag

Representa uma tag aplicada em um item.

Name Tipo Description
displayName

string

O nome da tag.

id

string (uuid)

O ID da tag.

ItemType

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.

EventSchemaSet

Um EventoSchemaSet.

DataAgent

Um DataAgent.

PayloadType

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.

SensitivityLabel

Representa uma etiqueta de sensibilidade aplicada a um item.

Name Tipo Description
id

string (uuid)

O ID da etiqueta de sensibilidade.

SensitivityLabelApplyStrategy

A estratégia para aplicar o rótulo de sensibilidade. O valor padrão é ApplyOrFail. Tipos adicionais podem ser adicionados ao longo do tempo.

Valor Description
ApplyOrFail

Aplique o rótulo de sensibilidade ou falhe a operação se não puder ser aplicada.

Ignore

Ignore o rótulo de sensibilidade se não puder ser aplicado e prossiga com a operação sem aplicar o rótulo.

SensitivityLabelSettings

As definições da etiqueta de sensibilidade.

Name Tipo Description
labelId

string (uuid)

O ID da etiqueta de sensibilidade.

sensitivityLabelApplyStrategy

SensitivityLabelApplyStrategy

A estratégia para aplicar o rótulo de sensibilidade.