다음을 통해 공유

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 매개 변수

Name In(다음 안에) 필수 형식 Description
$filter
 query

string

부울 조건에 따라 결과를 필터링합니다.
$skip
 query

integer

int32

첫 번째 n 결과 건너뛰기
$top
 query

integer

int32

첫 번째 n 결과만 반환합니다.

응답

Name 형식 Description
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"
    }
  ]
}

정의

Name Description
AzureResource

Log Analytics 작업 영역과 같은 사용자 소유 Azure 리소스를 자세히 설명하는 응답입니다.
DefaultDatasetStorageFormat

그룹의 기본 데이터 세트 스토리지 형식
Group

Power BI 그룹
Groups

Power BI 그룹 목록의 OData 응답 래퍼

AzureResource

Log Analytics 작업 영역과 같은 사용자 소유 Azure 리소스를 자세히 설명하는 응답입니다.

Name 형식 Description
id

string

Power BI 내의 리소스에 대한 식별자입니다.
resourceGroup

string

리소스가 있는 구독 내의 리소스 그룹입니다.
resourceName

string

리소스의 이름입니다.
subscriptionId

string

리소스가 있는 Azure 구독입니다.

DefaultDatasetStorageFormat

그룹의 기본 데이터 세트 스토리지 형식

Name 형식 Description
Large

string

대용량 데이터 세트 스토리지 형식
Small

string

작은 데이터 세트 스토리지 형식

Group

Power BI 그룹

Name 형식 Description
capacityId

string

용량 ID
dataflowStorageId

string

Power BI 데이터 흐름 스토리지 계정 ID
defaultDatasetStorageFormat

DefaultDatasetStorageFormat

작업 영역의 기본 데이터 세트 스토리지 형식입니다. 가 인 경우에만 반환됩니다.isOnDedicatedCapacitytrue
id

string

작업 영역 ID
isOnDedicatedCapacity

boolean

그룹이 전용 용량에 할당되었는지 여부
isReadOnly

boolean

그룹이 읽기 전용인지 여부
logAnalyticsWorkspace

AzureResource

그룹에 할당된 Log Analytics 작업 영역입니다. 단일 그룹을 검색할 때만 반환됩니다.
name

string

그룹 이름

Groups

Power BI 그룹 목록의 OData 응답 래퍼

Name 형식 Description
odata.context

string

OData 컨텍스트
value

Group[]

그룹 목록