Groups - Get Groups

Service:

Power BI REST APIs

API Version:

v1.0

Restituisce un elenco di aree di lavoro a cui l'utente può accedere.

Autorizzazioni

Questa chiamata API può essere chiamata da un profilo entità servizio. Per altre informazioni, vedere Profili entità servizio in Power BI Embedded.

Ambito obbligatorio

Workspace.Read.All o Workspace.ReadWrite.All

Limitazioni

• Le autorizzazioni utente per le aree di lavoro richiedono tempo per l'aggiornamento e potrebbero non essere immediatamente disponibili quando si usano le chiamate API. Per aggiornare le autorizzazioni utente, usare la chiamata API Aggiorna autorizzazioni utente .
  
  

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}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
$filter	query		string	Filtra i risultati in base a una condizione booleana
$skip	query		integer int32	Ignora i primi n risultati
$top	query		integer int32	Restituisce solo i primi n risultati

Risposte

Nome	Tipo	Descrizione
200 OK	Groups	OK

Esempio

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

Definizioni

Nome	Descrizione
AzureResource	Risposta che illustra in dettaglio una risorsa di Azure di proprietà dell'utente, ad esempio un'area di lavoro Log Analytics.
DefaultDatasetStorageFormat	Formato di archiviazione del set di dati predefinito nel gruppo
Group	Un gruppo di Power BI
Groups	Wrapper di risposta OData per un elenco di gruppi di Power BI

AzureResource

Risposta che illustra in dettaglio una risorsa di Azure di proprietà dell'utente, ad esempio un'area di lavoro Log Analytics.

Nome	Tipo	Descrizione
id	string	Identificatore della risorsa all'interno di Power BI.
resourceGroup	string	Gruppo di risorse all'interno della sottoscrizione in cui risiede la risorsa.
resourceName	string	Nome della risorsa.
subscriptionId	string	Sottoscrizione di Azure in cui risiede la risorsa.

DefaultDatasetStorageFormat

Formato di archiviazione del set di dati predefinito nel gruppo

Nome	Tipo	Descrizione
Large	string	Formato di archiviazione del set di dati Large
Small	string	Formato di archiviazione di set di dati di piccole dimensioni

Group

Un gruppo di Power BI

Nome	Tipo	Descrizione
capacityId	string	ID della capacità
dataflowStorageId	string	ID dell'account di archiviazione del flusso di dati di Power BI
defaultDatasetStorageFormat	DefaultDatasetStorageFormat	Formato di archiviazione del set di dati predefinito nell'area di lavoro. Restituito solo quando isOnDedicatedCapacity è true
id	string	ID area di lavoro
isOnDedicatedCapacity	boolean	Indica se il gruppo è assegnato a una capacità dedicata
isReadOnly	boolean	Indica se il gruppo è di sola lettura
logAnalyticsWorkspace	AzureResource	Area di lavoro Log Analytics assegnata al gruppo. Viene restituito solo quando si recupera un singolo gruppo.
name	string	Nome del gruppo

Groups

Wrapper di risposta OData per un elenco di gruppi di Power BI

Nome	Tipo	Descrizione
odata.context	string	Contesto OData
value	Group[]	Elenco di gruppi