Partilhar via


Push Datasets - Datasets PostDataset

Cria um novo conjunto de dados em Meu workspace.

Escopo necessário

Dataset.ReadWrite.All

Limitações

Essa chamada à API dá suporte apenas a conjuntos de dados push. Para obter uma lista completa de limitações, consulte Limitações de conjuntos de dados por push.

POST https://api.powerbi.com/v1.0/myorg/datasets
POST https://api.powerbi.com/v1.0/myorg/datasets?defaultRetentionPolicy={defaultRetentionPolicy}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
defaultRetentionPolicy
query

DefaultRetentionPolicy

A política de retenção padrão

Corpo da solicitação

Nome Obrigatório Tipo Description
name True

string

O nome do conjunto de dados

tables True

Table[]

As tabelas do conjunto de dados

datasources

Datasource[]

As fontes de dados associadas a esse conjunto de dados

defaultMode

DatasetMode

O modo ou tipo do conjunto de dados

relationships

Relationship[]

As relações do conjunto de dados

Respostas

Nome Tipo Description
201 Created

Dataset

Criado

202 Accepted

Dataset

Aceito

Exemplos

Push example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/datasets?defaultRetentionPolicy=basicFIFO
{
  "name": "SalesMarketing",
  "defaultMode": "Push",
  "tables": [
    {
      "name": "Product",
      "columns": [
        {
          "name": "ProductID",
          "dataType": "Int64"
        },
        {
          "name": "Name",
          "dataType": "string"
        },
        {
          "name": "Category",
          "dataType": "string"
        },
        {
          "name": "IsCompete",
          "dataType": "bool"
        },
        {
          "name": "ManufacturedOn",
          "dataType": "DateTime"
        },
        {
          "name": "Sales",
          "dataType": "Int64",
          "formatString": "Currency"
        }
      ]
    }
  ]
}

Sample Response

{
  "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "name": "SalesMarketing",
  "defaultRetentionPolicy": "basicFIFO"
}

Definições

Nome Description
ASMashupExpression

Uma fonte de tabela de conjunto de dados

Column

Uma coluna de conjunto de dados

CreateDatasetRequest

Um conjunto de dados do Power BI

CrossFilteringBehavior

A direção do filtro da relação

Dataset

Um conjunto de dados do Power BI. 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.

DatasetMode

O modo ou tipo 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)

Datasource

Uma fonte de dados do Power BI

DatasourceConnectionDetails

Os detalhes da conexão da fonte de dados do Power BI. Veja exemplos em Obter Fontes de Dados ou Obter Fontes de Dados em Grupo.

DefaultRetentionPolicy

A política de retenção padrã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

Measure

Uma medida do Power BI

PrincipalType

O tipo de entidade de segurança

Relationship

Uma relação entre tabelas em um conjunto de dados

Row

Uma linha de dados em um conjunto de dados

ServicePrincipalProfile

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

Table

Uma tabela de conjunto de dados

ASMashupExpression

Uma fonte de tabela de conjunto de dados

Nome Tipo Description
expression

string

A expressão de origem

Column

Uma coluna de conjunto de dados

Nome Tipo Description
dataCategory

string

Opcional. O valor da cadeia de caracteres a ser usado para a categoria de dados que descreve os dados nessa coluna.

dataType

string

O tipo de dados de coluna

formatString

string

Opcional. O formato da coluna conforme especificado em FORMAT_STRING.

isHidden

boolean

Opcional. Se a coluna está oculta. O padrão é false.

name

string

O nome da coluna

sortByColumn

string

Opcional. Nome da cadeia de caracteres de uma coluna na mesma tabela para ser usada para classificar a coluna atual.

summarizeBy

string

Opcional. A função de agregação a ser usada para resumir essa coluna.

CreateDatasetRequest

Um conjunto de dados do Power BI

Nome Tipo Description
datasources

Datasource[]

As fontes de dados associadas a esse conjunto de dados

defaultMode

DatasetMode

O modo ou tipo do conjunto de dados

name

string

O nome do conjunto de dados

relationships

Relationship[]

As relações do conjunto de dados

tables

Table[]

As tabelas do conjunto de dados

CrossFilteringBehavior

A direção do filtro da relação

Nome Tipo Description
Automatic

string

O comportamento de filtragem cruzada é definido automaticamente

BothDirections

string

Para fins de filtragem, ambas as tabelas são tratadas como uma única tabela.

OneDirection

string

Para fins de filtragem, o filtro será aplicado na tabela em que os valores estão sendo agregados.

Dataset

Um conjunto de dados do Power BI. 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

DatasetMode

O modo ou tipo do conjunto de dados

Nome Tipo Description
AsAzure

string

Um conjunto de dados com uma conexão dinâmica com Azure Analysis Services

AsOnPrem

string

Um conjunto de dados com uma conexão dinâmica com Azure Analysis Services locais

Push

string

Um conjunto de dados que permite acesso programático para enviar dados por push para o Power BI

PushStreaming

string

Um conjunto de dados que dá suporte ao streaming de dados e permite acesso programático para enviar dados por push para o Power BI

Streaming

string

Um conjunto de dados que dá suporte ao streaming de dados. Para obter mais informações, confira Streaming em tempo real no Power BI.

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

Datasource

Uma fonte de dados do Power BI

Nome Tipo Description
connectionDetails

DatasourceConnectionDetails

Os detalhes da conexão da fonte de dados

connectionString

string

(Preterido) A fonte de dados cadeia de conexão. Disponível somente para DirectQuery.

datasourceId

string

A ID da fonte de dados associada, que está vazia quando não está associada a um gateway

datasourceType

string

O tipo de fonte de dados

gatewayId

string

A ID do gateway associado, que está vazia quando não está associada a um gateway. Ao usar um cluster de gateway, a ID do gateway refere-se ao gateway primário (primeiro) no cluster e é semelhante à ID do cluster do gateway.

name

string

(Preterido) O nome da fonte de dados. Disponível somente para DirectQuery.

DatasourceConnectionDetails

Os detalhes da conexão da fonte de dados do Power BI. Veja exemplos em Obter Fontes de Dados ou Obter Fontes de Dados em Grupo.

Nome Tipo Description
account

string

A conta de conexão

classInfo

string

As informações da classe de conexão

database

string

O banco de dados de conexão

domain

string

O domínio de conexão

emailAddress

string

O endereço de email de conexão

kind

string

O tipo de conexão

loginServer

string

O servidor de logon de conexão

path

string

O caminho da conexão

server

string

O servidor de conexão

url

string

A URL de conexão

DefaultRetentionPolicy

A política de retenção padrão

Nome Tipo Description
None

string

Nenhum

basicFIFO

string

basicFIFO

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

Measure

Uma medida do Power BI

Nome Tipo Description
description

string

Opcional. A descrição da medida.

expression

string

Uma expressão DAX válida

formatString

string

Opcional. Uma cadeia de caracteres que descreve como o valor deve ser formatado quando é exibido conforme especificado em FORMAT_STRING.

isHidden

boolean

Opcional. Se a medida está oculta.

name

string

O nome da medida

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

Relationship

Uma relação entre tabelas em um conjunto de dados

Nome Tipo Valor padrão Description
crossFilteringBehavior

CrossFilteringBehavior

OneDirection

A direção do filtro da relação

fromColumn

string

O nome da coluna de chave estrangeira

fromTable

string

O nome da tabela de chave estrangeira

name

string

O nome e o identificador da relação

toColumn

string

O nome da coluna de chave primária

toTable

string

O nome da tabela de chaves primárias

Row

Uma linha de dados em um conjunto de dados

Nome Tipo Description
id

string

A ID de linha exclusiva

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

Table

Uma tabela de conjunto de dados

Nome Tipo Description
columns

Column[]

O esquema de coluna para esta tabela

description

string

A descrição da tabela

isHidden

boolean

Opcional. Se essa tabela de conjunto de dados está oculta.

measures

Measure[]

As medidas dentro desta tabela

name

string

O nome da tabela

rows

Row[]

As linhas de dados dentro desta tabela

source

ASMashupExpression[]

A origem da tabela