Items - List Items
Nota
Essa API está em versão prévia.
Retorna uma lista de itens ativos do Fabric e do PowerBI.
Essa API dá suporte a de paginação. Um máximo de 10.000 registros pode ser retornado por solicitação. Com o token contínuo fornecido na resposta, você pode obter os próximos 10.000 registros.
Ordem da página:
- Itens de malha
- Datamarts
- Relatórios
- Painéis
- SemanticModels
- Apps
- Fluxos de dados
Permissões
O chamador deve ser um administrador do Fabric 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 solicitações por hora.
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 | Sim |
Interface
GET https://api.fabric.microsoft.com/v1/admin/items
GET https://api.fabric.microsoft.com/v1/admin/items?workspaceId={workspaceId}&capacityId={capacityId}&state={state}&type={type}&continuationToken={continuationToken}
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
capacity
|
query |
string uuid |
A ID de capacidade do workspace. |
|
continuation
|
query |
string |
Token contínuo usado para obter os itens da próxima página. |
|
state
|
query |
string |
O estado do item. Os estados com suporte estão ativos. |
|
type
|
query |
string |
O tipo de item. |
|
workspace
|
query |
string uuid |
A ID do workspace. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
A operação foi bem-sucedida. |
|
Other Status Codes |
Códigos de erro comuns:
|
Exemplos
Get a list of items using type query parameter example |
Get all items in the tenant example |
Get list of datamarts using type query parameter example |
Get a list of items using type query parameter example
Solicitação de exemplo
GET https://api.fabric.microsoft.com/v1/admin/items?type=Report
Resposta de exemplo
{
"itemEntities": [
{
"id": "b1a7e572-2585-4650-98ae-b92356f4460b",
"type": "Report",
"name": "Test Report",
"state": "Active",
"lastUpdatedDate": "2022-06-27T16:55:04.893",
"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"
}
}
}
],
"continuationUri": null,
"continuationToken": null
}
Get all items in the tenant example
Solicitação de exemplo
GET https://api.fabric.microsoft.com/v1/admin/items
Resposta de exemplo
{
"itemEntities": [
{
"id": "17d8929d-ab32-46d1-858b-fdea74e93bff",
"type": "Notebook",
"name": "Test",
"description": "Test notebook.",
"state": "Active",
"lastUpdatedDate": "2022-04-29T17:47:29.98673",
"workspaceId": "7f4496db-9929-47bd-89c0-d7eb2f517a95",
"capacityId": "D5E336D6-D919-4ECC-B424-1F771A506851",
"creatorPrincipal": {
"id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
"displayName": "Caleb Foster",
"type": "User",
"userDetails": {
"userPrincipalName": "caleb@example.com"
}
}
},
{
"id": "37d8929d-ab32-46d1-858b-fdea74e93bff",
"type": "KQLDatabase",
"name": "TestKusto",
"description": "Test KQL database.",
"state": "Active",
"lastUpdatedDate": "2022-06-30T17:47:29.98673",
"workspaceId": "8f4496db-9929-47bd-89c0-d7eb2f517a95",
"capacityId": "D5E336D6-D919-4ECC-B424-1F881A506851",
"creatorPrincipal": {
"id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
"displayName": "Jacob Hancock",
"type": "User",
"userDetails": {
"userPrincipalName": "jacob@example.com"
}
}
}
],
"continuationUri": "https://api.fabric.microsoft.com/v1/admin/items?continuationToken=MSwxMDAwMCww",
"continuationToken": "MSwxMDAwMCww"
}
Get list of datamarts using type query parameter example
Solicitação de exemplo
GET https://api.fabric.microsoft.com/v1/admin/items?type=Lakehouse
Resposta de exemplo
{
"itemEntities": [
{
"id": "b1a7e572-2585-4650-98ae-b92356f4460b",
"type": "Lakehouse",
"name": "Lakehouse 2022-03-16T21:42:38.442Z",
"state": "Active",
"lastUpdatedDate": "2022-06-27T16:55:04.893",
"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"
}
}
}
],
"continuationUri": null,
"continuationToken": null
}
Definições
Nome | Description |
---|---|
Error |
O objeto de detalhes do recurso relacionado ao erro. |
Error |
A resposta de erro. |
Error |
Os detalhes da resposta de erro. |
Group |
Detalhes específicos do grupo. Aplicável quando o tipo principal é |
Group |
O tipo do grupo. Tipos de grupo adicionais podem ser adicionados ao longo do tempo. |
Item |
Detalhes do item. |
Items |
Uma lista de itens. |
Item |
O estado do item. Estados de item adicionais podem ser adicionados ao longo do tempo. |
Item |
O tipo do item. Tipos de item adicionais podem ser adicionados ao longo do tempo. |
Principal |
Representa uma identidade ou um grupo do Microsoft Entra. |
Principal |
O tipo da entidade de segurança. Tipos de entidades de segurança adicionais podem ser adicionados ao longo do tempo. |
Service |
Detalhes específicos da entidade de serviço. Aplicável quando o tipo principal é |
Service |
Detalhes do perfil da entidade de serviço. Aplicável quando o tipo principal é |
User |
Detalhes específicos da entidade de usuário. Aplicável quando o tipo principal é |
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 |
Lista de detalhes de erro adicionais. |
|
relatedResource |
Os detalhes do recurso relacionado ao erro. |
|
requestId |
string |
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 |
Os detalhes do recurso relacionado ao erro. |
GroupDetails
Detalhes específicos do grupo. Aplicável quando o tipo principal é Group
.
Nome | Tipo | Description |
---|---|---|
groupType |
O tipo do grupo. Tipos de grupo adicionais podem ser adicionados ao longo do tempo. |
GroupType
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 |
A entidade de segurança é um grupo de segurança. |
Unknown |
O tipo de grupo principal é desconhecido. |
Item
Detalhes do item.
Nome | Tipo | Description |
---|---|---|
capacityId |
string uuid |
A ID de capacidade do workspace. |
creatorPrincipal |
O proprietário do item. |
|
description |
string |
Detalhes do item, incluindo o tipo de item e o uso do item. |
id |
string uuid |
A ID do item. |
lastUpdatedDate |
string date-time |
A última data e hora atualizadas. |
name |
string |
O nome do item. |
state |
O status do item. |
|
type |
O tipo de item. Inclui valores como Synapse, Notebook, Kqldatabase e SynapseWorkbook. |
|
workspaceId |
string uuid |
A ID do workspace do item. |
Items
Uma lista de itens.
Nome | Tipo | Description |
---|---|---|
continuationToken |
string |
O token do próximo lote do conjunto de resultados. Se não houver mais registros, ele será removido da resposta. |
continuationUri |
string |
O URI do próximo lote do conjunto de resultados. Se não houver mais registros, ele será removido da resposta. |
itemEntities |
Item[] |
A lista de itens para um determinado locatário. |
ItemState
O estado do item. Estados de item adicionais podem ser adicionados ao longo do tempo.
Valor | Description |
---|---|
Active |
Um item ativo. |
ItemType
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. |
Principal
Representa uma identidade ou um grupo do Microsoft Entra.
Nome | Tipo | Description |
---|---|---|
displayName |
string |
O nome de exibição da entidade de segurança. |
groupDetails |
Detalhes específicos do grupo. Aplicável quando o tipo principal é |
|
id |
string uuid |
A ID da entidade de segurança. |
servicePrincipalDetails |
Detalhes específicos da entidade de serviço. Aplicável quando o tipo principal é |
|
servicePrincipalProfileDetails |
Detalhes do perfil da entidade de serviço. Aplicável quando o tipo principal é |
|
type |
O tipo da entidade de segurança. Tipos de entidades de segurança adicionais podem ser adicionados ao longo do tempo. |
|
userDetails |
Detalhes específicos da entidade de usuário. Aplicável quando o tipo principal é |
PrincipalType
O tipo da entidade de segurança. Tipos de entidades de segurança adicionais podem ser adicionados ao longo do tempo.
Valor | Description |
---|---|
Group |
A entidade de segurança é um grupo de segurança. |
ServicePrincipal |
A entidade de segurança é 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
Detalhes específicos da entidade de serviço. Aplicável quando o tipo principal é ServicePrincipal
.
Nome | Tipo | Description |
---|---|---|
aadAppId |
string uuid |
O Microsoft Entra AppId da entidade de serviço. |
ServicePrincipalProfileDetails
Detalhes do perfil da entidade de serviço. Aplicável quando o tipo principal é ServicePrincipalProfile
.
Nome | Tipo | Description |
---|---|---|
parentPrincipal |
A entidade pai do perfil da entidade de serviço. |
UserDetails
Detalhes específicos da entidade de usuário. Aplicável quando o tipo principal é User
.
Nome | Tipo | Description |
---|---|---|
userPrincipalName |
string |
O nome da entidade de usuário. |