Admin - WorkspaceInfo GetScanResult

  • Ссылка
Service:
Power BI REST APIs
API Version:
v1.0

Возвращает результат проверки для указанной проверки.

Этот вызов API выполняется только после успешного вызова API GetScanStatus . Результат сканирования останется доступным в течение 24 часов.

Разрешения

Пользователь должен иметь права администратора (например, глобальный администратор Microsoft 365 или администратор службы Power BI) или пройти проверку подлинности с помощью субъекта-службы.

При выполнении проверки подлинности субъекта-службы приложение не должно иметь необходимых разрешений с согласием администратора для Power BI в портал Azure.

Требуемая область

Tenant.Read.All или Tenant.ReadWrite.All

Применимо только при проверке подлинности с помощью стандартного маркера доступа делегированного администратора. Не должен присутствовать, если используется проверка подлинности через субъект-службу.

Ограничения

Максимум 500 запросов в час. 

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

Параметры URI

Имя В Обязательно Тип Описание
scanId
 path True

string

uuid

Идентификатор сканирования, который включен в ответ от рабочих областей или вызов API Администратор WorkspaceInfo PostWorkspaceInfo, который активировал проверку.

Ответы

Имя Тип Описание
200 OK

WorkspaceInfoResponse

ОК

Примеры

Example

Sample Request

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

Sample Response

Status code:
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"
            }
          ]
        }
      ],
      "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"
    }
  ]
}

Определения

Имя Описание
ASMashupExpression

Источник таблицы набора данных
Column

Столбец набора данных
DashboardUser

Запись права доступа пользователя Power BI для панели мониторинга
DashboardUserAccessRight

Право доступа, которое пользователь имеет для панели мониторинга (уровень разрешений)
DataflowUser

Запись права доступа пользователя Power BI для потока данных
DataflowUserAccessRight

Право доступа, которое пользователь имеет для потока данных (уровень разрешений)
datamartState

Текущее состояние объекта данных
datamartStatus

Состояние объекта данных
datamartType

Тип объекта данных
DatamartUser

Запись права доступа пользователя Power BI для отчета
DatamartUserAccessRight

Право доступа, которое пользователь имеет для объекта datamart (уровень разрешений)
DatasetUser

Запись права доступа пользователя Power BI для набора данных
DatasetUserAccessRight

Право доступа, которое пользователь имеет для набора данных (уровень разрешений)
Datasource

Источник данных Power BI
DatasourceConnectionDetails

Сведения о подключении к источнику данных Power BI. Примеры см. в разделах Получение источников данных или Получение источников данных в группе.
DatasourceUsage

Использование источника данных
DefaultDatasetStorageFormat

Формат хранения набора данных по умолчанию в группе
DependentDataflow

Поток данных, зависимый от Power BI
DependentDatamart

Зависимый объект данных Power BI
DependentDataset

Набор данных, зависимый от Power BI
EndorsementDetails

Сведения о подтверждении Power BI
Expression

Выражение набора данных
GroupUser

Пользователь Power BI с доступом к рабочей области
GroupUserAccessRight

Право доступа (уровень разрешений), которое пользователь имеет в рабочей области
Measure

Мера Power BI
PrincipalType

Тип участника
ReportUser

Запись права доступа пользователя Power BI для отчета
ReportUserAccessRight

Право доступа, которое пользователь имеет для отчета (уровень разрешений)
Role

Роль в конфигурации RLS набора данных
RoleMember

Член роли
RoleTablePermission

Фильтр ролей
Row

Строка данных в наборе данных
SensitivityLabel

Сведения о метках конфиденциальности для элемента Power BI (например, отчета или панели мониторинга)
ServicePrincipalProfile

Профиль субъекта служба Power BI. Применимо только для решения Power BI Embedded мультитенантности.
Table

Таблица наборов данных
WorkspaceInfo

Сведения о рабочей области
WorkspaceInfoDashboard

Панель мониторинга Power BI, возвращенная API WorkspaceInfo. API возвращает подмножество из следующего списка свойств панели мониторинга. Подмножество зависит от вызываемого API, разрешений вызывающей стороны и доступности данных в базе данных Power BI.
WorkspaceInfoDataflow

Метаданные потока данных, возвращаемые API сведений о рабочей области. Ниже приведен список свойств, которые могут быть возвращены для потока данных. Возвращается только подмножество свойств в зависимости от вызываемого API, разрешений вызывающего объекта и доступности данных в базе данных Power BI.
WorkspaceInfoDatamart

Объект данных Power BI, возвращаемый API сведений о рабочей области. API возвращает подмножество из следующего списка свойств datamart. Подмножество зависит от вызываемого API, разрешений вызывающей стороны и доступности данных в базе данных Power BI.
WorkspaceInfoDataset

Набор данных Power BI, возвращаемый API WorkspaceInfo. API возвращает подмножество из следующего списка свойств набора данных. Подмножество зависит от вызываемого API, разрешений вызывающей стороны и доступности данных в базе данных Power BI.
WorkspaceInfoReport

Отчет Power BI, возвращенный API сведений о рабочей области. API возвращает подмножество из следующего списка свойств отчета. Подмножество зависит от вызываемого API, разрешений вызывающей стороны и доступности данных в базе данных Power BI.
WorkspaceInfoResponse

Ответ сведений о рабочей области
WorkspaceInfoTile

Плитка Power BI, возвращенная API WorkspaceInfo

ASMashupExpression

Источник таблицы набора данных

Имя Тип Описание
expression

string

Исходное выражение

Column

Столбец набора данных

Имя Тип Описание
dataCategory

string

Необязательный элемент. Строковое значение, используемое для категории данных, которая описывает данные в этом столбце.
dataType

string

Тип данных столбца
formatString

string

Необязательный элемент. Формат столбца, указанный в FORMAT_STRING.
isHidden

boolean

Необязательный элемент. Является ли столбец скрытым. Значение по умолчанию — false.
name

string

Имя столбца
sortByColumn

string

Необязательный элемент. Строка, представляющая собой название столбца в той же таблице, который нужно использовать для сортировки текущего столбца.
summarizeBy

string

Необязательный элемент. Агрегатная функция, используемая для суммирования этого столбца.

DashboardUser

Запись права доступа пользователя Power BI для панели мониторинга

Имя Тип Описание
dashboardUserAccessRight

DashboardUserAccessRight

Право доступа, которое пользователь имеет для панели мониторинга (уровень разрешений)
displayName

string

Отображаемое имя участника
emailAddress

string

Адрес электронной почты пользователя
graphId

string

Идентификатор участника в Microsoft Graph. Доступно только для api-интерфейсов администратора.
identifier

string

Идентификатор субъекта
principalType

PrincipalType

Тип участника
profile

ServicePrincipalProfile

Профиль субъекта служба Power BI. Применимо только для решения Power BI Embedded мультитенантности.
userType

string

Тип пользователя.

DashboardUserAccessRight

Право доступа, которое пользователь имеет для панели мониторинга (уровень разрешений)

Имя Тип Описание
None

string

Нет разрешений на содержимое на панели мониторинга
Owner

string

Предоставляет доступ на чтение, запись и повторное предоставление общего доступа к содержимому в отчете
Read

string

Предоставляет доступ на чтение к содержимому на панели мониторинга
ReadCopy

string

Предоставляет доступ на чтение и копирование содержимого на панели мониторинга
ReadReshare

string

Предоставляет доступ на чтение и повторное предоставление общего доступа к содержимому на панели мониторинга
ReadWrite

string

Предоставляет доступ на чтение и запись к содержимому на панели мониторинга

DataflowUser

Запись права доступа пользователя Power BI для потока данных

Имя Тип Описание
DataflowUserAccessRight

DataflowUserAccessRight

Право доступа, которое пользователь имеет для потока данных (уровень разрешений)
displayName

string

Отображаемое имя участника
emailAddress

string

Адрес электронной почты пользователя
graphId

string

Идентификатор участника в Microsoft Graph. Доступно только для api-интерфейсов администратора.
identifier

string

Идентификатор субъекта
principalType

PrincipalType

Тип участника
profile

ServicePrincipalProfile

Профиль субъекта служба Power BI. Применимо только для решения Power BI Embedded мультитенантности.
userType

string

Тип пользователя.

DataflowUserAccessRight

Право доступа, которое пользователь имеет для потока данных (уровень разрешений)

Имя Тип Описание
None

string

Удаляет разрешение на содержимое в потоке данных.
Owner

string

Предоставляет доступ на чтение, запись и повторное предоставление общего доступа к содержимому в потоке данных
Read

string

Предоставляет доступ на чтение содержимому в потоке данных
ReadReshare

string

Предоставляет доступ на чтение и повторное предоставление общего доступа к содержимому в потоке данных
ReadWrite

string

Предоставляет доступ на чтение и запись для содержимого в потоке данных

datamartState

Текущее состояние объекта данных

Имя Тип Описание
Active

string

Объект данных активен
Deleted

string

Объект datamart был удален
Evicted

string

Объект datamart был вытеслен
Initialized

string

Объект datamart инициализирован
Invalid

string

Объект данных имеет недопустимое состояние
Migrating

string

Объект datamart выполняет миграцию

datamartStatus

Состояние объекта данных

Имя Тип Описание
Available

string

Доступный объект datamart
Error

string

Объект datamart имеет состояние ошибки
InProgress

string

Объект данных находится в процессе выполнения
Invalid

string

Объект данных имеет недопустимое состояние
NoCapacity

string

Хранилище данных не имеет емкости
OutOfRegion

string

Объект данных находится вне региона
SuspendedInCriticalPhase

string

Объект данных приостановлен на критическом этапе

datamartType

Тип объекта данных

Имя Тип Описание
Dataverse

string

Объект datamart имеет тип Dataverse.
Datawarehouse

string

Объект данных имеет тип Datawarehouse.
Ignore

string

Объект данных не имеет типа
Lakehouse

string

Объект данных имеет тип Lakehouse.
Sql

string

Объект datamart имеет тип Sql.
Unset

string

Тип datamart был unset

DatamartUser

Запись права доступа пользователя Power BI для отчета

Имя Тип Описание
datamartUserAccessRight

DatamartUserAccessRight

Право доступа, которое пользователь имеет для объекта datamart (уровень разрешений)
displayName

string

Отображаемое имя участника
emailAddress

string

Адрес электронной почты пользователя
graphId

string

Идентификатор участника в Microsoft Graph. Доступно только для api-интерфейсов администратора.
identifier

string

Идентификатор субъекта
principalType

PrincipalType

Тип участника
profile

ServicePrincipalProfile

Профиль субъекта служба Power BI. Применимо только для решения Power BI Embedded мультитенантности.
userType

string

Тип пользователя.

DatamartUserAccessRight

Право доступа, которое пользователь имеет для объекта datamart (уровень разрешений)

Имя Тип Описание
Explore

string

Предоставляет доступ к просмотру содержимого в datamart
None

string

Нет разрешений на содержимое в datamart
Read

string

Предоставляет доступ на чтение к содержимому в datamart
ReadExplore

string

Предоставляет доступ на чтение и изучение содержимого в datamart
ReadReshare

string

Предоставляет доступ на чтение и повторное предоставление общего доступа к содержимому в datamart
ReadReshareExplore

string

Предоставляет доступ для чтения и повторного доступа к содержимому в datamart, а также доступ к ним
ReadWrite

string

Предоставляет доступ на чтение и запись к содержимому в datamart
ReadWriteExplore

string

Предоставляет доступ на чтение и запись, а также просмотр содержимого в datamart
ReadWriteReshare

string

Предоставляет доступ для чтения и записи и повторного доступа к содержимому в datamart.
ReadWriteReshareExplore

string

Предоставляет доступ для чтения, записи и повторного доступа к содержимому в datamart, а также для изучения.
Reshare

string

Предоставляет общий доступ к содержимому в datamart
Write

string

Предоставляет доступ на запись к содержимому в datamart

DatasetUser

Запись права доступа пользователя Power BI для набора данных

Имя Тип Описание
datasetUserAccessRight

DatasetUserAccessRight

Право доступа, которое пользователь имеет для набора данных (уровень разрешений)
displayName

string

Отображаемое имя участника
emailAddress

string

Адрес электронной почты пользователя
graphId

string

Идентификатор участника в Microsoft Graph. Доступно только для api-интерфейсов администратора.
identifier

string

Идентификатор субъекта
principalType

PrincipalType

Тип участника
profile

ServicePrincipalProfile

Профиль субъекта служба Power BI. Применимо только для решения Power BI Embedded мультитенантности.
userType

string

Тип пользователя.

DatasetUserAccessRight

Право доступа, которое пользователь имеет для набора данных (уровень разрешений)

Имя Тип Описание
None

string

Удаляет разрешение на содержимое в наборе данных.
Read

string

Предоставляет доступ на чтение содержимого в наборе данных.
ReadExplore

string

Предоставляет доступ на чтение и просмотр к содержимому в наборе данных.
ReadReshare

string

Предоставляет доступ для чтения и повторного доступа к содержимому в наборе данных.
ReadReshareExplore

string

Предоставляет доступ на чтение, повторное предоставление общего доступа и просмотр к содержимому в наборе данных
ReadWrite

string

Предоставляет доступ на чтение и запись к содержимому в наборе данных.
ReadWriteExplore

string

Предоставляет доступ на чтение, запись и просмотр содержимого в наборе данных
ReadWriteReshare

string

Предоставляет доступ для чтения, записи и повторного доступа к содержимому в наборе данных.
ReadWriteReshareExplore

string

Предоставляет доступ для чтения, записи, повторного доступа и просмотра к содержимому в наборе данных.

Datasource

Источник данных Power BI

Имя Тип Описание
connectionDetails

DatasourceConnectionDetails

Сведения о подключении к источнику данных
connectionString

string

(Не рекомендуется) Источник данных строка подключения. Доступно только для DirectQuery.
datasourceId

string

Идентификатор привязанного источника данных, который пуст, если он не привязан к шлюзу
datasourceType

string

Тип источника данных
gatewayId

string

Идентификатор привязанного шлюза, который пуст, если он не привязан к шлюзу. При использовании кластера шлюза идентификатор шлюза относится к основному (первому) шлюзу в кластере и аналогичен идентификатору кластера шлюза.
name

string

(Не рекомендуется) Имя источника данных. Доступно только для DirectQuery.

DatasourceConnectionDetails

Сведения о подключении к источнику данных Power BI. Примеры см. в разделах Получение источников данных или Получение источников данных в группе.

Имя Тип Описание
account

string

Учетная запись подключения
classInfo

string

Сведения о классе подключения
database

string

База данных подключения
domain

string

Домен подключения
emailAddress

string

Адрес электронной почты для подключения
kind

string

Тип подключения
loginServer

string

Сервер входа подключения
path

string

Путь подключения
server

string

Сервер подключения
url

string

URL-адрес подключения

DatasourceUsage

Использование источника данных

Имя Тип Описание
datasourceInstanceId

string

Идентификатор экземпляра источника данных

DefaultDatasetStorageFormat

Формат хранения набора данных по умолчанию в группе

Имя Тип Описание
Large

string

Формат хранения большого набора данных
Small

string

Формат хранения небольшого набора данных

DependentDataflow

Поток данных, зависимый от Power BI

Имя Тип Описание
groupId

string

Идентификатор целевой группы
targetDataflowId

string

Идентификатор целевого потока данных

DependentDatamart

Зависимый объект данных Power BI

Имя Тип Описание
groupId

string

Идентификатор целевой группы
targetDatamartId

string

Идентификатор целевого объекта datamart

DependentDataset

Набор данных, зависимый от Power BI

Имя Тип Описание
groupId

string

Идентификатор целевой группы
targetDatasetId

string

Идентификатор целевого набора данных

EndorsementDetails

Сведения о подтверждении Power BI

Имя Тип Описание
certifiedBy

string

Пользователь, который сертифицировал элемент Power BI (например, отчет или панель мониторинга);
endorsement

string

Состояние подтверждения

Expression

Выражение набора данных

Имя Тип Описание
description

string

Описание выражения
expression

ASMashupExpression

Источник таблицы набора данных
name

string

Имя выражения

GroupUser

Пользователь Power BI с доступом к рабочей области

Имя Тип Описание
displayName

string

Отображаемое имя участника
emailAddress

string

Адрес электронной почты пользователя
graphId

string

Идентификатор участника в Microsoft Graph. Доступно только для api-интерфейсов администратора.
groupUserAccessRight

GroupUserAccessRight

Право доступа (уровень разрешений), которое пользователь имеет в рабочей области
identifier

string

Идентификатор субъекта
principalType

PrincipalType

Тип участника
profile

ServicePrincipalProfile

Профиль субъекта служба Power BI. Применимо только для решения Power BI Embedded мультитенантности.
userType

string

Тип пользователя.

GroupUserAccessRight

Право доступа (уровень разрешений), которое пользователь имеет в рабочей области

Имя Тип Описание
Admin

string

Права администратора на содержимое рабочей области
Contributor

string

Чтение и просмотр (ReadExplore) доступ к содержимому рабочей области
Member

string

Права на чтение, повторное предоставление общего доступа и изучение (ReadReshareExplore) к содержимому рабочей области
None

string

Нет доступа к содержимому рабочей области
Viewer

string

Доступ только для чтения (чтение) к содержимому рабочей области

Measure

Мера Power BI

Имя Тип Описание
description

string

Необязательный элемент. Описание меры.
expression

string

Допустимое выражение DAX
formatString

string

Необязательный элемент. Строка, описывающая форматирование значения при его отображении, как указано в FORMAT_STRING.
isHidden

boolean

Необязательный элемент. Скрыта ли мера.
name

string

Имя меры

PrincipalType

Тип участника

Имя Тип Описание
App

string

Тип субъекта-службы
Group

string

Тип участника группы
None

string

Нет типа субъекта. Используйте для доступа на уровне всей организации.
User

string

Тип участника-пользователя

ReportUser

Запись права доступа пользователя Power BI для отчета

Имя Тип Описание
displayName

string

Отображаемое имя участника
emailAddress

string

Адрес электронной почты пользователя
graphId

string

Идентификатор участника в Microsoft Graph. Доступно только для api-интерфейсов администратора.
identifier

string

Идентификатор субъекта
principalType

PrincipalType

Тип участника
profile

ServicePrincipalProfile

Профиль субъекта служба Power BI. Применимо только для решения Power BI Embedded мультитенантности.
reportUserAccessRight

ReportUserAccessRight

Право доступа, которое пользователь имеет для отчета (уровень разрешений)
userType

string

Тип пользователя.

ReportUserAccessRight

Право доступа, которое пользователь имеет для отчета (уровень разрешений)

Имя Тип Описание
None

string

Нет разрешений на содержимое в отчете
Owner

string

Предоставляет доступ на чтение, запись и повторное предоставление общего доступа к содержимому в отчете
Read

string

Предоставляет доступ на чтение к содержимому в отчете
ReadCopy

string

Предоставляет доступ на чтение и копирование содержимого в отчете
ReadReshare

string

Предоставляет доступ на чтение и повторное предоставление общего доступа к содержимому в отчете
ReadWrite

string

Предоставляет доступ на чтение и запись к содержимому в отчете

Role

Роль в конфигурации RLS набора данных

Имя Тип Описание
members

RoleMember

Массив со списком членов роли
modelPermission

string

Разрешения, имеющиеся у роли в наборе данных. Например, Чтение
name

string

Имя роли
tablePermissions

RoleTablePermission

Массив со списком всех фильтров, определенных для роли.

RoleMember

Член роли

Имя Тип Описание
identityProvider

string

Поставщик удостоверений члена роли
memberId

string

GUID члена роли, назначенный поставщиком удостоверений
memberName

string

Имя члена роли
memberType

string

Тип члена роли (пользователь или группа)

RoleTablePermission

Фильтр ролей

Имя Тип Описание
filterExpression

string

Выражение, которое фильтрует таблицу, указанную в фильтре
name

string

Имя таблицы, указанной в фильтре

Row

Строка данных в наборе данных

Имя Тип Описание
id

string

Уникальный идентификатор строки

SensitivityLabel

Сведения о метках конфиденциальности для элемента Power BI (например, отчета или панели мониторинга)

Имя Тип Описание
labelId

string

Идентификатор метки конфиденциальности

ServicePrincipalProfile

Профиль субъекта служба Power BI. Применимо только для решения Power BI Embedded мультитенантности.

Имя Тип Описание
displayName

string

Имя профиля субъекта-службы
id

string

Идентификатор профиля субъекта-службы

Table

Таблица наборов данных

Имя Тип Описание
columns

Column[]

Схема столбца для этой таблицы
description

string

Описание таблицы
isHidden

boolean

Необязательный элемент. Скрыта ли эта таблица набора данных.
measures

Measure[]

Меры в этой таблице
name

string

имя таблицы;
rows

Row[]

Строки данных в этой таблице
source

ASMashupExpression[]

Источник таблицы

WorkspaceInfo

Сведения о рабочей области

Имя Тип Описание
capacityId

string

Идентификатор емкости рабочей области
dashboards

WorkspaceInfoDashboard[]

Панели мониторинга, связанные с этой рабочей областью. Список возвращаемых свойств панели мониторинга зависит от разных вызовов API, поэтому в ответе API могут отображаться не все свойства панели мониторинга.
dataRetrievalState

string

Состояние получения данных рабочей области
dataflows

WorkspaceInfoDataflow[]

Потоки данных, связанные с этой рабочей областью. Список возвращаемых свойств потока данных зависит от разных вызовов API, поэтому в ответе API могут отображаться не все свойства потока данных.
datamarts

WorkspaceInfoDatamart[]

Диаграммы данных, связанные с этой рабочей областью. Список возвращаемых свойств datamart зависит от разных вызовов API, поэтому в ответе API могут отображаться не все свойства datamart.
datasets

WorkspaceInfoDataset[]

Наборы данных, связанные с этой рабочей областью. Список возвращаемых свойств набора данных зависит от разных вызовов API, поэтому в ответе API могут отображаться не все свойства набора данных.
defaultDatasetStorageFormat

DefaultDatasetStorageFormat

Формат хранения набора данных по умолчанию в рабочей области. Возвращается только в том случае, если isOnDedicatedCapacity имеет значение true
description

string

Описание рабочей области
id

string

Идентификатор объекта рабочей области
isOnDedicatedCapacity

boolean

Назначена ли рабочая область выделенной емкости
name

string

Имя рабочей области
reports

WorkspaceInfoReport[]

Отчеты, связанные с этой рабочей областью. Список возвращаемых свойств отчета зависит от разных вызовов API, поэтому в ответе API могут отображаться не все свойства отчета.
state

string

Состояние рабочей области
type

string

Тип рабочей области
users

GroupUser[]

Пользователи с доступом к рабочей области. Список возвращается только при явном запросе. Чтобы получить список пользователей для классической рабочей области, используйте API Graph Azure Active Directory.

WorkspaceInfoDashboard

Панель мониторинга Power BI, возвращенная API WorkspaceInfo. API возвращает подмножество из следующего списка свойств панели мониторинга. Подмножество зависит от вызываемого API, разрешений вызывающей стороны и доступности данных в базе данных Power BI.

Имя Тип Описание
appId

string

Идентификатор приложения, возвращаемый только в том случае, если панель мониторинга принадлежит приложению.
dataClassification

string

Тег классификации данных элемента Power BI (например, отчета или панели мониторинга)
displayName

string

Отображаемое имя панели мониторинга
id

string

Идентификатор панели мониторинга
isReadOnly

boolean

Указывает, доступна ли панель мониторинга только для чтения
sensitivityLabel

SensitivityLabel

Метка конфиденциальности
tiles

WorkspaceInfoTile[]

Плитки, принадлежащие панели мониторинга
users

DashboardUser[]

(Пустое значение) Сведения о доступе пользователя к панели мониторинга. Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Сведения о пользователях на панели мониторинга Power BI можно получить с помощью команды Получить пользователей панели мониторинга в качестве вызова API Администратор или вызова API PostWorkspaceInfo с параметром getArtifactUsers .

WorkspaceInfoDataflow

Метаданные потока данных, возвращаемые API сведений о рабочей области. Ниже приведен список свойств, которые могут быть возвращены для потока данных. Возвращается только подмножество свойств в зависимости от вызываемого API, разрешений вызывающего объекта и доступности данных в базе данных Power BI.

Имя Тип Описание
configuredBy

string

Владелец потока данных
datasourceUsages

DatasourceUsage[]

Использование источников данных
description

string

Описание потока данных
endorsementDetails

EndorsementDetails

Сведения о подтверждении
misconfiguredDatasourceUsages

DatasourceUsage[]

Неправильно настроенное использование источника данных
modelUrl

string

URL-адрес файла определения потока данных (model.json)
modifiedBy

string

Пользователь, изменив поток данных
modifiedDateTime

string

Дата и время последнего изменения потока данных
name

string

Имя потока данных
objectId

string

Идентификатор потока данных
sensitivityLabel

SensitivityLabel

Метка конфиденциальности
upstreamDataflows

DependentDataflow[]

Список всех потоков данных, от которые зависит этот элемент
upstreamDatamarts

DependentDatamart[]

Список всех объектов данных, от которые зависит этот элемент
users

DataflowUser[]

(Пустое значение) Сведения о доступе пользователя к потоку данных. Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Вы можете получить сведения о пользователях в потоке данных Power BI с помощью метода Get Dataflow Users as Администратор API call или вызова API PostWorkspaceInfo с параметром getArtifactUser .

WorkspaceInfoDatamart

Объект данных Power BI, возвращаемый API сведений о рабочей области. API возвращает подмножество из следующего списка свойств datamart. Подмножество зависит от вызываемого API, разрешений вызывающей стороны и доступности данных в базе данных Power BI.

Имя Тип Описание
configuredBy

string

Имя владельца объекта данных
configuredById

string

Идентификатор владельца datamart
datasourceUsages

DatasourceUsage[]

Использование источников данных
description

string

Описание объекта данных
endorsementDetails

EndorsementDetails

Сведения о подтверждении datamart
id

string

Идентификатор datamart
modifiedBy

string

Последний пользователь, изменяющий объект datamart
modifiedById

string

Идентификатор последнего пользователя, изменившего объект данных
modifiedDateTime

string

Дата и время последнего изменения объекта данных
name

string

Имя объекта данных
sensitivityLabel

SensitivityLabel

Метка конфиденциальности datamart
state

datamartState

Текущее состояние объекта данных
status

datamartStatus

Состояние объекта данных
suspendedBatchId

string

идентификатор приостановленной пакетной службы datamart
type

datamartType

Тип объекта данных
upstreamDataflows

DependentDataflow[]

Список всех потоков данных, от которые зависит этот элемент
upstreamDatamarts

DependentDatamart[]

Список всех объектов данных, от которые зависит этот элемент
users

DatamartUser[]

Сведения о доступе пользователя к объекту данных Power BI.

WorkspaceInfoDataset

Набор данных Power BI, возвращаемый API WorkspaceInfo. API возвращает подмножество из следующего списка свойств набора данных. Подмножество зависит от вызываемого API, разрешений вызывающей стороны и доступности данных в базе данных Power BI.

Имя Тип Описание
ContentProviderType

string

Тип поставщика содержимого для набора данных
CreatedDate

string

Дата и время создания набора данных
configuredBy

string

Владелец набора данных
datasourceUsages

DatasourceUsage[]

Использование источников данных
description

string

Описание набора данных
endorsementDetails

EndorsementDetails

Сведения о подтверждении
expressions

Expression[]

Выражения набора данных
id

string

Идентификатор набора данных
misconfiguredDatasourceUsages

DatasourceUsage[]

Неправильно настроенное использование источника данных
name

string

Имя набора данных
roles

Role[]

Роли набора данных
schemaMayNotBeUpToDate

boolean

Может ли схема набора данных быть неактуаленной
schemaRetrievalError

string

Ошибка получения схемы набора данных
sensitivityLabel

SensitivityLabel

Метка конфиденциальности
tables

Table[]

Таблицы наборов данных
targetStorageMode

string

Режим хранения набора данных
upstreamDataflows

DependentDataflow[]

Список всех потоков данных, от которые зависит этот элемент
upstreamDatamarts

DependentDatamart[]

Список всех объектов данных, от которые зависит этот элемент
upstreamDatasets

DependentDataset[]

Наборы данных вышестоящий
users

DatasetUser[]

(Пустое значение) Сведения о доступе пользователя к набору данных. Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Сведения о пользователях элемента Power BI (например, отчет или панель мониторинга) можно получить с помощью API получения пользователей набора данных в качестве Администратор или API PostWorkspaceInfo с параметром getArtifactUsers .

WorkspaceInfoReport

Отчет Power BI, возвращенный API сведений о рабочей области. API возвращает подмножество из следующего списка свойств отчета. Подмножество зависит от вызываемого API, разрешений вызывающей стороны и доступности данных в базе данных Power BI.

Имя Тип Описание
appId

string

Идентификатор приложения, возвращаемый только в том случае, если отчет принадлежит приложению
createdBy

string

Владелец отчета. Доступно только для отчетов, созданных после июня 2019 г.
createdById

string

Идентификатор владельца отчета. Доступно только для отчетов, созданных после июня 2019 г.
createdDateTime

string

Дата и время создания отчета
datasetId

string

Идентификатор набора данных отчета
datasetWorkspaceId

string

Идентификатор рабочей области связанного набора данных, возвращаемый только в том случае, если связанный набор данных принадлежит другой рабочей области.
description

string

Описание отчета
endorsementDetails

EndorsementDetails

Сведения о подтверждении
id

string

Идентификатор отчета
modifiedBy

string

Последний пользователь, изменяющий отчет
modifiedById

string

Идентификатор последнего пользователя, изменившего отчет
modifiedDateTime

string

Дата и время последнего изменения отчета
name

string

Имя отчета
originalReportId

string

Фактический идентификатор отчета при публикации рабочей области в виде приложения.
reportType enum:
  • PaginatedReport
  • PowerBIReport

Тип отчета
sensitivityLabel

SensitivityLabel

Метка конфиденциальности
users

ReportUser[]

(Пустое значение) Сведения о доступе пользователя к отчету Power BI. Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Вы можете получить сведения о пользователях в отчете Power BI с помощью метода Get Report Users as Администратор ВЫЗОВ API или вызова API PostWorkspaceInfo с параметром getArtifactUsers .

WorkspaceInfoResponse

Ответ сведений о рабочей области

Имя Тип Описание
datasourceInstances

Datasource[]

Экземпляры источников данных, связанные с этой проверкой
misconfiguredDatasourceInstances

Datasource[]

Неправильно настроенные экземпляры источника данных, связанные с этой проверкой
workspaces

WorkspaceInfo[]

Сведения о рабочей области, связанные с этой проверкой

WorkspaceInfoTile

Плитка Power BI, возвращенная API WorkspaceInfo

Имя Тип Описание
datasetId

string

Идентификатор набора данных. Доступно только для плиток, созданных из отчета или с помощью набора данных, таких как плитки Q&A.
datasetWorkspaceId

string

Идентификатор рабочей области связанного набора данных, возвращаемый только в том случае, если связанный набор данных принадлежит другой рабочей области.
id

string

Идентификатор плитки
reportId

string

Идентификатор отчета. Доступно только для плиток, созданных из отчета.
title

string

Отображаемое имя плитки