Groups - Get Groups

Service:

Power BI REST APIs

API Version:

v1.0

Возвращает список рабочих областей, к которые у пользователя есть доступ.

Разрешения

Этот вызов API может вызываться профилем субъекта-службы. Дополнительные сведения см. в статье Профили субъектов-служб в Power BI Embedded.

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

Workspace.Read.All или Workspace.ReadWrite.All

Ограничения

• Для обновления разрешений пользователей для рабочих областей требуется время, и при использовании вызовов API они могут быть недоступны не сразу. Чтобы обновить разрешения пользователей, используйте вызов API "Обновить разрешения пользователя ".
  
  

GET https://api.powerbi.com/v1.0/myorg/groups

With optional parameters:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
$filter	query		string	Фильтрует результаты на основе логического условия
$skip	query		integer int32	Пропускает первые n результатов
$top	query		integer int32	Возвращает только первые n результатов

Ответы

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

Примеры

Example

Get a list of workspaces using a filter example

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "sample group"
    },
    {
      "id": "3d9b93c6-7b6d-4801-a491-1738910904fd",
      "isReadOnly": false,
      "isOnDedicatedCapacity": true,
      "capacityId": "0f084df7-c13d-451b-af5f-ed0c466403b2",
      "defaultDatasetStorageFormat": "Small",
      "name": "marketing group"
    },
    {
      "id": "a2f89923-421a-464e-bf4c-25eab39bb09f",
      "isReadOnly": false,
      "isOnDedicatedCapacity": true,
      "capacityId": "0f084df7-c13d-451b-af5f-ed0c466403b2",
      "defaultDatasetStorageFormat": "Large",
      "name": "contoso",
      "dataflowStorageId": "d692ae06-708c-485e-9987-06ff0fbdbb1f"
    }
  ]
}

Get a list of workspaces using a filter example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups?$filter=contains(name,'marketing')%20or%20name%20eq%20'contoso'

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "3d9b93c6-7b6d-4801-a491-1738910904fd",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "marketing group"
    },
    {
      "id": "a2f89923-421a-464e-bf4c-25eab39bb09f",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "contoso",
      "dataflowStorageId": "d692ae06-708c-485e-9987-06ff0fbdbb1f"
    }
  ]
}

Определения

Имя	Описание
AzureResource	Ответ с подробными сведениями о ресурсе Azure, принадлежавом пользователю, например рабочей области Log Analytics.
DefaultDatasetStorageFormat	Формат хранилища набора данных по умолчанию в группе
Group	Группа Power BI
Groups	Оболочка ответа OData для списка групп Power BI

AzureResource

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

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

DefaultDatasetStorageFormat

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

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

Group

Группа Power BI

Имя	Тип	Описание
capacityId	string	Идентификатор емкости
dataflowStorageId	string	Идентификатор учетной записи хранения потока данных Power BI
defaultDatasetStorageFormat	DefaultDatasetStorageFormat	Формат хранилища набора данных по умолчанию в рабочей области. Возвращается только в том случае, если isOnDedicatedCapacity имеет значение true
id	string	идентификатор рабочей области;
isOnDedicatedCapacity	boolean	Указывает, назначена ли группа выделенной емкости
isReadOnly	boolean	Является ли группа доступной только для чтения
logAnalyticsWorkspace	AzureResource	Рабочая область Log Analytics, назначенная группе. Возвращается только при получении одной группы.
name	string	Имя группы

Groups

Оболочка ответа OData для списка групп Power BI

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