Admin - Get Refreshables For Capacity

Ссылка

Служба:: Power BI REST APIs

Версия API:: v1.0

Возвращает список обновляемых ресурсов для указанной емкости, к которым у пользователя есть доступ.

Power BI сохраняет семидневный журнал обновления для каждого набора данных до 60 обновлений.

Разрешения

Пользователь должен быть администратором Fabric или пройти проверку подлинности с помощью субъекта-службы.
Поддерживаются делегированные разрешения.

При выполнении в рамках проверки подлинности службы приложения не должны иметь необходимые разрешения администратора для Power BI, заданные на портале Azure.

Требуемая область

Tenant.Read.All или Tenant.ReadWrite.All

Важно только при проверке подлинности через стандартный делегированный маркер доступа администратора. Не должно присутствовать при использовании проверки подлинности через субъект-службу.

Ограничения

Максимум 200 запросов в час.

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
capacityId	path	True	string uuid	Идентификатор емкости
$top	query	True	integer int32	Возвращает только первые результаты n.
$expand	query		string	Принимает разделенный запятыми список типов данных, который будет развернут встроенным в ответе. Поддерживает `capacities` и `groups`.
$filter	query		string	Возвращает подмножество результатов на основе условия параметра запроса Odata Odata фильтра.
$skip	query		integer int32	Пропускает первые результаты n. Используйте в начале, чтобы получить результаты за пределами первого 1000.

Ответы

Имя	Тип	Описание
200 OK	Refreshables	ХОРОШО

Примеры

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

Образец запроса

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

Пример ответа

Код состояния:: 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.

Образец запроса

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

Пример ответа

Код состояния:: 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

Образец запроса

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

Пример ответа

Код состояния:: 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"
      }
    }
  ]
}

Определения

Имя	Описание
Capacity	Емкость Power BI
CapacityState	Состояние емкости
capacityUserAccessRight	Право доступа, которое пользователь имеет в емкости
days	Дни выполнения обновления
Refresh	Запись журнала обновления Power BI
Refreshable	Обновление Power BI — это набор данных, который был обновлен по крайней мере один раз или для которого существует допустимое расписание обновления. Если набор данных не соответствует ни одного из этих условий, он не будет отображаться в ответе API. Power BI сохраняет семидневный журнал обновления для каждого набора данных до 60 обновлений.
RefreshableGroup	Группа Power BI, связанная с обновляемым элементом
RefreshableKind	Вид обновляемого
Refreshables	Список обновляемых компонентов Power BI
RefreshAttempt	Power BI автоматически выполняет несколько попыток обновить набор данных при сбое обновления. Этот объект содержит сведения о каждой попытке обновления.
RefreshAttemptType	Тип попытки обновления.
RefreshSchedule	Расписание обновления Power BI для импортированной модели
RefreshType	Тип запроса на обновление
ScheduleNotifyOption	Параметр уведомления о завершении запланированного обновления. Субъекты-службы поддерживают только значение `NoNotification`.
TenantKey	Сведения о ключе шифрования

Capacity

Object

Емкость Power BI

Имя	Тип	Описание
admins	string[]	Массив администраторов емкости
capacityUserAccessRight	capacityUserAccessRight	Право доступа, которое пользователь имеет в емкости
displayName	string	Отображаемое имя емкости
id	string	Идентификатор емкости
region	string	Регион Azure, в котором была подготовлена емкость
sku	string	Номер SKU емкости
state	CapacityState	Состояние емкости
tenantKey	TenantKey	Сведения о ключе шифрования (применяется только к маршрутам администратора)
tenantKeyId	string	Идентификатор ключа шифрования (применимо только к маршруту администратора)

CapacityState

Enumeration

Состояние емкости

Значение	Описание
Active	Емкость готова к использованию
Deleted	Емкость удалена и недоступна
Deleting	Удаление емкости выполняется
Invalid	Не удается использовать емкость
NotActivated	Неподдерживаемые
PreSuspended	Неподдерживаемые
ProvisionFailed	Сбой подготовки емкости
Provisioning	Активация емкости выполняется
Suspended	Использование емкости приостановлено
UpdatingSku	Изменение номера SKU емкости выполняется

capacityUserAccessRight

Enumeration

Право доступа, которое пользователь имеет в емкости

Значение	Описание
Admin	У пользователя есть права администратора на емкость
Assign	Пользователь имеет права участника и может назначать рабочие области емкости
None	У пользователя нет доступа к емкости

days

Enumeration

Дни выполнения обновления

Значение	Описание
Friday
Monday
Saturday
Sunday
Thursday
Tuesday
Wednesday

Refresh

Object

Запись журнала обновления Power BI

Имя	Тип	Описание
endTime	string	Дата окончания и время обновления (может быть пустым, если выполняется обновление)
refreshAttempts	RefreshAttempt[]	Список попыток обновления.
refreshType	RefreshType	Тип запроса на обновление
requestId	string	Идентификатор запроса на обновление. Укажите этот идентификатор во всех запросах на обслуживание.
serviceExceptionJson	string	Код ошибки сбоя в формате JSON (пустой, если ошибка отсутствует)
startTime	string	Дата начала и время обновления
status	string	`Unknown`, если состояние завершения неизвестно или выполняется обновление. `Completed` для успешно завершенного обновления. `Failed` для неудачного обновления (`serviceExceptionJson` будет содержать код ошибки). `Disabled`, если обновление отключено выборочным обновлением.

Refreshable

Object

Обновление Power BI — это набор данных, который был обновлен по крайней мере один раз или для которого существует допустимое расписание обновления. Если набор данных не соответствует ни одного из этих условий, он не будет отображаться в ответе API. Power BI сохраняет семидневный журнал обновления для каждого набора данных до 60 обновлений.

Имя	Тип	Описание
averageDuration	number	Средняя длительность обновления в секундах во время периода времени, для которого существуют данные обновления
capacity	Capacity	Емкость обновляемого элемента
configuredBy	string[]	Обновляемые владельцы
endTime	string	Время окончания окна, для которого существуют данные обновления
group	RefreshableGroup	Связанная группа для обновляемого элемента
id	string	Идентификатор объекта обновляемого объекта
kind	RefreshableKind	Вид обновляемого
lastRefresh	Refresh	Последняя запись журнала обновления Power BI для обновляемого элемента
medianDuration	number	Продолжительность медиана в секундах обновления в течение периода времени, для которого существуют данные обновления
name	string	Отображаемое имя обновляемого объекта
refreshCount	integer	Количество обновлений в течение периода времени, для которого существуют данные обновления
refreshFailures	integer	Количество сбоев обновления в течение периода времени, для которого существуют данные обновления
refreshSchedule	RefreshSchedule	Расписание обновления для обновляемого элемента
refreshesPerDay	integer	Количество обновлений в день (запланированное и по запросу) в течение периода времени, для которого существуют данные обновления
startTime	string	Время начала окна, для которого существуют данные обновления

RefreshableGroup

Object

Группа Power BI, связанная с обновляемым элементом

Имя	Тип	Описание
id	string	Идентификатор рабочей области
name	string	Имя группы

RefreshableKind

Enumeration

Вид обновляемого

Значение	Описание
Dataset	Набор данных

Refreshables

Object

Список обновляемых компонентов Power BI

Имя	Тип	Описание
@odata.context	string	Контекст OData
value	Refreshable[]	Обновляемые компоненты

RefreshAttempt

Object

Power BI автоматически выполняет несколько попыток обновить набор данных при сбое обновления. Этот объект содержит сведения о каждой попытке обновления.

Имя	Тип	Описание
attemptId	integer	Индекс попытки обновления.
endTime	string	Дата окончания и время попытки обновления. Значение пусто, если выполняется попытка обновления.
serviceExceptionJson	string	Код ошибки сбоя в формате JSON. Void, если ошибка отсутствует.
startTime	string	Дата начала и время попытки обновления.
type	RefreshAttemptType	Тип попытки обновления.

RefreshAttemptType

Enumeration

Тип попытки обновления.

Значение	Описание
Data	Обновление пытается загрузить данные в набор данных.
Query	Попытка обновить кэши запросов класса Premium и плитки панели мониторинга.u

RefreshSchedule

Object

Расписание обновления Power BI для импортированной модели

Имя	Тип	Описание
days	days[]	Дни выполнения обновления
enabled	boolean	Включена ли обновление
localTimeZoneId	string	Идентификатор используемого часового пояса. Дополнительные сведения см. в сведения о часовом поясе.
notifyOption	ScheduleNotifyOption	Параметр уведомления о завершении запланированного обновления. Субъекты-службы поддерживают только значение `NoNotification`.
times	string[]	Время суток для выполнения обновления

RefreshType

Enumeration

Тип запроса на обновление

Значение	Описание
OnDemand	Обновление было активировано интерактивно с помощью портала Power BI
OnDemandTraining	Обновление было активировано интерактивно через портал Power BI с помощью автоматического обучения агрегирования
Scheduled	Обновление было активировано параметром расписания обновления набора данных
ViaApi	Обновление было активировано вызовом API
ViaEnhancedApi	Обновление было активировано вызовом REST API расширенного обновления
ViaXmlaEndpoint	Обновление было активировано через общедоступную конечную точку XMLA Power BI

ScheduleNotifyOption

Enumeration

Параметр уведомления о завершении запланированного обновления. Субъекты-службы поддерживают только значение NoNotification.

Значение	Описание
MailOnFailure	Уведомление по почте будет отправлено при сбое обновления
NoNotification	Уведомление не будет отправлено

TenantKey

Object

Сведения о ключе шифрования

Имя	Тип	Описание
createdAt	string	Дата и время создания ключа шифрования
id	string	Идентификатор ключа шифрования
isDefault	boolean	Является ли ключ шифрования ключом по умолчанию для всего клиента. Любая только что созданная емкость наследует ключ по умолчанию.
keyVaultKeyIdentifier	string	Универсальный код ресурса (URI), уникально указывающий ключ шифрования в Azure Key Vault
name	string	Имя ключа шифрования
updatedAt	string	Дата последнего обновления и время ключа шифрования

Поделиться через

Admin - Get Refreshables For Capacity

Разрешения

Требуемая область

Ограничения

Параметры URI

Ответы

Примеры

Example

Образец запроса

Пример ответа

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

Образец запроса

Пример ответа

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

Образец запроса

Пример ответа

Определения

Capacity

CapacityState

capacityUserAccessRight

days

Refresh

Refreshable

RefreshableGroup

RefreshableKind

Refreshables

RefreshAttempt

RefreshAttemptType

RefreshSchedule

RefreshType

ScheduleNotifyOption

TenantKey

Дополнительные ресурсы