Items - Create Item

Serviço:: Core

Versão 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 uma função de espaço de trabalho de colaborador .

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.

Interfaz

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

Parâmetros URI

Nome	Em	Necessário	Tipo	Descrição
workspaceId	path	True	string (uuid)	O ID do espaço de trabalho.

Órgão do Pedido

Nome	Necessário	Tipo	Descrição
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.
folderId		string (uuid)	O ID da pasta. Se não especificado ou nulo, o item é criado com o espaço de trabalho como sua pasta.

Respostas

Nome	Tipo	Descrição
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. FolderNotFound - Não foi possível localizar a pasta solicitada. WorkspaceItemsLimitExceeded - Limite de itens do espaço de trabalho excedido.

Nome

Tipo

Descrição

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.
FolderNotFound - Não foi possível localizar a pasta solicitada.
WorkspaceItemsLimitExceeded - Limite de itens do espaço de trabalho excedido.

Exemplos

Create an item example

Create an item in folder example

Create an item example

Pedido de exemplo

HTTP

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

Create an item in folder example

Pedido de exemplo

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb/items

{
  "displayName": "Item 1",
  "type": "Lakehouse",
  "folderId": "bbbbbbbb-1111-2222-3333-cccccccccccc"
}

Resposta de exemplo

Código de estado:: 201

{
  "displayName": "Item 1",
  "description": "",
  "type": "Lakehouse",
  "folderId": "bbbbbbbb-1111-2222-3333-cccccccccccc",
  "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
  "id": "cccccccc-2222-3333-4444-dddddddddddd"
}

Código de estado:: 202

Location: https://api.fabric.microsoft.com/v1/operations/0000aaaa-11bb-cccc-dd22-eeeeee333333
x-ms-operation-id: 0000aaaa-11bb-cccc-dd22-eeeeee333333
Retry-After: 30

Definições

Nome	Descrição
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.
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.

CreateItemRequest

Objetivo

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

Nome	Tipo	Descrição
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.
folderId	string (uuid)	O ID da pasta. Se não especificado ou nulo, o item é criado com o espaço de trabalho como sua pasta.
type	ItemType	O tipo de item.

ErrorRelatedResource

Objetivo

O objeto de detalhes do recurso relacionado ao erro.

Nome	Tipo	Descrição
resourceId	string	A ID do recurso envolvida no erro.
resourceType	string	O tipo de recurso envolvido no erro.

ErrorResponse

Objetivo

A resposta de erro.

Nome	Tipo	Descrição
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

Objetivo

Os detalhes da resposta de erro.

Nome	Tipo	Descrição
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

Objetivo

Um objeto de item.

Nome	Tipo	Descrição
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.
tags	ItemTag[]	Lista de tags aplicadas.
type	ItemType	O tipo de item.
workspaceId	string (uuid)	O ID do espaço de trabalho.

ItemDefinition

Objetivo

Um objeto de definição de item.

Nome	Tipo	Descrição
format	string	O formato da definição do item.
parts	ItemDefinitionPart[]	Uma lista de partes de definição.

ItemDefinitionPart

Objetivo

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

Nome	Tipo	Descrição
path	string	O caminho da parte do item.
payload	string	A carga útil da parte do item.
payloadType	PayloadType	O tipo de carga útil.

ItemTag

Objetivo

Representa uma tag aplicada em um item.

Nome	Tipo	Descrição
displayName	string	O nome da tag.
id	string (uuid)	O ID da tag.

ItemType

Enumeração

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

Valor	Descrição
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.

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	Descrição
InlineBase64	Base em linha 64.

Partilhar via

Items - Create Item

Permissões

Escopos delegados necessários

Limitações

Identidades suportadas pelo Microsoft Entra

Interfaz

Parâmetros URI

Órgão do Pedido

Respostas

Exemplos

Create an item example

Pedido de exemplo

Resposta de exemplo

Create an item in folder example

Pedido de exemplo

Resposta de exemplo

Definições

CreateItemRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

Item

ItemDefinition

ItemDefinitionPart

ItemTag

ItemType

PayloadType