Items - Get Item

Referência

Serviço:: Admin

Versão da API:: v1

Observação

Esta API está em pré-visualização.

Retorna o item de malha ou PowerBI especificado.

Permissões

O chamador deve ser um administrador de malha ou autenticar usando uma entidade de serviço.

Escopos delegados necessários

Tenant.Read.All ou Tenant.ReadWrite.All

Limitações

Máximo de 200 pedidos por hora.

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	Sim

Interface

GET https://api.fabric.microsoft.com/v1/admin/workspaces/{workspaceId}/items/{itemId}

Com parâmetros opcionais:

GET https://api.fabric.microsoft.com/v1/admin/workspaces/{workspaceId}/items/{itemId}?type={type}

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
itemId	path	True	string uuid	O ID do item
workspaceId	path	True	string uuid	O ID do espaço de trabalho.
type	query		string	O tipo do item. Ao consultar os seguintes tipos, esse parâmetro é necessário: Relatório Painel de instrumentos Modelo Semântico Aplicação Fluxo de dados

Name

Necessário

Tipo

Description

itemId

path

True

string

uuid

O ID do item

workspaceId

path

True

string

uuid

O ID do espaço de trabalho.

type

query

string

O tipo do item. Ao consultar os seguintes tipos, esse parâmetro é necessário:

Relatório
Painel de instrumentos
Modelo Semântico
Aplicação
Fluxo de dados

Respostas

Name	Tipo	Description
200 OK	Item	OK
Other Status Codes	ErrorResponse	Códigos de erro comuns: ItemNotFound - ID do item não existe. InvalidItemType - O tipo de item não é válido.

Name

Tipo

Description

200 OK

Item

Other Status Codes

ErrorResponse

Códigos de erro comuns:

ItemNotFound - ID do item não existe.
InvalidItemType - O tipo de item não é válido.

Exemplos

Get item details by ID and type example

Get item details by ID example

Get item details by ID and type example

Pedido de amostra

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces/7f4496db-9929-47bd-89c0-d7eb2f517a98/items/f089354e-8366-4e18-aea3-4cb4a3a50b48?type=Report

Resposta da amostra

Código de estado:: 200

{
  "id": "17d8929d-ab32-46d1-858b-fdea74e93bf2",
  "type": "Report",
  "name": "Test",
  "description": "Test Jacob's Report,",
  "state": "Active",
  "lastUpdatedDate": "2022-04-29T17:47:29.98673",
  "workspaceId": "7f4496db-9929-47bd-89c0-d7eb2f517a98",
  "capacityId": "D5E336D6-D919-4ECC-B424-1F771A506851",
  "creatorPrincipal": {
    "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
    "displayName": "Jacob Hancock",
    "type": "User",
    "userDetails": {
      "userPrincipalName": "Jacob@example.com"
    }
  }
}

Get item details by ID example

Pedido de amostra

HTTP

GET https://api.fabric.microsoft.com/v1/admin/workspaces/7f4496db-9929-47bd-89c0-d7eb2f517a98/items/f089354e-8366-4e18-aea3-4cb4a3a50b48

Resposta da amostra

Código de estado:: 200

{
  "id": "17d8929d-ab32-46d1-858b-fdea74e93bf2",
  "type": "Kusto",
  "name": "Test",
  "description": "Test Jacob's notebook.",
  "state": "Active",
  "lastUpdatedDate": "2022-04-29T17:47:29.98673",
  "workspaceId": "7f4496db-9929-47bd-89c0-d7eb2f517a98",
  "capacityId": "D5E336D6-D919-4ECC-B424-1F771A506851",
  "creatorPrincipal": {
    "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
    "displayName": "Jacob Hancock",
    "type": "User",
    "userDetails": {
      "userPrincipalName": "Jacob@example.com"
    }
  }
}

Definições

Name	Description
ErrorRelatedResource	O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
GroupDetails	Detalhes específicos do grupo. Aplicável quando o tipo principal é `Group`.
GroupType	O tipo do grupo. Tipos de grupo adicionais podem ser adicionados ao longo do tempo.
Item	Detalhes do item.
ItemState	O estado do item. Estados de itens adicionais podem ser adicionados ao longo do tempo.
ItemType	O tipo do item. Tipos de itens adicionais podem ser adicionados ao longo do tempo.
Principal	Representa uma identidade ou um grupo do Microsoft Entra.
PrincipalType	O tipo do principal. Ao longo do tempo, podem ser acrescentados tipos principais adicionais.
ServicePrincipalDetails	Detalhes específicos da entidade de serviço. Aplicável quando o tipo principal é `ServicePrincipal`.
ServicePrincipalProfileDetails	Detalhes do perfil da entidade de serviço. Aplicável quando o tipo principal é `ServicePrincipalProfile`.
UserDetails	Detalhes específicos principais do usuário. Aplicável quando o tipo principal é `User`.

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.

GroupDetails

Object

Detalhes específicos do grupo. Aplicável quando o tipo principal é Group.

Name	Tipo	Description
groupType	GroupType	O tipo do grupo. Tipos de grupo adicionais podem ser adicionados ao longo do tempo.

GroupType

Enumeração

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

Valor	Description
DistributionList	Principal é uma lista de distribuição.
SecurityGroup	Principal é um grupo de segurança.
Unknown	O tipo de grupo principal é desconhecido.

Item

Object

Detalhes do item.

Name	Tipo	Description
capacityId	string uuid	O ID de capacidade do espaço de trabalho.
creatorPrincipal	Principal	O proprietário do item.
description	string	Detalhes do item, incluindo o tipo de item e o uso do item.
id	string uuid	O ID do item.
lastUpdatedDate	string date-time	A data e hora da última atualização.
name	string	O nome do item.
state	ItemState	O status do item.
type	ItemType	O tipo de item. Inclui valores como Synapse, Notebook, Kqldatabase e SynapseWorkbook.
workspaceId	string uuid	A ID do espaço de trabalho do item.

ItemState

Enumeração

O estado do item. Estados de itens adicionais podem ser adicionados ao longo do tempo.

Valor	Description
Active	Um item ativo.

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.

Principal

Object

Representa uma identidade ou um grupo do Microsoft Entra.

Name	Tipo	Description
displayName	string	O nome de exibição da entidade de segurança.
groupDetails	GroupDetails	Detalhes específicos do grupo. Aplicável quando o tipo principal é `Group`.
id	string uuid	O ID da entidade de segurança.
servicePrincipalDetails	ServicePrincipalDetails	Detalhes específicos da entidade de serviço. Aplicável quando o tipo principal é `ServicePrincipal`.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Detalhes do perfil da entidade de serviço. Aplicável quando o tipo principal é `ServicePrincipalProfile`.
type	PrincipalType	O tipo do principal. Ao longo do tempo, podem ser acrescentados tipos principais adicionais.
userDetails	UserDetails	Detalhes específicos principais do usuário. Aplicável quando o tipo principal é `User`.

PrincipalType

Enumeração

O tipo do principal. Ao longo do tempo, podem ser acrescentados tipos principais adicionais.

Valor	Description
Group	Principal é um grupo de segurança.
ServicePrincipal	Principal é uma entidade de serviço do Microsoft Entra.
ServicePrincipalProfile	Principal é um perfil de entidade de serviço.
User	Principal é uma entidade de usuário do Microsoft Entra.

ServicePrincipalDetails

Object

Detalhes específicos da entidade de serviço. Aplicável quando o tipo principal é ServicePrincipal.

Name	Tipo	Description
aadAppId	string uuid	O Microsoft Entra AppId da entidade de serviço.

ServicePrincipalProfileDetails

Object

Detalhes do perfil da entidade de serviço. Aplicável quando o tipo principal é ServicePrincipalProfile.

Name	Tipo	Description
parentPrincipal	Principal	A entidade principal do perfil da entidade de serviço.

UserDetails

Object

Detalhes específicos principais do usuário. Aplicável quando o tipo principal é User.

Name	Tipo	Description
userPrincipalName	string	O nome principal do usuário.

Partilhar via

Items - Get Item

Permissões

Escopos delegados necessários

Limitações

Identidades suportadas pelo Microsoft Entra

Interface

Parâmetros do URI

Respostas

Exemplos

Get item details by ID and type example

Pedido de amostra

Resposta da amostra

Get item details by ID example

Pedido de amostra

Resposta da amostra

Definições

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupType

Item

ItemState

ItemType

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails

Recursos adicionais