Partilhar via

Items - Create Item

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

Cria um item no espaço de trabalho especificado.
Esta API é suportada para vários tipos de itens, localize os tipos de item suportados em Visão geral do gerenciamento de itens. Você pode usar API Obter definição de item para obter uma definição de item.

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

Permissões

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

Escopos delegados necessários

Para APIs de item, use estes tipos de escopo:

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

Para obter mais informações sobre escopos, consulte artigo Escopos.

Limitações

  • Para criar um item de malha que não seja do PowerBI, o espaço de trabalho deve estar em uma capacidade de malha suportada. 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 suportadas pelo Microsoft Entra

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

Identidade Suporte
Utilizador Sim
da entidade de serviço e identidades gerenciadas Quando o tipo de item na chamada é suportado. Verifique a API correspondente para o tipo de item que você está chamando para ver se sua chamada é suportada. Por exemplo, modelos semânticos são suportados.

Interface

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

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 do item. O nome para 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 creationPayload é suportada e lista as propriedades do item. Use creationPayload ou definition. Não é possível usar os dois ao mesmo tempo.
definition

ItemDefinition

A definição do item. A página Criar Item do tipo relevante indica se a definição é suportada e detalha sua estrutura. Use definition ou creationPayload. Não é possível usar os dois ao mesmo tempo.
description

string

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

Respostas

Name Tipo Description
201 Created

Item

Criado com sucesso
202 Accepted

Pedido aceite, fornecimento de itens em curso

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á é usado.

  • CorruptedPayload - A carga fornecida está corrompida

Exemplos

Create an item example

Pedido de amostra

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

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

Resposta da amostra

Código de estado:
201 
{
  "displayName": "Item 1",
  "description": "",
  "type": "Lakehouse",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}
Código de estado:
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

Name Description
CreateItemRequest

Crie carga útil 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 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.

CreateItemRequest

Object

Crie carga útil de solicitação de item.

Name Tipo Description
creationPayload

object

Um conjunto de propriedades usadas para criar o item. A página Criar Item do tipo relevante indica se creationPayload é suportada e lista as propriedades do item. Use creationPayload ou definition. Não é possível usar os dois ao mesmo tempo.
definition

ItemDefinition

A definição do item. A página Criar Item do tipo relevante indica se a definição é suportada e detalha sua estrutura. Use definition ou creationPayload. Não é possível usar os dois 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 para exibição deve seguir regras de nomenclatura de acordo com o tipo de item.
type

ItemType

O tipo de item.

ErrorRelatedResource

Object

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

Object

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

ID da solicitação associada ao erro.

ErrorResponseDetails

Object

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.

Item

Object

Um objeto de item.

Name Tipo Description
description

string

A descrição do item.
displayName

string

O nome de exibição do item.
id

string

uuid

O ID do item.
type

ItemType

O tipo de item.
workspaceId

string

uuid

O ID do espaço de trabalho.

ItemDefinition

Object

Um objeto de definição de item.

Name Tipo Description
format

string

O formato da definição do item.
parts

ItemDefinitionPart[]

Uma lista de partes de definição.

ItemDefinitionPart

Object

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

Name Tipo Description
path

string

O caminho da parte do item.
payload

string

A carga útil da parte do item.
payloadType

PayloadType

O tipo de carga útil.

ItemType

Enumeração

O tipo do item. Tipos de itens 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

Uma API para o item GraphQL.
KQLDashboard

Um painel KQL.
KQLDatabase

Um banco de dados KQL.
KQLQueryset

Um conjunto de consultas KQL.
Lakehouse

Uma casa no lago.
MLExperiment

Uma experiência de aprendizagem automática.
MLModel

Um modelo de aprendizagem automática.
MirroredDatabase

Um banco de dados espelhado.
MirroredWarehouse

Um armazém espelhado.
MountedDataFactory

Um MountedDataFactory.
Notebook

Um caderno.
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 de faísca.
Warehouse

Um armazém.

PayloadType

Enumeração

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.