Compartir a través de


Admin - Groups GetGroupsAsAdmin

Devuelve una lista de áreas de trabajo de la organización.

Permisos

  • El usuario debe tener derechos de administrador (como Office 365 administrador global o administrador del servicio Power BI) o autenticarse mediante una entidad de servicio.
  • Se admiten permisos delegados.

Cuando se ejecuta con la autenticación prinicipal del servicio, una aplicación no debe tener ninguna premisión necesaria de consentimiento del administrador para Power BI establecida en él en el Azure Portal.

Ámbito requerido

Tenant.Read.All o Tenant.ReadWrite.All

Solo es relevante al autenticarse a través de un token de acceso de administrador delegado estándar. No debe estar presente cuando se usa la autenticación a través de una entidad de servicio.

Limitaciones

Máximo de 50 solicitudes por hora o 15 solicitudes por minuto, por inquilino. Esta llamada también agotará el tiempo de espera después de 30 segundos para evitar efectos adversos en el servicio Power BI.

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$top={$top}
GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand={$expand}&$filter={$filter}&$top={$top}&$skip={$skip}

Parámetros de identificador URI

Nombre En Requerido Tipo Description
$top
query True

integer

int32

Devuelve solo los primeros n resultados. Este parámetro es obligatorio y debe estar en el intervalo de 1 a 5000.

$expand
query

string

Acepta una lista separada por comas de tipos de datos, que se expandirán en línea en la respuesta. Admite users, , dashboardsreports, datasets, dataflowsy workbooks.

$filter
query

string

Filtra los resultados en función de una condición booleana.

$skip
query

integer

int32

Omite los primeros n resultados. Use con top para capturar resultados más allá de los primeros 5000.

Respuestas

Nombre Tipo Description
200 OK

AdminGroups

Aceptar

Ejemplos

Get deleted workspaces example.
Get orphaned workspaces example.
Get workspaces with their 'dashboards' expanded example
Get workspaces with their 'datasets' expanded example
Get workspaces with their 'datasets' expanded example.
Get workspaces with their 'reports' expanded example
Get workspaces with their 'users' expanded example.
Get workspaces with their 'workbooks' expanded example

Get deleted workspaces example.

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$filter=state eq 'Deleted'&$top=100

Sample Response

{
  "value": [
    {
      "id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "Sample Group 2",
      "description": "Deleted sample group",
      "type": "Workspace",
      "state": "Deleted"
    }
  ]
}

Get orphaned workspaces example.

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=users&$filter=(not users/any()) or (not users/any(u: u/groupUserAccessRight eq Microsoft.PowerBI.ServiceContracts.Api.GroupUserAccessRight'Admin'))&$top=100

Sample Response

{
  "value": [
    {
      "id": "d5caa808-8c91-400a-911d-06af08dbcc31",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "Orphaned Group",
      "description": "Sample orphan group",
      "type": "Workspace",
      "state": "Active",
      "hasWorkspaceLevelSettings": false,
      "users": []
    }
  ]
}

Get workspaces with their 'dashboards' expanded example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=dashboards&$top=100

Sample Response

{
  "value": [
    {
      "id": "94E57E92-CEE2-486D-8CC8-218C97200579",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "capacityMigrationStatus": "Migrated",
      "description": "shorter description",
      "type": "Workspace",
      "state": "Removing",
      "name": "a",
      "hasWorkspaceLevelSettings": false,
      "dashboards": [
        {
          "id": "4668133c-ae3f-42fb-ad7c-214a8623280c",
          "displayName": "SQlAzure-Refresh.pbix",
          "isReadOnly": false
        },
        {
          "id": "a8f18ca7-63e8-4220-bc1c-f576ec180b98",
          "displayName": "cdvc",
          "isReadOnly": false
        }
      ]
    }
  ]
}

Get workspaces with their 'datasets' expanded example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=datasets&$top=100

Sample Response

{
  "value": [
    {
      "id": "94E57E92-CEE2-486D-8CC8-218C97200579",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "capacityMigrationStatus": "Migrated",
      "description": "shorter description",
      "type": "Workspace",
      "state": "Removing",
      "name": "a",
      "hasWorkspaceLevelSettings": false,
      "datasets": [
        {
          "id": "8ce96c50-85a0-4db3-85c6-7ccc3ed46523",
          "name": "SQlAzure-Refresh",
          "addRowsAPIEnabled": false,
          "configuredBy": "admin@granularcontrols.ccsctp.net",
          "isRefreshable": true,
          "isEffectiveIdentityRequired": false,
          "isEffectiveIdentityRolesRequired": false,
          "isOnPremGatewayRequired": false,
          "targetStorageMode": "Abf",
          "createdDate": "2019-04-30T21:35:15.867-07:00",
          "ContentProviderType": "PbixInImportMode",
          "isInPlaceSharingEnabled": false
        },
        {
          "id": "7d6a4f72-1906-4e08-a469-bd6bc1ab7b69",
          "name": "NESGames",
          "addRowsAPIEnabled": false,
          "configuredBy": "admin@granularcontrols.ccsctp.net",
          "isRefreshable": true,
          "isEffectiveIdentityRequired": false,
          "isEffectiveIdentityRolesRequired": false,
          "isOnPremGatewayRequired": false,
          "targetStorageMode": "Abf",
          "createdDate": "2019-04-30T21:35:15.867-07:00",
          "ContentProviderType": "PbixInImportMode",
          "isInPlaceSharingEnabled": false
        }
      ]
    }
  ]
}

Get workspaces with their 'datasets' expanded example.

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=datasets

Sample Response

{
  "value": [
    {
      "id": "e380d1d0-1fa6-460b-9a90-1a5c6b02414c",
      "isReadOnly": false,
      "isOnDedicatedCapacity": true,
      "capacityId": "0f084df7-c13d-451b-af5f-ed0c466403b2",
      "defaultDatasetStorageFormat": "Small",
      "name": "Sample Group 1",
      "description": "Sample group",
      "type": "Workspace",
      "state": "Active",
      "hasWorkspaceLevelSettings": true,
      "datasets": [
        {
          "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
          "name": "SalesMarketing",
          "addRowsAPIEnabled": false,
          "configuredBy": "john@contoso.com",
          "isRefreshable": true,
          "isEffectiveIdentityRequired": false,
          "isEffectiveIdentityRolesRequired": false,
          "isOnPremGatewayRequired": false,
          "isInPlaceSharingEnabled": false,
          "encryption": {
            "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
            "encryptionStatus": "InSyncWithWorkspace"
          }
        }
      ]
    },
    {
      "id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "Sample Group 2",
      "description": "Deleted sample group",
      "type": "Workspace",
      "state": "Deleted",
      "datasets": []
    }
  ]
}

Get workspaces with their 'reports' expanded example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=reports&$top=100

Sample Response

{
  "value": [
    {
      "id": "EC1EE11F-845D-495E-82A3-9DAC2072305A",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "capacityMigrationStatus": "Migrated",
      "description": "cvcv",
      "type": "Workspace",
      "state": "Active",
      "name": "WSv2Test12",
      "hasWorkspaceLevelSettings": true,
      "reports": []
    },
    {
      "id": "94E57E92-CEE2-486D-8CC8-218C97200579",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "capacityMigrationStatus": "Migrated",
      "description": "shorter description",
      "type": "Workspace",
      "state": "Removing",
      "name": "a",
      "hasWorkspaceLevelSettings": false,
      "reports": [
        {
          "id": "5DBA60B0-D9A7-42AE-B12C-6D9D51E7739A",
          "reportType": "PowerBIReport",
          "name": "SQlAzure-Refresh",
          "datasetId": "8ce96c50-85a0-4db3-85c6-7ccc3ed46523"
        },
        {
          "id": "197E5C3C-D2F3-42D8-A536-875FB6D7D48C",
          "reportType": "PowerBIReport",
          "name": "NESGames",
          "datasetId": "7d6a4f72-1906-4e08-a469-bd6bc1ab7b69"
        }
      ]
    }
  ]
}

Get workspaces with their 'users' expanded example.

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=users&$top=100

Sample Response

{
  "value": [
    {
      "id": "e380d1d0-1fa6-460b-9a90-1a5c6b02414c",
      "isReadOnly": false,
      "isOnDedicatedCapacity": true,
      "capacityId": "0f084df7-c13d-451b-af5f-ed0c466403b2",
      "defaultDatasetStorageFormat": "Small",
      "name": "Sample Group 1",
      "description": "Sample group",
      "type": "Workspace",
      "state": "Active",
      "hasWorkspaceLevelSettings": false,
      "users": [
        {
          "emailAddress": "john@contoso.com",
          "groupUserAccessRight": "Admin"
        }
      ]
    },
    {
      "id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "Sample Group 2",
      "description": "Deleted sample group",
      "type": "Workspace",
      "state": "Deleted",
      "users": []
    }
  ]
}

Get workspaces with their 'workbooks' expanded example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=workbooks&$top=100

Sample Response

{
  "value": [
    {
      "id": "94E57E92-CEE2-486D-8CC8-218C97200579",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "description": "shorter description",
      "type": "Workspace",
      "state": "Removing",
      "hasWorkspaceLevelSettings": false,
      "name": "a",
      "workbooks": [
        {
          "name": "My Excel sheet",
          "datasetId": "8ce96c50-85a0-4db3-85c6-7ccc3ed46523"
        }
      ]
    }
  ]
}

Definiciones

Nombre Description
AdminDashboard

Un panel de Power BI devuelto por Administración API. La API devuelve un subconjunto de la siguiente lista de propiedades del panel. El subconjunto depende de la API llamada, los permisos del autor de la llamada y la disponibilidad de datos en la base de datos de Power BI.

AdminDataflow

Metadatos de un flujo de datos devuelto por Administración API. A continuación se muestra una lista de propiedades que se pueden devolver para un flujo de datos. Solo se devolverá un subconjunto de las propiedades en función de la API denominada, los permisos del autor de la llamada y la disponibilidad de los datos en la base de datos de Power BI.

AdminDataset

Un conjunto de datos de Power BI devuelto por Administración API. La API devuelve un subconjunto de la siguiente lista de propiedades del conjunto de datos. El subconjunto depende de la API llamada, los permisos del autor de la llamada y la disponibilidad de los datos en la base de datos de Power BI.

AdminGroup

Un grupo de Power BI devuelto por las API de administrador

AdminGroups

Contenedor de respuesta de OData para una lista de grupos de Power BI devueltos por Administración API

AdminReport

Un informe de Power BI devuelto por Administración API. La API devuelve un subconjunto de la siguiente lista de propiedades de informe. El subconjunto depende de la API llamada, los permisos del autor de la llamada y la disponibilidad de datos en la base de datos de Power BI.

AdminTile

Icono de Power BI devuelto por Administración API.

AzureResource

Respuesta que detalla un recurso de Azure propiedad del usuario, como un área de trabajo de Log Analytics.

DashboardUser

Una entrada correcta de acceso de usuario de Power BI para un panel

DashboardUserAccessRight

El derecho de acceso que tiene el usuario para el panel (nivel de permiso)

DataflowUser

Una entrada de derecho de acceso de usuario de Power BI para un flujo de datos

DataflowUserAccessRight

Derecho de acceso que tiene un usuario para el flujo de datos (nivel de permiso)

DatasetQueryScaleOutSettings

Consulta de la configuración de escalado horizontal de un conjunto de datos

DatasetUser

Una entrada de derecho de acceso de usuario de Power BI para un conjunto de datos

DatasetUserAccessRight

Derecho de acceso que tiene el usuario para el conjunto de datos (nivel de permiso)

DefaultDatasetStorageFormat

Formato de almacenamiento del conjunto de datos predeterminado en el grupo

DependentDataflow

Un flujo de datos dependiente de Power BI

Encryption

Información de cifrado de un conjunto de datos

EncryptionStatus

Estado del cifrado del conjunto de datos

GroupType

Tipo de grupo

GroupUser

Un usuario de Power BI con acceso al área de trabajo

GroupUserAccessRight

Derecho de acceso (nivel de permiso) que un usuario tiene en el área de trabajo

PrincipalType

El tipo de entidad de seguridad

ReportUser

Entrada correcta de acceso de usuario de Power BI para un informe

ReportUserAccessRight

El derecho de acceso que tiene el usuario para el informe (nivel de permiso)

ServicePrincipalProfile

Un perfil principal de servicio Power BI. Solo es relevante para Power BI Embedded solución multiinquilino.

Subscription

Una suscripción de correo electrónico para un elemento de Power BI (por ejemplo, un informe o un panel)

SubscriptionUser

Un usuario de suscripción de correo electrónico de Power BI

Workbook

Un libro de Power BI

AdminDashboard

Un panel de Power BI devuelto por Administración API. La API devuelve un subconjunto de la siguiente lista de propiedades del panel. El subconjunto depende de la API llamada, los permisos del autor de la llamada y la disponibilidad de datos en la base de datos de Power BI.

Nombre Tipo Description
appId

string

El identificador de la aplicación, devuelto solo si el panel pertenece a una aplicación

displayName

string

Nombre para mostrar del panel

embedUrl

string

Dirección URL de inserción del panel

id

string

Identificador del panel

isReadOnly

boolean

Si el panel es de solo lectura

subscriptions

Subscription[]

(Valor vacío) Los detalles de la suscripción de un elemento de Power BI (por ejemplo, un informe o un panel). Esta propiedad se quitará de la respuesta de carga en una próxima versión. Puede recuperar información de suscripción para un informe de Power BI mediante la llamada a la API Obtener suscripciones de informes como Administración.

tiles

AdminTile[]

Iconos que pertenecen al panel

users

DashboardUser[]

(Valor vacío) Detalles de acceso del usuario del panel. Esta propiedad se quitará de la respuesta de carga en una próxima versión. Puede recuperar información de usuario en un panel de Power BI mediante la llamada a la API Obtener usuarios del panel como Administración o la llamada API postWorkspaceInfo con el getArtifactUsers parámetro .

webUrl

string

Dirección URL web del panel

workspaceId

string

Identificador del área de trabajo (GUID) del panel. Esta propiedad solo se devolverá en GetDashboardsAsAdmin.

AdminDataflow

Metadatos de un flujo de datos devuelto por Administración API. A continuación se muestra una lista de propiedades que se pueden devolver para un flujo de datos. Solo se devolverá un subconjunto de las propiedades en función de la API denominada, los permisos del autor de la llamada y la disponibilidad de los datos en la base de datos de Power BI.

Nombre Tipo Description
configuredBy

string

Propietario del flujo de datos

description

string

Descripción del flujo de datos

modelUrl

string

Dirección URL del archivo de definición de flujo de datos (model.json)

modifiedBy

string

El usuario que modificó el flujo de datos

modifiedDateTime

string

Fecha y hora en que se modificó por última vez el flujo de datos

name

string

Nombre del flujo de datos

objectId

string

Identificador del flujo de datos

users

DataflowUser[]

(Valor vacío) Detalles de acceso del usuario del flujo de datos. Esta propiedad se quitará de la respuesta de carga en una próxima versión. Puede recuperar información de usuario en un flujo de datos de Power BI mediante la llamada a la API Obtener usuarios de flujo de datos como Administración llamada API o la llamada a la API PostWorkspaceInfo con el getArtifactUser parámetro .

workspaceId

string

Identificador del área de trabajo del flujo de datos.

AdminDataset

Un conjunto de datos de Power BI devuelto por Administración API. La API devuelve un subconjunto de la siguiente lista de propiedades del conjunto de datos. El subconjunto depende de la API llamada, los permisos del autor de la llamada y la disponibilidad de los datos en la base de datos de Power BI.

Nombre Tipo Description
ContentProviderType

string

Tipo de proveedor de contenido para el conjunto de datos

CreateReportEmbedURL

string

Dirección URL de inserción del informe de creación del conjunto de datos

CreatedDate

string

Fecha y hora de creación del conjunto de datos

Encryption

Encryption

Información de cifrado del conjunto de datos. Solo se aplica cuando $expand se especifica .

IsEffectiveIdentityRequired

boolean

Si el conjunto de datos requiere una identidad eficaz, que debe enviar en una llamada a la API GenerateToken .

IsEffectiveIdentityRolesRequired

boolean

Si la seguridad de nivel de fila se define dentro del archivo .pbix de Power BI. Si es así, debe especificar un rol.

IsInPlaceSharingEnabled

boolean

Si el conjunto de datos se puede compartir con usuarios externos que se van a consumir en su propio inquilino

IsOnPremGatewayRequired

boolean

Si el conjunto de datos requiere una puerta de enlace de datos local

IsRefreshable

boolean

Si el conjunto de datos es actualizable o no. Un conjunto de datos actualizable de Power BI es un conjunto de datos que se ha actualizado al menos una vez o para el que existe una programación de actualización válida.

QnaEmbedURL

string

Dirección URL de inserción de Q&del conjunto de datos

addRowsAPIEnabled

boolean

Si el conjunto de datos permite agregar nuevas filas

configuredBy

string

Propietario del conjunto de datos

description

string

Descripción del conjunto de datos

id

string

Identificador del conjunto de datos

name

string

Nombre del conjunto de datos

queryScaleOutSettings

DatasetQueryScaleOutSettings

Consulta de la configuración de escalabilidad horizontal de un conjunto de datos

targetStorageMode

string

Modo de almacenamiento del conjunto de datos

upstreamDataflows

DependentDataflow[]

La lista de todos los flujos de datos de este elemento depende de

users

DatasetUser[]

(Valor vacío) Detalles de acceso del usuario del conjunto de datos. Esta propiedad se quitará de la respuesta de carga en una próxima versión. Puede recuperar información de usuario en un elemento de Power BI (por ejemplo, un informe o un panel) mediante la API Obtener usuarios del conjunto de datos como Administración API o postWorkspaceInfo API con el getArtifactUsers parámetro .

webUrl

string

Dirección URL web del conjunto de datos

workspaceId

string

Identificador del área de trabajo del conjunto de datos. Esta propiedad solo se devolverá en GetDatasetsAsAdmin.

AdminGroup

Un grupo de Power BI devuelto por las API de administrador

Nombre Tipo Description
capacityId

string

El identificador de capacidad

dashboards

AdminDashboard[]

Paneles que pertenecen al grupo

dataflowStorageId

string

Identificador de la cuenta de almacenamiento de flujo de datos de Power BI

dataflows

AdminDataflow[]

Flujos de datos que pertenecen al grupo

datasets

AdminDataset[]

Conjuntos de datos que pertenecen al grupo

defaultDatasetStorageFormat

DefaultDatasetStorageFormat

Formato de almacenamiento del conjunto de datos predeterminado en el área de trabajo. Solo se devuelve cuando isOnDedicatedCapacity es true

description

string

Descripción del grupo

hasWorkspaceLevelSettings

boolean

Si el área de trabajo tiene una configuración personalizada

id

string

Identificador del área de trabajo

isOnDedicatedCapacity

boolean

Si el grupo está asignado a una capacidad dedicada

isReadOnly

boolean

Si el grupo es de solo lectura

logAnalyticsWorkspace

AzureResource

Área de trabajo de Log Analytics asignada al grupo. Solo se devuelve cuando se recupera un único grupo.

name

string

Nombre del grupo

pipelineId

string

Identificador de canalización de implementación al que está asignado el área de trabajo.

reports

AdminReport[]

Los informes que pertenecen al grupo

state

string

Estado del grupo

type

GroupType

Tipo de grupo que se va a devolver.

users

GroupUser[]

(Valor vacío) Los usuarios que pertenecen al grupo y sus derechos de acceso. Esta propiedad se quitará de la respuesta de carga en una próxima versión. Puede recuperar información de usuario en un elemento de Power BI (por ejemplo, un informe o un panel) mediante la llamada API Obtener usuarios de grupo como Administración o la llamada API postWorkspaceInfo con el getArtifactUsers parámetro .

workbooks

Workbook[]

Libros que pertenecen al grupo

AdminGroups

Contenedor de respuesta de OData para una lista de grupos de Power BI devueltos por Administración API

Nombre Tipo Description
odata.context

string

Contexto de OData

value

AdminGroup[]

Lista de grupos

AdminReport

Un informe de Power BI devuelto por Administración API. La API devuelve un subconjunto de la siguiente lista de propiedades de informe. El subconjunto depende de la API llamada, los permisos del autor de la llamada y la disponibilidad de datos en la base de datos de Power BI.

Nombre Tipo Description
appId

string

El identificador de la aplicación, que se devuelve solo si el informe pertenece a una aplicación

createdBy

string

Propietario del informe. Solo está disponible para los informes creados después de junio de 2019.

createdDateTime

string

Fecha y hora de creación del informe

datasetId

string

El identificador del conjunto de datos del informe

description

string

Descripción del informe

embedUrl

string

Dirección URL de inserción del informe

id

string

Identificador del informe

isOwnedByMe

boolean

Determine si el usuario actual crea el informe.

modifiedBy

string

Último usuario que modificó el informe

modifiedDateTime

string

Fecha y hora en que se modificó por última vez el informe

name

string

Nombre del informe

originalReportId

string

Identificador de informe real cuando el área de trabajo se publica como una aplicación.

reportType enum:
  • PaginatedReport
  • PowerBIReport

Tipo de informe

subscriptions

Subscription[]

(Valor vacío) Los detalles de la suscripción de un elemento de Power BI (por ejemplo, un informe o un panel). Esta propiedad se quitará de la respuesta de carga en una próxima versión. Puede recuperar información de suscripción para un informe de Power BI mediante la llamada a la API Obtener suscripciones de informes como Administración.

users

ReportUser[]

(Valor vacío) Detalles de acceso del usuario para un informe de Power BI. Esta propiedad se quitará de la respuesta de carga en una próxima versión. Puede recuperar información de usuario en un informe de Power BI mediante la llamada a la API Obtener usuarios de informes como Administración o la llamada API de PostWorkspaceInfo con el getArtifactUsers parámetro .

webUrl

string

Dirección URL web del informe

workspaceId

string

Identificador del área de trabajo (GUID) del informe. Esta propiedad solo se devolverá en GetReportsAsAdmin.

AdminTile

Icono de Power BI devuelto por Administración API.

Nombre Tipo Description
colSpan

integer

Número de columnas de intervalo de iconos

datasetId

string

Id. del conjunto de datos. Solo está disponible para los iconos creados a partir de un informe o mediante un conjunto de datos, como los iconos de Q&A.

embedData

string

Datos para insertar del icono

embedUrl

string

Dirección URL de inserción del icono

id

string

Identificador del icono

reportId

string

Identificador del informe. Solo está disponible para los iconos creados a partir de un informe.

rowSpan

integer

Número de filas de intervalo de mosaicos

title

string

Nombre para mostrar del icono

AzureResource

Respuesta que detalla un recurso de Azure propiedad del usuario, como un área de trabajo de Log Analytics.

Nombre Tipo Description
id

string

Identificador del recurso en Power BI.

resourceGroup

string

Grupo de recursos dentro de la suscripción donde reside el recurso.

resourceName

string

Nombre del recurso.

subscriptionId

string

La suscripción de Azure donde reside el recurso.

DashboardUser

Una entrada correcta de acceso de usuario de Power BI para un panel

Nombre Tipo Description
dashboardUserAccessRight

DashboardUserAccessRight

El derecho de acceso que tiene el usuario para el panel (nivel de permiso)

displayName

string

Nombre para mostrar de la entidad de seguridad

emailAddress

string

Dirección de correo electrónico del usuario

graphId

string

Identificador de la entidad de seguridad en Microsoft Graph. Solo está disponible para las API de administrador.

identifier

string

Identificador de la entidad de seguridad

principalType

PrincipalType

Tipo de entidad de seguridad

profile

ServicePrincipalProfile

Un perfil principal de servicio Power BI. Solo es relevante para Power BI Embedded solución multiinquilino.

userType

string

Tipo del usuario.

DashboardUserAccessRight

El derecho de acceso que tiene el usuario para el panel (nivel de permiso)

Nombre Tipo Description
None

string

Sin permiso para el contenido en el panel

Owner

string

Concede acceso de lectura, escritura y recompartición al contenido del informe

Read

string

Concede acceso de lectura al contenido en el panel

ReadCopy

string

Concede acceso de lectura y copia al contenido en el panel

ReadReshare

string

Concede acceso de lectura y recompartición al contenido en el panel

ReadWrite

string

Concede acceso de lectura y escritura al contenido en el panel

DataflowUser

Una entrada de derecho de acceso de usuario de Power BI para un flujo de datos

Nombre Tipo Description
DataflowUserAccessRight

DataflowUserAccessRight

Derecho de acceso que tiene un usuario para el flujo de datos (nivel de permiso)

displayName

string

Nombre para mostrar de la entidad de seguridad

emailAddress

string

Dirección de correo electrónico del usuario

graphId

string

Identificador de la entidad de seguridad en Microsoft Graph. Solo está disponible para las API de administrador.

identifier

string

Identificador de la entidad de seguridad

principalType

PrincipalType

Tipo de entidad de seguridad

profile

ServicePrincipalProfile

Un perfil principal de servicio Power BI. Solo es relevante para Power BI Embedded solución multiinquilino.

userType

string

Tipo del usuario.

DataflowUserAccessRight

Derecho de acceso que tiene un usuario para el flujo de datos (nivel de permiso)

Nombre Tipo Description
None

string

Quita el permiso para el contenido en el flujo de datos.

Owner

string

Concede acceso de lectura, escritura y recompartición al contenido del flujo de datos.

Read

string

Concede acceso de lectura al contenido en el flujo de datos.

ReadReshare

string

Concede acceso de lectura y recompartición al contenido en el flujo de datos

ReadWrite

string

Concede acceso de lectura y escritura al contenido en el flujo de datos.

DatasetQueryScaleOutSettings

Consulta de la configuración de escalado horizontal de un conjunto de datos

Nombre Tipo Description
autoSyncReadOnlyReplicas

boolean

Si el conjunto de datos sincroniza automáticamente las réplicas de solo lectura

maxReadOnlyReplicas

integer

Número máximo de réplicas de solo lectura para el conjunto de datos (0-64, -1 para el número automático de réplicas)

DatasetUser

Una entrada de derecho de acceso de usuario de Power BI para un conjunto de datos

Nombre Tipo Description
datasetUserAccessRight

DatasetUserAccessRight

Derecho de acceso que tiene el usuario para el conjunto de datos (nivel de permiso)

displayName

string

Nombre para mostrar de la entidad de seguridad

emailAddress

string

Dirección de correo electrónico del usuario

graphId

string

Identificador de la entidad de seguridad en Microsoft Graph. Solo está disponible para las API de administrador.

identifier

string

Identificador de la entidad de seguridad

principalType

PrincipalType

Tipo de entidad de seguridad

profile

ServicePrincipalProfile

Un perfil principal de servicio Power BI. Solo es relevante para Power BI Embedded solución multiinquilino.

userType

string

Tipo del usuario.

DatasetUserAccessRight

Derecho de acceso que tiene el usuario para el conjunto de datos (nivel de permiso)

Nombre Tipo Description
None

string

Quita el permiso para el contenido del conjunto de datos.

Read

string

Concede acceso de lectura al contenido del conjunto de datos.

ReadExplore

string

Concede acceso de lectura y exploración al contenido del conjunto de datos.

ReadReshare

string

Concede acceso de lectura y recompartición al contenido del conjunto de datos

ReadReshareExplore

string

Concede acceso de lectura, volver a compartir y explorar el contenido del conjunto de datos.

ReadWrite

string

Concede acceso de lectura y escritura al contenido del conjunto de datos.

ReadWriteExplore

string

Concede acceso de lectura, escritura y exploración al contenido del conjunto de datos.

ReadWriteReshare

string

Concede acceso de lectura, escritura y recompartición al contenido del conjunto de datos.

ReadWriteReshareExplore

string

Concede acceso de lectura, escritura, recursos compartidos y exploración al contenido del conjunto de datos.

DefaultDatasetStorageFormat

Formato de almacenamiento del conjunto de datos predeterminado en el grupo

Nombre Tipo Description
Large

string

Formato de almacenamiento de conjunto de datos de gran tamaño

Small

string

Formato de almacenamiento de conjunto de datos pequeño

DependentDataflow

Un flujo de datos dependiente de Power BI

Nombre Tipo Description
groupId

string

Identificador del grupo de destino

targetDataflowId

string

Identificador del flujo de datos de destino

Encryption

Información de cifrado de un conjunto de datos

Nombre Tipo Description
EncryptionStatus

EncryptionStatus

Estado del cifrado del conjunto de datos

EncryptionStatus

Estado del cifrado del conjunto de datos

Nombre Tipo Description
InSyncWithWorkspace

string

Se admite el cifrado y está sincronizado con la configuración de cifrado.

NotInSyncWithWorkspace

string

Se admite el cifrado, pero no está sincronizado con la configuración de cifrado.

NotSupported

string

No se admite el cifrado para este conjunto de datos.

Unknown

string

El estado de cifrado es desconocido debido a daños en el conjunto de datos.

GroupType

Tipo de grupo

Nombre Tipo Description
Group

string

Versión V1 del área de trabajo compartida. Este tipo de áreas de trabajo quedará en desuso, ya que Microsoft migra todas las áreas de trabajo a la versión más reciente del área de trabajo compartida.

Personal

string

Tipo especial de área de trabajo diseñada para la lista de SharePoint y la integración de OneDrive

PersonalGroup

string

"Mi área de trabajo", también conocida como área de trabajo personal

Workspace

string

Área de trabajo compartida o área de trabajo simple usada para compartir contenido con otros usuarios de la organización

GroupUser

Un usuario de Power BI con acceso al área de trabajo

Nombre Tipo Description
displayName

string

Nombre para mostrar de la entidad de seguridad

emailAddress

string

Dirección de correo electrónico del usuario

graphId

string

Identificador de la entidad de seguridad en Microsoft Graph. Solo está disponible para las API de administrador.

groupUserAccessRight

GroupUserAccessRight

Derecho de acceso (nivel de permiso) que un usuario tiene en el área de trabajo

identifier

string

Identificador de la entidad de seguridad

principalType

PrincipalType

El tipo de entidad de seguridad

profile

ServicePrincipalProfile

Un perfil principal de servicio Power BI. Solo es relevante para Power BI Embedded solución multiinquilino.

userType

string

Tipo del usuario.

GroupUserAccessRight

Derecho de acceso (nivel de permiso) que un usuario tiene en el área de trabajo

Nombre Tipo Description
Admin

string

Derechos de administrador para el contenido del área de trabajo

Contributor

string

Acceso de lectura y exploración (ReadExplore) al contenido del área de trabajo

Member

string

Derechos de acceso leer, volver a compartir y explorar (ReadReshareExplore) al contenido del área de trabajo

None

string

Sin acceso al contenido del área de trabajo

Viewer

string

Acceso de solo lectura (lectura) al contenido del área de trabajo

PrincipalType

El tipo de entidad de seguridad

Nombre Tipo Description
App

string

Tipo de entidad de servicio

Group

string

Tipo de entidad de seguridad de grupo

None

string

No hay ningún tipo de entidad de seguridad. Se usa para el acceso de nivel de organización completo.

User

string

Tipo de entidad de seguridad de usuario

ReportUser

Entrada correcta de acceso de usuario de Power BI para un informe

Nombre Tipo Description
displayName

string

Nombre para mostrar de la entidad de seguridad

emailAddress

string

Dirección de correo electrónico del usuario

graphId

string

Identificador de la entidad de seguridad en Microsoft Graph. Solo está disponible para las API de administrador.

identifier

string

Identificador de la entidad de seguridad

principalType

PrincipalType

El tipo de entidad de seguridad

profile

ServicePrincipalProfile

Un perfil principal de servicio Power BI. Solo es relevante para Power BI Embedded solución multiinquilino.

reportUserAccessRight

ReportUserAccessRight

Derecho de acceso que el usuario tiene para el informe (nivel de permiso)

userType

string

Tipo del usuario.

ReportUserAccessRight

El derecho de acceso que tiene el usuario para el informe (nivel de permiso)

Nombre Tipo Description
None

string

Sin permiso para el contenido del informe

Owner

string

Concede acceso de lectura, escritura y recompartición al contenido del informe

Read

string

Concede acceso de lectura al contenido del informe

ReadCopy

string

Concede acceso de lectura y copia al contenido del informe

ReadReshare

string

Concede acceso de lectura y recompartición al contenido del informe

ReadWrite

string

Concede acceso de lectura y escritura al contenido del informe

ServicePrincipalProfile

Un perfil principal de servicio Power BI. Solo es relevante para Power BI Embedded solución multiinquilino.

Nombre Tipo Description
displayName

string

Nombre del perfil de entidad de servicio

id

string

Identificador del perfil de entidad de servicio

Subscription

Una suscripción de correo electrónico para un elemento de Power BI (por ejemplo, un informe o un panel)

Nombre Tipo Description
artifactDisplayName

string

Nombre del elemento de Power BI suscrito (por ejemplo, un informe o un panel)

artifactId

string

Identificador del elemento de Power BI suscrito (por ejemplo, un informe o un panel)

artifactType

string

Tipo de elemento de Power BI (por ejemplo, Dashboard, Reporto Dataset).

attachmentFormat

string

Formato del informe adjunto en la suscripción de correo electrónico

endDate

string

Fecha y hora de finalización de la suscripción de correo electrónico

frequency

string

Frecuencia de la suscripción de correo electrónico

id

string

Identificador de suscripción

isEnabled

boolean

Si la suscripción de correo electrónico está habilitada

linkToContent

boolean

Si existe un vínculo de suscripción en la suscripción de correo electrónico

previewImage

boolean

Si existe una captura de pantalla del informe en la suscripción de correo electrónico

startDate

string

Fecha y hora de inicio de la suscripción de correo electrónico

subArtifactDisplayName

string

Nombre de página del elemento de Power BI suscrito, si es un informe.

title

string

El nombre de la aplicación

users

SubscriptionUser[]

Los detalles de cada suscriptor de correo electrónico. Al usar la llamada API Get User Subscriptions As Administración, el valor devuelto es una matriz vacía (null). Esta propiedad se quitará de la respuesta de carga en una próxima versión. Puede recuperar información de suscripción en un informe o panel de Power BI mediante las llamadas api obtener suscripciones de informe como Administración o Obtener suscripciones de panel como Administración llamadas API.

SubscriptionUser

Un usuario de suscripción de correo electrónico de Power BI

Nombre Tipo Description
displayName

string

Nombre para mostrar de la entidad de seguridad

emailAddress

string

Dirección de correo electrónico del usuario

graphId

string

Identificador de la entidad de seguridad en Microsoft Graph. Solo está disponible para las API de administrador.

identifier

string

Identificador de la entidad de seguridad

principalType

PrincipalType

Tipo de entidad de seguridad

profile

ServicePrincipalProfile

Un perfil principal de servicio Power BI. Solo es relevante para Power BI Embedded solución multiinquilino.

userType

string

Tipo del usuario.

Workbook

Un libro de Power BI

Nombre Tipo Description
datasetId

string

Identificador del conjunto de datos asociado a un libro. Solo se aplica si el libro tiene un conjunto de datos asociado.

name

string

Nombre del libro