Capacities - Get Refreshables

Servizio:: Power BI REST APIs

Versione API:: v1.0

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

Power BI mantiene una cronologia di aggiornamento 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}

Con parametri facoltativi:

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) minimum: 1	Restituisce solo i primi n risultati.
$expand	query		string	Accetta un elenco delimitato da virgole di tipi di dati, che verrà espanso inline nella risposta. Supporta `capacity` e `group`.
$filter	query		string	Restituisce un sottoinsieme di risultati in base condizione del parametro di query di filtro Odata.
$skip	query		integer (int32)	Ignora i primi n risultati. Usare con l'inizio 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

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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.

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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	Una 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 aggiornabili di Power BI
RefreshAttempt	Power BI esegue automaticamente più tentativi di aggiornamento di 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 modello importato
RefreshType	Tipo di richiesta di aggiornamento
ScheduleNotifyOption	Opzione di notifica alla chiusura di un aggiornamento pianificato. Le entità servizio supportano solo il valore `NoNotification`.
TenantKey	Informazioni sulla chiave di crittografia

Capacity

Object

Una capacità di Power BI

Nome	Tipo	Descrizione
admins	string[]	Matrice di amministratori della capacità
capacityUserAccessRight	capacityUserAccessRight	Diritto di accesso che un utente ha sulla capacità
displayName	string	Nome visualizzato della capacità
id	string (uuid)	ID capacità
region	string	Area di Azure in cui è stato effettuato il provisioning della capacità
sku	string	SKU della capacità
state	CapacityState	Stato della capacità
tenantKey	TenantKey	Informazioni sulla chiave di crittografia (si applica solo alle route di amministrazione)
tenantKeyId	string (uuid)	ID di una chiave di crittografia (applicabile solo alla route dell'amministratore)

CapacityState

Enumerazione

Stato della capacità

Valore	Descrizione
NotActivated	Non confermato
Active	La capacità è pronta per l'uso
Provisioning	L'attivazione della capacità è in corso
ProvisionFailed	Provisioning della capacità non riuscita
PreSuspended	Non confermato
Suspended	L'uso della capacità è sospeso
Deleting	L'eliminazione della capacità è in corso
Deleted	La capacità è stata eliminata e non è disponibile
Invalid	Non è possibile usare la capacità
UpdatingSku	È in corso una modifica dello SKU della capacità

capacityUserAccessRight

Enumerazione

Diritto di accesso che l'utente ha sulla capacità

Valore	Descrizione
None	L'utente non ha accesso alla capacità
Assign	L'utente ha diritti di collaboratore e può assegnare aree di lavoro alla capacità
Admin	L'utente dispone dei diritti di amministratore per la capacità

days

Enumerazione

Giorni in cui eseguire l'aggiornamento

Valore	Descrizione
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Sunday

Refresh

Object

Voce della cronologia degli aggiornamenti di Power BI

Nome	Tipo	Descrizione
endTime	string (date-time)	Data e ora di fine dell'aggiornamento (può essere vuota se è in corso un aggiornamento) in formato UTC.
refreshAttempts	RefreshAttempt[]	Elenco di 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 errore errore in formato JSON (vuoto se non viene visualizzato alcun errore)
startTime	string (date-time)	Data e ora di inizio dell'aggiornamento in formato UTC.
status	string	`Unknown` se lo stato di completamento è sconosciuto o se è in corso un aggiornamento. `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

Object

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 sono presenti i dati di aggiornamento
capacity	Capacity	Capacità per l'elemento aggiornabile
configuredBy	string[]	Proprietari aggiornabili
endTime	string (date-time)	Ora di fine della finestra per cui i dati di aggiornamento esistono in formato UTC.
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 media in secondi di un aggiornamento entro l'intervallo di tempo per cui sono presenti i dati di aggiornamento
name	string	Nome visualizzato dell'oggetto aggiornabile
refreshCount	integer	Numero di aggiornamenti entro l'intervallo di tempo per il quale sono presenti i dati di aggiornamento
refreshFailures	integer	Numero di errori di aggiornamento entro l'intervallo di tempo per il quale sono presenti i 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 il quale sono presenti i dati di aggiornamento
startTime	string (date-time)	Ora di inizio della finestra per cui i dati di aggiornamento esistono in formato UTC.

RefreshableGroup

Object

Gruppo di Power BI associato a un elemento aggiornabile

Nome	Tipo	Descrizione
id	string (uuid)	ID dell'area di lavoro
name	string	Nome del gruppo

RefreshableKind

Enumerazione

Tipo aggiornabile

Valore	Descrizione
Dataset	Dataset

Refreshables

Object

Elenco aggiornabili di Power BI

Nome	Tipo	Descrizione
@odata.context	string	Contesto OData
value	Refreshable[]	Gli aggiornamenti

RefreshAttempt

Object

Power BI esegue automaticamente più tentativi di aggiornamento di 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 (date-time)	Data e ora di fine del tentativo di aggiornamento. Il valore è void se il tentativo di aggiornamento è in corso.
serviceExceptionJson	string	Codice errore errore in formato JSON. Void se non è presente alcun errore.
startTime	string (date-time)	Data e ora di inizio del tentativo di aggiornamento.
type	RefreshAttemptType	Tipo di tentativo di aggiornamento.

RefreshAttemptType

Enumerazione

Tipo di tentativo di aggiornamento.

Valore	Descrizione
Data	Tentativo di aggiornamento di caricare i dati nel set di dati.
Query	Tentativo di aggiornare le cache delle query Premium e i riquadri del dashboard.u

RefreshSchedule

Object

Pianificazione dell'aggiornamento di Power BI per modello importato

Nome	Tipo	Descrizione
days	days[]	Giorni in cui eseguire l'aggiornamento
enabled	boolean	Indica se l'aggiornamento è abilitato
localTimeZoneId	string	ID del fuso orario da utilizzare. Per altre informazioni, vedere informazioni sul fuso orario.
notifyOption	ScheduleNotifyOption	Opzione di notifica alla chiusura di un aggiornamento pianificato. Le entità servizio supportano solo il valore `NoNotification`.
times	string[]	Orari del giorno per l'esecuzione dell'aggiornamento

RefreshType

Enumerazione

Tipo di richiesta di aggiornamento

Valore	Descrizione
Scheduled	L'aggiornamento è stato attivato da un'impostazione di pianificazione dell'aggiornamento del set di dati
OnDemand	L'aggiornamento è stato attivato in modo interattivo tramite il portale di Power BI
ViaApi	L'aggiornamento è stato attivato da una chiamata API
ViaXmlaEndpoint	L'aggiornamento è stato attivato tramite l'endpoint XMLA pubblico di Power BI
ViaEnhancedApi	L'aggiornamento è stato attivato da una chiamata all'API REST di aggiornamento avanzato
OnDemandTraining	L'aggiornamento è stato attivato in modo interattivo tramite il portale di Power BI con training delle aggregazioni automatiche

ScheduleNotifyOption

Enumerazione

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

Valore	Descrizione
NoNotification	Non verrà inviata alcuna notifica
MailOnFailure	Verrà inviata una notifica di posta elettronica in caso di errore di aggiornamento

TenantKey

Object

Informazioni sulla chiave di crittografia

Nome	Tipo	Descrizione
createdAt	string (date-time)	Data e ora di creazione della chiave di crittografia
id	string (uuid)	ID della chiave di crittografia
isDefault	boolean	Indica 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 (date-time)	Data e ora dell'ultimo aggiornamento della chiave di crittografia

Condividi tramite

Capacities - Get Refreshables

Ambito obbligatorio

Parametri dell'URI

Risposte

Esempio

Example

Esempio di richiesta

Risposta di esempio

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

Esempio di richiesta

Risposta di esempio

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

Esempio di richiesta

Risposta di esempio

Definizioni

Capacity

CapacityState

capacityUserAccessRight

days

Refresh

Refreshable

RefreshableGroup

RefreshableKind

Refreshables

RefreshAttempt

RefreshAttemptType

RefreshSchedule

RefreshType

ScheduleNotifyOption

TenantKey