다음을 통해 공유

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

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

string

Odata 필터 쿼리 매개 변수 조건에 따라 결과의 하위 집합을 반환합니다.
$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

샘플 요청

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"
    }
  ]
}

정의

Name Description
AzureResource

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

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

Power BI 그룹
Groups

Power BI 그룹 목록에 대한 OData 응답 래퍼

AzureResource

Object

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

Name 형식 Description
id

string (uuid)

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

string

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

string

리소스의 이름입니다.
subscriptionId

string (uuid)

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

DefaultDatasetStorageFormat

열거형

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

값 Description
Small

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

큰 데이터 세트 스토리지 형식

Group

Object

Power BI 그룹

Name 형식 Description
capacityId

string (uuid)

용량 ID
dataflowStorageId

string (uuid)

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

DefaultDatasetStorageFormat

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

string (uuid)

작업 영역 ID
isOnDedicatedCapacity

boolean

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

boolean

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

AzureResource

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

string

그룹 이름

Groups

Object

Power BI 그룹 목록에 대한 OData 응답 래퍼

Name 형식 Description
@odata.context

string

OData 컨텍스트
value

Group[]

그룹 목록