Admin - Get Refreshables

Služba:: Power BI REST APIs

Verze rozhraní API:: v1.0

Vrátí seznam aktualizovatelných položek pro organizaci v rámci kapacity.

Power BI uchovává pro každou datovou sadu historii sedmidenní aktualizace až do maximálního počtu 60 aktualizací.

Dovolení

Uživatel musí být správcem infrastruktury nebo se musí ověřit pomocí instančního objektu.
Delegovaná oprávnění jsou podporována.

Při spuštění v rámci ověřování prinicipal služby nesmí aplikace nesmí mít na webu Azure Portal nastavené žádné žádosti o udělení souhlasu správce pro Power BI.

Požadovaný obor

Tenant.Read.All nebo Tenant.ReadWrite.All

Relevantní pouze při ověřování prostřednictvím standardního delegovaného přístupového tokenu správce. Při ověřování pomocí instančního objektu nesmí být k dispozici.

Omezení

Maximálně 200 požadavků za hodinu.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
$top	query	True	integer (int32) minimum: 1	Vrátí pouze první n výsledků.
$expand	query		string	Přijme čárkami oddělený seznam datových typů, který se v odpovědi rozbalí. Podporuje `capacities` a `groups`.
$filter	query		string	Vrátí podmnožinu výsledků na základě Odata podmínky parametru dotazu filtru.
$skip	query		integer (int32)	Přeskočí první n výsledků. Pomocí horní části můžete načíst výsledky nad rámec prvních 1 000.

Odpovědi

Name	Typ	Description
200 OK	Refreshables	OK

Příklady

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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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.

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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"
      }
    }
  ]
}

Definice

Name	Description
Capacity	Kapacita Power BI
CapacityState	Stav kapacity
capacityUserAccessRight	Přístupové právo, které má uživatel v kapacitě
days	Dny, kdy se má aktualizace spustit
Refresh	Položka historie aktualizace Power BI
Refreshable	Aktualizovatelná datová sada Power BI je datová sada, která se aktualizovala alespoň jednou nebo pro kterou existuje platný plán aktualizace. Pokud datová sada nesplňuje některou z těchto podmínek, nezobrazí se v odpovědi rozhraní API. Power BI uchovává pro každou datovou sadu historii sedmidenní aktualizace až do maximálního počtu 60 aktualizací.
RefreshableGroup	Skupina Power BI přidružená k aktualizovatelné položce
RefreshableKind	Aktualizovatelný druh
Refreshables	Seznam aktualizovatelných položek Power BI
RefreshAttempt	Power BI automaticky provede několik pokusů o aktualizaci datové sady, pokud dojde k selhání aktualizace. Tento objekt obsahuje informace o každém pokusu o aktualizaci.
RefreshAttemptType	Typ pokusu o aktualizaci.
RefreshSchedule	Plán aktualizace Power BI pro importovaný model
RefreshType	Typ žádosti o aktualizaci
ScheduleNotifyOption	Možnost oznámení při ukončení plánované aktualizace. Instanční objekty podporují pouze `NoNotification` hodnotu.
TenantKey	Informace o šifrovacím klíči

Capacity

Objekt

Kapacita Power BI

Name	Typ	Description
admins	string[]	Pole správců kapacity
capacityUserAccessRight	capacityUserAccessRight	Přístupové právo, které má uživatel na kapacitě
displayName	string	Zobrazovaný název kapacity
id	string (uuid)	ID kapacity
region	string	Oblast Azure, ve které byla kapacita zřízena
sku	string	Skladová položka kapacity
state	CapacityState	Stav kapacity
tenantKey	TenantKey	Informace o šifrovacím klíči (platí jenom pro trasy správce)
tenantKeyId	string (uuid)	ID šifrovacího klíče (platí jenom pro trasu správce)

CapacityState

Výčet

Stav kapacity

Hodnota	Description
NotActivated	Nepodporovaný
Active	Kapacita je připravená k použití.
Provisioning	Probíhá aktivace kapacity
ProvisionFailed	Zřizování kapacity se nezdařilo.
PreSuspended	Nepodporovaný
Suspended	Použití kapacity je pozastaveno.
Deleting	Probíhá odstranění kapacity.
Deleted	Kapacita byla odstraněna a není k dispozici.
Invalid	Kapacitu nejde použít.
UpdatingSku	Probíhá změna skladové položky kapacity.

capacityUserAccessRight

Výčet

Přístupové právo, které má uživatel v kapacitě

Hodnota	Description
None	Uživatel nemá přístup ke kapacitě.
Assign	Uživatel má práva přispěvatele a může přiřazovat pracovní prostory ke kapacitě.
Admin	Uživatel má oprávnění správce ke kapacitě.

days

Výčet

Dny, kdy se má aktualizace spustit

Hodnota	Description
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Sunday

Refresh

Objekt

Položka historie aktualizace Power BI

Name	Typ	Description
endTime	string (date-time)	Koncové datum a čas aktualizace (může být prázdné, pokud probíhá aktualizace) ve formátu UTC.
refreshAttempts	RefreshAttempt[]	Seznam pokusů o aktualizaci.
refreshType	RefreshType	Typ žádosti o aktualizaci
requestId	string	Identifikátor žádosti o aktualizaci. Zadejte tento identifikátor ve všech požadavcích služby.
serviceExceptionJson	string	Kód chyby selhání ve formátu JSON (prázdný, pokud žádná chyba)
startTime	string (date-time)	Počáteční datum a čas aktualizace ve formátu UTC.
status	string	`Unknown`, pokud je stav dokončení neznámý nebo probíhá aktualizace. `Completed` úspěšné dokončení aktualizace. `Failed` neúspěšné aktualizace (`serviceExceptionJson` bude obsahovat kód chyby). `Disabled`, pokud je aktualizace zakázaná selektivní aktualizací.

Refreshable

Objekt

Aktualizovatelná datová sada Power BI je datová sada, která se aktualizovala alespoň jednou nebo pro kterou existuje platný plán aktualizace. Pokud datová sada nesplňuje některou z těchto podmínek, nezobrazí se v odpovědi rozhraní API. Power BI uchovává pro každou datovou sadu historii sedmidenní aktualizace až do maximálního počtu 60 aktualizací.

Name	Typ	Description
averageDuration	number	Průměrná doba trvání v sekundách aktualizace během časového intervalu, pro který existují data aktualizace
capacity	Capacity	Kapacita aktualizovatelné položky
configuredBy	string[]	Aktualizovatelné vlastníky
endTime	string (date-time)	Koncový čas okna, pro které existují data aktualizace ve formátu UTC.
group	RefreshableGroup	Přidružená skupina pro aktualizovatelnou položku
id	string	ID objektu aktualizovatelného objektu
kind	RefreshableKind	Aktualizovatelný druh
lastRefresh	Refresh	Poslední položka historie aktualizace Power BI pro aktualizovatelnou položku
medianDuration	number	Medián doby trvání v sekundách aktualizace v časovém intervalu, pro který existují data aktualizace
name	string	Zobrazovaný název aktualizovatelného
refreshCount	integer	Počet aktualizací v časovém intervalu, pro který existují data aktualizace
refreshFailures	integer	Počet selhání aktualizace v časovém intervalu, pro který existují data aktualizace
refreshSchedule	RefreshSchedule	Plán aktualizace pro aktualizovatelnou položku
refreshesPerDay	integer	Počet aktualizací za den (naplánovaný a na vyžádání) v časovém intervalu, pro který existují data aktualizace
startTime	string (date-time)	Počáteční čas okna, pro které existují data aktualizace ve formátu UTC.

RefreshableGroup

Objekt

Skupina Power BI přidružená k aktualizovatelné položce

Name	Typ	Description
id	string (uuid)	ID pracovního prostoru
name	string	Název skupiny

RefreshableKind

Výčet

Aktualizovatelný druh

Hodnota	Description
Dataset	Dataset

Refreshables

Objekt

Seznam aktualizovatelných položek Power BI

Name	Typ	Description
@odata.context	string	Kontext OData
value	Refreshable[]	Aktualizovatelné

RefreshAttempt

Objekt

Power BI automaticky provede několik pokusů o aktualizaci datové sady, pokud dojde k selhání aktualizace. Tento objekt obsahuje informace o každém pokusu o aktualizaci.

Name	Typ	Description
attemptId	integer	Index pokusu o aktualizaci.
endTime	string (date-time)	Koncové datum a čas pokusu o aktualizaci. Hodnota je void, pokud probíhá pokus o aktualizaci.
executionMetrics	object[]	Metriky spouštění modulu Analysis Services zachycené během pokusu o aktualizaci.
serviceExceptionJson	string	Kód chyby selhání ve formátu JSON Pokud nedojde k žádné chybě, Void.
startTime	string (date-time)	Počáteční datum a čas pokusu o aktualizaci.
type	RefreshAttemptType	Typ pokusu o aktualizaci.

RefreshAttemptType

Výčet

Typ pokusu o aktualizaci.

Hodnota	Description
Data	Aktualizace se pokusí načíst data do datové sady.
Query	Pokus o aktualizaci mezipaměti dotazů Premium a dlaždic řídicího panelu

RefreshSchedule

Objekt

Plán aktualizace Power BI pro importovaný model

Name	Typ	Description
days	days[]	Dny, kdy se má aktualizace spustit
enabled	boolean	Jestli je aktualizace povolená
localTimeZoneId	string	ID časového pásma, které se má použít. Další informace naleznete v tématu Informace o časovém pásmu.
notifyOption	ScheduleNotifyOption	Možnost oznámení při ukončení plánované aktualizace. Instanční objekty podporují pouze `NoNotification` hodnotu.
times	string[]	Denní doba provádění aktualizace

RefreshType

Výčet

Typ žádosti o aktualizaci

Hodnota	Description
Scheduled	Aktualizace se aktivovala nastavením plánu aktualizace datové sady.
OnDemand	Aktualizace se aktivovala interaktivně prostřednictvím portálu Power BI.
ViaApi	Aktualizace se aktivovala voláním rozhraní API.
ViaXmlaEndpoint	Aktualizace se aktivovala prostřednictvím veřejného koncového bodu XMLA Power BI.
ViaEnhancedApi	Aktualizace se aktivovala voláním rozšířeného rozhraní REST API pro aktualizaci.
OnDemandTraining	Aktualizace se aktivovala interaktivně prostřednictvím portálu Power BI s automatickým trénováním agregací.

ScheduleNotifyOption

Výčet

Možnost oznámení při ukončení plánované aktualizace. Instanční objekty podporují pouze NoNotification hodnotu.

Hodnota	Description
NoNotification	Nebudou odeslána žádná oznámení.
MailOnFailure	Při selhání aktualizace se odešle e-mailové oznámení.

TenantKey

Objekt

Informace o šifrovacím klíči

Name	Typ	Description
createdAt	string (date-time)	Datum a čas vytvoření šifrovacího klíče
id	string (uuid)	ID šifrovacího klíče
isDefault	boolean	Určuje, jestli je šifrovací klíč výchozím klíčem pro celého tenanta. Všechny nově vytvořené kapacity dědí výchozí klíč.
keyVaultKeyIdentifier	string	Identifikátor URI, který jednoznačně určuje šifrovací klíč ve službě Azure Key Vault
name	string	Název šifrovacího klíče
updatedAt	string (date-time)	Datum a čas poslední aktualizace šifrovacího klíče

Sdílet prostřednictvím

Admin - Get Refreshables

Dovolení

Požadovaný obor

Omezení

Parametry identifikátoru URI

Odpovědi

Příklady

Example

Ukázkový požadavek

Ukázková odpověď

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

Ukázkový požadavek

Ukázková odpověď

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

Ukázkový požadavek

Ukázková odpověď

Definice

Capacity

CapacityState

capacityUserAccessRight

days

Refresh

Refreshable

RefreshableGroup

RefreshableKind

Refreshables

RefreshAttempt

RefreshAttemptType

RefreshSchedule

RefreshType

ScheduleNotifyOption

TenantKey