Admin - Get Refreshables

Serviço:: Power BI REST APIs

Versão da API:: v1.0

Retorna uma lista de atualizáveis para a organização dentro de uma capacidade.

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.

Permissões

O usuário deve ser um administrador do Fabric 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 quaisquer pré-remissões necessárias de consentimento do administrador para o Power BI definidas 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 200 solicitações por hora.

GET https://api.powerbi.com/v1.0/myorg/admin/capacities/refreshables?$top={$top}

Com parâmetros opcionais:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
$top	query	True	integer (int32) minimum: 1	Retorna apenas os primeiros n resultados.
$expand	query		string	Aceita uma lista separada por vírgulas de tipos de dados, que será expandida embutida na resposta. Dá suporte a `capacities` e `groups`.
$filter	query		string	Retorna um subconjunto de resultados com base em condição do parâmetro de consulta de filtro Odata.
$skip	query		integer (int32)	Ignora os primeiros n resultados. Use com a parte superior para buscar resultados além dos primeiros 1000.

Respostas

Nome	Tipo	Description
200 OK	Refreshables	OKEY

Exemplos

Example

Get refreshables, filtering for an average refresh duration of greater than 30 minutes example.

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

Example

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 200

{
  "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, filtering for an average refresh duration of greater than 30 minutes example.

Solicitação de exemplo

GET https://api.powerbi.com/v1.0/myorg/admin/capacities/refreshables?$filter=averageDuration gt 1800

Resposta de exemplo

Código de status:: 200

{
  "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": 3289.3814,
      "medianDuration": 2268.6245,
      "refreshesPerDay": 11,
      "lastRefresh": {
        "refreshType": "ViaApi",
        "startTime": "2017-06-13T09:25:43.153Z",
        "endTime": "2017-06-13T09:58:05.221Z",
        "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

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 200

{
  "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 tiver uma falha de atualização. Este 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 modelo importado
RefreshType	O tipo de solicitação de atualização
ScheduleNotifyOption	A opção de notificação no encerramento de uma atualização agendada. As entidades de serviço só dão suporte ao valor `NoNotification`.
TenantKey	Informações de chave de criptografia

Capacity

Objeto

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 (uuid)	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 (uuid)	A ID de uma chave de criptografia (aplicável somente à rota do administrador)

CapacityState

Enumeração

O estado de capacidade

Valor	Description
NotActivated	Unsupported
Active	A capacidade está pronta para uso
Provisioning	A ativação da capacidade está em andamento
ProvisionFailed	Falha no provisionamento da capacidade
PreSuspended	Unsupported
Suspended	O uso da capacidade é suspenso
Deleting	A exclusão da capacidade está em andamento
Deleted	A capacidade foi excluída e não está disponível
Invalid	A capacidade não pode ser usada
UpdatingSku	Uma alteração de SKU de capacidade está em andamento

capacityUserAccessRight

Enumeração

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

Valor	Description
None	O usuário não tem acesso à capacidade
Assign	O usuário tem direitos de colaborador e pode atribuir workspaces à capacidade
Admin	O usuário tem direitos de administrador sobre a capacidade

days

Enumeração

Os dias em que executar a atualização

Valor	Description
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Sunday

Refresh

Objeto

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

Nome	Tipo	Description
endTime	string (date-time)	A data e a hora de término da atualização (pode estar vazia se uma atualização estiver em andamento) no formato UTC.
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 não houver erro)
startTime	string (date-time)	A data e a hora de início da atualização no formato UTC.
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

Objeto

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 (date-time)	A hora de término da janela para a qual os dados de atualização existem no formato UTC.
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ções 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 (date-time)	A hora de início da janela para a qual os dados de atualização existem no formato UTC.

RefreshableGroup

Objeto

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

Nome	Tipo	Description
id	string (uuid)	A ID do workspace
name	string	O nome do grupo

RefreshableKind

Enumeração

O tipo atualizável

Valor	Description
Dataset	Dataset

Refreshables

Objeto

Uma lista de atualizações do Power BI

Nome	Tipo	Description
@odata.context	string	Contexto OData
value	Refreshable[]	Os refreshables

RefreshAttempt

Objeto

O Power BI faz automaticamente várias tentativas de atualizar um conjunto de dados se ele tiver uma falha de atualização. Este 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 (date-time)	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 (date-time)	A data e a hora de início da tentativa de atualização.
type	RefreshAttemptType	O tipo de tentativa de atualização.

RefreshAttemptType

Enumeração

O tipo de tentativa de atualização.

Valor	Description
Data	A tentativa de atualização de carregar dados no conjunto de dados.
Query	A tentativa de atualizar caches de consulta premium e blocos de dashboard.u

RefreshSchedule

Objeto

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

Nome	Tipo	Description
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.
notifyOption	ScheduleNotifyOption	A opção de notificação no encerramento de uma atualização agendada. As entidades de serviço só dão suporte ao valor `NoNotification`.
times	string[]	As horas do dia para executar a atualização

RefreshType

Enumeração

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

Valor	Description
Scheduled	A atualização foi disparada por uma configuração de agendamento de atualização do conjunto de dados
OnDemand	A atualização foi disparada interativamente por meio do portal do Power BI
ViaApi	A atualização foi disparada por uma chamada à API
ViaXmlaEndpoint	A atualização foi disparada por meio do ponto de extremidade XMLA público do Power BI
ViaEnhancedApi	A atualização foi disparada por uma chamada à API REST de atualização aprimorada
OnDemandTraining	A atualização foi disparada interativamente por meio do portal do Power BI com treinamento automático de agregações

ScheduleNotifyOption

Enumeração

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

Valor	Description
NoNotification	Nenhuma notificação será enviada
MailOnFailure	Uma notificação por email será enviada por falha de atualização

TenantKey

Objeto

Informações de chave de criptografia

Nome	Tipo	Description
createdAt	string (date-time)	A data e a hora de criação da chave de criptografia
id	string (uuid)	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 (date-time)	A data e a hora da última atualização da chave de criptografia

Partilhar via

Admin - Get Refreshables

Permissões

Escopo necessário

Limitações

Parâmetros de URI

Respostas

Exemplos

Example

Solicitação de exemplo

Resposta de exemplo

Get refreshables, filtering for an average refresh duration of greater than 30 minutes example.

Solicitação de exemplo

Resposta de exemplo

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

Solicitação de exemplo

Resposta de exemplo

Definições

Capacity

CapacityState

capacityUserAccessRight

days

Refresh

Refreshable

RefreshableGroup

RefreshableKind

Refreshables

RefreshAttempt

RefreshAttemptType

RefreshSchedule

RefreshType

ScheduleNotifyOption

TenantKey