Admin - Get Refreshables For Capacity

Reference

Service:: Power BI REST APIs

API Version:: v1.0

Vrátí seznam aktualizovatelných položek pro zadanou kapacitu, ke které má uživatel přístup.

Power BI uchovává pro každou datovou sadu sedmidenní historii aktualizací, maximálně 6 aktualizací.

Oprávnění

Uživatel musí mít oprávnění správce (například Office 365 globálního správce nebo správce služby Power BI) nebo ověřování pomocí instančního objektu.
Delegovaná oprávnění jsou podporovaná.

Při spuštění v rámci původního ověřování služby nesmí mít aplikace v Azure Portal nastavená žádná oprávnění vyžadovaná správcem 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. Nesmí být k dispozici při použití ověřování prostřednictvím instančního objektu.

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

With optional parameters:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
capacityId	path	True	string uuid	ID kapacity
$top	query	True	integer int32	Vrátí pouze prvních n výsledků.
$expand	query		string	Přijímá seznam datových typů oddělených čárkami, který se v odpovědi rozbalí. Podporuje `capacities` a `groups`.
$filter	query		string	Filtruje výsledky na základě logické podmínky.
$skip	query		integer int32	Přeskočí prvních n výsledků. Pokud chcete načíst výsledky nad rámec prvních 1000, použijte s horní.

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

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/capacities/{capacityId}/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/admin/capacities/{capacityId}/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/admin/capacities/{capacityId}/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"
      }
    }
  ]
}

Definice

Name	Description
Capacity	Kapacita Power BI
CapacityState	Stav kapacity
capacityUserAccessRight	Přístupová práva, která má uživatel ke kapacitě
days	Dny, ve kterých se má aktualizace spustit
Refresh	Položka historie aktualizace Power BI
Refreshable	Aktualizovatelná datová sada Power BI je datová sada, která se aspoň jednou aktualizovala nebo pro kterou existuje platný plán aktualizace. Pokud datová sada některou z těchto podmínek nesplňuje, nezobrazí se v odpovědi rozhraní API. Power BI uchovává pro každou datovou sadu sedmidenní historii aktualizací, maximálně však 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í o ukončení plánované aktualizace. Instanční objekty podporují `NoNotification` pouze hodnotu .
TenantKey	Informace o šifrovacím klíči

Capacity

Kapacita Power BI

Name	Typ	Description
admins	string[]	Pole správců kapacity
capacityUserAccessRight	capacityUserAccessRight	Přístupová práva, která má uživatel ke kapacitě
displayName	string	Zobrazovaný název kapacity
id	string	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	ID šifrovacího klíče (platí jenom pro trasu správce)

CapacityState

Stav kapacity

Name	Typ	Description
Active	string	Kapacita je připravená k použití.
Deleted	string	Kapacita se odstranila a není k dispozici.
Deleting	string	Probíhá odstraňování kapacity.
Invalid	string	Kapacitu nelze použít.
NotActivated	string	Nepodporované
PreSuspended	string	Nepodporované
ProvisionFailed	string	Zřizování kapacity se nezdařilo.
Provisioning	string	Probíhá aktivace kapacity.
Suspended	string	Využití kapacity je pozastaveno.
UpdatingSku	string	Probíhá změna skladové položky kapacity

capacityUserAccessRight

Přístupová práva, která má uživatel ke kapacitě

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

days

Dny, ve kterých se má aktualizace spustit

Name	Typ	Description
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

Refresh

Položka historie aktualizace Power BI

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

Refreshable

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

Name	Typ	Description
averageDuration	number	Průměrná doba trvání aktualizace v sekundách během časového intervalu, pro který existují data aktualizace
capacity	Capacity	Kapacita aktualizovatelné položky
configuredBy	string[]	Obnovitelní vlastníci
endTime	string	Čas ukončení okna, pro které existují data aktualizace
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í aktualizace v sekundách 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ých a na vyžádání) v časovém intervalu, pro který existují data aktualizace
startTime	string	Počáteční čas okna, pro které existují data aktualizace

RefreshableGroup

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

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

RefreshableKind

Aktualizovatelný druh

Name	Typ	Description
Dataset	string	Datová sada

Refreshables

Seznam aktualizovatelných položek Power BI

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

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.

Name	Typ	Description
attemptId	integer	Index pokusu o aktualizaci.
endTime	string	Koncové datum a čas pokusu o aktualizaci. Pokud probíhá pokus o aktualizaci, hodnota je void.
serviceExceptionJson	string	Kód chyby selhání ve formátu JSON Pokud nedojde k žádné chybě, je neplatná.
startTime	string	Počáteční datum a čas pokusu o aktualizaci.
type	RefreshAttemptType	Typ pokusu o aktualizaci.

RefreshAttemptType

Typ pokusu o aktualizaci.

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

RefreshSchedule

Plán aktualizace Power BI pro importovaný model

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

RefreshType

Typ žádosti o aktualizaci

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

ScheduleNotifyOption

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

Name	Typ	Description
MailOnFailure	string	Při selhání aktualizace se odešle e-mailové oznámení.
NoNotification	string	Žádné oznámení se nepošlou.

TenantKey

Informace o šifrovacím klíči

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

Admin - Get Refreshables For Capacity

Oprávnění

Požadovaný obor

Parametry identifikátoru URI

Odpovědi

Příklady

Example

Sample Request

Sample Response

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

Sample Request

Sample Response

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

Sample Request

Sample Response

Definice

Capacity

CapacityState

capacityUserAccessRight

days

Refresh

Refreshable

RefreshableGroup

RefreshableKind

Refreshables

RefreshAttempt

RefreshAttemptType

RefreshSchedule

RefreshType

ScheduleNotifyOption

TenantKey

Další materiály