Admin - Groups GetGroupsAsAdmin

Ссылка

Service:: Power BI REST APIs

API Version:: v1.0

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

Разрешения

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

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

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

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

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

Ограничения

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

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

With optional parameters:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
$top	query	True	integer int32	Возвращает только первые n результатов. Этот параметр является обязательным и должен находиться в диапазоне от 1 до 5000.
$expand	query		string	Принимает разделенный запятыми список типов данных, который будет развернут в ответе. Поддерживает `users`, `reports`, `dashboards`, `datasets`, `dataflows`и `workbooks`.
$filter	query		string	Фильтрует результаты по логическому условию
$skip	query		integer int32	Пропускает первые n результатов. Используйте с top для получения результатов после первых 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.

Sample Request

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

Sample Response

Status code:: 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.

Sample Request

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

Sample Response

Status code:: 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

Sample Request

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

Sample Response

Status code:: 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

Sample Request

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

Sample Response

Status code:: 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.

Sample Request

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

Sample Response

Status code:: 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

Sample Request

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

Sample Response

Status code:: 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.

Sample Request

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

Sample Response

Status code:: 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

Sample Request

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

Sample Response

Status code:: 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	Идентификатор панели мониторинга
isReadOnly	boolean	Указывает, доступна ли панель мониторинга только для чтения
subscriptions	Subscription[]	(Пустое значение) Сведения о подписке для элемента Power BI (например, отчета или панели мониторинга). Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Сведения о подписке для отчета Power BI можно получить с помощью команды Получить подписки на отчеты как Администратор вызов API.
tiles	AdminTile[]	Плитки, принадлежащие панели мониторинга
users	DashboardUser[]	(Пустое значение) Сведения о доступе пользователя к панели мониторинга. Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Сведения о пользователях на панели мониторинга Power BI можно получить с помощью команды Get Dashboard Users as Администратор вызова API или вызова API PostWorkspaceInfo с параметром `getArtifactUsers` .
webUrl	string	URL-адрес панели мониторинга
workspaceId	string	Идентификатор рабочей области (GUID) панели мониторинга. Это свойство будет возвращено только в GetDashboardsAsAdmin.

AdminDataflow

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

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

AdminDataset

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

Имя	Тип	Описание
ContentProviderType	string	Тип поставщика содержимого для набора данных
CreateReportEmbedURL	string	URL-адрес внедрения отчета для создания набора данных
CreatedDate	string	Дата и время создания набора данных
Encryption	Encryption	Сведения о шифровании набора данных. Применимо только в том случае, если `$expand` задан параметр .
IsEffectiveIdentityRequired	boolean	Требуется ли для набора данных действующее удостоверение, которое необходимо отправить в вызове API GenerateToken .
IsEffectiveIdentityRolesRequired	boolean	Определяется ли безопасность на уровне строк в PBIX-файле Power BI. В этом случае необходимо указать роль.
IsInPlaceSharingEnabled	boolean	Можно ли предоставить доступ к набору данных внешним пользователям для использования в их собственном клиенте
IsOnPremGatewayRequired	boolean	Требуется ли для набора данных локальный шлюз данных
IsRefreshable	boolean	Является ли набор данных обновляемым или нет. Обновляемый набор данных Power BI — это набор данных, который был обновлен по крайней мере один раз или для которого существует допустимое расписание обновления.
QnaEmbedURL	string	URL-адрес внедрения набора данных Q&A
addRowsAPIEnabled	boolean	Позволяет ли набор данных добавлять новые строки
configuredBy	string	Владелец набора данных
description	string	Описание набора данных
id	string	Идентификатор набора данных
name	string	Имя набора данных
queryScaleOutSettings	DatasetQueryScaleOutSettings	Параметры масштабирования запроса для набора данных
targetStorageMode	string	Режим хранения набора данных
upstreamDataflows	DependentDataflow[]	Список всех потоков данных, от которые зависит этот элемент
users	DatasetUser[]	(Пустое значение) Сведения о доступе пользователя к набору данных. Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Сведения о пользователях элемента Power BI (например, отчет или панель мониторинга) можно получить с помощью API получения пользователей набора данных в качестве Администратор или API PostWorkspaceInfo с параметром `getArtifactUsers` .
webUrl	string	URL-адрес веб-сайта набора данных
workspaceId	string	Идентификатор рабочей области набора данных. Это свойство будет возвращено только в GetDatasetsAsAdmin.

AdminGroup

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

Имя	Тип	Описание
capacityId	string	Идентификатор емкости
dashboards	AdminDashboard[]	Панели мониторинга, принадлежащие группе
dataflowStorageId	string	Идентификатор учетной записи хранения потока данных Power BI
dataflows	AdminDataflow[]	Потоки данных, принадлежащие группе
datasets	AdminDataset[]	Наборы данных, принадлежащие группе
defaultDatasetStorageFormat	DefaultDatasetStorageFormat	Формат хранилища набора данных по умолчанию в рабочей области. Возвращается только в том случае, если `isOnDedicatedCapacity` имеет значение `true`
description	string	Описание группы
hasWorkspaceLevelSettings	boolean	Наличие настраиваемых параметров в рабочей области
id	string	идентификатор рабочей области;
isOnDedicatedCapacity	boolean	Указывает, назначена ли группа выделенной емкости
isReadOnly	boolean	Является ли группа доступной только для чтения
logAnalyticsWorkspace	AzureResource	Рабочая область Log Analytics, назначенная группе. Возвращается только при получении одной группы.
name	string	Имя группы
pipelineId	string	Идентификатор конвейера развертывания, которому назначена рабочая область.
reports	AdminReport[]	Отчеты, принадлежащие группе
state	string	Состояние группы
type	GroupType	Тип возвращаемой группы.
users	GroupUser[]	(Пустое значение) Пользователи, принадлежащие группе, и их права доступа. Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Вы можете получить сведения о пользователе в элементе Power BI (например, отчете или панели мониторинга) с помощью вызова API Get Group Users As Администратор или вызова API PostWorkspaceInfo с параметром `getArtifactUsers` .
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	Дата и время создания отчета
datasetId	string	Идентификатор набора данных отчета
description	string	Описание отчета
embedUrl	string	URL-адрес внедрения отчета
id	string	Идентификатор отчета
isOwnedByMe	boolean	Определите, создан ли отчет текущим пользователем.
modifiedBy	string	Последний пользователь, изменяющий отчет
modifiedDateTime	string	Дата и время последнего изменения отчета
name	string	Имя отчета
originalReportId	string	Фактический идентификатор отчета при публикации рабочей области в виде приложения.
reportType	enum: PaginatedReport PowerBIReport	Тип отчета
subscriptions	Subscription[]	(Пустое значение) Сведения о подписке для элемента Power BI (например, отчета или панели мониторинга). Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Сведения о подписке для отчета Power BI можно получить с помощью команды Получить подписки на отчеты как Администратор вызов API.
users	ReportUser[]	(Пустое значение) Сведения о доступе пользователей к отчету Power BI. Это свойство будет удалено из ответа полезных данных в предстоящем выпуске. Вы можете получить сведения о пользователях в отчете Power BI с помощью метода Get Report Users as Администратор API или вызова API PostWorkspaceInfo с параметром `getArtifactUsers` .
webUrl	string	URL-адрес отчета в интернете
workspaceId	string	Идентификатор рабочей области (GUID) отчета. Это свойство будет возвращено только в GetReportsAsAdmin.

AdminTile

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

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

AzureResource

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

Имя	Тип	Описание
id	string	Идентификатор ресурса в Power BI.
resourceGroup	string	Группа ресурсов в подписке, в которой находится ресурс.
resourceName	string	Имя ресурса.
subscriptionId	string	Подписка 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	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	Предоставляет доступ на чтение и запись к содержимому в потоке данных

DatasetQueryScaleOutSettings

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

Имя	Тип	Описание
autoSyncReadOnlyReplicas	boolean	Автоматически ли набор данных синхронизирует реплики только для чтения
maxReadOnlyReplicas	integer	Максимальное число реплик только для чтения для набора данных (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	string	Удаляет разрешение на содержимое в наборе данных.
Read	string	Предоставляет доступ на чтение к содержимому в наборе данных.
ReadExplore	string	Предоставляет доступ на чтение и просмотр к содержимому в наборе данных
ReadReshare	string	Предоставляет доступ для чтения и повторного доступа к содержимому в наборе данных.
ReadReshareExplore	string	Предоставляет доступ для чтения, повторного доступа и просмотра к содержимому в наборе данных.
ReadWrite	string	Предоставляет доступ на чтение и запись к содержимому в наборе данных.
ReadWriteExplore	string	Предоставляет доступ для чтения, записи и просмотра к содержимому в наборе данных.
ReadWriteReshare	string	Предоставляет доступ для чтения, записи и повторного доступа к содержимому в наборе данных.
ReadWriteReshareExplore	string	Предоставляет доступ для чтения, записи, повторного доступа и просмотра к содержимому в наборе данных.

DefaultDatasetStorageFormat

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

Имя	Тип	Описание
Large	string	Формат хранения большого набора данных
Small	string	Формат хранения небольших наборов данных

DependentDataflow

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

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

Encryption

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

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

EncryptionStatus

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

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

GroupType

Тип группы

Имя	Тип	Описание
Group	string	Версия 1 общей рабочей области. Этот тип рабочих областей будет нерекомендуем, так как корпорация Майкрософт переносит все рабочие области в последнюю версию общей рабочей области.
Personal	string	Специальный тип рабочей области, предназначенный для интеграции со списком SharePoint и OneDrive
PersonalGroup	string	"Моя рабочая область", также известная как личная рабочая область
Workspace	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	Доступ только для чтения (чтение) к содержимому рабочей области

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

ServicePrincipalProfile

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

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

Subscription

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

Имя	Тип	Описание
artifactDisplayName	string	Имя элемента Power BI, на который подписана подписка (например, отчет или панель мониторинга).
artifactId	string	Идентификатор элемента Power BI, на который подписана подписка (например, отчет или панель мониторинга).
artifactType	string	Тип элемента Power BI (например `Report`, , `Dashboard`или `Dataset`)
attachmentFormat	string	Формат отчета, вложенного в подписку электронной почты
endDate	string	Дата и время окончания подписки по электронной почте
frequency	string	Частота подписки электронной почты
id	string	Идентификатор подписки
isEnabled	boolean	Включена ли подписка на электронную почту
linkToContent	boolean	Существует ли ссылка на подписку в подписке электронной почты
previewImage	boolean	Существует ли снимок экрана отчета в подписке электронной почты
startDate	string	Дата и время начала подписки электронной почты
subArtifactDisplayName	string	Имя страницы элемента Power BI, на который подписана подписка, если это отчет.
title	string	Имя приложения
users	SubscriptionUser[]	Сведения о каждом подписчике электронной почты. При использовании вызова API Get User Subscriptions As Администратор возвращаемое значение представляет собой пустой массив (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	Имя книги

Поделиться через

Admin - Groups GetGroupsAsAdmin

Разрешения

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

Ограничения

Параметры URI

Ответы

Примеры

Get deleted workspaces example.

Sample Request

Sample Response

Get orphaned workspaces example.

Sample Request

Sample Response

Get workspaces with their 'dashboards' expanded example

Sample Request

Sample Response

Get workspaces with their 'datasets' expanded example

Sample Request

Sample Response

Get workspaces with their 'datasets' expanded example.

Sample Request

Sample Response

Get workspaces with their 'reports' expanded example

Sample Request

Sample Response

Get workspaces with their 'users' expanded example.

Sample Request

Sample Response

Get workspaces with their 'workbooks' expanded example

Sample Request

Sample Response

Определения

AdminDashboard

AdminDataflow

AdminDataset

AdminGroup

AdminGroups

AdminReport

AdminTile

AzureResource

DashboardUser

DashboardUserAccessRight

DataflowUser

DataflowUserAccessRight

DatasetQueryScaleOutSettings

DatasetUser

DatasetUserAccessRight

DefaultDatasetStorageFormat

DependentDataflow

Encryption

EncryptionStatus

GroupType

GroupUser

GroupUserAccessRight

PrincipalType

ReportUser

ReportUserAccessRight

ServicePrincipalProfile

Subscription

SubscriptionUser

Workbook

Дополнительные ресурсы