Capacities - Get Refreshables

  • Riferimento
Service:
Power BI REST APIs
API Version:
v1.0

Restituisce un elenco di aggiornabili per tutte le capacità a cui l'utente ha accesso.

Power BI mantiene una cronologia degli aggiornamenti di sette giorni per ogni set di dati, fino a un massimo di sessanta aggiornamenti.

Ambito obbligatorio

Capacity.Read.All o Capacity.ReadWrite.All

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
$top
 query True

integer

int32

Restituisce solo i primi n risultati.
$expand
 query

string

Accetta un elenco delimitato da virgole di tipi di dati, che verranno espansi inline nella risposta. Supporta capacity e group.
$filter
 query

string

Filtra i risultati in base a una condizione booleana
$skip
 query

integer

int32

Ignora i primi n risultati. Usare con la parte superiore per recuperare i risultati oltre i primi 1000.

Risposte

Nome Tipo Descrizione
200 OK

Refreshables

OK

Esempio

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

Sample Request

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

Sample Response

Status code:
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.

Sample Request

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

Sample Response

Status code:
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

Sample Request

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

Sample Response

Status code:
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"
      }
    }
  ]
}

Definizioni

Nome Descrizione
Capacity

Capacità di Power BI
CapacityState

Stato della capacità
capacityUserAccessRight

Diritto di accesso che l'utente ha sulla capacità
days

Giorni in cui eseguire l'aggiornamento
Refresh

Voce della cronologia degli aggiornamenti di Power BI
Refreshable

Un aggiornamento di Power BI è un set di dati aggiornato almeno una volta o per il quale esiste una pianificazione di aggiornamento valida. Se un set di dati non soddisfa una di queste condizioni, non verrà visualizzato nella risposta dell'API. Power BI mantiene una cronologia di aggiornamento di sette giorni per ogni set di dati, fino a un massimo di sessanta aggiornamenti.
RefreshableGroup

Gruppo di Power BI associato a un elemento Aggiornabile
RefreshableKind

Tipo aggiornabile
Refreshables

Elenco di aggiornamenti di Power BI
RefreshAttempt

Power BI esegue automaticamente più tentativi di aggiornare un set di dati se si verifica un errore di aggiornamento. Questo oggetto contiene informazioni su ogni tentativo di aggiornamento.
RefreshAttemptType

Tipo di tentativo di aggiornamento.
RefreshSchedule

Pianificazione dell'aggiornamento di Power BI per il modello importato
RefreshType

Tipo di richiesta di aggiornamento
ScheduleNotifyOption

Opzione di notifica alla chiusura di un aggiornamento pianificato. Le entità servizio supportano solo il NoNotification valore.
TenantKey

Informazioni sulla chiave di crittografia

Capacity

Capacità di Power BI

Nome Tipo Descrizione
admins

string[]

Matrice di amministratori della capacità
capacityUserAccessRight

capacityUserAccessRight

Il diritto di accesso di un utente ha la capacità
displayName

string

Nome visualizzato della capacità
id

string

ID capacità
region

string

Area di Azure in cui è stato effettuato il provisioning della capacità
sku

string

SKU di capacità
state

CapacityState

Stato della capacità
tenantKey

TenantKey

Informazioni sulla chiave di crittografia (si applica solo alle route di amministrazione)
tenantKeyId

string

ID di una chiave di crittografia (applicabile solo alla route di amministrazione)

CapacityState

Stato della capacità

Nome Tipo Descrizione
Active

string

La capacità è pronta per l'uso
Deleted

string

La capacità è stata eliminata e non è disponibile
Deleting

string

L'eliminazione della capacità è in corso
Invalid

string

La capacità non può essere usata
NotActivated

string

Non supportato
PreSuspended

string

Non supportato
ProvisionFailed

string

Provisioning della capacità non riuscita
Provisioning

string

L'attivazione della capacità è in corso
Suspended

string

L'uso della capacità viene sospeso
UpdatingSku

string

Una modifica dello SKU della capacità è in corso

capacityUserAccessRight

Diritto di accesso che l'utente ha sulla capacità

Nome Tipo Descrizione
Admin

string

L'utente ha diritti di amministratore sulla capacità
Assign

string

L'utente ha diritti di collaboratore e può assegnare aree di lavoro alla capacità
None

string

L'utente non ha accesso alla capacità

days

Giorni in cui eseguire l'aggiornamento

Nome Tipo Descrizione
Friday

string

Monday

string

Saturday

string

Sunday

string

Thursday

string

Tuesday

string

Wednesday

string

Refresh

Voce della cronologia degli aggiornamenti di Power BI

Nome Tipo Descrizione
endTime

string

Data di fine e ora dell'aggiornamento (può essere vuoto se è in corso un aggiornamento)
refreshAttempts

RefreshAttempt[]

Elenco tentativi di aggiornamento.
refreshType

RefreshType

Tipo di richiesta di aggiornamento
requestId

string

Identificatore della richiesta di aggiornamento. Specificare questo identificatore in tutte le richieste di servizio.
serviceExceptionJson

string

Codice di errore non riuscito nel formato JSON (vuoto se non si verifica alcun errore)
startTime

string

Data e ora di inizio dell'aggiornamento
status

string

  • Unknown se lo stato di completamento è sconosciuto o un aggiornamento è in corso.
  • Completed per un aggiornamento completato correttamente.
  • Failed per un aggiornamento non riuscito (serviceExceptionJson conterrà il codice di errore).
  • Disabled se l'aggiornamento è disabilitato da un aggiornamento selettivo.

Refreshable

Un aggiornamento di Power BI è un set di dati aggiornato almeno una volta o per il quale esiste una pianificazione di aggiornamento valida. Se un set di dati non soddisfa una di queste condizioni, non verrà visualizzato nella risposta dell'API. Power BI mantiene una cronologia di aggiornamento di sette giorni per ogni set di dati, fino a un massimo di sessanta aggiornamenti.

Nome Tipo Descrizione
averageDuration

number

Durata media in secondi di un aggiornamento durante l'intervallo di tempo per cui esistono dati di aggiornamento
capacity

Capacity

Capacità dell'elemento aggiornabile
configuredBy

string[]

Proprietari aggiornabili
endTime

string

Ora di fine della finestra per cui esistono dati di aggiornamento
group

RefreshableGroup

Gruppo associato per l'elemento aggiornabile
id

string

ID oggetto dell'oggetto aggiornabile
kind

RefreshableKind

Tipo aggiornabile
lastRefresh

Refresh

Ultima voce della cronologia degli aggiornamenti di Power BI per l'elemento aggiornabile
medianDuration

number

Durata mediata in secondi di un aggiornamento all'interno dell'intervallo di tempo per cui esistono i dati di aggiornamento
name

string

Nome visualizzato dell'aggiornamento
refreshCount

integer

Numero di aggiornamenti all'interno dell'intervallo di tempo per il quale esistono dati di aggiornamento
refreshFailures

integer

Numero di errori di aggiornamento entro l'intervallo di tempo per il quale esistono dati di aggiornamento
refreshSchedule

RefreshSchedule

Pianificazione dell'aggiornamento per l'elemento aggiornabile
refreshesPerDay

integer

Numero di aggiornamenti al giorno (pianificati e su richiesta) entro l'intervallo di tempo per cui esistono i dati di aggiornamento
startTime

string

Ora di inizio della finestra per cui sono presenti i dati di aggiornamento

RefreshableGroup

Gruppo di Power BI associato a un elemento Aggiornabile

Nome Tipo Descrizione
id

string

ID area di lavoro
name

string

Nome del gruppo

RefreshableKind

Tipo aggiornabile

Nome Tipo Descrizione
Dataset

string

Set di dati

Refreshables

Elenco di aggiornamenti di Power BI

Nome Tipo Descrizione
odata.context

string

Contesto OData
value

Refreshable[]

Aggiornabili

RefreshAttempt

Power BI esegue automaticamente più tentativi di aggiornare un set di dati se si verifica un errore di aggiornamento. Questo oggetto contiene informazioni su ogni tentativo di aggiornamento.

Nome Tipo Descrizione
attemptId

integer

Indice del tentativo di aggiornamento.
endTime

string

Data di fine e ora del tentativo di aggiornamento. Il valore è vuoto se il tentativo di aggiornamento è in corso.
serviceExceptionJson

string

Codice errore errore in formato JSON. Void se non è presente alcun errore.
startTime

string

Data e ora di inizio del tentativo di aggiornamento.
type

RefreshAttemptType

Tipo di tentativo di aggiornamento.

RefreshAttemptType

Tipo di tentativo di aggiornamento.

Nome Tipo Descrizione
Data

string

Tentativo di aggiornamento di caricare i dati nel set di dati.
Query

string

Tentativo di aggiornare le cache delle query Premium e i riquadri del dashboard.u

RefreshSchedule

Pianificazione dell'aggiornamento di Power BI per il modello importato

Nome Tipo Descrizione
NotifyOption

ScheduleNotifyOption

Opzione di notifica alla chiusura di un aggiornamento pianificato. Le entità servizio supportano solo il NoNotification valore.
days

days[]

Giorni in cui eseguire l'aggiornamento
enabled

boolean

Se l'aggiornamento è abilitato
localTimeZoneId

string

ID del fuso orario da usare. Per altre informazioni, vedere Informazioni sul fuso orario.
times

string[]

Orari del giorno per eseguire l'aggiornamento

RefreshType

Tipo di richiesta di aggiornamento

Nome Tipo Descrizione
OnDemand

string

L'aggiornamento è stato attivato in modo interattivo tramite il portale di Power BI
OnDemandTraining

string

L'aggiornamento è stato attivato in modo interattivo tramite il portale di Power BI con il training automatico delle aggregazioni
Scheduled

string

L'aggiornamento è stato attivato da un'impostazione di pianificazione dell'aggiornamento del set di dati
ViaApi

string

L'aggiornamento è stato attivato da una chiamata API
ViaEnhancedApi

string

L'aggiornamento è stato attivato da una chiamata API REST di aggiornamento avanzata
ViaXmlaEndpoint

string

L'aggiornamento è stato attivato tramite l'endpoint XMLA pubblico di Power BI

ScheduleNotifyOption

Opzione di notifica alla chiusura di un aggiornamento pianificato. Le entità servizio supportano solo il NoNotification valore.

Nome Tipo Descrizione
MailOnFailure

string

Una notifica di posta elettronica verrà inviata in caso di errore di aggiornamento
NoNotification

string

Nessuna notifica verrà inviata

TenantKey

Informazioni sulla chiave di crittografia

Nome Tipo Descrizione
createdAt

string

Data e ora di creazione della chiave di crittografia
id

string

ID della chiave di crittografia
isDefault

boolean

Se la chiave di crittografia è la chiave predefinita per l'intero tenant. Qualsiasi capacità appena creata eredita la chiave predefinita.
keyVaultKeyIdentifier

string

URI che specifica in modo univoco la chiave di crittografia in Azure Key Vault
name

string

Nome della chiave di crittografia
updatedAt

string

Data e ora dell'ultimo aggiornamento della chiave di crittografia