Admin - Groups GetGroupsAsAdmin

Referensi

Service:: Power BI REST APIs

API Version:: v1.0

Mengembalikan daftar ruang kerja untuk organisasi.

Izin

Pengguna harus memiliki hak administrator (seperti Office 365 Administrator Global atau Administrator Layanan Power BI) atau mengautentikasi menggunakan perwakilan layanan.
Izin yang didelegasikan didukung.

Saat berjalan di bawah autentikasi perwakilan layanan, aplikasi tidak boleh memiliki izin admin yang diperlukan untuk Power BI yang diatur di dalam portal Azure.

Cakupan yang Diperlukan

Tenant.Read.All atau Tenant.ReadWrite.All

Hanya relevan saat mengautentikasi melalui token akses admin standar yang didelegasikan. Tidak boleh ada ketika autentikasi melalui perwakilan layanan digunakan.

Batasan

Maksimum 50 permintaan per jam atau 15 permintaan per menit, per penyewa. Panggilan ini juga akan kehabisan waktu setelah 30 detik untuk mencegah efek buruk pada layanan Power BI.

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

With optional parameters:

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
$top	query	True	integer int32	Hanya mengembalikan hasil n pertama. Parameter ini wajib dan harus dalam kisaran 1-5000.
$expand	query		string	Menerima daftar jenis data yang dipisahkan koma, yang akan diperluas sebaris dalam respons. `users`Mendukung , , `reportsdashboards`, `datasets`, `dataflows`, dan `workbooks`.
$filter	query		string	Memfilter hasil berdasarkan kondisi boolean
$skip	query		integer int32	Melompati hasil n pertama. Gunakan dengan atas untuk mengambil hasil di luar 5000 pertama.

Respons

Nama	Jenis	Deskripsi
200 OK	AdminGroups	OK

Contoh

Get deleted workspaces example.

Get orphaned workspaces example.

Get workspaces with their 'dashboards' expanded example

Get workspaces with their 'datasets' expanded example

Get workspaces with their 'datasets' expanded example.

Get workspaces with their 'reports' expanded example

Get workspaces with their 'users' expanded example.

Get workspaces with their 'workbooks' expanded example

Get deleted workspaces example.

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$filter=state eq 'Deleted'&$top=100

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "Sample Group 2",
      "description": "Deleted sample group",
      "type": "Workspace",
      "state": "Deleted"
    }
  ]
}

Get orphaned workspaces example.

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=users&$filter=(not users/any()) or (not users/any(u: u/groupUserAccessRight eq Microsoft.PowerBI.ServiceContracts.Api.GroupUserAccessRight'Admin'))&$top=100

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "d5caa808-8c91-400a-911d-06af08dbcc31",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "Orphaned Group",
      "description": "Sample orphan group",
      "type": "Workspace",
      "state": "Active",
      "hasWorkspaceLevelSettings": false,
      "users": []
    }
  ]
}

Get workspaces with their 'dashboards' expanded example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=dashboards&$top=100

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "94E57E92-CEE2-486D-8CC8-218C97200579",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "capacityMigrationStatus": "Migrated",
      "description": "shorter description",
      "type": "Workspace",
      "state": "Removing",
      "name": "a",
      "hasWorkspaceLevelSettings": false,
      "dashboards": [
        {
          "id": "4668133c-ae3f-42fb-ad7c-214a8623280c",
          "displayName": "SQlAzure-Refresh.pbix",
          "isReadOnly": false
        },
        {
          "id": "a8f18ca7-63e8-4220-bc1c-f576ec180b98",
          "displayName": "cdvc",
          "isReadOnly": false
        }
      ]
    }
  ]
}

Get workspaces with their 'datasets' expanded example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=datasets&$top=100

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "94E57E92-CEE2-486D-8CC8-218C97200579",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "capacityMigrationStatus": "Migrated",
      "description": "shorter description",
      "type": "Workspace",
      "state": "Removing",
      "name": "a",
      "hasWorkspaceLevelSettings": false,
      "datasets": [
        {
          "id": "8ce96c50-85a0-4db3-85c6-7ccc3ed46523",
          "name": "SQlAzure-Refresh",
          "addRowsAPIEnabled": false,
          "configuredBy": "admin@granularcontrols.ccsctp.net",
          "isRefreshable": true,
          "isEffectiveIdentityRequired": false,
          "isEffectiveIdentityRolesRequired": false,
          "isOnPremGatewayRequired": false,
          "targetStorageMode": "Abf",
          "createdDate": "2019-04-30T21:35:15.867-07:00",
          "ContentProviderType": "PbixInImportMode",
          "isInPlaceSharingEnabled": false
        },
        {
          "id": "7d6a4f72-1906-4e08-a469-bd6bc1ab7b69",
          "name": "NESGames",
          "addRowsAPIEnabled": false,
          "configuredBy": "admin@granularcontrols.ccsctp.net",
          "isRefreshable": true,
          "isEffectiveIdentityRequired": false,
          "isEffectiveIdentityRolesRequired": false,
          "isOnPremGatewayRequired": false,
          "targetStorageMode": "Abf",
          "createdDate": "2019-04-30T21:35:15.867-07:00",
          "ContentProviderType": "PbixInImportMode",
          "isInPlaceSharingEnabled": false
        }
      ]
    }
  ]
}

Get workspaces with their 'datasets' expanded example.

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=datasets

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "e380d1d0-1fa6-460b-9a90-1a5c6b02414c",
      "isReadOnly": false,
      "isOnDedicatedCapacity": true,
      "capacityId": "0f084df7-c13d-451b-af5f-ed0c466403b2",
      "defaultDatasetStorageFormat": "Small",
      "name": "Sample Group 1",
      "description": "Sample group",
      "type": "Workspace",
      "state": "Active",
      "hasWorkspaceLevelSettings": true,
      "datasets": [
        {
          "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
          "name": "SalesMarketing",
          "addRowsAPIEnabled": false,
          "configuredBy": "john@contoso.com",
          "isRefreshable": true,
          "isEffectiveIdentityRequired": false,
          "isEffectiveIdentityRolesRequired": false,
          "isOnPremGatewayRequired": false,
          "isInPlaceSharingEnabled": false,
          "encryption": {
            "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
            "encryptionStatus": "InSyncWithWorkspace"
          }
        }
      ]
    },
    {
      "id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "Sample Group 2",
      "description": "Deleted sample group",
      "type": "Workspace",
      "state": "Deleted",
      "datasets": []
    }
  ]
}

Get workspaces with their 'reports' expanded example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=reports&$top=100

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "EC1EE11F-845D-495E-82A3-9DAC2072305A",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "capacityMigrationStatus": "Migrated",
      "description": "cvcv",
      "type": "Workspace",
      "state": "Active",
      "name": "WSv2Test12",
      "hasWorkspaceLevelSettings": true,
      "reports": []
    },
    {
      "id": "94E57E92-CEE2-486D-8CC8-218C97200579",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "capacityMigrationStatus": "Migrated",
      "description": "shorter description",
      "type": "Workspace",
      "state": "Removing",
      "name": "a",
      "hasWorkspaceLevelSettings": false,
      "reports": [
        {
          "id": "5DBA60B0-D9A7-42AE-B12C-6D9D51E7739A",
          "reportType": "PowerBIReport",
          "name": "SQlAzure-Refresh",
          "datasetId": "8ce96c50-85a0-4db3-85c6-7ccc3ed46523"
        },
        {
          "id": "197E5C3C-D2F3-42D8-A536-875FB6D7D48C",
          "reportType": "PowerBIReport",
          "name": "NESGames",
          "datasetId": "7d6a4f72-1906-4e08-a469-bd6bc1ab7b69"
        }
      ]
    }
  ]
}

Get workspaces with their 'users' expanded example.

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=users&$top=100

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "e380d1d0-1fa6-460b-9a90-1a5c6b02414c",
      "isReadOnly": false,
      "isOnDedicatedCapacity": true,
      "capacityId": "0f084df7-c13d-451b-af5f-ed0c466403b2",
      "defaultDatasetStorageFormat": "Small",
      "name": "Sample Group 1",
      "description": "Sample group",
      "type": "Workspace",
      "state": "Active",
      "hasWorkspaceLevelSettings": false,
      "users": [
        {
          "emailAddress": "john@contoso.com",
          "groupUserAccessRight": "Admin"
        }
      ]
    },
    {
      "id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "Sample Group 2",
      "description": "Deleted sample group",
      "type": "Workspace",
      "state": "Deleted",
      "users": []
    }
  ]
}

Get workspaces with their 'workbooks' expanded example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=workbooks&$top=100

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "94E57E92-CEE2-486D-8CC8-218C97200579",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "description": "shorter description",
      "type": "Workspace",
      "state": "Removing",
      "hasWorkspaceLevelSettings": false,
      "name": "a",
      "workbooks": [
        {
          "name": "My Excel sheet",
          "datasetId": "8ce96c50-85a0-4db3-85c6-7ccc3ed46523"
        }
      ]
    }
  ]
}

Definisi

Nama	Deskripsi
AdminDashboard	Dasbor Power BI yang dikembalikan oleh API Admin. API mengembalikan subset dari daftar properti dasbor berikut. Subset bergantung pada API yang disebut, izin pemanggil, dan ketersediaan data dalam database Power BI.
AdminDataflow	Metadata aliran data yang dikembalikan oleh API Admin. Di bawah ini adalah daftar properti yang dapat dikembalikan untuk aliran data. Hanya subset properti yang akan dikembalikan tergantung pada API yang dipanggil, izin pemanggil, dan ketersediaan data dalam database Power BI.
AdminDataset	Himpunan data Power BI yang dikembalikan oleh API Admin. API mengembalikan subset dari daftar properti himpunan data berikut. Subset bergantung pada API yang disebut, izin pemanggil, dan ketersediaan data dalam database Power BI.
AdminGroup	Grup Power BI yang dikembalikan oleh API admin
AdminGroups	Pembungkus respons OData untuk daftar grup Power BI yang dikembalikan oleh API Admin
AdminReport	Laporan Power BI yang dikembalikan oleh API Admin. API mengembalikan subset dari daftar properti laporan berikut. Subset bergantung pada API yang disebut, izin pemanggil, dan ketersediaan data dalam database Power BI.
AdminTile	Petak Peta Power BI yang dikembalikan oleh API Admin.
AzureResource	Respons yang merinci sumber daya Azure milik pengguna seperti ruang kerja Analitik Log.
DashboardUser	Entri kanan akses pengguna Power BI untuk dasbor
DashboardUserAccessRight	Hak akses yang dimiliki pengguna untuk dasbor (tingkat izin)
DataflowUser	Entri kanan akses pengguna Power BI untuk aliran data
DataflowUserAccessRight	Hak akses yang dimiliki pengguna untuk aliran data (tingkat izin)
DatasetQueryScaleOutSettings	Pengaturan peluasan skala kueri himpunan data
DatasetUser	Entri kanan akses pengguna Power BI untuk himpunan data
DatasetUserAccessRight	Hak akses yang dimiliki pengguna untuk himpunan data (tingkat izin)
DefaultDatasetStorageFormat	Format penyimpanan himpunan data default dalam grup
DependentDataflow	Aliran data dependen Power BI
Encryption	Informasi enkripsi untuk himpunan data
EncryptionStatus	Status enkripsi himpunan data
GroupType	Jenis grup
GroupUser	Pengguna Power BI dengan akses ke ruang kerja
GroupUserAccessRight	Hak akses (tingkat izin) yang dimiliki pengguna di ruang kerja
PrincipalType	Jenis utama
ReportUser	Entri kanan akses pengguna Power BI untuk laporan
ReportUserAccessRight	Hak akses yang dimiliki pengguna untuk laporan (tingkat izin)
ServicePrincipalProfile	Profil utama layanan Power BI. Hanya relevan untuk solusi multipenyewa Power BI Embedded.
Subscription	Langganan email untuk item Power BI (seperti laporan atau dasbor)
SubscriptionUser	Pengguna langganan email Power BI
Workbook	Buku kerja Power BI

AdminDashboard

Dasbor Power BI yang dikembalikan oleh API Admin. API mengembalikan subset dari daftar properti dasbor berikut. Subset bergantung pada API yang disebut, izin pemanggil, dan ketersediaan data dalam database Power BI.

Nama	Jenis	Deskripsi
appId	string	ID aplikasi, dikembalikan hanya jika dasbor milik aplikasi
displayName	string	Nama tampilan dasbor
embedUrl	string	URL semat dasbor
id	string	ID dasbor
isReadOnly	boolean	Apakah dasbor bersifat baca-saja
subscriptions	Subscription[]	(Nilai Kosong) Detail langganan untuk item Power BI (seperti laporan atau dasbor). Properti ini akan dihapus dari respons payload dalam rilis mendatang. Anda bisa mengambil informasi langganan untuk laporan Power BI dengan menggunakan Dapatkan Langganan Laporan sebagai Admin panggilan API.
tiles	AdminTile[]	Petak yang termasuk dalam dasbor
users	DashboardUser[]	(Nilai kosong) Detail akses pengguna dasbor. Properti ini akan dihapus dari respons payload dalam rilis mendatang. Anda dapat mengambil informasi pengguna di dasbor Power BI dengan menggunakan Get Dashboard Users sebagai Admin panggilan API, atau panggilan POSTWorkspaceInfo API dengan `getArtifactUsers` parameter .
webUrl	string	URL web dasbor
workspaceId	string	ID ruang kerja (GUID) dasbor. Properti ini hanya akan dikembalikan di GetDashboardsAsAdmin.

AdminDataflow

Metadata aliran data yang dikembalikan oleh API Admin. Di bawah ini adalah daftar properti yang dapat dikembalikan untuk aliran data. Hanya subset properti yang akan dikembalikan tergantung pada API yang dipanggil, izin pemanggil, dan ketersediaan data dalam database Power BI.

Nama	Jenis	Deskripsi
configuredBy	string	Pemilik aliran data
description	string	Deskripsi aliran data
modelUrl	string	URL ke file definisi aliran data (model.json)
modifiedBy	string	Pengguna yang memodifikasi aliran data
modifiedDateTime	string	Tanggal dan waktu aliran data terakhir diubah
name	string	Nama aliran data
objectId	string	ID aliran data
users	DataflowUser[]	(Nilai kosong) Detail akses pengguna aliran data. Properti ini akan dihapus dari respons payload dalam rilis mendatang. Anda dapat mengambil informasi pengguna tentang aliran data Power BI dengan menggunakan panggilan Dapatkan Pengguna Aliran Data sebagai Admin API, atau panggilan API PostWorkspaceInfo dengan `getArtifactUser` parameter .
workspaceId	string	ID ruang kerja aliran data.

AdminDataset

Himpunan data Power BI yang dikembalikan oleh API Admin. API mengembalikan subset dari daftar properti himpunan data berikut. Subset bergantung pada API yang disebut, izin pemanggil, dan ketersediaan data dalam database Power BI.

Nama	Jenis	Deskripsi
ContentProviderType	string	Jenis penyedia konten untuk himpunan data
CreateReportEmbedURL	string	URL semat laporan pembuatan himpunan data
CreatedDate	string	Tanggal dan waktu pembuatan himpunan data
Encryption	Encryption	Informasi enkripsi himpunan data. Hanya berlaku ketika `$expand` ditentukan.
IsEffectiveIdentityRequired	boolean	Apakah himpunan data memerlukan identitas yang efektif, yang harus Anda kirim dalam panggilan GENERATEToken API.
IsEffectiveIdentityRolesRequired	boolean	Apakah keamanan tingkat baris ditentukan di dalam file .pbix Power BI. Jika demikian, Anda harus menentukan peran.
IsInPlaceSharingEnabled	boolean	Apakah himpunan data dapat dibagikan dengan pengguna eksternal untuk dikonsumsi di penyewa mereka sendiri
IsOnPremGatewayRequired	boolean	Apakah himpunan data memerlukan gateway data lokal
IsRefreshable	boolean	Apakah himpunan data dapat disegarkan atau tidak. Himpunan data yang dapat disegarkan Power BI adalah himpunan data yang telah di-refresh setidaknya sekali, atau di mana jadwal refresh yang valid ada.
QnaEmbedURL	string	Himpunan data Q&URL semat
addRowsAPIEnabled	boolean	Apakah himpunan data memungkinkan penambahan baris baru
configuredBy	string	Pemilik himpunan data
description	string	Deskripsi himpunan data
id	string	ID himpunan data
name	string	Nama himpunan data
queryScaleOutSettings	DatasetQueryScaleOutSettings	Pengaturan peluasan skala kueri himpunan data
targetStorageMode	string	Mode penyimpanan himpunan data
upstreamDataflows	DependentDataflow[]	Daftar semua aliran data yang bergantung pada item ini
users	DatasetUser[]	(Nilai kosong) Detail akses pengguna himpunan data. Properti ini akan dihapus dari respons payload dalam rilis mendatang. Anda dapat mengambil informasi pengguna tentang item Power BI (seperti laporan atau dasbor) dengan menggunakan Get Dataset Users as Admin API, atau PostWorkspaceInfo API dengan `getArtifactUsers` parameter .
webUrl	string	URL web himpunan data
workspaceId	string	ID ruang kerja himpunan data. Properti ini hanya akan dikembalikan di GetDatasetsAsAdmin.

AdminGroup

Grup Power BI yang dikembalikan oleh API admin

Nama	Jenis	Deskripsi
capacityId	string	ID kapasitas
dashboards	AdminDashboard[]	Dasbor yang termasuk dalam grup
dataflowStorageId	string	ID akun penyimpanan aliran data Power BI
dataflows	AdminDataflow[]	Aliran data yang termasuk dalam grup
datasets	AdminDataset[]	Himpunan data yang termasuk dalam grup
defaultDatasetStorageFormat	DefaultDatasetStorageFormat	Format penyimpanan himpunan data default di ruang kerja. Dikembalikan hanya ketika `isOnDedicatedCapacity` adalah `true`
description	string	Deskripsi grup
hasWorkspaceLevelSettings	boolean	Apakah ruang kerja memiliki pengaturan kustom
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
pipelineId	string	ID alur penyebaran tempat ruang kerja ditetapkan.
reports	AdminReport[]	Laporan yang termasuk dalam grup
state	string	Status grup
type	GroupType	Jenis grup yang dikembalikan.
users	GroupUser[]	(Nilai kosong) Pengguna yang termasuk dalam grup dan hak akses mereka. Properti ini akan dihapus dari respons payload dalam rilis mendatang. Anda dapat mengambil informasi pengguna pada item Power BI (seperti laporan atau dasbor) dengan menggunakan panggilan Get Group Users As Admin API, atau panggilan POSTWorkspaceInfo API dengan `getArtifactUsers` parameter .
workbooks	Workbook[]	Buku kerja yang termasuk dalam grup

AdminGroups

Pembungkus respons OData untuk daftar grup Power BI yang dikembalikan oleh API Admin

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

AdminReport

Laporan Power BI yang dikembalikan oleh API Admin. API mengembalikan subset dari daftar properti laporan berikut. Subset bergantung pada API yang disebut, izin pemanggil, dan ketersediaan data dalam database Power BI.

Nama	Jenis	Deskripsi
appId	string	ID aplikasi, dikembalikan hanya jika laporan milik aplikasi
createdBy	string	Pemilik laporan. Hanya tersedia untuk laporan yang dibuat setelah Juni 2019.
createdDateTime	string	Tanggal dan waktu pembuatan laporan
datasetId	string	ID himpunan data laporan
description	string	Deskripsi laporan
embedUrl	string	URL laporan yang disematkan
id	string	ID laporan
isOwnedByMe	boolean	Tentukan apakah laporan dibuat oleh pengguna saat ini.
modifiedBy	string	Pengguna terakhir yang mengubah laporan
modifiedDateTime	string	Tanggal dan waktu laporan terakhir diubah
name	string	Nama laporan
originalReportId	string	ID laporan aktual saat ruang kerja diterbitkan sebagai aplikasi.
reportType	enum: PaginatedReport PowerBIReport	Jenis laporan
subscriptions	Subscription[]	(Nilai Kosong) Detail langganan untuk item Power BI (seperti laporan atau dasbor). Properti ini akan dihapus dari respons payload dalam rilis mendatang. Anda bisa mengambil informasi langganan untuk laporan Power BI dengan menggunakan Dapatkan Langganan Laporan sebagai Admin panggilan API.
users	ReportUser[]	(Nilai kosong) Detail akses pengguna untuk laporan Power BI. Properti ini akan dihapus dari respons payload dalam rilis mendatang. Anda dapat mengambil informasi pengguna pada laporan Power BI dengan menggunakan panggilan Get Report Users as Admin API, atau panggilan POSTWorkspaceInfo API dengan `getArtifactUsers` parameter .
webUrl	string	URL web laporan
workspaceId	string	ID ruang kerja (GUID) laporan. Properti ini hanya akan dikembalikan di GetReportsAsAdmin.

AdminTile

Petak Peta Power BI yang dikembalikan oleh API Admin.

Nama	Jenis	Deskripsi
colSpan	integer	Jumlah kolom rentang petak peta
datasetId	string	ID himpunan data. Hanya tersedia untuk petak peta yang dibuat dari laporan atau dengan menggunakan himpunan data, seperti petak peta Q&A.
embedData	string	Menyematkan data untuk petak peta
embedUrl	string	URL semat petak peta
id	string	ID petak peta
reportId	string	ID laporan. Hanya tersedia untuk petak peta yang dibuat dari laporan.
rowSpan	integer	Jumlah baris rentang petak peta
title	string	Nama tampilan petak peta

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.

DashboardUser

Entri kanan akses pengguna Power BI untuk dasbor

Nama	Jenis	Deskripsi
dashboardUserAccessRight	DashboardUserAccessRight	Hak akses yang dimiliki pengguna untuk dasbor (tingkat izin)
displayName	string	Nama tampilan prinsipal
emailAddress	string	Alamat email pengguna
graphId	string	Pengidentifikasi prinsipal di Microsoft Graph. Hanya tersedia untuk API admin.
identifier	string	Pengidentifikasi prinsipal
principalType	PrincipalType	Jenis utama
profile	ServicePrincipalProfile	Profil utama layanan Power BI. Hanya relevan untuk solusi multipenyewa Power BI Embedded.
userType	string	Jenis pengguna.

DashboardUserAccessRight

Hak akses yang dimiliki pengguna untuk dasbor (tingkat izin)

Nama	Jenis	Deskripsi
None	string	Tidak ada izin untuk konten di dasbor
Owner	string	Memberikan akses Baca, Tulis, dan Reshare ke konten dalam laporan
Read	string	Memberikan akses Baca ke konten di dasbor
ReadCopy	string	Memberikan akses Baca dan Salin ke konten di dasbor
ReadReshare	string	Memberikan akses Baca dan Reshare ke konten di dasbor
ReadWrite	string	Memberikan akses Baca dan Tulis ke konten di dasbor

DataflowUser

Entri kanan akses pengguna Power BI untuk aliran data

Nama	Jenis	Deskripsi
DataflowUserAccessRight	DataflowUserAccessRight	Hak akses yang dimiliki pengguna untuk aliran data (tingkat izin)
displayName	string	Nama tampilan prinsipal
emailAddress	string	Alamat email pengguna
graphId	string	Pengidentifikasi prinsipal di Microsoft Graph. Hanya tersedia untuk API admin.
identifier	string	Pengidentifikasi prinsipal
principalType	PrincipalType	Jenis utama
profile	ServicePrincipalProfile	Profil utama layanan Power BI. Hanya relevan untuk solusi multipenyewa Power BI Embedded.
userType	string	Jenis pengguna.

DataflowUserAccessRight

Hak akses yang dimiliki pengguna untuk aliran data (tingkat izin)

Nama	Jenis	Deskripsi
None	string	Menghapus izin ke konten dalam aliran data
Owner	string	Memberikan akses Baca, Tulis, dan Buat Ulang ke konten dalam aliran data
Read	string	Memberikan akses Baca ke konten dalam aliran data
ReadReshare	string	Memberikan akses Baca dan Buat Ulang ke konten dalam aliran data
ReadWrite	string	Memberikan akses Baca dan Tulis ke konten dalam aliran data

DatasetQueryScaleOutSettings

Pengaturan peluasan skala kueri himpunan data

Nama	Jenis	Deskripsi
autoSyncReadOnlyReplicas	boolean	Apakah himpunan data secara otomatis menyinkronkan replika baca-saja
maxReadOnlyReplicas	integer	Jumlah maksimum replika baca-saja untuk himpunan data (0-64, -1 untuk jumlah replika otomatis)

DatasetUser

Entri kanan akses pengguna Power BI untuk himpunan data

Nama	Jenis	Deskripsi
datasetUserAccessRight	DatasetUserAccessRight	Hak akses yang dimiliki pengguna untuk himpunan data (tingkat izin)
displayName	string	Nama tampilan prinsipal
emailAddress	string	Alamat email pengguna
graphId	string	Pengidentifikasi prinsipal di Microsoft Graph. Hanya tersedia untuk API admin.
identifier	string	Pengidentifikasi prinsipal
principalType	PrincipalType	Jenis utama
profile	ServicePrincipalProfile	Profil utama layanan Power BI. Hanya relevan untuk solusi multipenyewa Power BI Embedded.
userType	string	Jenis pengguna.

DatasetUserAccessRight

Hak akses yang dimiliki pengguna untuk himpunan data (tingkat izin)

Nama	Jenis	Deskripsi
None	string	Menghapus izin ke konten dalam himpunan data
Read	string	Memberikan akses Baca ke konten dalam himpunan data
ReadExplore	string	Memberikan akses Baca dan Jelajahi ke konten dalam himpunan data
ReadReshare	string	Memberikan akses Baca dan Reshare ke konten dalam himpunan data
ReadReshareExplore	string	Memberikan akses Baca, Reshare, dan Jelajahi ke konten dalam himpunan data
ReadWrite	string	Memberikan akses Baca dan Tulis ke konten dalam himpunan data
ReadWriteExplore	string	Memberikan akses Baca, Tulis, dan Jelajahi ke konten dalam himpunan data
ReadWriteReshare	string	Memberikan akses Baca, Tulis, dan Reshare ke konten dalam himpunan data
ReadWriteReshareExplore	string	Memberikan akses Baca, Tulis, Reshare, dan Jelajahi konten dalam himpunan data

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

DependentDataflow

Aliran data dependen Power BI

Nama	Jenis	Deskripsi
groupId	string	ID grup target
targetDataflowId	string	ID aliran data target

Encryption

Informasi enkripsi untuk himpunan data

Nama	Jenis	Deskripsi
EncryptionStatus	EncryptionStatus	Status enkripsi himpunan data

EncryptionStatus

Status enkripsi himpunan data

Nama	Jenis	Deskripsi
InSyncWithWorkspace	string	Enkripsi didukung dan sinkron dengan pengaturan enkripsi
NotInSyncWithWorkspace	string	Enkripsi didukung tetapi tidak sinkron dengan pengaturan enkripsi
NotSupported	string	Enkripsi tidak didukung untuk himpunan data ini
Unknown	string	Status enkripsi tidak diketahui karena kerusakan himpunan data

GroupType

Jenis grup

Nama	Jenis	Deskripsi
Group	string	Versi V1 ruang kerja bersama. Jenis ruang kerja ini tidak akan digunakan lagi saat Microsoft memigrasikan semua ruang kerja ke versi terbaru ruang kerja bersama
Personal	string	Tipe ruang kerja khusus yang dimaksudkan untuk daftar SharePoint dan integrasi OneDrive
PersonalGroup	string	"Ruang kerja saya", juga dikenal sebagai ruang kerja pribadi
Workspace	string	Ruang kerja bersama atau ruang kerja sederhana yang digunakan untuk berbagi konten dengan pengguna lain di organisasi

GroupUser

Pengguna Power BI dengan akses ke ruang kerja

Nama	Jenis	Deskripsi
displayName	string	Nama tampilan utama
emailAddress	string	Alamat email pengguna
graphId	string	Pengidentifikasi utama di Microsoft Graph. Hanya tersedia untuk API admin.
groupUserAccessRight	GroupUserAccessRight	Hak akses (tingkat izin) yang dimiliki pengguna di ruang kerja
identifier	string	Pengidentifikasi utama
principalType	PrincipalType	Jenis utama
profile	ServicePrincipalProfile	Profil utama layanan Power BI. Hanya relevan untuk solusi multi-penyewaan Power BI Embedded.
userType	string	Jenis pengguna.

GroupUserAccessRight

Hak akses (tingkat izin) yang dimiliki pengguna di ruang kerja

Nama	Jenis	Deskripsi
Admin	string	Hak administrator untuk konten ruang kerja
Contributor	string	Membaca dan menjelajahi akses (ReadExplore) ke konten ruang kerja
Member	string	Membaca, membentuk ulang, dan menjelajahi hak akses (ReadReshareExplore) ke konten ruang kerja
None	string	Tidak ada akses ke konten ruang kerja
Viewer	string	Akses baca-saja (Baca) ke konten ruang kerja

PrincipalType

Jenis utama

Nama	Jenis	Deskripsi
App	string	Jenis perwakilan layanan
Group	string	Jenis utama grup
None	string	Tidak ada jenis utama. Gunakan untuk seluruh akses tingkat organisasi.
User	string	Jenis prinsipal pengguna

ReportUser

Entri kanan akses pengguna Power BI untuk laporan

Nama	Jenis	Deskripsi
displayName	string	Nama tampilan prinsipal
emailAddress	string	Alamat email pengguna
graphId	string	Pengidentifikasi prinsipal di Microsoft Graph. Hanya tersedia untuk API admin.
identifier	string	Pengidentifikasi prinsipal
principalType	PrincipalType	Jenis utama
profile	ServicePrincipalProfile	Profil utama layanan Power BI. Hanya relevan untuk solusi multipenyewa Power BI Embedded.
reportUserAccessRight	ReportUserAccessRight	Hak akses yang dimiliki pengguna untuk laporan (tingkat izin)
userType	string	Jenis pengguna.

ReportUserAccessRight

Hak akses yang dimiliki pengguna untuk laporan (tingkat izin)

Nama	Jenis	Deskripsi
None	string	Tidak ada izin untuk konten dalam laporan
Owner	string	Memberikan akses Baca, Tulis, dan Reshare ke konten dalam laporan
Read	string	Memberikan akses Baca ke konten dalam laporan
ReadCopy	string	Memberikan akses Baca dan Salin ke konten dalam laporan
ReadReshare	string	Memberikan akses Baca dan Reshare ke konten dalam laporan
ReadWrite	string	Memberikan akses Baca dan Tulis ke konten dalam laporan

ServicePrincipalProfile

Profil utama layanan Power BI. Hanya relevan untuk solusi multipenyewa Power BI Embedded.

Nama	Jenis	Deskripsi
displayName	string	Nama profil perwakilan layanan
id	string	ID profil perwakilan layanan

Subscription

Langganan email untuk item Power BI (seperti laporan atau dasbor)

Nama	Jenis	Deskripsi
artifactDisplayName	string	Nama item Power BI langganan (seperti laporan atau dasbor)
artifactId	string	ID item Power BI langganan (seperti laporan atau dasbor)
artifactType	string	Jenis item Power BI (misalnya `Report`, , `Dashboard`atau `Dataset`)
attachmentFormat	string	Format laporan yang dilampirkan dalam langganan email
endDate	string	Tanggal dan waktu akhir langganan email
frequency	string	Frekuensi langganan email
id	string	ID langganan
isEnabled	boolean	Apakah langganan email diaktifkan
linkToContent	boolean	Apakah tautan langganan ada di langganan email
previewImage	boolean	Apakah cuplikan layar laporan ada di langganan email
startDate	string	Tanggal dan waktu mulai langganan email
subArtifactDisplayName	string	Nama halaman item Power BI langganan, jika itu adalah laporan.
title	string	Nama aplikasi
users	SubscriptionUser[]	Detail setiap pelanggan email. Saat menggunakan panggilan Get User Subscriptions As Admin API, nilai yang dikembalikan adalah array kosong (null). Properti ini akan dihapus dari respons payload dalam rilis mendatang. Anda dapat mengambil informasi langganan pada laporan atau dasbor Power BI dengan menggunakan panggilan Dapatkan Langganan Laporan Sebagai Admin atau Dapatkan Langganan Dasbor Sebagai Admin API.

SubscriptionUser

Pengguna langganan email Power BI

Nama	Jenis	Deskripsi
displayName	string	Nama tampilan prinsipal
emailAddress	string	Alamat email pengguna
graphId	string	Pengidentifikasi prinsipal di Microsoft Graph. Hanya tersedia untuk API admin.
identifier	string	Pengidentifikasi prinsipal
principalType	PrincipalType	Jenis utama
profile	ServicePrincipalProfile	Profil utama layanan Power BI. Hanya relevan untuk solusi multipenyewa Power BI Embedded.
userType	string	Jenis pengguna.

Workbook

Buku kerja Power BI

Nama	Jenis	Deskripsi
datasetId	string	ID himpunan data yang terkait dengan buku kerja. Hanya berlaku jika buku kerja memiliki himpunan data terkait.
name	string	Nama buku kerja

Share via

Admin - Groups GetGroupsAsAdmin

Izin

Cakupan yang Diperlukan

Batasan

Parameter URI

Respons

Contoh

Get deleted workspaces example.

Sample Request

Sample Response

Get orphaned workspaces example.

Sample Request

Sample Response

Get workspaces with their 'dashboards' expanded example

Sample Request

Sample Response

Get workspaces with their 'datasets' expanded example

Sample Request

Sample Response

Get workspaces with their 'datasets' expanded example.

Sample Request

Sample Response

Get workspaces with their 'reports' expanded example

Sample Request

Sample Response

Get workspaces with their 'users' expanded example.

Sample Request

Sample Response

Get workspaces with their 'workbooks' expanded example

Sample Request

Sample Response

Definisi

AdminDashboard

AdminDataflow

AdminDataset

AdminGroup

AdminGroups

AdminReport

AdminTile

AzureResource

DashboardUser

DashboardUserAccessRight

DataflowUser

DataflowUserAccessRight

DatasetQueryScaleOutSettings

DatasetUser

DatasetUserAccessRight

DefaultDatasetStorageFormat

DependentDataflow

Encryption

EncryptionStatus

GroupType

GroupUser

GroupUserAccessRight

PrincipalType

ReportUser

ReportUserAccessRight

ServicePrincipalProfile

Subscription

SubscriptionUser

Workbook

Sumber Daya Tambahan: