Items - List Items

Referencia

Servicio:: Admin

Versión de la API:: v1

Nota

Esta API está en versión preliminar.

Devuelve una lista de elementos activos de Fabric y PowerBI.

Esta API admite paginación. Se puede devolver un máximo de 10 000 registros por solicitud. Con el token continuo proporcionado en la respuesta, puede obtener los siguientes 10 000 registros.

Orden de página:

Elementos de tejido
Datamarts
Informes
Paneles
SemanticModels
Aplicaciones
Flujos de datos

Permisos

El autor de la llamada debe ser un administrador de Fabric o autenticarse mediante una entidad de servicio.

Ámbitos delegados necesarios

Tenant.Read.All o Tenant.ReadWrite.All

Limitaciones

Máximo de 200 solicitudes por hora.

Identidades admitidas de Microsoft Entra

Esta API admite las identidades de Microsoft enumeradas en esta sección.

Identidad	Apoyo
Usuario	Sí
de entidad de servicio y identidades administradas	Sí

Interfaz

GET https://api.fabric.microsoft.com/v1/admin/items

Con parámetros opcionales:

GET https://api.fabric.microsoft.com/v1/admin/items?workspaceId={workspaceId}&capacityId={capacityId}&state={state}&type={type}&continuationToken={continuationToken}

Parámetros de identificador URI

Nombre	En	Tipo	Description
capacityId	query	string uuid	Identificador de capacidad del área de trabajo.
continuationToken	query	string	Token continuo usado para obtener los elementos de la página siguiente.
state	query	string	Estado del elemento. Los estados admitidos están activos.
type	query	string	Tipo de elemento.
workspaceId	query	string uuid	Identificador del área de trabajo.

Respuestas

Nombre	Tipo	Description
200 OK	Items	La operación se realizó correctamente.
Other Status Codes	ErrorResponse	Códigos de error comunes: ItemNotFound: el identificador de elemento no existe. InvalidItemType: el tipo de elemento no es válido. InvalidItemState: el estado del elemento no es válido.

Nombre

Tipo

Description

200 OK

Items

La operación se realizó correctamente.

Other Status Codes

ErrorResponse

Códigos de error comunes:

ItemNotFound: el identificador de elemento no existe.
InvalidItemType: el tipo de elemento no es válido.
InvalidItemState: el estado del elemento no es válido.

Ejemplos

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

Solicitud de ejemplo

HTTP

GET https://api.fabric.microsoft.com/v1/admin/items?type=Report

Respuesta de muestra

status code:: 200

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

Solicitud de ejemplo

HTTP

GET https://api.fabric.microsoft.com/v1/admin/items

Respuesta de muestra

status code:: 200

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

Solicitud de ejemplo

HTTP

GET https://api.fabric.microsoft.com/v1/admin/items?type=Lakehouse

Respuesta de muestra

status code:: 200

{
  "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
}

Definiciones

Nombre	Description
ErrorRelatedResource	Objeto de detalles del recurso relacionado con el error.
ErrorResponse	Respuesta de error.
ErrorResponseDetails	Detalles de la respuesta de error.
GroupDetails	Detalles específicos del grupo. Aplicable cuando el tipo de entidad de seguridad es `Group`.
GroupType	Tipo del grupo. Se pueden agregar tipos de grupo adicionales a lo largo del tiempo.
Item	Detalles del elemento.
Items	Lista de elementos.
ItemState	Estado del elemento. Se pueden agregar estados de elemento adicionales con el tiempo.
ItemType	Tipo del elemento. Se pueden agregar tipos de elementos adicionales a lo largo del tiempo.
Principal	Representa una identidad o un grupo de Microsoft Entra.
PrincipalType	Tipo de la entidad de seguridad. Se pueden agregar tipos de entidad de seguridad adicionales a lo largo del tiempo.
ServicePrincipalDetails	Detalles específicos de la entidad de servicio. Aplicable cuando el tipo de entidad de seguridad es `ServicePrincipal`.
ServicePrincipalProfileDetails	Detalles del perfil de entidad de servicio. Aplicable cuando el tipo de entidad de seguridad es `ServicePrincipalProfile`.
UserDetails	Detalles específicos de la entidad de seguridad de usuario. Aplicable cuando el tipo de entidad de seguridad es `User`.

ErrorRelatedResource

Object

Objeto de detalles del recurso relacionado con el error.

Nombre	Tipo	Description
resourceId	string	Identificador de recurso implicado en el error.
resourceType	string	Tipo del recurso implicado en el error.

ErrorResponse

Object

Respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message	string	Representación legible del error.
moreDetails	ErrorResponseDetails[]	Lista de detalles de error adicionales.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.
requestId	string	Identificador de la solicitud asociada al error.

ErrorResponseDetails

Object

Detalles de la respuesta de error.

Nombre	Tipo	Description
errorCode	string	Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message	string	Representación legible del error.
relatedResource	ErrorRelatedResource	Detalles del recurso relacionado con el error.

GroupDetails

Object

Detalles específicos del grupo. Aplicable cuando el tipo de entidad de seguridad es Group.

Nombre	Tipo	Description
groupType	GroupType	Tipo del grupo. Se pueden agregar tipos de grupo adicionales a lo largo del tiempo.

GroupType

Enumeración

Tipo del grupo. Se pueden agregar tipos de grupo adicionales a lo largo del tiempo.

Valor	Description
DistributionList	La entidad de seguridad es una lista de distribución.
SecurityGroup	La entidad de seguridad es un grupo de seguridad.
Unknown	El tipo de grupo principal es desconocido.

Item

Object

Detalles del elemento.

Nombre	Tipo	Description
capacityId	string uuid	Identificador de capacidad del área de trabajo.
creatorPrincipal	Principal	Propietario del elemento.
description	string	Detalles del elemento, incluido el tipo de elemento y el uso de elementos.
id	string uuid	Identificador del elemento.
lastUpdatedDate	string date-time	Fecha y hora actualizadas por última vez.
name	string	Nombre del elemento.
state	ItemState	Estado del elemento.
type	ItemType	Tipo de elemento. Incluye valores como Synapse, Notebook, Kqldatabase y SynapseWorkbook.
workspaceId	string uuid	Identificador del área de trabajo del elemento.

Items

Object

Lista de elementos.

Nombre	Tipo	Description
continuationToken	string	Token del siguiente lote del conjunto de resultados. Si no hay más registros, se quita de la respuesta.
continuationUri	string	Identificador URI del siguiente lote del conjunto de resultados. Si no hay más registros, se quita de la respuesta.
itemEntities	Item[]	Lista de elementos de un inquilino determinado.

ItemState

Enumeración

Estado del elemento. Se pueden agregar estados de elemento adicionales con el tiempo.

Valor	Description
Active	Un elemento activo.

ItemType

Enumeración

Tipo del elemento. Se pueden agregar tipos de elementos adicionales a lo largo del tiempo.

Valor	Description
Dashboard	Panel de PowerBI.
DataPipeline	Una canalización de datos.
Datamart	Datamart de PowerBI.
Environment	Un entorno.
Eventhouse	Un centro de eventos.
Eventstream	Una secuencia de eventos.
GraphQLApi	Una API para el elemento GraphQL.
KQLDashboard	Un panel de KQL.
KQLDatabase	Una base de datos KQL.
KQLQueryset	Un conjunto de consultas KQL.
Lakehouse	Una casa de lago.
MLExperiment	Un experimento de aprendizaje automático.
MLModel	Un modelo de aprendizaje automático.
MirroredDatabase	Una base de datos reflejada.
MirroredWarehouse	Un almacén reflejado.
MountedDataFactory	A MountedDataFactory.
Notebook	Un cuaderno.
PaginatedReport	Informe paginado de PowerBI.
Reflex	Un reflejo.
Report	Informe de PowerBI.
SQLDatabase	A SQLDatabase.
SQLEndpoint	Un punto de conexión de SQL.
SemanticModel	Modelo semántico de PowerBI.
SparkJobDefinition	Una definición de trabajo de Spark.
Warehouse	Un almacén.

Principal

Object

Representa una identidad o un grupo de Microsoft Entra.

Nombre	Tipo	Description
displayName	string	Nombre para mostrar de la entidad de seguridad.
groupDetails	GroupDetails	Detalles específicos del grupo. Aplicable cuando el tipo de entidad de seguridad es `Group`.
id	string uuid	Identificador de la entidad de seguridad.
servicePrincipalDetails	ServicePrincipalDetails	Detalles específicos de la entidad de servicio. Aplicable cuando el tipo de entidad de seguridad es `ServicePrincipal`.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Detalles del perfil de entidad de servicio. Aplicable cuando el tipo de entidad de seguridad es `ServicePrincipalProfile`.
type	PrincipalType	Tipo de la entidad de seguridad. Se pueden agregar tipos de entidad de seguridad adicionales a lo largo del tiempo.
userDetails	UserDetails	Detalles específicos de la entidad de seguridad de usuario. Aplicable cuando el tipo de entidad de seguridad es `User`.

PrincipalType

Enumeración

Tipo de la entidad de seguridad. Se pueden agregar tipos de entidad de seguridad adicionales a lo largo del tiempo.

Valor	Description
Group	La entidad de seguridad es un grupo de seguridad.
ServicePrincipal	La entidad de seguridad es una entidad de servicio de Microsoft Entra.
ServicePrincipalProfile	La entidad de servicio es un perfil de entidad de servicio.
User	La entidad de seguridad es una entidad de seguridad de usuario de Microsoft Entra.

ServicePrincipalDetails

Object

Detalles específicos de la entidad de servicio. Aplicable cuando el tipo de entidad de seguridad es ServicePrincipal.

Nombre	Tipo	Description
aadAppId	string uuid	Microsoft Entra AppId de la entidad de servicio.

ServicePrincipalProfileDetails

Object

Detalles del perfil de entidad de servicio. Aplicable cuando el tipo de entidad de seguridad es ServicePrincipalProfile.

Nombre	Tipo	Description
parentPrincipal	Principal	La entidad de seguridad principal del perfil de la entidad de servicio.

UserDetails

Object

Detalles específicos de la entidad de seguridad de usuario. Aplicable cuando el tipo de entidad de seguridad es User.

Nombre	Tipo	Description
userPrincipalName	string	Nombre principal de usuario.

Compartir a través de

Items - List Items

Permisos

Ámbitos delegados necesarios

Limitaciones

Identidades admitidas de Microsoft Entra

Interfaz

Parámetros de identificador URI

Respuestas

Ejemplos

Get a list of items using type query parameter example

Solicitud de ejemplo

Respuesta de muestra

Get all items in the tenant example

Solicitud de ejemplo

Respuesta de muestra

Get list of datamarts using type query parameter example

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupType

Item

Items

ItemState

ItemType

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails

Recursos adicionales