Compartilhar via


Items - Update Graph Model Definition

Substitui a definição do GraphModel especificado.

Observação

O item GraphModel está atualmente em versão prévia (saiba mais).

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

Atualizar a definição do GraphModel não afeta seu rótulo de confidencialidade.

Permissions

O chamador deve ter permissões de leitura e gravação para o GraphModel.

Escopos delegados necessários

Item.ReadWrite.All

Microsoft Entra identidades com suporte

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

Identidade Support
Utilizador Yes
Entidade de serviço e identidades gerenciadas Yes

Interfase

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/graphModels/{graphModelId}/updateDefinition
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/graphModels/{graphModelId}/updateDefinition?updateMetadata={updateMetadata}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
graphModelId
path True

string (uuid)

A ID do GraphModel.

workspaceId
path True

string (uuid)

O identificador do espaço de trabalho.

updateMetadata
query

boolean

Quando definido como true e o arquivo .platform é fornecido como parte da definição, os metadados do item são atualizados usando os metadados no arquivo .platform

Corpo da solicitação

Nome Obrigatório Tipo Description
definition True

GraphModelPublicDefinition

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

Respostas

Nome Tipo Description
200 OK

Solicitação concluída com êxito.

202 Accepted

Solicitação aceita. A definição de atualização está em andamento.

Cabeçalhos

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

ErrorResponse

O limite de taxa de serviço foi excedido. O servidor retorna um Retry-After cabeçalho indicando, em segundos, quanto tempo o cliente deve aguardar antes de enviar solicitações adicionais.

Cabeçalhos

Retry-After: integer

Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • OperationNotSupportedForItem – Operação sem suporte para o item solicitado.

  • CorruptedPayload – O conteúdo fornecido está corrompido.

Exemplos

Update a GraphModel public definition example

Solicitação de exemplo

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/graphModels/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

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

Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

Definições

Nome Description
ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.

ErrorResponse

A resposta de erro.

ErrorResponseDetails

Os detalhes da resposta de erro.

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 do GraphModel.

GraphModelPublicDefinitionPart

Objeto de parte de definição GraphModel.

PayloadType

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

UpdateGraphModelDefinitionRequest

Atualizar o conteúdo da solicitação de definição pública do GraphModel.

ErrorRelatedResource

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

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

ID da solicitação associada ao erro.

ErrorResponseDetails

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.

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, especificamente projetada para dar suporte a cenários de CI/CD no Fabric.

GraphModelPublicDefinition

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

Nome 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.

Nome Tipo Description
path

string

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

payload

string

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

payloadType

PayloadType

O tipo de conteúdo.

PayloadType

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.

UpdateGraphModelDefinitionRequest

Atualizar o conteúdo da solicitação de definição pública do GraphModel.

Nome Tipo Description
definition

GraphModelPublicDefinition

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