Admin - WorkspaceInfo GetScanResult

Serviço:: Power BI REST APIs

Versão da API:: v1.0

Obtém o resultado da verificação para a verificação especificada.

Faça essa chamada à API somente após uma chamada bem-sucedida getScanStatus API. O resultado da verificação permanecerá disponível por 24 horas.

Permissões

O usuário deve ser um administrador do Fabric ou autenticar usando uma entidade de serviço.

Ao executar em autenticação de entidade de serviço, um aplicativo não deve ter permissões necessárias de consentimento do administrador para o Power BI definidas nele no portal do Azure.

Escopo necessário

Tenant.Read.All ou Tenant.ReadWrite.All

Relevante somente ao autenticar por meio de um token de acesso de administrador delegado padrão. Não deve estar presente quando a autenticação por meio de uma entidade de serviço é usada.

Limitações

Máximo de 500 solicitações por hora.

GET https://api.powerbi.com/v1.0/myorg/admin/workspaces/scanResult/{scanId}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
scanId	path	True	string (uuid)	A ID de verificação, que é incluída na resposta dos workspaces ou do Admin – WorkspaceInfo PostWorkspaceInfo chamada à API que disparou a verificação.

Respostas

Nome	Tipo	Description
200 OK	WorkspaceInfoResponse	OKEY

Exemplos

Example

Solicitação de exemplo

GET https://api.powerbi.com/v1.0/myorg/admin/workspaces/scanResult/e7d03602-4873-4760-b37e-1563ef5358e3

Resposta de exemplo

Código de status:: 200

{
  "workspaces": [
    {
      "id": "d507422c-8d6d-4361-ac7a-30074a8cd0a1",
      "name": "V2 shared",
      "type": "Workspace",
      "state": "Active",
      "isOnDedicatedCapacity": true,
      "capacityId": "0f084df7-c13d-451b-af5f-ed0c466403b2",
      "defaultDatasetStorageFormat": "Small",
      "reports": [
        {
          "id": "c6d072d1-ed20-4b60-8329-16c4b934203b",
          "name": "CompositeModelParams-RLS",
          "datasetId": "132593c4-bf8d-4548-8f25-1ebb16a1613c",
          "createdDateTime": "2020-06-16T08:22:49.14",
          "modifiedDateTime": "2020-06-16T08:22:49.14",
          "modifiedBy": "john@contoso.com",
          "reportType": "PaginatedReport",
          "endorsementDetails": {
            "endorsement": "Certified",
            "certifiedBy": "john@contoso.com"
          },
          "sensitivityLabel": {
            "labelId": "85b38049-4259-43a2-8feb-244e222d96c0"
          },
          "users": [
            {
              "displayName": "John Nick",
              "emailAddress": "john@contoso.com",
              "appUserAccessRight": "ReadExplore",
              "identifier": "john@contoso.com",
              "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
              "principalType": "User"
            }
          ],
          "tags": [
            "3b4b36a5-7895-4548-93b7-924e6e65833e",
            "8ce91ed7-8423-4492-b831-48906997aab2"
          ]
        }
      ],
      "dashboards": [
        {
          "id": "80814ece-9302-49e3-b6bc-bad2f7a86c1a",
          "displayName": "CompositeModelParamsDashboard",
          "isReadOnly": false,
          "tiles": [
            {
              "id": "e687cc21-5b32-48f5-8c5e-4b844f190579",
              "title": "CompositeModelParamsDashboard",
              "reportId": "c6d072d1-ed20-4b60-8329-16c4b934203b",
              "datasetId": "132593c4-bf8d-4548-8f25-1ebb16a1613c"
            }
          ],
          "sensitivityLabel": {
            "labelId": "d9b9581a-0594-4c39-81c5-91ddf40baeda"
          },
          "users": [
            {
              "displayName": "John Nick",
              "emailAddress": "john@contoso.com",
              "appUserAccessRight": "ReadExplore",
              "identifier": "john@contoso.com",
              "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
              "principalType": "User"
            }
          ],
          "tags": [
            "3b4b36a5-7895-4548-93b7-924e6e65833e",
            "8ce91ed7-8423-4492-b831-48906997aab2"
          ]
        }
      ],
      "datasets": [
        {
          "id": "e7e8a355-e77b-4418-a7b8-ae5972fdaa03",
          "name": "ExportB",
          "tables": [
            {
              "name": "DW_Revenues",
              "columns": [
                {
                  "name": "RowNumber-2662979B-1795-4F74-8F37-6A1BA8059B61",
                  "dataType": "Int64",
                  "isHidden": true
                }
              ],
              "measures": [
                {
                  "name": "MyMeasure",
                  "expression": "CALCULATE(SELECTEDVALUE('DW_Revenues DW_RevenuesTestToBeDeleted'[Numbers])*10)",
                  "description": "My measure",
                  "isHidden": false
                }
              ],
              "isHidden": false,
              "description": "My table",
              "source": [
                {
                  "expression": "let\n    Source = Revenues,\n    Param = RevenuesParam\nin\n    Source"
                }
              ]
            }
          ],
          "relationships": [],
          "configuredBy": "john@contoso.com",
          "targetStorageMode": "Abf",
          "endorsementDetails": {
            "endorsement": "Certified",
            "certifiedBy": "john@contoso.com"
          },
          "expressions": [
            {
              "name": "Revenues",
              "description": "revenues",
              "expression": "let\n    Source = Sql.Database(\"sqlserver.database.windows.net\", \"DB\"),\n    RevenuesTable = Source{[Schema=\"DB_SCHEMA\",Item=\"DB_SCHEMA_ITEM\"]}[Data]\nin\n    RevenuesTable"
            },
            {
              "name": "RevenuesParam",
              "description": "revenues param",
              "expression": "\"revenues param value\" meta [IsParameterQuery=true, Type=\"Text\", IsParameterQueryRequired=true]"
            }
          ],
          "roles": [
            {
              "name": "Teams",
              "modelPermission": "Read",
              "members": [
                {
                  "memberName": "john@contoso.com",
                  "memberId": "ee96296b-fb71-4f65-a8af-c0ec5a7daced",
                  "memberType": "User",
                  "identityProvider": "AzureAD"
                },
                {
                  "memberName": "group@contoso.com",
                  "memberId": "0a1cdbc3-f82c-4001-8b96-be04ae9d25a3",
                  "memberType": "Group",
                  "identityProvider": "AzureAD"
                }
              ],
              "tablePermissions": [
                {
                  "name": "DW_Revenues DW_RevenuesTest",
                  "filterExpression": "[InTeams] = \"True\""
                }
              ]
            }
          ],
          "upstreamDataflows": [
            {
              "targetDataflowId": "a842dbb1-32ca-46b0-9648-498b2c2d5e38",
              "groupId": "b7416115-7421-42c0-b525-1505ce40d2f0"
            },
            {
              "targetDataflowId": "06898194-2eaf-4122-bacc-133db1f8585d",
              "groupId": "7263838d-80d7-4b8d-a1f6-50fc27e74a97"
            }
          ],
          "datasourceUsages": [
            {
              "datasourceInstanceId": "c79ad907-df19-43fe-a0f7-d9f365d67070"
            }
          ],
          "misconfiguredDatasourceUsages": [
            {
              "datasourceInstanceId": "80ec28bc-fe81-43ea-be52-a07a95cfbcab"
            }
          ],
          "sensitivityLabel": {
            "labelId": "bf3dc57d-d796-41c0-bbe9-a47f5ee3331e"
          },
          "users": [
            {
              "displayName": "John Nick",
              "emailAddress": "john@contoso.com",
              "appUserAccessRight": "ReadExplore",
              "identifier": "john@contoso.com",
              "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
              "principalType": "User"
            }
          ],
          "tags": [
            "3b4b36a5-7895-4548-93b7-924e6e65833e",
            "8ce91ed7-8423-4492-b831-48906997aab2"
          ]
        }
      ],
      "dataflows": [
        {
          "objectId": "a842dbb1-32ca-46b0-9648-498b2c2d5e38",
          "name": "Azure SQL",
          "description": "Azure SQL dataflow",
          "configuredBy": "john@contoso.com",
          "modifiedBy": "john@contoso.com",
          "modifiedDateTime": "2020-06-16T08:27:47.783Z",
          "endorsementDetails": {
            "endorsement": "Certified",
            "certifiedBy": "john@contoso.com"
          },
          "datasourceUsages": [
            {
              "datasourceInstanceId": "c79ad907-df19-43fe-a0f7-d9f365d67070"
            }
          ],
          "misconfiguredDatasourceUsages": [
            {
              "datasourceInstanceId": "80ec28bc-fe81-43ea-be52-a07a95cfbcab"
            }
          ],
          "sensitivityLabel": {
            "labelId": "5c9f8c24-2a94-4fd2-a105-9a8b096c5af1"
          },
          "users": [
            {
              "displayName": "John Nick",
              "emailAddress": "john@contoso.com",
              "appUserAccessRight": "ReadExplore",
              "identifier": "john@contoso.com",
              "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
              "principalType": "User"
            }
          ],
          "tags": [
            "3b4b36a5-7895-4548-93b7-924e6e65833e",
            "8ce91ed7-8423-4492-b831-48906997aab2"
          ]
        }
      ],
      "datamarts": [
        {
          "id": "9df8d63c-db5b-44c3-a8e3-9f8c8ec1eec2",
          "name": "MyDatamart",
          "description": "SQL datamart",
          "type": "Sql",
          "configuredBy": "john@contoso.com",
          "configuredById": "5c9f8c24-2a94-4fd2-a105-9a8b096cdsew",
          "modifiedBy": "john@contoso.com",
          "modifiedDateTime": "2020-06-16T08:27:47.783Z",
          "sensitivityLabel": {
            "labelId": "5c9f8c24-2a94-4fd2-a105-9a8b096c5af1"
          },
          "endorsementDetails": {
            "endorsement": "Certified",
            "certifiedBy": "john@contoso.com"
          },
          "UpstreamDataflows": [
            {
              "targetDataflowId": "5c9f8c24-2a94-34fd-a105-9a8b096c4555",
              "groupId": "5c9f8c24-4dsc-4fd2-a105-9a8b096c4fgt"
            }
          ],
          "datasourceUsages": [
            {
              "datasourceInstanceId": "c79ad907-df19-43fe-a0f7-d9f365d67070"
            }
          ],
          "Users": [
            {
              "displayName": "John Nick",
              "emailAddress": "john@contoso.com",
              "identifier": "john@contoso.com",
              "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
              "principalType": "User",
              "userType": "User",
              "profile": {
                "id": "45416453",
                "displayName": "John's profile"
              },
              "datamartUserAccessRight": "Read"
            }
          ],
          "tags": [
            "3b4b36a5-7895-4548-93b7-924e6e65833e",
            "8ce91ed7-8423-4492-b831-48906997aab2"
          ]
        }
      ],
      "users": [
        {
          "displayName": "John Nick",
          "emailAddress": "john@contoso.com",
          "appUserAccessRight": "ReadExplore",
          "identifier": "john@contoso.com",
          "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
          "principalType": "User"
        }
      ]
    }
  ],
  "datasourceInstances": [
    {
      "datasourceType": "Sql",
      "connectionDetails": {
        "server": "qlserver.database.windows.net",
        "database": "dbo.largest_table"
      },
      "datasourceId": "c79ad907-df19-43fe-a0f7-d9f365d67070",
      "gatewayId": "e820592e-f8cf-4a6f-b1ed-566799d29565"
    }
  ],
  "misconfiguredDatasourceInstances": [
    {
      "datasourceType": "Sql",
      "connectionDetails": {
        "server": "sqlserver.database.windows.net",
        "database": "dbo.table"
      },
      "datasourceId": "80ec28bc-fe81-43ea-be52-a07a95cfbcab",
      "gatewayId": "505a19c1-4190-4e8e-a4f6-dd72722feced"
    }
  ]
}

Definições

Nome	Description
ASMashupExpression	Uma fonte de tabela de conjunto de dados
Column	Uma coluna de conjunto de dados
DashboardUser	Uma entrada certa de acesso de usuário do Power BI para um dashboard
DashboardUserAccessRight	O direito de acesso que o usuário tem para o painel (nível de permissão)
DataflowUser	Uma entrada certa de acesso de usuário do Power BI para um fluxo de dados
DataflowUserAccessRight	O direito de acesso que um usuário tem para o fluxo de dados (nível de permissão)
datamartState	O estado atual do datamart
datamartStatus	O status de datamart
datamartType	O tipo de datamart
DatamartUser	Uma entrada certa de acesso de usuário do Power BI para um relatório
DatamartUserAccessRight	O direito de acesso que o usuário tem para o datamart (nível de permissão)
DatasetUser	Uma entrada certa de acesso de usuário do Power BI para um conjunto de dados
DatasetUserAccessRight	O direito de acesso que o usuário tem para o conjunto de dados (nível de permissão)
Datasource	Uma fonte de dados do Power BI
DatasourceConnectionDetails	Os detalhes da conexão da fonte de dados do Power BI. Veja exemplos em Obter fontes de dados ou obter fontes de dados no grupo.
DatasourceUsage	Uso da fonte de dados
DefaultDatasetStorageFormat	O formato de armazenamento do conjunto de dados padrão no grupo
DependentDataflow	Um fluxo de dados dependente do Power BI
DependentDatamart	Um datamart dependente do Power BI
DependentDataset	Um conjunto de dados dependente do Power BI
EndorsementDetails	Detalhes de endosso do Power BI
Expression	Uma expressão de conjunto de dados
GroupUser	Um usuário do Power BI com acesso ao workspace
GroupUserAccessRight	O direito de acesso (nível de permissão) que um usuário tem no workspace
Measure	Uma medida do Power BI
PrincipalType	O tipo principal
ReportUser	Uma entrada certa de acesso de usuário do Power BI para um relatório
ReportUserAccessRight	O direito de acesso que o usuário tem para o relatório (nível de permissão)
Role	Uma função na configuração RLS de um conjunto de dados
RoleMember	Um membro de função
RoleTablePermission	Um filtro de função
Row	Uma linha de dados em um conjunto de dados
SensitivityLabel	Informações de rótulo de confidencialidade para um item do Power BI (como um relatório ou um painel)
ServicePrincipalProfile	Um perfil de entidade de serviço do Power BI. Relevante apenas para solução de vários locatários do Power BI Embedded.
Table	Uma tabela de conjunto de dados
WorkspaceInfo	Detalhes das informações do workspace
WorkspaceInfoDashboard	Um painel do Power BI retornado pelas APIs WorkspaceInfo. A API retorna um subconjunto da lista a seguir de propriedades do painel. O subconjunto depende da API chamada, das permissões de chamador e da disponibilidade de dados no banco de dados do Power BI.
WorkspaceInfoDataflow	Os metadados de um fluxo de dados retornado pelas APIs de Informações do Workspace. Veja abaixo uma lista de propriedades que podem ser retornadas para um fluxo de dados. Somente um subconjunto das propriedades será retornado dependendo da API chamada, das permissões de chamador e da disponibilidade dos dados no banco de dados do Power BI.
WorkspaceInfoDatamart	Um datamart do Power BI retornado pelas APIs de Informações do Workspace. A API retorna um subconjunto da lista a seguir de propriedades de datamart. O subconjunto depende da API chamada, das permissões de chamador e da disponibilidade de dados no banco de dados do Power BI.
WorkspaceInfoDataset	Um conjunto de dados do Power BI retornado pelas APIs WorkspaceInfo. A API retorna um subconjunto da lista a seguir de propriedades do conjunto de dados. O subconjunto depende da API chamada, das permissões de chamador e da disponibilidade dos dados no banco de dados do Power BI.
WorkspaceInfoReport	Um relatório do Power BI retornado pelas APIs de Informações do Workspace. A API retorna um subconjunto da lista a seguir de propriedades de relatório. O subconjunto depende da API chamada, das permissões de chamador e da disponibilidade de dados no banco de dados do Power BI.
WorkspaceInfoResponse	Resposta de informações do workspace
WorkspaceInfoTile	Um bloco do Power BI retornado por APIs WorkspaceInfo

ASMashupExpression

Objeto

Uma fonte de tabela de conjunto de dados

Nome	Tipo	Description
expression	string	A expressão de origem

Column

Objeto

Uma coluna de conjunto de dados

Nome	Tipo	Description
dataCategory	string	Opcional. O valor da cadeia de caracteres a ser usado para a categoria de dados que descreve os dados nessa coluna.
dataType	string	O tipo de dados de coluna
formatString	string	Opcional. O formato da coluna conforme especificado em FORMAT_STRING.
isHidden	boolean	Opcional. Se a coluna está oculta. O padrão é `false`.
name	string pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$	O nome da coluna
sortByColumn	string	Opcional. Nome da cadeia de caracteres de uma coluna na mesma tabela a ser usada para ordenar a coluna atual.
summarizeBy	string	Opcional. A função de agregação a ser usada para resumir esta coluna.

DashboardUser

Objeto

Uma entrada certa de acesso de usuário do Power BI para um dashboard

Nome	Tipo	Description
dashboardUserAccessRight	DashboardUserAccessRight	O direito de acesso que o usuário tem para o painel (nível de permissão)
displayName	string	Nome de exibição da entidade de segurança
emailAddress	string	Endereço de email do usuário
graphId	string	Identificador da entidade de segurança no Microsoft Graph. Disponível somente para APIs de administrador.
identifier	string	Identificador da entidade de segurança
principalType	PrincipalType	O tipo principal
profile	ServicePrincipalProfile	Um perfil de entidade de serviço do Power BI. Relevante apenas para solução de vários locatários do Power BI Embedded.
userType	string	Tipo do usuário.

DashboardUserAccessRight

Enumeração

O direito de acesso que o usuário tem para o painel (nível de permissão)

Valor	Description
None	Nenhuma permissão para conteúdo no painel
Read	Concede acesso de leitura ao conteúdo no painel
ReadWrite	Concede acesso de leitura e gravação ao conteúdo no painel
ReadReshare	Concede acesso de leitura e compartilhamento ao conteúdo no painel
ReadCopy	Concede acesso de leitura e cópia ao conteúdo no painel
Owner	Concede acesso de leitura, gravação e recompartilhamento ao conteúdo no relatório

DataflowUser

Objeto

Uma entrada certa de acesso de usuário do Power BI para um fluxo de dados

Nome	Tipo	Description
DataflowUserAccessRight	DataflowUserAccessRight	O direito de acesso que um usuário tem para o fluxo de dados (nível de permissão)
displayName	string	Nome de exibição da entidade de segurança
emailAddress	string	Endereço de email do usuário
graphId	string	Identificador da entidade de segurança no Microsoft Graph. Disponível somente para APIs de administrador.
identifier	string	Identificador da entidade de segurança
principalType	PrincipalType	O tipo principal
profile	ServicePrincipalProfile	Um perfil de entidade de serviço do Power BI. Relevante apenas para solução de vários locatários do Power BI Embedded.
userType	string	Tipo do usuário.

DataflowUserAccessRight

Enumeração

O direito de acesso que um usuário tem para o fluxo de dados (nível de permissão)

Valor	Description
None	Remove a permissão para o conteúdo no fluxo de dados
Read	Concede acesso de leitura ao conteúdo no fluxo de dados
ReadWrite	Concede acesso de leitura e gravação ao conteúdo no fluxo de dados
ReadReshare	Concede acesso de leitura e compartilhamento ao conteúdo no fluxo de dados
Owner	Concede acesso de leitura, gravação e compartilhamento ao conteúdo no fluxo de dados

datamartState

Enumeração

O estado atual do datamart

Valor	Description
Invalid	O datamart tem um estado inválido
Initialized	O datamart foi inicializado
Active	O datamart está ativo
Migrating	O datamart está migrando
Evicted	O datamart foi removido
Deleted	O datamart foi excluído

datamartStatus

Enumeração

O status de datamart

Valor	Description
Invalid	O datamart tem status inválido
Available	O datamart está disponível
SuspendedInCriticalPhase	O datamart é suspenso em fase crítica
InProgress	O datamart está em andamento
Error	O datamart tem status de erro
OutOfRegion	O datamart está fora da região
NoCapacity	O datamart não tem capacidade

datamartType

Enumeração

O tipo de datamart

Valor	Description
Unset	O tipo de datamart não foi definido
Ignore	O datamart não tem nenhum tipo
Sql	O datamart é do tipo Sql
Lakehouse	O datamart é do tipo Lakehouse
Dataverse	O datamart é do tipo Dataverse
Datawarehouse	O datamart é do tipo Datawarehouse

DatamartUser

Objeto

Uma entrada certa de acesso de usuário do Power BI para um relatório

Nome	Tipo	Description
datamartUserAccessRight	DatamartUserAccessRight	O direito de acesso que o usuário tem para o datamart (nível de permissão)
displayName	string	Nome de exibição da entidade de segurança
emailAddress	string	Endereço de email do usuário
graphId	string	Identificador da entidade de segurança no Microsoft Graph. Disponível somente para APIs de administrador.
identifier	string	Identificador da entidade de segurança
principalType	PrincipalType	O tipo principal
profile	ServicePrincipalProfile	Um perfil de entidade de serviço do Power BI. Relevante apenas para solução de vários locatários do Power BI Embedded.
userType	string	Tipo do usuário.

DatamartUserAccessRight

Enumeração

O direito de acesso que o usuário tem para o datamart (nível de permissão)

Valor	Description
None	Nenhuma permissão para conteúdo no datamart
Read	Concede acesso de leitura ao conteúdo em datamart
Write	Concede acesso de gravação ao conteúdo em datamart
Reshare	Concede acesso de recompartilhamento ao conteúdo em datamart
Explore	Concede a exploração do acesso ao conteúdo em datamart
ReadWrite	Concede acesso de leitura e gravação ao conteúdo em datamart
ReadReshare	Concede acesso de leitura e recompartilhamento ao conteúdo em datamart
ReadWriteReshare	Concede acesso de leitura, gravação e recompartilhamento ao conteúdo em datamart
ReadExplore	Concede acesso de leitura e exploração ao conteúdo em datamart
ReadReshareExplore	Concede a leitura e recompartão e explora o acesso ao conteúdo no datamart
ReadWriteExplore	Concede acesso de leitura e gravação e exploração ao conteúdo no datamart
ReadWriteReshareExplore	Concede leitura, gravação e recompartilhamento e explora o acesso ao conteúdo em datamart

DatasetUser

Objeto

Uma entrada certa de acesso de usuário do Power BI para um conjunto de dados

Nome	Tipo	Description
datasetUserAccessRight	DatasetUserAccessRight	O direito de acesso que o usuário tem para o conjunto de dados (nível de permissão)
displayName	string	Nome de exibição da entidade de segurança
emailAddress	string	Endereço de email do usuário
graphId	string	Identificador da entidade de segurança no Microsoft Graph. Disponível somente para APIs de administrador.
identifier	string	Identificador da entidade de segurança
principalType	PrincipalType	O tipo principal
profile	ServicePrincipalProfile	Um perfil de entidade de serviço do Power BI. Relevante apenas para solução de vários locatários do Power BI Embedded.
userType	string	Tipo do usuário.

DatasetUserAccessRight

Enumeração

O direito de acesso que o usuário tem para o conjunto de dados (nível de permissão)

Valor	Description
None	Remove a permissão para o conteúdo no conjunto de dados
Read	Concede acesso de leitura ao conteúdo no conjunto de dados
ReadWrite	Concede acesso de leitura e gravação ao conteúdo no conjunto de dados
ReadReshare	Concede acesso de leitura e compartilhamento ao conteúdo no conjunto de dados
ReadWriteReshare	Concede acesso de leitura, gravação e compartilhamento ao conteúdo no conjunto de dados
ReadExplore	Concede acesso de leitura e exploração ao conteúdo no conjunto de dados
ReadReshareExplore	Concede acesso de leitura, compartilhamento e exploração ao conteúdo no conjunto de dados
ReadWriteExplore	Concede acesso de leitura, gravação e exploração ao conteúdo no conjunto de dados
ReadWriteReshareExplore	Concede acesso de leitura, gravação, compartilhamento e exploração ao conteúdo no conjunto de dados

Datasource

Objeto

Uma fonte de dados do Power BI

Nome	Tipo	Description
connectionDetails	DatasourceConnectionDetails	Os detalhes da conexão da fonte de dados
connectionString	string	(Preterido) A cadeia de conexão da fonte de dados. Disponível somente para DirectQuery.
datasourceId	string (uuid)	A ID da fonte de dados associada, que está vazia quando não está associada a um gateway
datasourceType	string	O tipo de fonte de dados
gatewayId	string (uuid)	A ID do gateway associado, que está vazia quando não está associada a um gateway. Ao usar um cluster de gateway, a ID do gateway refere-se ao gateway primário (primeiro) no cluster e é semelhante à ID do cluster do gateway.
name	string	(Preterido) O nome da fonte de dados. Disponível somente para DirectQuery.

DatasourceConnectionDetails

Objeto

Os detalhes da conexão da fonte de dados do Power BI. Veja exemplos em Obter fontes de dados ou obter fontes de dados no grupo.

Nome	Tipo	Description
account	string	A conta de conexão
classInfo	string	As informações da classe de conexão
database	string	O banco de dados de conexão
domain	string	O domínio de conexão
emailAddress	string	O endereço de email de conexão
kind	string	O tipo de conexão
loginServer	string	O servidor de logon de conexão
path	string	O caminho da conexão
server	string	O servidor de conexão
url	string	A URL de conexão

DatasourceUsage

Objeto

Uso da fonte de dados

Nome	Tipo	Description
datasourceInstanceId	string (uuid)	A ID da instância da fonte de dados

DefaultDatasetStorageFormat

Enumeração

O formato de armazenamento do conjunto de dados padrão no grupo

Valor	Description
Small	Formato de armazenamento de conjunto de dados pequeno
Large	Formato de armazenamento de conjunto de dados grande

DependentDataflow

Objeto

Um fluxo de dados dependente do Power BI

Nome	Tipo	Description
groupId	string	A ID do grupo de destino
targetDataflowId	string	A ID do fluxo de dados de destino

DependentDatamart

Objeto

Um datamart dependente do Power BI

Nome	Tipo	Description
groupId	string	A ID do grupo de destino
targetDatamartId	string	A ID de datamart de destino

DependentDataset

Objeto

Um conjunto de dados dependente do Power BI

Nome	Tipo	Description
groupId	string	A ID do grupo de destino
targetDatasetId	string	A ID do conjunto de dados de destino

EndorsementDetails

Objeto

Detalhes de endosso do Power BI

Nome	Tipo	Description
certifiedBy	string	O usuário que certificou o item do Power BI (como um relatório ou um painel)
endorsement	string	O status de endosso

Expression

Objeto

Uma expressão de conjunto de dados

Nome	Tipo	Description
description	string	A descrição da expressão
expression	string	O valor da expressão
name	string	O nome da expressão

GroupUser

Objeto

Um usuário do Power BI com acesso ao workspace

Nome	Tipo	Description
displayName	string	Nome de exibição da entidade de segurança
emailAddress	string	Endereço de email do usuário
graphId	string	Identificador da entidade de segurança no Microsoft Graph. Disponível somente para APIs de administrador.
groupUserAccessRight	GroupUserAccessRight	O direito de acesso (nível de permissão) que um usuário tem no workspace
identifier	string	Identificador da entidade de segurança
principalType	PrincipalType	O tipo principal
profile	ServicePrincipalProfile	Um perfil de entidade de serviço do Power BI. Relevante apenas para solução de vários locatários do Power BI Embedded.
userType	string	Tipo do usuário.

GroupUserAccessRight

Enumeração

O direito de acesso (nível de permissão) que um usuário tem no workspace

Valor	Description
None	Sem acesso ao conteúdo do workspace
Member	Direitos de acesso de leitura, recompartilhamento e exploração (ReadReshareExplore) ao conteúdo do workspace
Admin	Direitos de administrador para o conteúdo do workspace
Contributor	Acesso de leitura e exploração (ReadExplore) ao conteúdo do workspace
Viewer	Acesso somente leitura (leitura) ao conteúdo do workspace

Measure

Objeto

Uma medida do Power BI

Nome	Tipo	Description
description	string	Opcional. A descrição da medida.
expression	string	Uma expressão DAX válida
formatString	string	Opcional. Uma cadeia de caracteres que descreve como o valor deve ser formatado quando ele é exibido conforme especificado em FORMAT_STRING.
isHidden	boolean	Opcional. Se a medida está oculta.
name	string pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$	O nome da medida

PrincipalType

Enumeração

O tipo principal

Valor	Description
None	Nenhum tipo de entidade de segurança. Use todo o acesso ao nível da organização.
User	Tipo de entidade de usuário
Group	Tipo de entidade de grupo
App	Tipo de entidade de serviço

ReportUser

Objeto

Uma entrada certa de acesso de usuário do Power BI para um relatório

Nome	Tipo	Description
displayName	string	Nome de exibição da entidade de segurança
emailAddress	string	Endereço de email do usuário
graphId	string	Identificador da entidade de segurança no Microsoft Graph. Disponível somente para APIs de administrador.
identifier	string	Identificador da entidade de segurança
principalType	PrincipalType	O tipo principal
profile	ServicePrincipalProfile	Um perfil de entidade de serviço do Power BI. Relevante apenas para solução de vários locatários do Power BI Embedded.
reportUserAccessRight	ReportUserAccessRight	O direito de acesso que o usuário tem para o relatório (nível de permissão)
userType	string	Tipo do usuário.

ReportUserAccessRight

Enumeração

O direito de acesso que o usuário tem para o relatório (nível de permissão)

Valor	Description
None	Nenhuma permissão para conteúdo no relatório
Read	Concede acesso de leitura ao conteúdo no relatório
ReadWrite	Concede acesso de leitura e gravação ao conteúdo no relatório
ReadReshare	Concede acesso de leitura e compartilhamento ao conteúdo no relatório
ReadCopy	Concede acesso de leitura e cópia ao conteúdo no relatório
Owner	Concede acesso de leitura, gravação e recompartilhamento ao conteúdo no relatório

Role

Objeto

Uma função na configuração RLS de um conjunto de dados

Nome	Tipo	Description
members	RoleMember	Uma matriz listando os membros da função
modelPermission	string	As permissões que a função tem no conjunto de dados. Por exemplo, Leitura
name	string	O nome da função
tablePermissions	RoleTablePermission	Uma matriz que lista todos os filtros definidos para a função

RoleMember

Objeto

Um membro de função

Nome	Tipo	Description
identityProvider	string	O provedor de identidade do membro da função
memberId	string	O GUID do membro de função conforme atribuído pelo provedor de identidade
memberName	string	O nome do membro da função
memberType	string	O tipo de membro de função (usuário ou grupo)

RoleTablePermission

Objeto

Um filtro de função

Nome	Tipo	Description
filterExpression	string	A expressão que filtra a tabela especificada no filtro
name	string	O nome da tabela especificada no filtro

Row

Objeto

Uma linha de dados em um conjunto de dados

Nome	Tipo	Description
id	string	A ID de linha exclusiva

SensitivityLabel

Objeto

Informações de rótulo de confidencialidade para um item do Power BI (como um relatório ou um painel)

Nome	Tipo	Description
labelId	string (uuid)	A ID do rótulo de confidencialidade

ServicePrincipalProfile

Objeto

Um perfil de entidade de serviço do Power BI. Relevante apenas para solução de vários locatários do Power BI Embedded.

Nome	Tipo	Description
displayName	string	O nome do perfil da entidade de serviço
id	string (uuid)	A ID do perfil da entidade de serviço

Table

Objeto

Uma tabela de conjunto de dados

Nome	Tipo	Description
columns	Column[]	O esquema de coluna para esta tabela
description	string	A descrição da tabela
isHidden	boolean	Opcional. Se essa tabela de conjunto de dados está oculta.
measures	Measure[]	As medidas dentro desta tabela
name	string pattern: ^[\x09\x0A\x0D\x20\x23\x2D\x30-\x39\x40-\x5A\x5E-\x5F\x61-\x7A\x7E-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]{1,100}$	O nome da tabela
rows	Row[]	As linhas de dados dentro desta tabela
source	ASMashupExpression[]	A origem da tabela

WorkspaceInfo

Objeto

Detalhes das informações do workspace

Nome	Tipo	Description
capacityId	string	A ID da capacidade do workspace
dashboards	WorkspaceInfoDashboard[]	Os painéis associados a esse workspace. A lista de propriedades de dashboard retornadas varia para diferentes chamadas à API, portanto, talvez você não veja todas as propriedades do painel em uma resposta à API.
dataRetrievalState	string	O estado de recuperação de dados do workspace
dataflows	WorkspaceInfoDataflow[]	Os fluxos de dados associados a esse workspace. A lista de propriedades de fluxo de dados retornadas varia para diferentes chamadas à API, portanto, talvez você não veja todas as propriedades de fluxo de dados em uma resposta à API.
datamarts	WorkspaceInfoDatamart[]	Os datamarts associados a esse workspace. A lista de propriedades de datamart retornadas varia para diferentes chamadas à API, portanto, talvez você não veja todas as propriedades de datamart em uma resposta à API.
datasets	WorkspaceInfoDataset[]	Os conjuntos de dados associados a esse workspace. A lista de propriedades de conjunto de dados retornadas varia para diferentes chamadas à API, portanto, talvez você não veja todas as propriedades do conjunto de dados em uma resposta à API.
defaultDatasetStorageFormat	DefaultDatasetStorageFormat	O formato de armazenamento do conjunto de dados padrão no workspace. Retornado somente quando `isOnDedicatedCapacity` é `true`
description	string	A descrição do workspace
id	string (uuid)	A ID do objeto do workspace
isOnDedicatedCapacity	boolean	Se o workspace é atribuído a uma capacidade dedicada
name	string	O nome do workspace
reports	WorkspaceInfoReport[]	Os relatórios associados a esse workspace. A lista de propriedades de relatório retornadas varia para chamadas de API diferentes, portanto, talvez você não veja todas as propriedades de relatório em uma resposta à API.
state	string	O estado do workspace
type	string	O tipo de workspace
users	GroupUser[]	Os usuários com acesso ao workspace. A lista é retornada somente quando solicitada explicitamente. Para recuperar uma lista de usuários para um workspace clássico, use a API do Graph do Azure Active Directory.

WorkspaceInfoDashboard

Objeto

Um painel do Power BI retornado pelas APIs WorkspaceInfo. A API retorna um subconjunto da lista a seguir de propriedades do painel. O subconjunto depende da API chamada, das permissões de chamador e da disponibilidade de dados no banco de dados do Power BI.

Nome	Tipo	Description
appId	string	A ID do aplicativo, retornada somente se o painel pertencer a um aplicativo
dataClassification	string	A marca de classificação de dados de um item do Power BI (como um relatório ou um painel)
displayName	string	O nome de exibição do painel
id	string (uuid)	A ID do painel
isReadOnly	boolean	Se o painel é somente leitura
sensitivityLabel	SensitivityLabel	O rótulo de confidencialidade
tags	string[] (uuid)	Os identificadores exclusivos para as marcas aplicadas em um item.
tiles	WorkspaceInfoTile[]	Os blocos que pertencem ao painel
users	DashboardUser[]	(Valor vazio) Os detalhes de acesso do usuário do painel. Essa propriedade será removida da resposta de conteúdo em uma versão futura. Você pode recuperar informações do usuário em um painel do Power BI usando o Obter Usuários do Painel como Administrador chamada à API ou a chamada à API PostWorkspaceInfo com o parâmetro `getArtifactUsers`.

WorkspaceInfoDataflow

Objeto

Os metadados de um fluxo de dados retornado pelas APIs de Informações do Workspace. Veja abaixo uma lista de propriedades que podem ser retornadas para um fluxo de dados. Somente um subconjunto das propriedades será retornado dependendo da API chamada, das permissões de chamador e da disponibilidade dos dados no banco de dados do Power BI.

Nome	Tipo	Description
configuredBy	string	O proprietário do fluxo de dados
datasourceUsages	DatasourceUsage[]	Os usos da fonte de dados
description	string	A descrição do fluxo de dados
endorsementDetails	EndorsementDetails	Os detalhes do endosso
misconfiguredDatasourceUsages	DatasourceUsage[]	Os usos mal configurados da fonte de dados
modelUrl	string	Uma URL para o arquivo de definição de fluxo de dados (model.json)
name	string	O nome do fluxo de dados
objectId	string (uuid)	A ID do fluxo de dados
sensitivityLabel	SensitivityLabel	O rótulo de confidencialidade
tags	string[] (uuid)	Os identificadores exclusivos para as marcas aplicadas em um item.
upstreamDataflows	DependentDataflow[]	A lista de todos os fluxos de dados dos quais este item depende
upstreamDatamarts	DependentDatamart[]	A lista de todas as datamarts que este item depende
users	DataflowUser[]	(Valor vazio) Os detalhes de acesso do usuário do fluxo de dados. Essa propriedade será removida da resposta de conteúdo em uma versão futura. Você pode recuperar informações do usuário sobre um fluxo de dados do Power BI usando a chamada Obter Usuários de Fluxo de Dados como Administrador chamada à API ou a chamada à API PostWorkspaceInfo com o parâmetro .

WorkspaceInfoDatamart

Objeto

Um datamart do Power BI retornado pelas APIs de Informações do Workspace. A API retorna um subconjunto da lista a seguir de propriedades de datamart. O subconjunto depende da API chamada, das permissões de chamador e da disponibilidade de dados no banco de dados do Power BI.

Nome	Tipo	Description
configuredBy	string	O nome do proprietário do datamart
configuredById	string	A ID do proprietário do datamart
datasourceUsages	DatasourceUsage[]	Os usos da fonte de dados
description	string	A descrição do datamart
endorsementDetails	EndorsementDetails	Os detalhes de endosso do datamart
id	string (uuid)	A ID do datamart
modifiedBy	string	O último usuário que modificou o datamart
modifiedById	string	A ID do último usuário que modificou o datamart
modifiedDateTime	string (date-time)	A data e a hora em que o datamart foi modificado pela última vez
name	string	O nome do datamart
sensitivityLabel	SensitivityLabel	O rótulo de confidencialidade de datamart
state	datamartState	O estado atual do datamart
status	datamartStatus	O status de datamart
suspendedBatchId	string	ID do lote suspensa datamart
tags	string[] (uuid)	Os identificadores exclusivos para as marcas aplicadas em um item.
type	datamartType	O tipo de datamart
upstreamDataflows	DependentDataflow[]	A lista de todos os fluxos de dados dos quais este item depende
upstreamDatamarts	DependentDatamart[]	A lista de todas as datamarts que este item depende
users	DatamartUser[]	Os detalhes de acesso do usuário para um datamart do Power BI.

WorkspaceInfoDataset

Objeto

Um conjunto de dados do Power BI retornado pelas APIs WorkspaceInfo. A API retorna um subconjunto da lista a seguir de propriedades do conjunto de dados. O subconjunto depende da API chamada, das permissões de chamador e da disponibilidade dos dados no banco de dados do Power BI.

Nome	Tipo	Description
ContentProviderType	string	Uma propriedade preterida que deve ser ignorada.
configuredBy	string	O proprietário do conjunto de dados
createdDate	string (date-time)	A data e a hora de criação do conjunto de dados
datasourceUsages	DatasourceUsage[]	Os usos da fonte de dados
description	string	A descrição do conjunto de dados
endorsementDetails	EndorsementDetails	Os detalhes do endosso
expressions	Expression[]	As expressões do conjunto de dados
id	string	A ID do conjunto de dados
misconfiguredDatasourceUsages	DatasourceUsage[]	Os usos mal configurados da fonte de dados
name	string	O nome do conjunto de dados
roles	Role[]	As funções do conjunto de dados
schemaMayNotBeUpToDate	boolean	Se o esquema do conjunto de dados pode não estar atualizado
schemaRetrievalError	string	O erro de recuperação de esquema do conjunto de dados
sensitivityLabel	SensitivityLabel	O rótulo de confidencialidade
tables	Table[]	As tabelas do conjunto de dados
tags	string[] (uuid)	Os identificadores exclusivos para as marcas aplicadas em um item.
targetStorageMode	string	O modo de armazenamento do conjunto de dados
upstreamDataflows	DependentDataflow[]	A lista de todos os fluxos de dados dos quais este item depende
upstreamDatamarts	DependentDatamart[]	A lista de todas as datamarts que este item depende
upstreamDatasets	DependentDataset[]	Os conjuntos de dados upstream
users	DatasetUser[]	(Valor vazio) Os detalhes de acesso do usuário do conjunto de dados. Essa propriedade será removida da resposta de conteúdo em uma versão futura. Você pode recuperar informações do usuário em um item do Power BI (como um relatório ou um painel) usando o Obter Usuários do Conjunto de Dados como Administrador API ou a API PostWorkspaceInfo com o parâmetro `getArtifactUsers`.

WorkspaceInfoReport

Objeto

Um relatório do Power BI retornado pelas APIs de Informações do Workspace. A API retorna um subconjunto da lista a seguir de propriedades de relatório. O subconjunto depende da API chamada, das permissões de chamador e da disponibilidade de dados no banco de dados do Power BI.

Nome	Tipo	Description
appId	string	A ID do aplicativo, retornada somente se o relatório pertencer a um aplicativo
createdBy	string	O proprietário do relatório. Disponível somente para relatórios criados após junho de 2019.
createdById	string	A ID do proprietário do relatório. Disponível somente para relatórios criados após junho de 2019.
createdDateTime	string (date-time)	A data e a hora de criação do relatório
datasetId	string	A ID do conjunto de dados do relatório
datasetWorkspaceId	string (uuid)	A ID do workspace do conjunto de dados relacionado, retornada somente se o conjunto de dados relacionado pertencer a um workspace diferente
description	string	A descrição do relatório
endorsementDetails	EndorsementDetails	Os detalhes do endosso
format	string	O tipo de formato de definição de relatório. Para PowerBIReport: PBIR PBIR-Legacy Para PaginatedReport: `RDL`
id	string (uuid)	A ID do relatório
isOwnedByMe	boolean	Indica se o usuário atual tem a capacidade de modificar ou criar uma cópia do relatório.
modifiedBy	string	O último usuário que modificou o relatório
modifiedById	string	A ID do último usuário que modificou o relatório
modifiedDateTime	string (date-time)	A data e a hora em que o relatório foi modificado pela última vez
name	string	O nome do relatório. Os relatórios do aplicativo começam com o prefixo [App].
originalReportId	string (uuid)	A ID do relatório real quando o workspace é publicado como um aplicativo.
reportType	enum: PaginatedReport PowerBIReport	O tipo de relatório
sensitivityLabel	SensitivityLabel	O rótulo de confidencialidade
tags	string[] (uuid)	Os identificadores exclusivos para as marcas aplicadas em um item.
users	ReportUser[]	(Valor vazio) Os detalhes de acesso do usuário para um relatório do Power BI. Essa propriedade será removida da resposta de conteúdo em uma versão futura. Você pode recuperar informações do usuário em um relatório do Power BI usando o Obter Usuários de Relatório como administrador chamada à API ou a chamada à API PostWorkspaceInfo com o parâmetro .

WorkspaceInfoResponse

Objeto

Resposta de informações do workspace

Nome	Tipo	Description
datasourceInstances	Datasource[]	As instâncias da fonte de dados associadas a essa verificação
misconfiguredDatasourceInstances	Datasource[]	As instâncias configuradas incorretamente da fonte de dados associadas a essa verificação
workspaces	WorkspaceInfo[]	As informações do workspace associadas a esta verificação

WorkspaceInfoTile

Objeto

Um bloco do Power BI retornado por APIs WorkspaceInfo

Nome	Tipo	Description
datasetId	string	A ID do conjunto de dados. Disponível somente para blocos criados a partir de um relatório ou usando um conjunto de dados, como blocos Q&A.
datasetWorkspaceId	string (uuid)	A ID do workspace do conjunto de dados relacionado, retornada somente se o conjunto de dados relacionado pertencer a um workspace diferente
id	string (uuid)	A ID do bloco
reportId	string (uuid)	A ID do relatório. Disponível apenas para blocos criados a partir de um relatório.
title	string	O nome de exibição do bloco

Compartilhar via

Admin - WorkspaceInfo GetScanResult

Permissões

Escopo necessário

Limitações

Parâmetros de URI

Respostas

Exemplos

Example

Solicitação de exemplo

Resposta de exemplo

Definições

ASMashupExpression

Column

DashboardUser

DashboardUserAccessRight

DataflowUser

DataflowUserAccessRight

datamartState

datamartStatus

datamartType

DatamartUser

DatamartUserAccessRight

DatasetUser

DatasetUserAccessRight

Datasource

DatasourceConnectionDetails

DatasourceUsage

DefaultDatasetStorageFormat

DependentDataflow

DependentDatamart

DependentDataset

EndorsementDetails

Expression

GroupUser

GroupUserAccessRight

Measure

PrincipalType

ReportUser

ReportUserAccessRight

Role

RoleMember

RoleTablePermission

Row

SensitivityLabel

ServicePrincipalProfile

Table

WorkspaceInfo

WorkspaceInfoDashboard

WorkspaceInfoDataflow

WorkspaceInfoDatamart

WorkspaceInfoDataset

WorkspaceInfoReport

WorkspaceInfoResponse

WorkspaceInfoTile