Push Datasets - Datasets PostDataset

Serviço:: Power BI REST APIs

Versão da API:: v1.0

Cria um novo conjunto de dados em Meu workspace.

Escopo necessário

Dataset.ReadWrite.All

Limitações

Essa chamada de API dá suporte apenas a conjuntos de dados por 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

Com parâmetros opcionais:

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	Aceitado

Exemplos

Push example

Solicitação de exemplo

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

Corpo da solicitação

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

Resposta de exemplo

Código de status:: 201

{
  "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 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.
DatasetMode	O modo ou tipo do conjunto de dados
DatasetQueryScaleOutSettings	Consultar configurações de expansão de um 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)
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 no 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 da criptografia do conjunto de dados
Measure	Uma medida do Power BI
PrincipalType	O tipo principal
Relationship	Uma relação entre tabelas em um conjunto de dados
Row	Uma linha de dados em um conjunto de dados
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.
Table	Uma tabela de conjunto de dados

ASMashupExpression

Objeto

Uma fonte de tabela de conjunto de dados

Nome	Tipo	Description
expression	string	A expressão de origem

Column

Objeto

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 pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$	O nome da coluna
sortByColumn	string	Opcional. Nome da cadeia de caracteres de uma coluna na mesma tabela a ser usada para ordenar a coluna atual.
summarizeBy	string	Opcional. A função de agregação a ser usada para resumir esta coluna.

CreateDatasetRequest

Objeto

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

Enumeração

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

Valor	Description
OneDirection	Para fins de filtragem, o filtro será aplicado na tabela em que os valores estão sendo agregados.
BothDirections	Para fins de filtragem, ambas as tabelas são tratadas como uma única tabela.
Automatic	O comportamento de filtragem cruzada é definido automaticamente

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

DatasetMode

Enumeração

O modo ou tipo do conjunto de dados

Valor	Description
AsAzure	Um conjunto de dados com uma conexão dinâmica com o Azure Analysis Services
AsOnPrem	Um conjunto de dados com uma conexão dinâmica com o Azure Analysis Services local
Push	Um conjunto de dados que permite acesso programático para enviar dados por push para o Power BI
Streaming	Um conjunto de dados que dá suporte ao streaming de dados. Para obter mais informações, confira Streaming em tempo real no Power BI.
PushStreaming	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

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)

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
ReadWrite	Concede acesso de leitura e gravação ao conteúdo no conjunto de dados
ReadReshare	Concede acesso de leitura e compartilhamento ao conteúdo no conjunto de dados
ReadWriteReshare	Concede acesso de leitura, gravação e compartilhamento ao conteúdo no conjunto de dados
ReadExplore	Concede acesso de leitura e exploração ao conteúdo no conjunto de dados
ReadReshareExplore	Concede acesso de leitura, compartilhamento e exploraçã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
ReadWriteReshareExplore	Concede acesso de leitura, gravação, compartilhamento e exploração ao conteúdo no conjunto de dados

Datasource

Objeto

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 cadeia de conexão da fonte de dados. Disponível somente para DirectQuery.
datasourceId	string (uuid)	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 (uuid)	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

Objeto

Os detalhes da conexão da fonte de dados do Power BI. Veja exemplos em Obter fontes de dados ou obter fontes de dados no 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

Enumeração

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

Valor	Description
None	Nenhum
basicFIFO	basicFIFO

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
Unknown	O status de criptografia é desconhecido devido à corrupção do conjunto de dados
NotSupported	Não há suporte para criptografia para esse conjunto de dados
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

Measure

Objeto

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 ele é exibido conforme especificado em FORMAT_STRING.
isHidden	boolean	Opcional. Se a medida está oculta.
name	string pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$	O nome da medida

PrincipalType

Enumeração

O tipo principal

Valor	Description
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
Group	Tipo de entidade de grupo
App	Tipo de entidade de serviço

Relationship

Objeto

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 pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$		O nome da coluna de chave estrangeira
fromTable	string pattern: ^[\x09\x0A\x0D\x20\x23\x2D\x30-\x39\x40-\x5A\x5E-\x5F\x61-\x7A\x7E-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]{1,100}$		O nome da tabela de chave estrangeira
name	string pattern: ^[\x09\x0A\x0D\x20\x23\x2D\x30-\x39\x40-\x5A\x5E-\x5F\x61-\x7A\x7E-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]{1,100}$		O nome e o identificador da relação
toColumn	string pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$		O nome da coluna de chave primária
toTable	string pattern: ^[\x09\x0A\x0D\x20\x23\x2D\x30-\x39\x40-\x5A\x5E-\x5F\x61-\x7A\x7E-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]{1,100}$		O nome da tabela de chave primária

Row

Objeto

Uma linha de dados em um conjunto de dados

Nome	Tipo	Description
id	string	A ID de linha exclusiva

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

Table

Objeto

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 pattern: ^[\x09\x0A\x0D\x20\x23\x2D\x30-\x39\x40-\x5A\x5E-\x5F\x61-\x7A\x7E-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]{1,100}$	O nome da tabela
rows	Row[]	As linhas de dados dentro desta tabela
source	ASMashupExpression[]	A origem da tabela

Partilhar via

Push Datasets - Datasets PostDataset

Escopo necessário

Limitações

Parâmetros de URI

Corpo da solicitação

Respostas

Exemplos

Push example

Solicitação de exemplo

Resposta de exemplo

Definições

ASMashupExpression

Column

CreateDatasetRequest

CrossFilteringBehavior

Dataset

DatasetMode

DatasetQueryScaleOutSettings

DatasetUser

DatasetUserAccessRight

Datasource

DatasourceConnectionDetails

DefaultRetentionPolicy

DependentDataflow

Encryption

EncryptionStatus

Measure

PrincipalType

Relationship

Row

ServicePrincipalProfile

Table