Compartilhar via

Items - Create Item

  • Referência
Serviço:
Core
Versão da API:
v1

Cria um item no workspace especificado.
Essa API tem suporte para vários tipos de item, localize os tipos de item com suporte Visão geral do gerenciamento de itens. Você pode usar Obter de API de definição de item para obter uma definição de item.

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

Permissões

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

Escopos delegados necessários

Para APIs de item, use estes tipos de escopo:

  • Escopo genérico: Item.ReadWrite.All
  • Escopo específico: itemType. ReadWrite.All (por exemplo: Notebook.ReadWrite.All)

para obter mais informações sobre escopos, consulte artigo de escopos.

Limitações

  • Para criar um item que não seja do PowerBI Fabric, o workspace deve estar em uma capacidade do Fabric com suporte. Para obter mais informações, consulte tipos de licença do Microsoft Fabric.
  • Para criar um item do PowerBI, o usuário deve ter a licença apropriada. Para obter mais informações, consulte tipos de licença do Microsoft Fabric.
  • Ao criar um item, use creationPayload ou definition, mas não use ambos ao mesmo tempo.

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 Quando há suporte para o tipo de item na chamada. Verifique a API correspondente para o tipo de item que você está chamando para ver se a chamada tem suporte. Por exemplo, há suporte para modelos semânticos.

Interface

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

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

ItemType

O tipo de item.
creationPayload

object

Um conjunto de propriedades usadas para criar o item. A página Criar Item do tipo relevante indica se há suporte para creationPayload e lista as propriedades do item. Use creationPayload ou definition. Você não pode usar ambos ao mesmo tempo.
definition

ItemDefinition

A definição do item. A página Criar Item do tipo relevante indica se a definição tem suporte e detalha sua estrutura. Use definition ou creationPayload. Você não pode usar ambos ao mesmo tempo.
description

string

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

Respostas

Nome Tipo Description
201 Created

Item

Criado com êxito
202 Accepted

Solicitação aceita, provisionamento de item 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

Exemplos

Create an item example

Solicitação de exemplo

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

{
  "displayName": "Item 1",
  "type": "Lakehouse"
}

Resposta de exemplo

Código de status:
201 
{
  "displayName": "Item 1",
  "description": "",
  "type": "Lakehouse",
  "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
CreateItemRequest

Criar conteúdo de solicitação de item.
ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.
Item

Um objeto de item.
ItemDefinition

Um objeto de definição de item.
ItemDefinitionPart

Um objeto de parte de definição de 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.

CreateItemRequest

Objeto

Criar conteúdo de solicitação de item.

Nome Tipo Description
creationPayload

object

Um conjunto de propriedades usadas para criar o item. A página Criar Item do tipo relevante indica se há suporte para creationPayload e lista as propriedades do item. Use creationPayload ou definition. Você não pode usar ambos ao mesmo tempo.
definition

ItemDefinition

A definição do item. A página Criar Item do tipo relevante indica se a definição tem suporte e detalha sua estrutura. Use definition ou creationPayload. Você não pode usar ambos ao mesmo tempo.
description

string

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

string

O nome de exibição do item. O nome de exibição deve seguir regras de nomenclatura de acordo com o tipo de item.
type

ItemType

O tipo de item.

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.

Item

Objeto

Um objeto de item.

Nome Tipo Description
description

string

A descrição do item.
displayName

string

O nome de exibição do item.
id

string

uuid

A ID do item.
type

ItemType

O tipo de item.
workspaceId

string

uuid

A ID do workspace.

ItemDefinition

Objeto

Um objeto de definição de item.

Nome Tipo Description
format

string

O formato da definição do item.
parts

ItemDefinitionPart[]

Uma lista de partes de definição.

ItemDefinitionPart

Objeto

Um objeto de parte de definição de item.

Nome Tipo Description
path

string

O caminho da parte do item.
payload

string

O conteúdo da parte do item.
payloadType

PayloadType

O tipo de conteúdo.

ItemType

Enumeração

O tipo do item. Tipos de item adicionais podem ser adicionados ao longo do tempo.

Valor Description
Dashboard

Painel do PowerBI.
DataPipeline

Um pipeline de dados.
Datamart

Datamart do PowerBI.
Environment

Um ambiente.
Eventhouse

Uma casa de eventos.
Eventstream

Um fluxo de eventos.
GraphQLApi

Um item de API para GraphQL.
KQLDashboard

Um painel KQL.
KQLDatabase

Um banco de dados KQL.
KQLQueryset

Um conjunto de consultas KQL.
Lakehouse

Uma casa no lago.
MLExperiment

Um experimento de aprendizado de máquina.
MLModel

Um modelo de machine learning.
MirroredDatabase

Um banco de dados espelhado.
MirroredWarehouse

Um armazém espelhado.
MountedDataFactory

Um MountedDataFactory.
Notebook

Um bloco de anotações.
PaginatedReport

Relatório paginado do PowerBI.
Reflex

Um Reflexo.
Report

Relatório do PowerBI.
SQLDatabase

Um SQLDatabase.
SQLEndpoint

Um ponto de extremidade SQL.
SemanticModel

Modelo semântico do PowerBI.
SparkJobDefinition

Uma definição de trabalho do Spark.
Warehouse

Um armazém.

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.