Admin - WorkspaceInfo GetScanResult
Obtém o resultado da verificação especificada.
Faça essa chamada à API somente após uma chamada bem-sucedida à API GetScanStatus . O resultado da verificação permanecerá disponível por 24 horas.
Permissões
O usuário deve ter direitos de administrador (como Administrador Global do Microsoft 365 ou Administrador de Serviços do Power BI) ou autenticar usando uma entidade de serviço.
Ao executar em autenticação de entidade de serviço, um aplicativo não deve ter nenhuma permissão de consentimento de administrador necessária para o Power BI definida 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 |
---|---|---|---|---|
scan
|
path | True |
string uuid |
A ID de verificação, que está incluída na resposta dos workspaces ou da chamada à API Administração - WorkspaceInfo PostWorkspaceInfo que disparou a verificação. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
OK |
Exemplos
Example
Sample Request
GET https://api.powerbi.com/v1.0/myorg/admin/workspaces/scanResult/e7d03602-4873-4760-b37e-1563ef5358e3
Sample Response
{
"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"
}
]
}
],
"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"
}
]
}
],
"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"
}
]
}
],
"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"
}
]
}
],
"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"
}
]
}
],
"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 |
---|---|
ASMashup |
Uma fonte de tabela de conjunto de dados |
Column |
Uma coluna de conjunto de dados |
Dashboard |
Uma entrada correta de acesso de usuário do Power BI para um dashboard |
Dashboard |
O direito de acesso que o usuário tem para o dashboard (nível de permissão) |
Dataflow |
Uma entrada correta de acesso de usuário do Power BI para um fluxo de dados |
Dataflow |
O direito de acesso que um usuário tem para o fluxo de dados (nível de permissão) |
datamart |
O estado atual do datamart |
datamart |
O datamart status |
datamart |
O tipo datamart |
Datamart |
Uma entrada correta de acesso de usuário do Power BI para um relatório |
Datamart |
O direito de acesso que o usuário tem para o datamart (nível de permissão) |
Dataset |
Uma entrada correta de acesso de usuário do Power BI para um conjunto de dados |
Dataset |
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 |
Datasource |
Os detalhes da conexão da fonte de dados do Power BI. Veja exemplos em Obter Fontes de Dados ou Obter Fontes de Dados em Grupo. |
Datasource |
Uso da fonte de dados |
Default |
O formato de armazenamento do conjunto de dados padrão no grupo |
Dependent |
Um fluxo de dados dependente do Power BI |
Dependent |
Um datamart dependente do Power BI |
Dependent |
Um conjunto de dados dependente do Power BI |
Endorsement |
Detalhes de endosso do Power BI |
Expression |
Uma expressão de conjunto de dados |
Group |
Um usuário do Power BI com acesso ao workspace |
Group |
O direito de acesso (nível de permissão) que um usuário tem no workspace |
Measure |
Uma medida do Power BI |
Principal |
O tipo de entidade de segurança |
Report |
Uma entrada correta de acesso de usuário do Power BI para um relatório |
Report |
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 |
Role |
Um membro de função |
Role |
Um filtro de função |
Row |
Uma linha de dados em um conjunto de dados |
Sensitivity |
Informações de rótulo de confidencialidade para um item do Power BI (como um relatório ou um dashboard) |
Service |
Um serviço do Power BI perfil principal. Relevante apenas para Power BI Embedded solução de várias locações. |
Table |
Uma tabela de conjunto de dados |
Workspace |
Detalhes das informações do workspace |
Workspace |
Um dashboard do Power BI retornado pelas APIs WorkspaceInfo. A API retorna um subconjunto da lista de propriedades de dashboard a seguir. O subconjunto depende da API chamada, das permissões de chamador e da disponibilidade de dados no banco de dados do Power BI. |
Workspace |
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. |
Workspace |
Um datamart do Power BI retornado pelas APIs de Informações do Workspace. A API retorna um subconjunto da lista a seguir de propriedades datamart. O subconjunto depende da API chamada, das permissões de chamador e da disponibilidade de dados no banco de dados do Power BI. |
Workspace |
Um conjunto de dados do Power BI retornado pelas APIs WorkspaceInfo. A API retorna um subconjunto da lista de propriedades do conjunto de dados a seguir. O subconjunto depende da API chamada, das permissões de chamador e da disponibilidade dos dados no banco de dados do Power BI. |
Workspace |
Um relatório do Power BI retornado pelas APIs de Informações do Workspace. A API retorna um subconjunto da lista de propriedades de relatório a seguir. O subconjunto depende da API chamada, das permissões de chamador e da disponibilidade de dados no banco de dados do Power BI. |
Workspace |
Resposta de informações do workspace |
Workspace |
Um bloco do Power BI retornado pelas APIs WorkspaceInfo |
ASMashupExpression
Uma fonte de tabela de conjunto de dados
Nome | Tipo | Description |
---|---|---|
expression |
string |
A expressão de origem |
Column
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 é |
name |
string |
O nome da coluna |
sortByColumn |
string |
Opcional. Nome da cadeia de caracteres de uma coluna na mesma tabela para ser usada para classificar a coluna atual. |
summarizeBy |
string |
Opcional. A função de agregação a ser usada para resumir esta coluna. |
DashboardUser
Uma entrada correta de acesso de usuário do Power BI para um dashboard
Nome | Tipo | Description |
---|---|---|
dashboardUserAccessRight |
O direito de acesso que o usuário tem para o dashboard (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 apenas para APIs de administrador. |
identifier |
string |
Identificador da entidade de segurança |
principalType |
O tipo de entidade de segurança |
|
profile |
Um serviço do Power BI perfil principal. Relevante apenas para Power BI Embedded solução de várias locações. |
|
userType |
string |
Tipo do usuário. |
DashboardUserAccessRight
O direito de acesso que o usuário tem para o dashboard (nível de permissão)
Nome | Tipo | Description |
---|---|---|
None |
string |
Nenhuma permissão para conteúdo no dashboard |
Owner |
string |
Concede acesso de leitura, gravação e recompartilhamento ao conteúdo no relatório |
Read |
string |
Concede acesso de leitura ao conteúdo no dashboard |
ReadCopy |
string |
Concede acesso de leitura e cópia ao conteúdo no dashboard |
ReadReshare |
string |
Concede acesso de leitura e compartilhamento ao conteúdo no dashboard |
ReadWrite |
string |
Concede acesso de leitura e gravação ao conteúdo no dashboard |
DataflowUser
Uma entrada correta de acesso de usuário do Power BI para um fluxo de dados
Nome | Tipo | Description |
---|---|---|
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 apenas para APIs de administrador. |
identifier |
string |
Identificador da entidade de segurança |
principalType |
O tipo de entidade de segurança |
|
profile |
Um serviço do Power BI perfil principal. Relevante apenas para Power BI Embedded solução de várias locações. |
|
userType |
string |
Tipo do usuário. |
DataflowUserAccessRight
O direito de acesso que um usuário tem para o fluxo de dados (nível de permissão)
Nome | Tipo | Description |
---|---|---|
None |
string |
Remove a permissão para o conteúdo no fluxo de dados |
Owner |
string |
Concede acesso de leitura, gravação e recompartilhamento ao conteúdo no fluxo de dados |
Read |
string |
Concede acesso de leitura ao conteúdo no fluxo de dados |
ReadReshare |
string |
Concede acesso de leitura e recompartilhamento ao conteúdo no fluxo de dados |
ReadWrite |
string |
Concede acesso de leitura e gravação ao conteúdo no fluxo de dados |
datamartState
O estado atual do datamart
Nome | Tipo | Description |
---|---|---|
Active |
string |
O datamart está ativo |
Deleted |
string |
O datamart foi excluído |
Evicted |
string |
O datamart foi removido |
Initialized |
string |
O datamart foi inicializado |
Invalid |
string |
O datamart tem um estado inválido |
Migrating |
string |
O datamart está migrando |
datamartStatus
O datamart status
Nome | Tipo | Description |
---|---|---|
Available |
string |
O datamart está disponível |
Error |
string |
O datamart tem erro status |
InProgress |
string |
O datamart está em andamento |
Invalid |
string |
O datamart tem status inválidos |
NoCapacity |
string |
O datamart não tem capacidade |
OutOfRegion |
string |
O datamart está fora da região |
SuspendedInCriticalPhase |
string |
O datamart é suspenso em fase crítica |
datamartType
O tipo datamart
Nome | Tipo | Description |
---|---|---|
Dataverse |
string |
O datamart é do tipo Dataverse |
Datawarehouse |
string |
O datamart é do tipo Datawarehouse |
Ignore |
string |
O datamart não tem nenhum tipo |
Lakehouse |
string |
O datamart é do tipo Lakehouse |
Sql |
string |
O datamart é do tipo Sql |
Unset |
string |
O tipo datamart não foi definido |
DatamartUser
Uma entrada correta de acesso de usuário do Power BI para um relatório
Nome | Tipo | Description |
---|---|---|
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 apenas para APIs de administrador. |
identifier |
string |
Identificador da entidade de segurança |
principalType |
O tipo de entidade de segurança |
|
profile |
Um serviço do Power BI perfil principal. Relevante apenas para Power BI Embedded solução de várias locações. |
|
userType |
string |
Tipo do usuário. |
DatamartUserAccessRight
O direito de acesso que o usuário tem para o datamart (nível de permissão)
Nome | Tipo | Description |
---|---|---|
Explore |
string |
Permite explorar o acesso ao conteúdo no datamart |
None |
string |
Nenhuma permissão para conteúdo no datamart |
Read |
string |
Concede acesso de leitura ao conteúdo no datamart |
ReadExplore |
string |
Concede acesso de leitura e exploração ao conteúdo no datamart |
ReadReshare |
string |
Concede acesso de leitura e recompartilhamento ao conteúdo no datamart |
ReadReshareExplore |
string |
Concede leitura e recompartilhamento e explora o acesso ao conteúdo no datamart |
ReadWrite |
string |
Concede acesso de leitura e gravação ao conteúdo no datamart |
ReadWriteExplore |
string |
Concede acesso de leitura e gravação e exploração ao conteúdo no datamart |
ReadWriteReshare |
string |
Concede acesso de leitura e gravação e recompartilhamento ao conteúdo no datamart |
ReadWriteReshareExplore |
string |
Concede leitura, gravação e recompartilhamento e explora o acesso ao conteúdo no datamart |
Reshare |
string |
Concede acesso de recompartilhamento ao conteúdo no datamart |
Write |
string |
Concede acesso de gravação ao conteúdo no datamart |
DatasetUser
Uma entrada correta de acesso de usuário do Power BI para um conjunto de dados
Nome | Tipo | Description |
---|---|---|
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 apenas para APIs de administrador. |
identifier |
string |
Identificador da entidade de segurança |
principalType |
O tipo de entidade de segurança |
|
profile |
Um serviço do Power BI perfil principal. Relevante apenas para Power BI Embedded solução de várias locações. |
|
userType |
string |
Tipo do usuário. |
DatasetUserAccessRight
O direito de acesso que o usuário tem para o conjunto de dados (nível de permissão)
Nome | Tipo | Description |
---|---|---|
None |
string |
Remove a permissão para o conteúdo no conjunto de dados |
Read |
string |
Concede acesso de leitura ao conteúdo no conjunto de dados |
ReadExplore |
string |
Concede acesso de Leitura e Exploração ao conteúdo no conjunto de dados |
ReadReshare |
string |
Concede acesso de leitura e compartilhamento ao conteúdo no conjunto de dados |
ReadReshareExplore |
string |
Concede acesso de Leitura, Recompartilhamento e Exploração ao conteúdo no conjunto de dados |
ReadWrite |
string |
Concede acesso de leitura e gravação ao conteúdo no conjunto de dados |
ReadWriteExplore |
string |
Concede acesso de Leitura, Gravação e Exploração ao conteúdo no conjunto de dados |
ReadWriteReshare |
string |
Concede acesso de leitura, gravação e recompartilhamento ao conteúdo no conjunto de dados |
ReadWriteReshareExplore |
string |
Concede acesso de Leitura, Gravação, Recompartilhamento e Explorar ao conteúdo no conjunto de dados |
Datasource
Uma fonte de dados do Power BI
Nome | Tipo | Description |
---|---|---|
connectionDetails |
Os detalhes da conexão da fonte de dados |
|
connectionString |
string |
(Preterido) A fonte de dados cadeia de conexão. Disponível apenas para DirectQuery. |
datasourceId |
string |
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 |
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 de gateway. |
name |
string |
(Preterido) O nome da fonte de dados. Disponível apenas para DirectQuery. |
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 em 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
Uso da fonte de dados
Nome | Tipo | Description |
---|---|---|
datasourceInstanceId |
string |
A ID da instância da fonte de dados |
DefaultDatasetStorageFormat
O formato de armazenamento do conjunto de dados padrão no grupo
Nome | Tipo | Description |
---|---|---|
Large |
string |
Formato de armazenamento de conjunto de dados grande |
Small |
string |
Formato de armazenamento de conjunto de dados pequeno |
DependentDataflow
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
Um datamart dependente do Power BI
Nome | Tipo | Description |
---|---|---|
groupId |
string |
A ID do grupo de destino |
targetDatamartId |
string |
A ID do datamart de destino |
DependentDataset
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
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 dashboard) |
endorsement |
string |
O status de endosso |
Expression
Uma expressão de conjunto de dados
Nome | Tipo | Description |
---|---|---|
description |
string |
A descrição da expressão |
expression |
Uma fonte de tabela de conjunto de dados |
|
name |
string |
O nome da expressão |
GroupUser
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 apenas para APIs de administrador. |
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 |
O tipo de entidade de segurança |
|
profile |
Um serviço do Power BI perfil principal. Relevante apenas para Power BI Embedded solução de várias locações. |
|
userType |
string |
Tipo do usuário. |
GroupUserAccessRight
O direito de acesso (nível de permissão) que um usuário tem no workspace
Nome | Tipo | Description |
---|---|---|
Admin |
string |
Direitos de administrador para o conteúdo do workspace |
Contributor |
string |
Acesso de leitura e exploração (ReadExplore) ao conteúdo do workspace |
Member |
string |
Direitos de acesso de leitura, recompartilhamento e exploração (ReadReshareExplore) ao conteúdo do workspace |
None |
string |
Sem acesso ao conteúdo do workspace |
Viewer |
string |
Acesso somente leitura (leitura) ao conteúdo do workspace |
Measure
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 |
O nome da medida |
PrincipalType
O tipo de entidade de segurança
Nome | Tipo | Description |
---|---|---|
App |
string |
Tipo de entidade de serviço |
Group |
string |
Tipo de entidade de grupo |
None |
string |
Nenhum tipo de entidade de segurança. Use para acesso em nível de organização inteiro. |
User |
string |
Tipo de entidade de usuário |
ReportUser
Uma entrada correta 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 apenas para APIs de administrador. |
identifier |
string |
Identificador da entidade de segurança |
principalType |
O tipo de entidade de segurança |
|
profile |
Um serviço do Power BI perfil principal. Relevante apenas para Power BI Embedded solução de várias locações. |
|
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
O direito de acesso que o usuário tem para o relatório (nível de permissão)
Nome | Tipo | Description |
---|---|---|
None |
string |
Nenhuma permissão para conteúdo no relatório |
Owner |
string |
Concede acesso de leitura, gravação e recompartilhamento ao conteúdo no relatório |
Read |
string |
Concede acesso de leitura ao conteúdo no relatório |
ReadCopy |
string |
Concede acesso de leitura e cópia ao conteúdo no relatório |
ReadReshare |
string |
Concede acesso de leitura e recompartilhamento ao conteúdo no relatório |
ReadWrite |
string |
Concede acesso de leitura e gravação ao conteúdo no relatório |
Role
Uma função na configuração RLS de um conjunto de dados
Nome | Tipo | Description |
---|---|---|
members |
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 |
Uma matriz que lista todos os filtros definidos para a função |
RoleMember
Um membro de função
Nome | Tipo | Description |
---|---|---|
identityProvider |
string |
O provedor de identidade de membro de função |
memberId |
string |
O GUID do membro da 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
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
Uma linha de dados em um conjunto de dados
Nome | Tipo | Description |
---|---|---|
id |
string |
A ID de linha exclusiva |
SensitivityLabel
Informações de rótulo de confidencialidade para um item do Power BI (como um relatório ou um dashboard)
Nome | Tipo | Description |
---|---|---|
labelId |
string |
A ID do rótulo de confidencialidade |
ServicePrincipalProfile
Um serviço do Power BI perfil principal. Relevante apenas para Power BI Embedded solução de várias locações.
Nome | Tipo | Description |
---|---|---|
displayName |
string |
O nome do perfil da entidade de serviço |
id |
string |
A ID do perfil da entidade de serviço |
Table
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 |
O nome da tabela |
rows |
Row[] |
As linhas de dados dentro desta tabela |
source |
A origem da tabela |
WorkspaceInfo
Detalhes das informações do workspace
Nome | Tipo | Description |
---|---|---|
capacityId |
string |
A ID da capacidade do workspace |
dashboards |
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 dashboard em uma resposta à API. |
|
dataRetrievalState |
string |
O estado de recuperação de dados do workspace |
dataflows |
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 |
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 datamart em uma resposta à API. |
|
datasets |
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 |
O formato de armazenamento do conjunto de dados padrão no workspace. Retornado somente quando |
|
description |
string |
A descrição do workspace |
id |
string |
A ID do objeto do workspace |
isOnDedicatedCapacity |
boolean |
Se o workspace é atribuído a uma capacidade dedicada |
name |
string |
O nome do workspace |
reports |
Os relatórios associados a esse workspace. A lista de propriedades de relatório retornadas varia para diferentes chamadas à API, portanto, talvez você não veja todas as propriedades do relatório em uma resposta à API. |
|
state |
string |
O estado do workspace |
type |
string |
O tipo de workspace |
users |
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 o API do Graph do Azure Active Directory. |
WorkspaceInfoDashboard
Um dashboard do Power BI retornado pelas APIs WorkspaceInfo. A API retorna um subconjunto da lista de propriedades de dashboard a seguir. 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 dashboard 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 dashboard) |
displayName |
string |
O nome de exibição do dashboard |
id |
string |
A ID do dashboard |
isReadOnly |
boolean |
Se o dashboard é somente leitura |
sensitivityLabel |
O rótulo de confidencialidade |
|
tiles |
Os blocos que pertencem ao dashboard |
|
users |
(Valor vazio) O dashboard detalhes de acesso do usuário. Essa propriedade será removida da resposta de carga em uma versão futura. Você pode recuperar informações do usuário em um dashboard do Power BI usando a chamada Obter Usuários do Painel como Administração API ou a chamada à API PostWorkspaceInfo com o |
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.
Nome | Tipo | Description |
---|---|---|
configuredBy |
string |
O proprietário do fluxo de dados |
datasourceUsages |
Os usos da fonte de dados |
|
description |
string |
A descrição do fluxo de dados |
endorsementDetails |
Os detalhes do endosso |
|
misconfiguredDatasourceUsages |
Os usos configurados incorretamente da fonte de dados |
|
modelUrl |
string |
Uma URL para o arquivo de definição de fluxo de dados (model.json) |
modifiedBy |
string |
O usuário que modificou o fluxo de dados |
modifiedDateTime |
string |
A data e a hora em que o fluxo de dados foi modificado pela última vez |
name |
string |
O nome do fluxo de dados |
objectId |
string |
A ID do fluxo de dados |
sensitivityLabel |
O rótulo de confidencialidade |
|
upstreamDataflows |
A lista de todos os fluxos de dados dos quais este item depende |
|
upstreamDatamarts |
A lista de todos os datamarts do qual este item depende |
|
users |
(Valor vazio) Os detalhes de acesso do usuário do fluxo de dados. Essa propriedade será removida da resposta de carga em uma versão futura. Você pode recuperar informações do usuário em um fluxo de dados do Power BI usando a chamada Obter Usuários de Fluxo de Dados como Administração chamada à API ou a chamada à API PostWorkspaceInfo com o |
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 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 |
Os usos da fonte de dados |
|
description |
string |
A descrição do datamart |
endorsementDetails |
Os detalhes de endosso do datamart |
|
id |
string |
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 |
A data e hora em que o datamart foi modificado pela última vez |
name |
string |
O nome do datamart |
sensitivityLabel |
O rótulo de confidencialidade de datamart |
|
state |
O estado atual do datamart |
|
status |
O datamart status |
|
suspendedBatchId |
string |
ID do lote suspensa datamart |
type |
O tipo datamart |
|
upstreamDataflows |
A lista de todos os fluxos de dados dos quais este item depende |
|
upstreamDatamarts |
A lista de todos os datamarts do qual este item depende |
|
users |
Os detalhes de acesso do usuário para um datamart do Power BI. |
WorkspaceInfoDataset
Um conjunto de dados do Power BI retornado pelas APIs WorkspaceInfo. A API retorna um subconjunto da lista de propriedades do conjunto de dados a seguir. 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 |
O tipo de provedor de conteúdo para o conjunto de dados |
CreatedDate |
string |
A data e hora de criação do conjunto de dados |
configuredBy |
string |
O proprietário do conjunto de dados |
datasourceUsages |
Os usos da fonte de dados |
|
description |
string |
A descrição do conjunto de dados |
endorsementDetails |
Os detalhes do endosso |
|
expressions |
As expressões de conjunto de dados |
|
id |
string |
A ID do conjunto de dados |
misconfiguredDatasourceUsages |
Os usos configurados incorretamente da fonte de dados |
|
name |
string |
O nome do conjunto de dados |
roles |
Role[] |
As funções de 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 |
O rótulo de confidencialidade |
|
tables |
Table[] |
As tabelas do conjunto de dados |
targetStorageMode |
string |
O modo de armazenamento do conjunto de dados |
upstreamDataflows |
A lista de todos os fluxos de dados dos quais este item depende |
|
upstreamDatamarts |
A lista de todos os datamarts do qual este item depende |
|
upstreamDatasets |
Os conjuntos de dados upstream |
|
users |
(Valor vazio) Os detalhes de acesso do usuário do conjunto de dados. Essa propriedade será removida da resposta de carga 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 dashboard) usando a API Obter Usuários do Conjunto de Dados como Administração ou a API PostWorkspaceInfo com o |
WorkspaceInfoReport
Um relatório do Power BI retornado pelas APIs de Informações do Workspace. A API retorna um subconjunto da lista de propriedades de relatório a seguir. 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 |
A data e hora de criação do relatório |
datasetId |
string |
A ID do conjunto de dados do relatório |
datasetWorkspaceId |
string |
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 |
Os detalhes do endosso |
|
id |
string |
A ID do relatório |
isOwnedByMe |
boolean |
Determine se o relatório é criado pelo usuário atual. |
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 |
A data e a hora em que o relatório foi modificado pela última vez |
name |
string |
O nome do relatório |
originalReportId |
string |
A ID do relatório real quando o workspace é publicado como um aplicativo. |
reportType |
enum:
|
O tipo de relatório |
sensitivityLabel |
O rótulo de confidencialidade |
|
users |
(Valor vazio) Os detalhes de acesso do usuário para um relatório do Power BI. Essa propriedade será removida da resposta de carga em uma versão futura. Você pode recuperar informações do usuário em um relatório do Power BI usando a chamada Obter Usuários de Relatório como Administração API ou a chamada à API PostWorkspaceInfo com o |
WorkspaceInfoResponse
Resposta de informações do workspace
Nome | Tipo | Description |
---|---|---|
datasourceInstances |
As instâncias de fonte de dados associadas a essa verificação |
|
misconfiguredDatasourceInstances |
As instâncias configuradas incorretamente da fonte de dados associadas a esta verificação |
|
workspaces |
As informações do workspace associadas a esta verificação |
WorkspaceInfoTile
Um bloco do Power BI retornado pelas APIs WorkspaceInfo
Nome | Tipo | Description |
---|---|---|
datasetId |
string |
A ID do conjunto de dados. Disponível apenas para blocos criados a partir de um relatório ou usando um conjunto de dados, como blocos Q&A. |
datasetWorkspaceId |
string |
A ID do workspace do conjunto de dados relacionado, retornada somente se o conjunto de dados relacionado pertencer a um workspace diferente |
id |
string |
A ID do bloco |
reportId |
string |
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 |