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

Groups - Get Groups

Служба:
Power BI REST APIs
Версия API:
v1.0

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

Разрешения

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

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

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

Ограничения

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

GET https://api.powerbi.com/v1.0/myorg/groups
С использованием необязательных параметров: 
GET https://api.powerbi.com/v1.0/myorg/groups?$filter={$filter}&$top={$top}&$skip={$skip}

Параметры URI

Имя В Обязательно Тип Описание
$filter
 query

string

Возвращает подмножество результатов на основе условия параметра запроса Odata Odata фильтра.
$skip
 query

integer (int32)

Пропускает первые результаты n
$top
 query

integer (int32)

Возвращает только первые результаты n

Ответы

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

Groups

ХОРОШО

Примеры

Example
Get a list of workspaces using a filter example

Example

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

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

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

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

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

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

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

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

Object

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

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

string (uuid)

Идентификатор ресурса в Power BI.
resourceGroup

string

Группа ресурсов в подписке, в которой находится ресурс.
resourceName

string

Имя ресурса.
subscriptionId

string (uuid)

Подписка Azure, в которой находится ресурс.

DefaultDatasetStorageFormat

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

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

Значение Описание
Small

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

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

Group

Object

Группа Power BI

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

string (uuid)

Идентификатор емкости
dataflowStorageId

string (uuid)

Идентификатор учетной записи хранения потока данных Power BI
defaultDatasetStorageFormat

DefaultDatasetStorageFormat

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

string (uuid)

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

boolean

Назначается ли группа выделенной емкости
isReadOnly

boolean

Является ли группа доступной только для чтения
logAnalyticsWorkspace

AzureResource

Рабочая область Log Analytics, назначенная группе. Возвращается только при получении одной группы.
name

string

Имя группы

Groups

Object

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

Имя Тип Описание
@odata.context

string

Контекст OData
value

Group[]

Список групп