Compartilhar via

Groups - Get Groups

Serviço:
Power BI REST APIs
Versão da API:
v1.0

Retorna uma lista de workspaces aos quais o usuário tem acesso.

Permissões

Essa chamada à API pode ser chamada por um perfil de entidade de serviço. Para obter mais informações, consulte: Perfis de entidade de serviço no Power BI Embedded.

Escopo necessário

Workspace.Read.All ou Workspace.ReadWrite.All

Limitações

  • As permissões de usuário para workspaces levam tempo para serem atualizadas e podem não estar disponíveis imediatamente ao usar chamadas à API. Para atualizar as permissões do usuário, use a chamada Atualizar Permissões de Usuário API. 

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
$filter
 query

string

Retorna um subconjunto de resultados com base em condição do parâmetro de consulta de filtro Odata.
$skip
 query

integer (int32)

Ignora os primeiros n resultados
$top
 query

integer (int32)

Retorna apenas os primeiros n resultados

Respostas

Nome Tipo Description
200 OK

Groups

OKEY

Exemplos

Example
Get a list of workspaces using a filter example

Example

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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"
    }
  ]
}

Definições

Nome Description
AzureResource

Uma resposta detalhando um recurso do Azure de propriedade do usuário, como um workspace do Log Analytics.
DefaultDatasetStorageFormat

O formato de armazenamento do conjunto de dados padrão no grupo
Group

Um grupo do Power BI
Groups

O wrapper de resposta OData para uma lista de grupos do Power BI

AzureResource

Objeto

Uma resposta detalhando um recurso do Azure de propriedade do usuário, como um workspace do Log Analytics.

Nome Tipo Description
id

string (uuid)

Um identificador para o recurso no Power BI.
resourceGroup

string

O grupo de recursos dentro da assinatura em que o recurso reside.
resourceName

string

O nome do recurso.
subscriptionId

string (uuid)

A assinatura do Azure na qual o recurso reside.

DefaultDatasetStorageFormat

Enumeração

O formato de armazenamento do conjunto de dados padrão no grupo

Valor Description
Small

Formato de armazenamento de conjunto de dados pequeno
Large

Formato de armazenamento de conjunto de dados grande

Group

Objeto

Um grupo do Power BI

Nome Tipo Description
capacityId

string (uuid)

A ID da capacidade
dataflowStorageId

string (uuid)

A ID da conta de armazenamento de fluxo de dados do Power BI
defaultDatasetStorageFormat

DefaultDatasetStorageFormat

O formato de armazenamento do conjunto de dados padrão no workspace. Retornado somente quando isOnDedicatedCapacity é true
id

string (uuid)

A ID do workspace
isOnDedicatedCapacity

boolean

Se o grupo é atribuído a uma capacidade dedicada
isReadOnly

boolean

Se o grupo é somente leitura
logAnalyticsWorkspace

AzureResource

O workspace do Log Analytics atribuído ao grupo. Isso é retornado somente ao recuperar um único grupo.
name

string

O nome do grupo

Groups

Objeto

O wrapper de resposta OData para uma lista de grupos do Power BI

Nome Tipo Description
@odata.context

string

Contexto OData
value

Group[]

A lista de grupos