Admin - Datasets GetDatasetsAsAdmin

Referência

Service:: Power BI REST APIs

API Version:: v1.0

Retorna uma lista de conjuntos de dados para a organização.

Permissões

O usuário deve ter direitos de administrador (como Office 365 Administrador Global ou Administrador de Serviços do Power BI) ou autenticar usando uma entidade de serviço.
Há suporte para permissões delegadas.

Ao executar em autenticação prinicipal de serviço, um aplicativo não deve ter nenhuma pré-permissão necessária de consentimento do administrador para o Power BI definida nele no portal do Azure.

Escopo necessário

Tenant.Read.All ou Tenant.ReadWrite.All

Relevante somente ao autenticar por meio de um token de acesso de administrador delegado padrão. Não deve estar presente quando a autenticação por meio de uma entidade de serviço é usada.

Limitações

Máximo de 50 solicitações por hora ou 5 solicitações por minuto, por locatário.

GET https://api.powerbi.com/v1.0/myorg/admin/datasets

With optional parameters:

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

Parâmetros de URI

Nome	Em	Tipo	Description
$filter	query	string	Filtra os resultados, com base em uma condição booliana
$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	AdminDatasets	OK

Exemplos

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/datasets

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "name": "SalesMarketing",
      "addRowsAPIEnabled": false,
      "configuredBy": "john@contoso.com",
      "isRefreshable": true,
      "isEffectiveIdentityRequired": false,
      "isEffectiveIdentityRolesRequired": false,
      "isOnPremGatewayRequired": false,
      "isInPlaceSharingEnabled": false,
      "workspaceId": "5c968528-70b6-4588-809f-ce811ffa5c23"
    }
  ]
}

Definições

Nome	Description
AdminDataset	Um conjunto de dados do Power BI retornado por APIs Administração. A API retorna um subconjunto da lista de propriedades do conjunto de dados a seguir. O subconjunto depende da API chamada, das permissões de chamador e da disponibilidade dos dados no banco de dados do Power BI.
AdminDatasets	Um wrapper de lista odata do conjunto de dados
DatasetQueryScaleOutSettings	Consultar configurações de expansão de um conjunto de dados
DatasetUser	Uma entrada correta de acesso de usuário do Power BI para um conjunto de dados
DatasetUserAccessRight	O direito de acesso que o usuário tem para o conjunto de dados (nível de permissão)
DependentDataflow	Um fluxo de dados dependente do Power BI
Encryption	Informações de criptografia para um conjunto de dados
EncryptionStatus	Status de criptografia de conjunto de dados
PrincipalType	O tipo de entidade de segurança
ServicePrincipalProfile	Um serviço do Power BI perfil principal. Relevante apenas para Power BI Embedded solução de multilocação.

AdminDataset

Um conjunto de dados do Power BI retornado por APIs Administração. A API retorna um subconjunto da lista de propriedades do conjunto de dados a seguir. O subconjunto depende da API chamada, das permissões de chamador e da disponibilidade dos dados no banco de dados do Power BI.

Nome	Tipo	Description
ContentProviderType	string	O tipo de provedor de conteúdo para o conjunto de dados
CreateReportEmbedURL	string	O conjunto de dados criar URL de inserção de relatório
CreatedDate	string	A data e a hora de criação do conjunto de dados
Encryption	Encryption	Informações de criptografia do conjunto de dados. Aplicável somente quando `$expand` for especificado.
IsEffectiveIdentityRequired	boolean	Se o conjunto de dados requer uma identidade efetiva, que você deve enviar em uma chamada à API GenerateToken .
IsEffectiveIdentityRolesRequired	boolean	Se a segurança em nível de linha é definida dentro do arquivo .pbix do Power BI. Nesse caso, você deve especificar uma função.
IsInPlaceSharingEnabled	boolean	Se o conjunto de dados pode ser compartilhado com usuários externos a serem consumidos em seu próprio locatário
IsOnPremGatewayRequired	boolean	Se o conjunto de dados requer um gateway de dados local
IsRefreshable	boolean	Se o conjunto de dados é atualizável ou não. Um conjunto de dados atualizável do Power BI é um conjunto de dados que foi atualizado pelo menos uma vez ou para o qual existe uma agenda de atualização válida.
QnaEmbedURL	string	A URL de inserção do conjunto de dados Q&A
addRowsAPIEnabled	boolean	Se o conjunto de dados permite adicionar novas linhas
configuredBy	string	O proprietário do conjunto de dados
description	string	A descrição do conjunto de dados
id	string	A ID do conjunto de dados
name	string	O nome do conjunto de dados
queryScaleOutSettings	DatasetQueryScaleOutSettings	Consultar configurações de expansão de um conjunto de dados
targetStorageMode	string	O modo de armazenamento do conjunto de dados
upstreamDataflows	DependentDataflow[]	A lista de todos os fluxos de dados dos quais este item depende
users	DatasetUser[]	(Valor vazio) Os detalhes de acesso do usuário do conjunto de dados. Essa propriedade será removida da resposta do conteúdo em uma versão futura. Você pode recuperar informações do usuário em um item do Power BI (como um relatório ou um dashboard) usando a API Obter Usuários do Conjunto de Dados como Administração ou a API PostWorkspaceInfo com o `getArtifactUsers` parâmetro .
webUrl	string	A URL da Web do conjunto de dados
workspaceId	string	A ID do workspace do conjunto de dados. Essa propriedade será retornada somente em GetDatasetsAsAdmin.

AdminDatasets

Um wrapper de lista odata do conjunto de dados

Nome	Tipo	Description
odata.context	string	Contexto OData
value	AdminDataset[]	Os conjuntos de dados

DatasetQueryScaleOutSettings

Consultar configurações de expansão de um conjunto de dados

Nome	Tipo	Description
autoSyncReadOnlyReplicas	boolean	Se o conjunto de dados sincroniza automaticamente réplicas somente leitura
maxReadOnlyReplicas	integer	Número máximo de réplicas somente leitura para o conjunto de dados (0-64, -1 para o número automático de réplicas)

DatasetUser

Uma entrada correta de acesso de usuário do Power BI para um conjunto de dados

Nome	Tipo	Description
datasetUserAccessRight	DatasetUserAccessRight	O direito de acesso que o usuário tem para o conjunto de dados (nível de permissão)
displayName	string	Nome de exibição da entidade de segurança
emailAddress	string	Endereço de email do usuário
graphId	string	Identificador da entidade de segurança no Microsoft Graph. Disponível somente para APIs de administrador.
identifier	string	Identificador da entidade de segurança
principalType	PrincipalType	O tipo de entidade de segurança
profile	ServicePrincipalProfile	Um serviço do Power BI perfil principal. Relevante apenas para Power BI Embedded solução de multilocação.
userType	string	Tipo do usuário.

DatasetUserAccessRight

O direito de acesso que o usuário tem para o conjunto de dados (nível de permissão)

Nome	Tipo	Description
None	string	Remove a permissão para o conteúdo no conjunto de dados
Read	string	Concede acesso de leitura ao conteúdo no conjunto de dados
ReadExplore	string	Concede acesso de Leitura e Exploração ao conteúdo no conjunto de dados
ReadReshare	string	Concede acesso de leitura e recompartilhamento ao conteúdo no conjunto de dados
ReadReshareExplore	string	Concede acesso de Leitura, Recompartilhar e Explorar ao conteúdo no conjunto de dados
ReadWrite	string	Concede acesso de leitura e gravação ao conteúdo no conjunto de dados
ReadWriteExplore	string	Concede acesso de Leitura, Gravação e Exploração ao conteúdo no conjunto de dados
ReadWriteReshare	string	Concede acesso de leitura, gravação e recompartilhamento ao conteúdo no conjunto de dados
ReadWriteReshareExplore	string	Concede acesso de Leitura, Gravação, Recompartilhamento e Exploração ao conteúdo no conjunto de dados

DependentDataflow

Um fluxo de dados dependente do Power BI

Nome	Tipo	Description
groupId	string	A ID do grupo de destino
targetDataflowId	string	A ID do fluxo de dados de destino

Encryption

Informações de criptografia para um conjunto de dados

Nome	Tipo	Description
EncryptionStatus	EncryptionStatus	Status de criptografia de conjunto de dados

EncryptionStatus

Status de criptografia de conjunto de dados

Nome	Tipo	Description
InSyncWithWorkspace	string	A criptografia tem suporte e está sincronizada com as configurações de criptografia
NotInSyncWithWorkspace	string	A criptografia tem suporte, mas não está sincronizada com as configurações de criptografia
NotSupported	string	Não há suporte para criptografia para este conjunto de dados
Unknown	string	A status de criptografia é desconhecida devido à corrupção do conjunto de dados

PrincipalType

O tipo de entidade de segurança

Nome	Tipo	Description
App	string	Tipo de entidade de serviço
Group	string	Tipo de entidade de grupo
None	string	Nenhum tipo de entidade de segurança. Use para acesso em nível de organização inteiro.
User	string	Tipo de entidade de usuário

ServicePrincipalProfile

Um serviço do Power BI perfil principal. Relevante apenas para Power BI Embedded solução de multilocação.

Nome	Tipo	Description
displayName	string	O nome do perfil da entidade de serviço
id	string	A ID do perfil da entidade de serviço

Compartilhar via