Admin - Groups GetGroupsAsAdmin

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

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

Возвращает список рабочих областей для организации.

Разрешения

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

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

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

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

Важно только при проверке подлинности через стандартный делегированный маркер доступа администратора. Не должно присутствовать при использовании проверки подлинности через субъект-службу.

Ограничения

Максимум 50 запросов в час или 15 запросов в минуту для каждого клиента. Этот вызов также будет истекать через 30 секунд, чтобы предотвратить негативное влияние на службу Power BI.

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
$top	query	True	integer (int32) minimum: 1 maximum: 5000	Возвращает только первые результаты n. Этот параметр является обязательным и должен находиться в диапазоне от 1 до 5000.
$expand	query		string	Принимает разделенный запятыми список типов данных, который будет развернут встроенным в ответе. Поддерживает `users`, `reports`, `dashboards`, `datasets`, `dataflows`и `workbooks`.
$filter	query		string	Возвращает подмножество результатов на основе условия параметра запроса Odata Odata фильтра.
$skip	query		integer (int32)	Пропускает первые результаты n. Используйте в начале, чтобы получить результаты за пределами первого 5000.

Ответы

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

Примеры

Get deleted workspaces example.

Get orphaned workspaces example.

Get workspaces with their 'dashboards' expanded example

Get workspaces with their 'datasets' expanded example

Get workspaces with their 'datasets' expanded example.

Get workspaces with their 'reports' expanded example

Get workspaces with their 'users' expanded example.

Get workspaces with their 'workbooks' expanded example

Get deleted workspaces example.

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

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

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

Код состояния:: 200

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

Get orphaned workspaces example.

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

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

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

Код состояния:: 200

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

Get workspaces with their 'dashboards' expanded example

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

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

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

Код состояния:: 200

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

Get workspaces with their 'datasets' expanded example

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

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

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

Код состояния:: 200

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

Get workspaces with their 'datasets' expanded example.

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

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

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

Код состояния:: 200

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

Get workspaces with their 'reports' expanded example

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

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

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

Код состояния:: 200

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

Get workspaces with their 'users' expanded example.

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

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

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

Код состояния:: 200

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

Get workspaces with their 'workbooks' expanded example

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

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

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

Код состояния:: 200

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

Определения

Имя	Описание
AdminDashboard	Панель мониторинга Power BI, возвращаемая API-интерфейсами администрирования. API возвращает подмножество из следующего списка свойств панели мониторинга. Подмножество зависит от вызываемого API, разрешений вызываемого абонента и доступности данных в базе данных Power BI.
AdminDataflow	Метаданные потока данных, возвращаемые API администрирования. Ниже приведен список свойств, которые могут быть возвращены для потока данных. Только подмножество свойств будет возвращено в зависимости от вызываемого API, разрешений вызывающего объекта и доступности данных в базе данных Power BI.
AdminDataset	Набор данных Power BI, возвращенный API-интерфейсами администратора. API возвращает подмножество из следующего списка свойств набора данных. Подмножество зависит от вызываемого API, разрешений вызываемого абонента и доступности данных в базе данных Power BI.
AdminGroup	Группа Power BI, возвращаемая API-интерфейсами администратора
AdminGroups	Оболочка ответа OData для списка групп Power BI, возвращаемых API-интерфейсами администрирования
AdminReport	Отчет Power BI, возвращенный API-интерфейсами администрирования. API возвращает подмножество из следующего списка свойств отчета. Подмножество зависит от вызываемого API, разрешений вызываемого абонента и доступности данных в базе данных Power BI.
AdminTile	Плитка Power BI, возвращаемая API администратора.
AzureResource	Ответ, подробно содержащий ресурс Azure, принадлежащий пользователю, например рабочую область Log Analytics.
DashboardUser	Правая запись доступа пользователя Power BI для панели мониторинга
DashboardUserAccessRight	Право доступа, которое пользователь имеет для панели мониторинга (уровень разрешений)
DataflowUser	Запись права доступа пользователя Power BI для потока данных
DataflowUserAccessRight	Право доступа, которое пользователь имеет для потока данных (уровень разрешений)
DatasetQueryScaleOutSettings	Параметры масштабирования запросов набора данных
DatasetUser	Запись права доступа пользователя Power BI для набора данных
DatasetUserAccessRight	Право доступа, которое пользователь имеет для набора данных (уровень разрешений)
DefaultDatasetStorageFormat	Формат хранилища набора данных по умолчанию в группе
DependentDataflow	Зависимый поток данных Power BI
Encryption	Сведения о шифровании для набора данных
EncryptionStatus	Состояние шифрования набора данных
GroupType	Тип группы
GroupUser	Пользователь Power BI с доступом к рабочей области
GroupUserAccessRight	Право доступа (уровень разрешений), которое пользователь имеет в рабочей области
PrincipalType	Тип субъекта
ReportUser	Запись права доступа пользователя Power BI для отчета
ReportUserAccessRight	Право доступа, которое пользователь имеет для отчета (уровень разрешений)
ServicePrincipalProfile	Профиль субъекта-службы Power BI. Применимо только для решения Power BI Embedded с несколькими арендами.
Subscription	Подписка по электронной почте для элемента Power BI (например, отчета или панели мониторинга)
SubscriptionUser	Пользователь подписки на электронную почту Power BI
Workbook	Книга Power BI

AdminDashboard

Объект

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

Имя	Тип	Описание
appId	string	Идентификатор приложения, возвращенный только в том случае, если панель мониторинга принадлежит приложению
displayName	string	Отображаемое имя панели мониторинга
embedUrl	string	URL-адрес внедрения панели мониторинга
id	string (uuid)	Идентификатор панели мониторинга
isReadOnly	boolean	Является ли панель мониторинга доступной только для чтения
subscriptions	Subscription[]	(Пустое значение) Сведения о подписке для элемента Power BI (например, отчета или панели мониторинга). Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Сведения о подписке для отчета Power BI можно получить с помощью вызова API получения подписок отчета в качестве администратора API.
tiles	AdminTile[]	Плитки, принадлежащие панели мониторинга
users	DashboardUser[]	(Пустое значение) Сведения о доступе пользователя к панели мониторинга. Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Вы можете получить сведения о пользователях на панели мониторинга Power BI с помощью вызова API получения пользователей панели мониторинга в качестве администратора или вызова API PostWorkspaceInfo с параметром `getArtifactUsers`.
webUrl	string	URL-адрес веб-панели мониторинга
workspaceId	string (uuid)	Идентификатор рабочей области (GUID) панели мониторинга. Это свойство будет возвращено только в GetDashboardsAsAdmin.

AdminDataflow

Объект

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

Имя	Тип	Описание
configuredBy	string	Владелец потока данных
description	string	Описание потока данных
modelUrl	string	URL-адрес файла определения потока данных (model.json)
name	string	Имя потока данных
objectId	string (uuid)	Идентификатор потока данных
users	DataflowUser[]	(Пустое значение) Сведения о доступе пользователей потока данных. Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Вы можете получить сведения о потоке данных Power BI с помощью вызова API Получения пользователей потока данных в качестве администратора или вызова API PostWorkspaceInfo с параметром `getArtifactUser`.
workspaceId	string (uuid)	Идентификатор рабочей области потока данных.

AdminDataset

Объект

Набор данных Power BI, возвращенный API-интерфейсами администратора. 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

Encryption

Сведения о шифровании набора данных. Применимо только при указании $expand.

addRowsAPIEnabled

boolean

Позволяет ли набор данных добавлять новые строки

configuredBy

string

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

createReportEmbedURL

string

URL-адрес внедрения отчета в набор данных

createdDate

string (date-time)

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

description

string

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

string

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

isEffectiveIdentityRequired

boolean

Требуется ли для набора данных эффективное удостоверение, которое необходимо отправить в вызов API GenerateTo ken.

isEffectiveIdentityRolesRequired

boolean

Определяется ли безопасность на уровне строк внутри PBIX-файла Power BI. В этом случае необходимо указать роль.

isInPlaceSharingEnabled

boolean

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

isOnPremGatewayRequired

boolean

Требуется ли для набора данных локальный шлюз данных

isRefreshable

boolean

Это поле возвращает true, если набор данных недавно обновлен или настроен для автоматического обновления, при этом режим подключения специально установлен в значение Import. Значение возвращает false для других режимов подключения, таких как DirectQuery и LiveConnection, независимо от того, обновляется ли набор данных вручную или настроен для автоматического обновления.

name

string

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

qnaEmbedURL

string

Url-адрес внедрения набора данных Q&A

queryScaleOutSettings

DatasetQueryScaleOutSettings

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

targetStorageMode

string

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

upstreamDataflows

DependentDataflow[]

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

users

DatasetUser[]

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

webUrl

string

URL-адрес веб-набора данных

workspaceId

string (uuid)

Идентификатор рабочей области набора данных. Это свойство будет возвращено только в GetDatasetsAsAdmin.

AdminGroup

Объект

Группа Power BI, возвращаемая API-интерфейсами администратора

Имя	Тип	Описание
capacityId	string (uuid)	Идентификатор емкости
dashboards	AdminDashboard[]	Панели мониторинга, принадлежащие группе
dataflowStorageId	string (uuid)	Идентификатор учетной записи хранения потока данных Power BI
dataflows	AdminDataflow[]	Потоки данных, принадлежащие группе
datasets	AdminDataset[]	Наборы данных, принадлежащие группе
defaultDatasetStorageFormat	DefaultDatasetStorageFormat	Формат хранилища набора данных по умолчанию в рабочей области. Возвращается только в том случае, если `isOnDedicatedCapacitytrue`
description	string	Описание группы
hasWorkspaceLevelSettings	boolean	Имеет ли рабочая область настраиваемые параметры
id	string (uuid)	Идентификатор рабочей области
isOnDedicatedCapacity	boolean	Назначается ли группа выделенной емкости
isReadOnly	boolean	Является ли группа доступной только для чтения
logAnalyticsWorkspace	AzureResource	Рабочая область Log Analytics, назначенная группе. Возвращается только при получении одной группы.
name	string	Имя группы
pipelineId	string (uuid)	Идентификатор конвейера развертывания, которому назначена рабочая область.
reports	AdminReport[]	Отчеты, принадлежащие группе
state	string	Состояние группы
type	GroupType	Тип возвращаемой группы.
users	GroupUser[]	(Пустое значение) Пользователи, принадлежащие группе и их права доступа. Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Вы можете получить сведения о пользователях в элементе Power BI (например, отчете или панели мониторинга), используя вызов API Get Group Users as Admin или вызов API postWorkspace Info PostWorkspaceInfo с параметром .
workbooks	Workbook[]	Книги, принадлежащие группе

AdminGroups

Объект

Оболочка ответа OData для списка групп Power BI, возвращаемых API-интерфейсами администрирования

Имя	Тип	Описание
@odata.context	string	Контекст OData
value	AdminGroup[]	Список групп

AdminReport

Объект

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

Имя	Тип	Описание
appId	string	Идентификатор приложения, возвращенный только в том случае, если отчет принадлежит приложению
createdBy	string	Владелец отчета. Доступно только для отчетов, созданных после июня 2019 года.
createdDateTime	string (date-time)	Дата и время создания отчета
datasetId	string	Идентификатор набора данных отчета
description	string	Описание отчета
embedUrl	string	URL-адрес внедрения отчета
format	string	Тип формата определения отчета. Для PowerBIReport: PBIR PBIR-Legacy Для PaginatedReport: `RDL`
id	string (uuid)	Идентификатор отчета
isOwnedByMe	boolean	Указывает, имеет ли текущий пользователь возможность изменять или создавать копию отчета.
modifiedBy	string	Последний пользователь, изменивший отчет
modifiedDateTime	string (date-time)	Дата и время последнего изменения отчета
name	string	Имя отчета. Отчеты приложений начинаются с префикса [App].
originalReportObjectId	string (uuid)	Фактический идентификатор отчета при публикации рабочей области в качестве приложения.
reportType	enum: PaginatedReport PowerBIReport	Тип отчета
subscriptions	Subscription[]	(Пустое значение) Сведения о подписке для элемента Power BI (например, отчета или панели мониторинга). Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Сведения о подписке для отчета Power BI можно получить с помощью вызова API получения подписок отчета в качестве администратора API.
users	ReportUser[]	(Пустое значение) Сведения о доступе пользователей к отчету Power BI. Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Вы можете получить сведения о пользователях в отчете Power BI с помощью вызова API получения пользователей отчета в качестве администратора или вызова API PostWorkspaceInfo с параметром `getArtifactUsers`.
webUrl	string	URL-адрес веб-отчета
workspaceId	string (uuid)	Идентификатор рабочей области (GUID) отчета. Это свойство будет возвращено только в GetReportsAsAdmin.

AdminTile

Объект

Плитка Power BI, возвращаемая API администратора.

Имя	Тип	Описание
colSpan	integer	Количество столбцов диапазона плиток
datasetId	string	Идентификатор набора данных. Доступно только для плиток, созданных из отчета или с помощью набора данных, например Q&плитки A.
embedData	string	Данные внедрения для плитки
embedUrl	string	URL-адрес внедрения плитки
id	string (uuid)	Идентификатор плитки
reportId	string (uuid)	Идентификатор отчета. Доступно только для плиток, созданных из отчета.
rowSpan	integer	Количество строк диапазона плиток
title	string	Отображаемое имя плитки

AzureResource

Объект

Ответ, подробно содержащий ресурс Azure, принадлежащий пользователю, например рабочую область Log Analytics.

Имя	Тип	Описание
id	string (uuid)	Идентификатор ресурса в Power BI.
resourceGroup	string	Группа ресурсов в подписке, в которой находится ресурс.
resourceName	string	Имя ресурса.
subscriptionId	string (uuid)	Подписка Azure, в которой находится ресурс.

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

DatasetQueryScaleOutSettings

Объект

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

Имя	Тип	Описание
autoSyncReadOnlyReplicas	boolean	Автоматически ли набор данных синхронизирует реплики только для чтения
maxReadOnlyReplicas	integer minimum: -1 maximum: 64	Максимальное количество реплик только для чтения для набора данных (0–64, -1 для автоматического числа реплик)

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

DefaultDatasetStorageFormat

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

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

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

DependentDataflow

Объект

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

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

Encryption

Объект

Сведения о шифровании для набора данных

Имя	Тип	Описание
EncryptionStatus	EncryptionStatus	Состояние шифрования набора данных

EncryptionStatus

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

Состояние шифрования набора данных

Значение	Описание
Unknown	Состояние шифрования неизвестно из-за повреждения набора данных
NotSupported	Шифрование не поддерживается для этого набора данных
InSyncWithWorkspace	Шифрование поддерживается и синхронизируется с параметрами шифрования.
NotInSyncWithWorkspace	Шифрование поддерживается, но не синхронизируется с параметрами шифрования.

GroupType

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

Тип группы

Значение	Описание
AdminWorkspace	Мониторинг администраторов для администраторов Fabric
PersonalGroup	"Моя рабочая область", также известная как личная рабочая область
Personal	Специальный тип рабочей области, предназначенный для интеграции со списком SharePoint и OneDrive
Group	Версия 1 общей рабочей области. Этот тип рабочих областей будет нерекомендуем, так как корпорация Майкрософт переносит все рабочие области в последнюю версию общей рабочей области.
Workspace	Общая рабочая область или простая рабочая область, используемая для совместного использования содержимого с другими пользователями в организации

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	Доступ только для чтения (чтение) к содержимому рабочей области

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	Предоставляет доступ к содержимому в отчете для чтения, записи и повторного доступа к содержимому

ServicePrincipalProfile

Объект

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

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

Subscription

Объект

Подписка по электронной почте для элемента Power BI (например, отчета или панели мониторинга)

Имя	Тип	Описание
artifactDisplayName	string	Имя подписанного элемента Power BI (например, отчета или панели мониторинга)
artifactId	string (uuid)	Идентификатор подписанного элемента Power BI (например, отчета или панели мониторинга)
artifactType	string	Тип элемента Power BI (например, `Report`, `Dashboard`или `Dataset`)
attachmentFormat	string	Формат отчета, присоединенного к подписке электронной почты
endDate	string (date-time)	Дата окончания и время подписки электронной почты
frequency	string	Частота подписки электронной почты
id	string (uuid)	Идентификатор подписки
isEnabled	boolean	Включена ли подписка на электронную почту
linkToContent	boolean	Существует ли ссылка на подписку электронной почты
previewImage	boolean	Наличие снимка экрана отчета в подписке электронной почты
startDate	string (date-time)	Дата начала и время подписки электронной почты
subArtifactDisplayName	string	Имя страницы подписанного элемента Power BI, если это отчет.
title	string	Имя приложения
users	SubscriptionUser[]	Сведения о каждом подписчике электронной почты. При использовании вызова API получения подписок пользователей от имени администратора возвращается возвращаемое значение пустого массива (NULL). Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Вы можете получить сведения о подписке в отчете Или панели мониторинга Power BI с помощью получения подписок отчетов от имени администратора или получения подписок панели мониторинга от имени администратора вызовов API.

SubscriptionUser

Объект

Пользователь подписки на электронную почту Power BI

Имя	Тип	Описание
displayName	string	Отображаемое имя субъекта
emailAddress	string	Адрес электронной почты пользователя
graphId	string	Идентификатор субъекта в Microsoft Graph. Доступно только для API администрирования.
identifier	string	Идентификатор субъекта
principalType	PrincipalType	Тип субъекта
profile	ServicePrincipalProfile	Профиль субъекта-службы Power BI. Применимо только для решения Power BI Embedded с несколькими арендами.
userType	string	Тип пользователя.

Workbook

Объект

Книга Power BI

Имя	Тип	Описание
datasetId	string	Идентификатор набора данных, связанного с книгой. Применяется только в том случае, если в книге есть связанный набор данных.
name	string	Имя книги