Datasets - Get Datasets

Referência

Serviço:: Power BI REST APIs

Versão da API:: v1.0

Retorna uma lista de conjuntos de dados do Meu workspace.

Escopo necessário

Dataset.ReadWrite.All ou Dataset.Read.All

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

Respostas

Nome	Tipo	Description
200 OK	Datasets	OKEY

Exemplos

Example

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "name": "SalesMarketing",
      "addRowsAPIEnabled": false,
      "configuredBy": "john@contoso.com",
      "isRefreshable": true,
      "isEffectiveIdentityRequired": false,
      "isEffectiveIdentityRolesRequired": false,
      "isOnPremGatewayRequired": false
    }
  ]
}

Definições

Nome	Description
Dataset	Um conjunto de dados do Power BI. A API retorna um subconjunto da lista a seguir de propriedades do conjunto de dados. O subconjunto depende da API chamada, das permissões de chamador e da disponibilidade dos dados no banco de dados do Power BI.
DatasetQueryScaleOutSettings	Consultar configurações de expansão de um conjunto de dados
Datasets	Um wrapper de lista OData do conjunto de dados
DatasetUser	Uma entrada certa 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 da criptografia do conjunto de dados
PrincipalType	O tipo principal
ServicePrincipalProfile	Um perfil de entidade de serviço do Power BI. Relevante apenas para solução de vários locatários do Power BI Embedded.

Dataset

Objeto

Um conjunto de dados do Power BI. A API retorna um subconjunto da lista a seguir de propriedades do conjunto de dados. 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	Uma propriedade preterida que deve ser ignorada.
Encryption	Encryption	Informações de criptografia do conjunto de dados. Aplicável somente quando `$expand` é especificado.
IsEffectiveIdentityRequired	boolean	Se o conjunto de dados requer uma identidade efetiva, que você deve enviar em uma chamada GenerateToken API.
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	Esse campo retorna `true` quando o conjunto de dados é atualizado recentemente ou está configurado para atualização automática, com o modo de conexão definido especificamente como "Importar". O valor retornará `false` para outros modos de conexão, como 'DirectQuery' e 'LiveConnection', independentemente de o conjunto de dados ser atualizado manualmente ou ser configurado para atualização automática.
addRowsAPIEnabled	boolean	Se o conjunto de dados permite adicionar novas linhas
configuredBy	string	O proprietário do conjunto de dados
createReportEmbedURL	string	O conjunto de dados cria a URL de inserção de relatório
createdDate	string (date-time)	A data e a hora de criação 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
qnaEmbedURL	string	A URL de inserção do conjunto de dados Q&A
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 de 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 painel) usando o Obter Usuários do Conjunto de Dados como Administrador API ou a API PostWorkspaceInfo com o parâmetro `getArtifactUsers`.
webUrl	string	A URL da Web do conjunto de dados

DatasetQueryScaleOutSettings

Objeto

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 minimum: -1 maximum: 64	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)

Datasets

Objeto

Um wrapper de lista OData do conjunto de dados

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

DatasetUser

Objeto

Uma entrada certa 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 principal
profile	ServicePrincipalProfile	Um perfil de entidade de serviço do Power BI. Relevante apenas para solução de vários locatários do Power BI Embedded.
userType	string	Tipo do usuário.

DatasetUserAccessRight

Enumeração

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

Valor	Description
None	Remove a permissão para o conteúdo no conjunto de dados
Read	Concede acesso de leitura ao conteúdo no conjunto de dados
ReadExplore	Concede acesso de leitura e exploração ao conteúdo no conjunto de dados
ReadReshare	Concede acesso de leitura e compartilhamento ao conteúdo no conjunto de dados
ReadReshareExplore	Concede acesso de leitura, compartilhamento e exploração ao conteúdo no conjunto de dados
ReadWrite	Concede acesso de leitura e gravação ao conteúdo no conjunto de dados
ReadWriteExplore	Concede acesso de leitura, gravação e exploração ao conteúdo no conjunto de dados
ReadWriteReshare	Concede acesso de leitura, gravação e compartilhamento ao conteúdo no conjunto de dados
ReadWriteReshareExplore	Concede acesso de leitura, gravação, compartilhamento e exploração ao conteúdo no conjunto de dados

DependentDataflow

Objeto

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

Objeto

Informações de criptografia para um conjunto de dados

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

EncryptionStatus

Enumeração

Status da criptografia do conjunto de dados

Valor	Description
InSyncWithWorkspace	A criptografia tem suporte e está em sincronia com as configurações de criptografia
NotInSyncWithWorkspace	A criptografia tem suporte, mas não está em sincronia com as configurações de criptografia
NotSupported	Não há suporte para criptografia para esse conjunto de dados
Unknown	O status de criptografia é desconhecido devido à corrupção do conjunto de dados

PrincipalType

Enumeração

O tipo principal

Valor	Description
App	Tipo de entidade de serviço
Group	Tipo de entidade de grupo
None	Nenhum tipo de entidade de segurança. Use todo o acesso ao nível da organização.
User	Tipo de entidade de usuário

ServicePrincipalProfile

Objeto

Um perfil de entidade de serviço do Power BI. Relevante apenas para solução de vários locatários do Power BI Embedded.

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

Compartilhar via

Datasets - Get Datasets

Escopo necessário

Respostas

Exemplos

Example

Solicitação de exemplo

Resposta de exemplo

Definições

Dataset

DatasetQueryScaleOutSettings

Datasets

DatasetUser

DatasetUserAccessRight

DependentDataflow

Encryption

EncryptionStatus

PrincipalType

ServicePrincipalProfile