Admin - WorkspaceInfo GetScanResult

Служба:: Power BI REST APIs

Версия API:: v1.0

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

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

Разрешения

Пользователь должен быть администратором Fabric или пройти проверку подлинности с помощью субъекта-службы.

При выполнении проверки подлинности субъекта-службы приложение не должно иметь необходимые разрешения администратора для 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)	Идентификатор проверки, который включается в ответ из рабочих областей или администратора — WorkspaceInfo PostWorkspaceInfo вызов API, активировавший проверку.

Ответы

Имя	Тип	Описание
200 OK	WorkspaceInfoResponse	ХОРОШО

Примеры

Example

Образец запроса

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

Пример ответа

Код состояния:: 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"
    }
  ]
}

Определения

Имя	Описание
ASMashupExpression	Источник таблицы набора данных
Column	Столбец набора данных
DashboardUser	Правая запись доступа пользователя Power BI для панели мониторинга
DashboardUserAccessRight	Право доступа, которое пользователь имеет для панели мониторинга (уровень разрешений)
DataflowUser	Запись права доступа пользователя Power BI для потока данных
DataflowUserAccessRight	Право доступа, которое пользователь имеет для потока данных (уровень разрешений)
datamartState	Текущее состояние datamart
datamartStatus	Состояние datamart
datamartType	Тип datamart
DatamartUser	Запись права доступа пользователя Power BI для отчета
DatamartUserAccessRight	Право доступа, которое пользователь имеет для datamart (уровень разрешений)
DatasetUser	Запись права доступа пользователя Power BI для набора данных
DatasetUserAccessRight	Право доступа, которое пользователь имеет для набора данных (уровень разрешений)
Datasource	Источник данных Power BI
DatasourceConnectionDetails	Сведения о подключении к источнику данных Power BI. См. примеры получения источников данных или получения источников данных в группе.
DatasourceUsage	Использование источника данных
DefaultDatasetStorageFormat	Формат хранилища набора данных по умолчанию в группе
DependentDataflow	Зависимый поток данных Power BI
DependentDatamart	Зависимый объект datamart 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	Объект datamart 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 pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$	Имя столбца
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	Нет разрешения на содержимое на панели мониторинга
Read	Предоставляет доступ на чтение к содержимому на панели мониторинга
ReadWrite	Предоставляет доступ на чтение и запись к содержимому на панели мониторинга
ReadReshare	Предоставляет доступ на чтение и повторное предоставление доступа к содержимому на панели мониторинга
ReadCopy	Предоставляет доступ на чтение и копирование содержимого на панели мониторинга
Owner	Предоставляет доступ к содержимому в отчете для чтения, записи и повторного доступа к содержимому

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	Удаляет разрешение на содержимое в потоке данных
Read	Предоставляет доступ на чтение к содержимому в потоке данных
ReadWrite	Предоставляет доступ на чтение и запись к содержимому в потоке данных
ReadReshare	Предоставляет доступ для чтения и повторного доступа к содержимому в потоке данных
Owner	Предоставляет доступ для чтения, записи и повторного доступа к содержимому в потоке данных

datamartState

Перечисление

Текущее состояние datamart

Значение	Описание
Invalid	Datamart имеет недопустимое состояние
Initialized	Datamart был инициализирован
Active	Datamart активен
Migrating	Datamart переносится
Evicted	Datamart был вытесщен
Deleted	Datamart удален

datamartStatus

Перечисление

Состояние datamart

Значение	Описание
Invalid	Datamart имеет недопустимое состояние
Available	Datamart доступен
SuspendedInCriticalPhase	Datamart приостановлен на критическом этапе
InProgress	Datamart выполняется
Error	Datamart имеет состояние ошибки
OutOfRegion	Datamart находится вне региона
NoCapacity	Datamart не имеет емкости

datamartType

Перечисление

Тип datamart

Значение	Описание
Unset	Тип datamart был не задан
Ignore	Datamart не имеет типа
Sql	Datamart имеет тип Sql
Lakehouse	Datamart имеет тип Lakehouse
Dataverse	Datamart имеет тип Dataverse
Datawarehouse	Datamart имеет тип Datawarehouse

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 (уровень разрешений)

Значение	Описание
None	Нет разрешения на содержимое в datamart
Read	Предоставляет доступ на чтение к содержимому в datamart
Write	Предоставляет доступ на запись к содержимому в datamart
Reshare	Предоставление повторного доступа к содержимому в datamart
Explore	Предоставляет доступ к содержимому в datamart
ReadWrite	Предоставляет доступ на чтение и запись к содержимому в datamart
ReadReshare	Предоставляет доступ для чтения и повторного доступа к содержимому в datamart
ReadWriteReshare	Предоставляет доступ для чтения и записи и повторного доступа к содержимому в datamart
ReadExplore	Предоставляет доступ для чтения и изучения содержимого в datamart
ReadReshareExplore	Предоставляет доступ к содержимому в datamart для чтения и повторного доступа к содержимому
ReadWriteExplore	Предоставляет доступ для чтения и записи и изучения содержимого в datamart
ReadWriteReshareExplore	Предоставляет доступ к содержимому в 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	Удаляет разрешение на содержимое в наборе данных
Read	Предоставляет доступ на чтение к содержимому в наборе данных
ReadWrite	Предоставляет доступ на чтение и запись к содержимому в наборе данных
ReadReshare	Предоставляет доступ на чтение и повторное предоставление доступа к содержимому в наборе данных
ReadWriteReshare	Предоставляет доступ для чтения, записи и повторного доступа к содержимому в наборе данных
ReadExplore	Предоставляет доступ на чтение и изучение содержимого в наборе данных
ReadReshareExplore	Предоставляет доступ к содержимому в наборе данных для чтения, повторного доступа и просмотра
ReadWriteExplore	Предоставляет доступ на чтение, запись и изучение содержимого в наборе данных
ReadWriteReshareExplore	Предоставляет доступ для чтения, записи, повторного доступа к содержимому в наборе данных

Datasource

Объект

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

Имя	Тип	Описание
connectionDetails	DatasourceConnectionDetails	Сведения о подключении к источнику данных
connectionString	string	(не рекомендуется) Строка подключения к источнику данных. Доступно только для DirectQuery.
datasourceId	string (uuid)	Идентификатор привязанного источника данных, который пуст, если не привязан к шлюзу
datasourceType	string	Тип источника данных
gatewayId	string (uuid)	Идентификатор привязанного шлюза, который пуст, если он не привязан к шлюзу. При использовании кластера шлюза идентификатор шлюза ссылается на первичный (первый) шлюз в кластере и аналогичен идентификатору кластера шлюза.
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 (uuid)	Идентификатор экземпляра источника данных

DefaultDatasetStorageFormat

Перечисление

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

Значение	Описание
Small	Формат хранилища небольшого набора данных
Large	Формат хранилища большого набора данных

DependentDataflow

Объект

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

Имя	Тип	Описание
groupId	string	Идентификатор целевой группы
targetDataflowId	string	Идентификатор целевого потока данных

DependentDatamart

Объект

Зависимый объект datamart 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	string	Значение выражения
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

Перечисление

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

Значение	Описание
None	Нет доступа к содержимому рабочей области
Member	Чтение, повторное использование и изучение прав доступа (ReadReshareExplore) к содержимому рабочей области
Admin	Права администратора на содержимое рабочей области
Contributor	Доступ к содержимому рабочей области для чтения и изучения (ReadExplore)
Viewer	Доступ только для чтения (чтение) к содержимому рабочей области

Measure

Объект

Мера Power BI

Имя	Тип	Описание
description	string	Необязательный. Описание меры.
expression	string	Допустимое выражение DAX
formatString	string	Необязательный. Строка, описывающая форматирование значения при отображении, как указано в FORMAT_STRING.
isHidden	boolean	Необязательный. Скрыта ли мера.
name	string pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$	Имя меры

PrincipalType

Перечисление

Тип субъекта

Значение	Описание
None	Нет типа субъекта. Используется для доступа на уровне всей организации.
User	Тип субъекта-пользователя
Group	Тип субъекта-группы
App	Тип субъекта-службы

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	Нет разрешения на содержимое в отчете
Read	Предоставляет доступ на чтение к содержимому в отчете
ReadWrite	Предоставляет доступ на чтение и запись к содержимому в отчете
ReadReshare	Предоставление доступа к содержимому в отчете для чтения и повторного доступа к содержимому
ReadCopy	Предоставление доступа к содержимому в отчете для чтения и копирования
Owner	Предоставляет доступ к содержимому в отчете для чтения, записи и повторного доступа к содержимому

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 (uuid)	Идентификатор метки конфиденциальности

ServicePrincipalProfile

Объект

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

Имя	Тип	Описание
displayName	string	Имя профиля субъекта-службы
id	string (uuid)	Идентификатор профиля субъекта-службы

Table

Объект

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

Имя	Тип	Описание
columns	Column[]	Схема столбцов для этой таблицы
description	string	Описание таблицы
isHidden	boolean	Необязательный. Скрыта ли эта таблица набора данных.
measures	Measure[]	Меры в этой таблице
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}$	Имя таблицы
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	Формат хранилища набора данных по умолчанию в рабочей области. Возвращается только в том случае, если `isOnDedicatedCapacitytrue`
description	string	Описание рабочей области
id	string (uuid)	Идентификатор объекта рабочей области
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 (uuid)	Идентификатор панели мониторинга
isReadOnly	boolean	Является ли панель мониторинга доступной только для чтения
sensitivityLabel	SensitivityLabel	Метка конфиденциальности
tags	string[] (uuid)	Уникальные идентификаторы тегов, примененных к элементу.
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)
name	string	Имя потока данных
objectId	string (uuid)	Идентификатор потока данных
sensitivityLabel	SensitivityLabel	Метка конфиденциальности
tags	string[] (uuid)	Уникальные идентификаторы тегов, примененных к элементу.
upstreamDataflows	DependentDataflow[]	Список всех потоков данных этого элемента зависит от
upstreamDatamarts	DependentDatamart[]	Список всех данных, от которой зависит этот элемент
users	DataflowUser[]	(Пустое значение) Сведения о доступе пользователей потока данных. Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Вы можете получить сведения о потоке данных Power BI с помощью вызова API Получения пользователей потока данных в качестве администратора или вызова API PostWorkspaceInfo с параметром `getArtifactUser`.

WorkspaceInfoDatamart

Объект

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

Имя	Тип	Описание
configuredBy	string	Имя владельца datamart
configuredById	string	Идентификатор владельца datamart
datasourceUsages	DatasourceUsage[]	Использование источника данных
description	string	Описание datamart
endorsementDetails	EndorsementDetails	Сведения о подтверждении datamart
id	string (uuid)	Идентификатор datamart
modifiedBy	string	Последний пользователь, изменивший datamart
modifiedById	string	Идентификатор последнего пользователя, изменившего datamart
modifiedDateTime	string (date-time)	Дата и время последнего изменения datamart
name	string	Имя datamart
sensitivityLabel	SensitivityLabel	Метка конфиденциальности datamart
state	datamartState	Текущее состояние datamart
status	datamartStatus	Состояние datamart
suspendedBatchId	string	идентификатор приостановленной пакетной службы datamart
tags	string[] (uuid)	Уникальные идентификаторы тегов, примененных к элементу.
type	datamartType	Тип datamart
upstreamDataflows	DependentDataflow[]	Список всех потоков данных этого элемента зависит от
upstreamDatamarts	DependentDatamart[]	Список всех данных, от которой зависит этот элемент
users	DatamartUser[]	Сведения о доступе пользователя для datamart Power BI.

WorkspaceInfoDataset

Объект

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

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

ContentProviderType

string

Тип поставщика контента для семантической модели.

Следующие contentProviderType хранятся в домашнем регионе клиента:

ContentProviderType
Excel
CSV
UsageMetricsUserReport
UsageMetricsUserDashboard
RealTimeInPushMode
RealTimeInPubNubMode
RealTimeInStreamingMode

Следующие contentProviderType хранятся в регионе емкости:

ContentProviderType
PowerBIDesktop
PowerBIModelingService
PbixInImportMode
PbixInDirectQueryMode
PbixInCompositeMode
InImportMode
InDirectQueryMode
InCompositeMode

configuredBy

string

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

createdDate

string (date-time)

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

datasourceUsages

DatasourceUsage[]

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

description

string

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

endorsementDetails

EndorsementDetails

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

expressions

Expression[]

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

string

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

misconfiguredDatasourceUsages

DatasourceUsage[]

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

name

string

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

roles

Role[]

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

schemaMayNotBeUpToDate

boolean

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

schemaRetrievalError

string

Ошибка извлечения схемы набора данных

sensitivityLabel

SensitivityLabel

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

tables

Table[]

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

WorkspaceInfoReport

Объект

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

Имя	Тип	Описание
appId	string	Идентификатор приложения, возвращенный только в том случае, если отчет принадлежит приложению
createdBy	string	Владелец отчета. Доступно только для отчетов, созданных после июня 2019 года.
createdById	string	Идентификатор владельца отчета. Доступно только для отчетов, созданных после июня 2019 года.
createdDateTime	string (date-time)	Дата и время создания отчета
datasetId	string	Идентификатор набора данных отчета
datasetWorkspaceId	string (uuid)	Идентификатор рабочей области связанного набора данных, возвращаемый только в том случае, если связанный набор данных принадлежит другой рабочей области.
description	string	Описание отчета
endorsementDetails	EndorsementDetails	Сведения о подтверждении
format	string	Тип формата определения отчета. Для PowerBIReport: PBIR PBIRLegacy Для PaginatedReport: `RDL`
id	string (uuid)	Идентификатор отчета
isOwnedByMe	boolean	Указывает, имеет ли текущий пользователь возможность изменять или создавать копию отчета.
modifiedBy	string	Последний пользователь, изменивший отчет
modifiedById	string	Идентификатор последнего пользователя, изменившего отчет
modifiedDateTime	string (date-time)	Дата и время последнего изменения отчета
name	string	Имя отчета. Отчеты приложений начинаются с префикса [App].
originalReportId	string (uuid)	Фактический идентификатор отчета при публикации рабочей области в качестве приложения.
reportType	enum: PaginatedReport PowerBIReport	Тип отчета
sensitivityLabel	SensitivityLabel	Метка конфиденциальности
tags	string[] (uuid)	Уникальные идентификаторы тегов, примененных к элементу.
users	ReportUser[]	(Пустое значение) Сведения о доступе пользователей к отчету Power BI. Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Вы можете получить сведения о пользователях в отчете Power BI с помощью вызова API получения пользователей отчета в качестве администратора или вызова API PostWorkspaceInfo с параметром `getArtifactUsers`.

WorkspaceInfoResponse

Объект

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

Имя	Тип	Описание
datasourceInstances	Datasource[]	Экземпляры источника данных, связанные с этой проверкой
misconfiguredDatasourceInstances	Datasource[]	Неправильно настроенные экземпляры источника данных, связанные с этой проверкой
workspaces	WorkspaceInfo[]	Сведения о рабочей области, связанные с этой проверкой

WorkspaceInfoTile

Объект

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

Имя	Тип	Описание
datasetId	string	Идентификатор набора данных. Доступно только для плиток, созданных из отчета или с помощью набора данных, например Q&плитки A.
datasetWorkspaceId	string (uuid)	Идентификатор рабочей области связанного набора данных, возвращаемый только в том случае, если связанный набор данных принадлежит другой рабочей области.
id	string (uuid)	Идентификатор плитки
reportId	string (uuid)	Идентификатор отчета. Доступно только для плиток, созданных из отчета.
title	string	Отображаемое имя плитки