Admin - Get Refreshables For Capacity

Référence

Service:: Power BI REST APIs

API Version:: v1.0

Retourne une liste d’actualisables pour la capacité spécifiée à laquelle l’utilisateur a accès.

Power BI conserve un historique d’actualisation de sept jours pour chaque jeu de données, jusqu’à un maximum de soixante actualisations.

Autorisations

L’utilisateur doit disposer de droits d’administrateur (par exemple, Office 365 administrateur général ou administrateur de service Power BI) ou s’authentifier à l’aide d’un principal de service.
Les autorisations déléguées sont prises en charge.

Lors de l’exécution sous l’authentification prinicipal du service, une application ne doit pas avoir de prémissions requises de consentement administrateur pour Power BI définies sur elle dans le Portail Azure.

Étendue requise

Tenant.Read.All ou Tenant.ReadWrite.All

Pertinent uniquement lors de l’authentification via un jeton d’accès administrateur délégué standard. Ne doit pas être présent lorsque l’authentification via un principal de service est utilisée.

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}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
capacityId	path	True	string uuid	ID de capacité
$top	query	True	integer int32	Retourne uniquement les n premiers résultats.
$expand	query		string	Accepte une liste de types de données séparées par des virgules, qui sera développée inline dans la réponse. Prend en charge `capacities` et `groups`.
$filter	query		string	Filtre les résultats en fonction d’une condition booléenne
$skip	query		integer int32	Ignore les n premiers résultats. Utilisez avec le haut pour extraire les résultats au-delà des 1000 premiers.

Réponses

Nom	Type	Description
200 OK	Refreshables	Ok

Exemples

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"
      }
    }
  ]
}

Définitions

Nom	Description
Capacity	Une capacité Power BI
CapacityState	État de capacité
capacityUserAccessRight	Droit d’accès de l’utilisateur sur la capacité
days	Jours pendant lesquels exécuter l’actualisation
Refresh	Une entrée d’historique d’actualisation Power BI
Refreshable	Une actualisation Power BI est un jeu de données qui a été actualisé au moins une fois ou pour lequel une planification d’actualisation valide existe. Si un jeu de données ne répond pas à l’une de ces conditions, il n’apparaîtra pas dans la réponse de l’API. Power BI conserve un historique d’actualisation de sept jours pour chaque jeu de données, jusqu’à un maximum de soixante actualisations.
RefreshableGroup	Un groupe Power BI associé à un élément actualisable
RefreshableKind	Type actualisable
Refreshables	Liste des actualisations Power BI
RefreshAttempt	Power BI effectue automatiquement plusieurs tentatives d’actualisation d’un jeu de données en cas d’échec d’actualisation. Cet objet contient des informations sur chaque tentative d’actualisation.
RefreshAttemptType	Type de tentative d’actualisation.
RefreshSchedule	Planification d’actualisation Power BI pour le modèle importé
RefreshType	Type de demande d’actualisation
ScheduleNotifyOption	Option de notification lors de l’arrêt d’une actualisation planifiée. Les principaux de service prennent uniquement en charge la `NoNotification` valeur.
TenantKey	Informations sur la clé de chiffrement

Capacity

Une capacité Power BI

Nom	Type	Description
admins	string[]	Tableau d’administrateurs de capacité
capacityUserAccessRight	capacityUserAccessRight	Droit d’accès d’un utilisateur sur la capacité
displayName	string	Nom d’affichage de la capacité
id	string	ID de capacité
region	string	Région Azure où la capacité a été provisionnée
sku	string	Référence SKU de capacité
state	CapacityState	État de capacité
tenantKey	TenantKey	Informations sur la clé de chiffrement (s’appliquent uniquement aux itinéraires d’administration)
tenantKeyId	string	ID d’une clé de chiffrement (applicable uniquement à l’itinéraire administrateur)

CapacityState

État de capacité

Nom	Type	Description
Active	string	La capacité est prête à être utilisée
Deleted	string	La capacité a été supprimée et n’est pas disponible
Deleting	string	La suppression de la capacité est en cours
Invalid	string	La capacité ne peut pas être utilisée
NotActivated	string	Non pris en charge
PreSuspended	string	Non pris en charge
ProvisionFailed	string	Échec de l’approvisionnement de la capacité
Provisioning	string	L’activation de la capacité est en cours
Suspended	string	L’utilisation de la capacité est suspendue
UpdatingSku	string	Un changement de référence SKU de capacité est en cours

capacityUserAccessRight

Droit d’accès de l’utilisateur sur la capacité

Nom	Type	Description
Admin	string	L’utilisateur dispose de droits d’administrateur sur la capacité
Assign	string	L’utilisateur dispose de droits contributeur et peut affecter des espaces de travail à la capacité
None	string	L’utilisateur n’a pas accès à la capacité

days

Jours pendant lesquels exécuter l’actualisation

Nom	Type	Description
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

Refresh

Une entrée d’historique d’actualisation Power BI

Nom	Type	Description
endTime	string	Date et heure de fin de l’actualisation (peut être vide si une actualisation est en cours)
refreshAttempts	RefreshAttempt[]	Liste des tentatives d’actualisation.
refreshType	RefreshType	Type de demande d’actualisation
requestId	string	Identificateur de la demande d’actualisation. Fournissez cet identificateur dans toutes les demandes de service.
serviceExceptionJson	string	Code d’erreur d’échec au format JSON (vide si aucune erreur)
startTime	string	Date et heure de début de l’actualisation
status	string	`Unknown` si l’état d’achèvement est inconnu ou si une actualisation est en cours. `Completed` pour une actualisation réussie. `Failed` pour une actualisation infructueuse (`serviceExceptionJson` contient le code d’erreur). `Disabled` si l’actualisation est désactivée par une actualisation sélective.

Refreshable

Une actualisation Power BI est un jeu de données qui a été actualisé au moins une fois ou pour lequel une planification d’actualisation valide existe. Si un jeu de données ne répond pas à l’une de ces conditions, il n’apparaîtra pas dans la réponse de l’API. Power BI conserve un historique d’actualisation de sept jours pour chaque jeu de données, jusqu’à un maximum de soixante actualisations.

Nom	Type	Description
averageDuration	number	Durée moyenne en secondes d’une actualisation pendant la fenêtre de temps pour laquelle des données d’actualisation existent
capacity	Capacity	Capacité de l’élément actualisable
configuredBy	string[]	Propriétaires actualisables
endTime	string	Heure de fin de la fenêtre pour laquelle des données d’actualisation existent
group	RefreshableGroup	Groupe associé pour l’élément actualisable
id	string	ID d’objet de l’objet actualisable
kind	RefreshableKind	Type actualisable
lastRefresh	Refresh	Dernière entrée de l’historique d’actualisation Power BI pour l’élément actualisable
medianDuration	number	Durée médiane en secondes d’une actualisation dans la fenêtre de temps pour laquelle des données d’actualisation existent
name	string	Nom d’affichage de l’actualisable
refreshCount	integer	Nombre d’actualisations dans la fenêtre de temps pour lesquelles des données d’actualisation existent
refreshFailures	integer	Nombre d’échecs d’actualisation dans la fenêtre de temps pour laquelle des données d’actualisation existent
refreshSchedule	RefreshSchedule	Planification d’actualisation de l’élément actualisable
refreshesPerDay	integer	Nombre d’actualisations par jour (planifiées et à la demande) dans la fenêtre de temps pour laquelle les données d’actualisation existent
startTime	string	Heure de début de la fenêtre pour laquelle des données d’actualisation existent

RefreshableGroup

Un groupe Power BI associé à un élément actualisable

Nom	Type	Description
id	string	L’ID de l’espace de travail
name	string	Nom du groupe

RefreshableKind

Type actualisable

Nom	Type	Description
Dataset	string	Dataset

Refreshables

Liste des actualisations Power BI

Nom	Type	Description
odata.context	string	Contexte OData
value	Refreshable[]	Actualisables

RefreshAttempt

Power BI effectue automatiquement plusieurs tentatives d’actualisation d’un jeu de données en cas d’échec d’actualisation. Cet objet contient des informations sur chaque tentative d’actualisation.

Nom	Type	Description
attemptId	integer	Index de la tentative d’actualisation.
endTime	string	Date et heure de fin de la tentative d’actualisation. La valeur est nulle si la tentative d’actualisation est en cours.
serviceExceptionJson	string	Code d’erreur d’échec au format JSON. Annuler s’il n’y a pas d’erreur.
startTime	string	Date et heure de début de la tentative d’actualisation.
type	RefreshAttemptType	Type de tentative d’actualisation.

RefreshAttemptType

Type de tentative d’actualisation.

Nom	Type	Description
Data	string	Tentative d’actualisation pour charger des données dans le jeu de données.
Query	string	Tentative d’actualisation des caches de requêtes Premium et des vignettes de tableau de bord.u

RefreshSchedule

Planification d’actualisation Power BI pour le modèle importé

Nom	Type	Description
NotifyOption	ScheduleNotifyOption	Option de notification lors de l’arrêt d’une actualisation planifiée. Les principaux de service prennent uniquement en charge la `NoNotification` valeur.
days	days[]	Jours pendant lesquels exécuter l’actualisation
enabled	boolean	Si l’actualisation est activée
localTimeZoneId	string	ID du fuseau horaire à utiliser. Pour plus d’informations, consultez Informations de fuseau horaire.
times	string[]	Heures de la journée pour exécuter l’actualisation

RefreshType

Type de demande d’actualisation

Nom	Type	Description
OnDemand	string	L’actualisation a été déclenchée de manière interactive via le portail Power BI
OnDemandTraining	string	L’actualisation a été déclenchée de manière interactive via le portail Power BI avec l’apprentissage des agrégations automatiques
Scheduled	string	L’actualisation a été déclenchée par un paramètre de planification d’actualisation du jeu de données
ViaApi	string	L’actualisation a été déclenchée par un appel d’API
ViaEnhancedApi	string	L’actualisation a été déclenchée par un appel d’API REST d’actualisation amélioré
ViaXmlaEndpoint	string	L’actualisation a été déclenchée via le point de terminaison XMLA public Power BI

ScheduleNotifyOption

Option de notification lors de l’arrêt d’une actualisation planifiée. Les principaux de service prennent uniquement en charge la NoNotification valeur.

Nom	Type	Description
MailOnFailure	string	Une notification par courrier électronique sera envoyée en cas d’échec d’actualisation
NoNotification	string	Aucune notification ne sera envoyée

TenantKey

Informations sur la clé de chiffrement

Nom	Type	Description
createdAt	string	Date et heure de création de la clé de chiffrement
id	string	ID de la clé de chiffrement
isDefault	boolean	Indique si la clé de chiffrement est la clé par défaut pour l’ensemble du locataire. Toute capacité nouvellement créée hérite de la clé par défaut.
keyVaultKeyIdentifier	string	URI qui spécifie de manière unique la clé de chiffrement dans Azure Key Vault
name	string	Nom de la clé de chiffrement
updatedAt	string	Date et heure de la dernière mise à jour de la clé de chiffrement

Admin - Get Refreshables For Capacity

Autorisations

Étendue requise

Paramètres URI

Réponses

Exemples

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

Définitions

Capacity

CapacityState

capacityUserAccessRight

days

Refresh

Refreshable

RefreshableGroup

RefreshableKind

Refreshables

RefreshAttempt

RefreshAttemptType

RefreshSchedule

RefreshType

ScheduleNotifyOption

TenantKey

Ressources supplémentaires