Partilhar via


Capacities - Get Refreshable For Capacity

Retorna o atualizável especificado para a capacidade especificada à qual o usuário tem acesso.

O Power BI mantém um histórico de atualização de sete dias para cada conjunto de dados, até um máximo de sessenta atualizações.

Escopo necessário

Capacity.Read.All ou Capacity.ReadWrite.All

GET https://api.powerbi.com/v1.0/myorg/capacities/{capacityId}/refreshables/{refreshableId}
GET https://api.powerbi.com/v1.0/myorg/capacities/{capacityId}/refreshables/{refreshableId}?$expand={$expand}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
capacityId
path True

string

uuid

A ID da capacidade

refreshableId
path True

string

A ID atualizável

$expand
query

string

Aceita uma lista separada por vírgulas de tipos de dados, que serão expandidos embutidos na resposta. capacities Dá suporte a e groups.

Respostas

Nome Tipo Description
200 OK

Refreshables

OK

Exemplos

Example
Get refreshables with their 'capacity' and 'group' expanded example

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/capacities/{capacityId}/refreshables/{refreshableId}

Sample Response

{
  "value": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "name": "SalesMarketing",
      "kind": "Dataset",
      "startTime": "2017-06-13T09:25:43.153Z",
      "endTime": "2017-06-19T11:22:32.445Z",
      "refreshCount": 22,
      "refreshFailures": 0,
      "averageDuration": 289.3814,
      "medianDuration": 268.6245,
      "refreshesPerDay": 11,
      "lastRefresh": {
        "refreshType": "ViaApi",
        "startTime": "2017-06-13T09:25:43.153Z",
        "endTime": "2017-06-13T09:31:43.153Z",
        "status": "Completed",
        "requestId": "9399bb89-25d1-44f8-8576-136d7e9014b1"
      },
      "refreshSchedule": {
        "days": [
          "Sunday",
          "Friday",
          "Saturday"
        ],
        "times": [
          "05:00",
          "11:30",
          "17:30",
          "23:00"
        ],
        "enabled": true,
        "localTimeZoneId": "UTC",
        "notifyOption": "MailOnFailure"
      },
      "configuredBy": [
        "john@contoso.com"
      ]
    }
  ]
}

Get refreshables with their 'capacity' and 'group' expanded example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/capacities/{capacityId}/refreshables/{refreshableId}?$expand=capacity,group

Sample Response

{
  "value": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "name": "SalesMarketing",
      "kind": "Dataset",
      "startTime": "2017-06-13T09:25:43.153Z",
      "endTime": "2017-06-19T11:22:32.445Z",
      "refreshCount": 22,
      "refreshFailures": 0,
      "averageDuration": 289.3814,
      "medianDuration": 268.6245,
      "refreshesPerDay": 11,
      "lastRefresh": {
        "refreshType": "ViaApi",
        "startTime": "2017-06-13T09:25:43.153Z",
        "endTime": "2017-06-13T09:31:43.153Z",
        "status": "Completed",
        "requestId": "9399bb89-25d1-44f8-8576-136d7e9014b1"
      },
      "refreshSchedule": {
        "days": [
          "Sunday",
          "Friday",
          "Saturday"
        ],
        "times": [
          "05:00",
          "11:30",
          "17:30",
          "23:00"
        ],
        "enabled": true,
        "localTimeZoneId": "UTC",
        "notifyOption": "MailOnFailure"
      },
      "configuredBy": [
        "john@contoso.com"
      ],
      "capacity": {
        "id": "0f084df7-c13d-451b-af5f-ed0c466403b2",
        "displayName": "MyCapacity",
        "sku": "A1"
      },
      "group": {
        "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
        "name": "SalesMarketing"
      }
    }
  ]
}

Definições

Nome Description
Capacity

Uma capacidade do Power BI

CapacityState

O estado de capacidade

capacityUserAccessRight

O direito de acesso que o usuário tem na capacidade

days

Os dias em que executar a atualização

Refresh

Uma entrada de histórico de atualização do Power BI

Refreshable

Um atualizável do Power BI é um conjunto de dados que foi atualizado pelo menos uma vez ou para o qual existe um agendamento de atualização válido. Se um conjunto de dados não atender a nenhuma dessas condições, ele não aparecerá na resposta da API. O Power BI mantém um histórico de atualização de sete dias para cada conjunto de dados, até um máximo de sessenta atualizações.

RefreshableGroup

Um grupo do Power BI associado a um item Atualizável

RefreshableKind

O tipo atualizável

Refreshables

Uma lista de atualizações do Power BI

RefreshAttempt

O Power BI faz automaticamente várias tentativas de atualizar um conjunto de dados se ele apresentar uma falha de atualização. Esse objeto contém informações sobre cada tentativa de atualização.

RefreshAttemptType

O tipo de tentativa de atualização.

RefreshSchedule

Um agendamento de atualização do Power BI para o modelo importado

RefreshType

O tipo de solicitação de atualização

ScheduleNotifyOption

A opção de notificação sobre o encerramento de uma atualização agendada. As entidades de serviço só dão suporte ao NoNotification valor.

TenantKey

Informações de chave de criptografia

Capacity

Uma capacidade do Power BI

Nome Tipo Description
admins

string[]

Uma matriz de administradores de capacidade

capacityUserAccessRight

capacityUserAccessRight

O direito de acesso que um usuário tem na capacidade

displayName

string

O nome de exibição da capacidade

id

string

A ID da capacidade

region

string

A região do Azure em que a capacidade foi provisionada

sku

string

O SKU de capacidade

state

CapacityState

O estado de capacidade

tenantKey

TenantKey

Informações de chave de criptografia (aplica-se apenas a rotas de administrador)

tenantKeyId

string

A ID de uma chave de criptografia (aplicável somente à rota de administrador)

CapacityState

O estado de capacidade

Nome Tipo Description
Active

string

A capacidade está pronta para uso

Deleted

string

A capacidade foi excluída e não está disponível

Deleting

string

A exclusão da capacidade está em andamento

Invalid

string

A capacidade não pode ser usada

NotActivated

string

Sem suporte

PreSuspended

string

Sem suporte

ProvisionFailed

string

Falha no provisionamento da capacidade

Provisioning

string

A ativação da capacidade está em andamento

Suspended

string

O uso da capacidade é suspenso

UpdatingSku

string

Uma alteração de SKU de capacidade está em andamento

capacityUserAccessRight

O direito de acesso que o usuário tem na capacidade

Nome Tipo Description
Admin

string

O usuário tem direitos de administrador sobre a capacidade

Assign

string

O usuário tem contribuidor direitos e pode atribuir workspaces à capacidade

None

string

O usuário não tem acesso à capacidade

days

Os dias em que executar a atualização

Nome Tipo Description
Friday

string

Monday

string

Saturday

string

Sunday

string

Thursday

string

Tuesday

string

Wednesday

string

Refresh

Uma entrada de histórico de atualização do Power BI

Nome Tipo Description
endTime

string

A data e a hora de término da atualização (pode estar vazia se uma atualização estiver em andamento)

refreshAttempts

RefreshAttempt[]

A lista de tentativas de atualização.

refreshType

RefreshType

O tipo de solicitação de atualização

requestId

string

O identificador da solicitação de atualização. Forneça esse identificador em todas as solicitações de serviço.

serviceExceptionJson

string

Código de erro de falha no formato JSON (vazio se nenhum erro)

startTime

string

A data e a hora de início da atualização

status

string

  • Unknown se o estado de conclusão for desconhecido ou se uma atualização estiver em andamento.
  • Completed para uma atualização concluída com êxito.
  • Failed para uma atualização malsucedida (serviceExceptionJson conterá o código de erro).
  • Disabled se a atualização estiver desabilitada por uma atualização seletiva.

Refreshable

Um atualizável do Power BI é um conjunto de dados que foi atualizado pelo menos uma vez ou para o qual existe um agendamento de atualização válido. Se um conjunto de dados não atender a nenhuma dessas condições, ele não aparecerá na resposta da API. O Power BI mantém um histórico de atualização de sete dias para cada conjunto de dados, até um máximo de sessenta atualizações.

Nome Tipo Description
averageDuration

number

A duração média em segundos de uma atualização durante a janela de tempo para a qual os dados de atualização existem

capacity

Capacity

A capacidade do item atualizável

configuredBy

string[]

Os proprietários atualizáveis

endTime

string

A hora de término da janela para a qual os dados de atualização existem

group

RefreshableGroup

O grupo associado para o item atualizável

id

string

A ID do objeto do atualizável

kind

RefreshableKind

O tipo atualizável

lastRefresh

Refresh

A última entrada de histórico de atualização do Power BI para o item atualizável

medianDuration

number

A duração mediana em segundos de uma atualização dentro da janela de tempo para a qual os dados de atualização existem

name

string

O nome de exibição do atualizável

refreshCount

integer

O número de atualizações dentro da janela de tempo para a qual os dados de atualização existem

refreshFailures

integer

O número de falhas de atualização dentro da janela de tempo para a qual os dados de atualização existem

refreshSchedule

RefreshSchedule

O agendamento de atualização para o item atualizável

refreshesPerDay

integer

O número de atualizações por dia (agendadas e sob demanda) dentro da janela de tempo para a qual os dados de atualização existem

startTime

string

A hora de início da janela para a qual os dados de atualização existem

RefreshableGroup

Um grupo do Power BI associado a um item Atualizável

Nome Tipo Description
id

string

A ID do workspace

name

string

O nome do grupo

RefreshableKind

O tipo atualizável

Nome Tipo Description
Dataset

string

Conjunto de dados

Refreshables

Uma lista de atualizações do Power BI

Nome Tipo Description
odata.context

string

Contexto OData

value

Refreshable[]

Os refreshables

RefreshAttempt

O Power BI faz automaticamente várias tentativas de atualizar um conjunto de dados se ele apresentar uma falha de atualização. Esse objeto contém informações sobre cada tentativa de atualização.

Nome Tipo Description
attemptId

integer

O índice da tentativa de atualização.

endTime

string

A data e a hora de término da tentativa de atualização. O valor será nulo se a tentativa de atualização estiver em andamento.

serviceExceptionJson

string

Código de erro de falha no formato JSON. Nulo se não houver erro.

startTime

string

A data e a hora de início da tentativa de atualização.

type

RefreshAttemptType

O tipo de tentativa de atualização.

RefreshAttemptType

O tipo de tentativa de atualização.

Nome Tipo Description
Data

string

A tentativa de atualização de carregar dados no conjunto de dados.

Query

string

A tentativa de atualizar caches de consulta premium e dashboard tiles.u

RefreshSchedule

Um agendamento de atualização do Power BI para o modelo importado

Nome Tipo Description
NotifyOption

ScheduleNotifyOption

A opção de notificação sobre o encerramento de uma atualização agendada. As entidades de serviço só dão suporte ao NoNotification valor.

days

days[]

Os dias em que executar a atualização

enabled

boolean

Se a atualização está habilitada

localTimeZoneId

string

A ID do fuso horário a ser usado. Para obter mais informações, consulte Informações de fuso horário.

times

string[]

As horas do dia para executar a atualização

RefreshType

O tipo de solicitação de atualização

Nome Tipo Description
OnDemand

string

A atualização foi disparada interativamente por meio do portal do Power BI

OnDemandTraining

string

A atualização foi disparada interativamente por meio do portal do Power BI com treinamento automático de agregações

Scheduled

string

A atualização foi disparada por uma configuração de agendamento de atualização do conjunto de dados

ViaApi

string

A atualização foi disparada por uma chamada à API

ViaEnhancedApi

string

A atualização foi disparada por uma chamada avançada à API REST de atualização

ViaXmlaEndpoint

string

A atualização foi disparada por meio do ponto de extremidade XMLA público do Power BI

ScheduleNotifyOption

A opção de notificação sobre o encerramento de uma atualização agendada. As entidades de serviço só dão suporte ao NoNotification valor.

Nome Tipo Description
MailOnFailure

string

Uma notificação por email será enviada em caso de falha na atualização

NoNotification

string

Nenhuma notificação será enviada

TenantKey

Informações de chave de criptografia

Nome Tipo Description
createdAt

string

A data e a hora de criação da chave de criptografia

id

string

A ID da chave de criptografia

isDefault

boolean

Se a chave de criptografia é a chave padrão para todo o locatário. Qualquer capacidade recém-criada herda a chave padrão.

keyVaultKeyIdentifier

string

O URI que especifica exclusivamente a chave de criptografia no Azure Key Vault

name

string

O nome da chave de criptografia

updatedAt

string

A data e a hora da última atualização da chave de criptografia