Groups - Get Groups

Hizmet:

Power BI REST APIs

API Sürümü:

v1.0

Kullanıcının erişimi olan çalışma alanlarının listesini döndürür.

İzinler

Bu API çağrısı bir hizmet sorumlusu profili tarafından çağrılabilir. Daha fazla bilgi için bkz. Power BI Embeddedhizmet sorumlusu profilleri.

Gerekli Kapsam

Workspace.Read.All veya Workspace.ReadWrite.All

Sınırlama

• Çalışma alanlarının kullanıcı izinlerinin güncelleştirilmesi zaman alır ve API çağrıları kullanılırken hemen kullanılamayabilir. Kullanıcı izinlerini yenilemek için Kullanıcı İzinlerini Yenile API çağrısını kullanın.
  
  

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

İsteğe bağlı parametrelerle:

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
$filter	query		string	Odata filtre sorgusu parametre koşuluna göre sonuçların bir alt kümesini döndürür.
$skip	query		integer (int32)	İlk n sonucu atlar
$top	query		integer (int32)	Yalnızca ilk n sonucu döndürür

Yanıtlar

Name	Tür	Description
200 OK	Groups	TAMAM

Örnekler

Example

Get a list of workspaces using a filter example

Example

Örnek isteği

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

Örnek yanıt

Durum kodu:

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

Örnek isteği

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

Örnek yanıt

Durum kodu:

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

Tanımlar

Name	Description
AzureResource	Log Analytics çalışma alanı gibi kullanıcıya ait bir Azure kaynağının ayrıntılarını içeren yanıt.
DefaultDatasetStorageFormat	Gruptaki varsayılan veri kümesi depolama biçimi
Group	Power BI grubu
Groups	Power BI gruplarının listesi için OData yanıt sarmalayıcısı

AzureResource

Object

Log Analytics çalışma alanı gibi kullanıcıya ait bir Azure kaynağının ayrıntılarını içeren yanıt.

Name	Tür	Description
id	string (uuid)	Power BI içindeki kaynağın tanımlayıcısı.
resourceGroup	string	Kaynağın bulunduğu abonelik içindeki kaynak grubu.
resourceName	string	Kaynağın adı.
subscriptionId	string (uuid)	Kaynağın bulunduğu Azure aboneliği.

DefaultDatasetStorageFormat

Listeleme

Gruptaki varsayılan veri kümesi depolama biçimi

Değer	Description
Small	Küçük veri kümesi depolama biçimi
Large	Büyük veri kümesi depolama biçimi

Group

Object

Power BI grubu

Name	Tür	Description
capacityId	string (uuid)	Kapasite kimliği
dataflowStorageId	string (uuid)	Power BI veri akışı depolama hesabı kimliği
defaultDatasetStorageFormat	DefaultDatasetStorageFormat	Çalışma alanındaki varsayılan veri kümesi depolama biçimi. Yalnızca isOnDedicatedCapacitytrue döndürülür
id	string (uuid)	Çalışma alanı kimliği
isOnDedicatedCapacity	boolean	Grubun ayrılmış kapasiteye atanıp atanmadığı
isReadOnly	boolean	Grubun salt okunur olup olmadığı
logAnalyticsWorkspace	AzureResource	Gruba atanan Log Analytics çalışma alanı. Bu yalnızca tek bir grup alınırken döndürülür.
name	string	Grup adı

Groups

Object

Power BI gruplarının listesi için OData yanıt sarmalayıcısı

Name	Tür	Description
@odata.context	string	OData bağlamı
value	Group[]	Grup listesi