Groups - Get Groups

Service:

Power BI REST APIs

API Version:

v1.0

Mengembalikan daftar ruang kerja yang dapat diakses pengguna.

Izin

Panggilan API ini dapat dipanggil oleh profil perwakilan layanan. Untuk informasi selengkapnya lihat: Profil perwakilan layanan di Power BI Embedded.

Cakupan yang Diperlukan

Workspace.Read.All atau Workspace.ReadWrite.All

Batasan

• Izin pengguna untuk ruang kerja membutuhkan waktu untuk diperbarui dan mungkin tidak segera tersedia saat menggunakan panggilan API. Untuk merefresh izin pengguna, gunakan panggilan REFRESH USER Permissions 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}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
$filter	query		string	Memfilter hasil, berdasarkan kondisi boolean
$skip	query		integer int32	Melewati hasil n pertama
$top	query		integer int32	Hanya mengembalikan hasil n pertama

Respons

Nama	Jenis	Deskripsi
200 OK	Groups	OK

Contoh

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

Definisi

Nama	Deskripsi
AzureResource	Respons yang merinci sumber daya Azure milik pengguna seperti ruang kerja Analitik Log.
DefaultDatasetStorageFormat	Format penyimpanan himpunan data default dalam grup
Group	Grup Power BI
Groups	Pembungkus respons OData untuk daftar grup Power BI

AzureResource

Respons yang merinci sumber daya Azure milik pengguna seperti ruang kerja Analitik Log.

Nama	Jenis	Deskripsi
id	string	Pengidentifikasi untuk sumber daya dalam Power BI.
resourceGroup	string	Grup sumber daya dalam langganan tempat sumber daya berada.
resourceName	string	Nama sumber daya.
subscriptionId	string	Langganan Azure tempat sumber daya berada.

DefaultDatasetStorageFormat

Format penyimpanan himpunan data default dalam grup

Nama	Jenis	Deskripsi
Large	string	Format penyimpanan himpunan data besar
Small	string	Format penyimpanan himpunan data kecil

Group

Grup Power BI

Nama	Jenis	Deskripsi
capacityId	string	ID kapasitas
dataflowStorageId	string	ID akun penyimpanan aliran data Power BI
defaultDatasetStorageFormat	DefaultDatasetStorageFormat	Format penyimpanan himpunan data default di ruang kerja. Dikembalikan hanya ketika isOnDedicatedCapacity adalah true
id	string	ID ruang kerja
isOnDedicatedCapacity	boolean	Apakah grup ditetapkan ke kapasitas khusus
isReadOnly	boolean	Apakah grup bersifat baca-saja
logAnalyticsWorkspace	AzureResource	Ruang kerja Analitik Log yang ditetapkan ke grup. Ini hanya dikembalikan saat mengambil satu grup.
name	string	Nama grup

Groups

Pembungkus respons OData untuk daftar grup Power BI

Nama	Jenis	Deskripsi
odata.context	string	Konteks OData
value	Group[]	Daftar grup