Admin - Get Refreshable For Capacity

返回用户有权访问的指定容量的指定可刷新性。

Power BI 为每个数据集保留七天的刷新历史记录,最多保留 60 次刷新。

权限

  • 用户必须是 Fabric 管理员或使用服务主体进行身份验证。
  • 支持委派的权限。

在服务特权身份验证下运行时,应用 不得 在 Azure 门户中为其上设置的 Power BI 提供任何管理员许可。

所需范围

Tenant.Read.All 或 Tenant.ReadWrite.All

仅在通过标准委派管理员访问令牌进行身份验证时相关。 使用服务主体进行身份验证时不得存在。

局限性

每小时最多 200 个请求。

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

URI 参数

名称 必需 类型 说明
capacityId
path True

string

uuid

容量 ID

refreshableId
path True

string

可刷新 ID

$expand
query

string

接受以逗号分隔的数据类型列表,该列表将在响应中内联扩展。 支持 capacitiesgroups

响应

名称 类型 说明
200 OK

Refreshables

还行

示例

Example
Get a refreshable with its 'capacity' and 'group' expanded example

Example

示例请求

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

示例响应

{
  "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 a refreshable with its 'capacity' and 'group' expanded example

示例请求

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

示例响应

{
  "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

Power BI 容量

名称 类型 说明
admins

string[]

容量管理员数组

capacityUserAccessRight

capacityUserAccessRight

用户对容量的访问权限

displayName

string

容量的显示名称

id

string

容量 ID

region

string

预配容量的 Azure 区域

sku

string

容量 SKU

state

CapacityState

容量状态

tenantKey

TenantKey

加密密钥信息(仅适用于管理路由)

tenantKeyId

string

加密密钥的 ID(仅适用于管理路由)

CapacityState

容量状态

名称 类型 说明
Active

string

容量已准备就绪,可供使用

Deleted

string

容量已删除且不可用

Deleting

string

正在删除容量

Invalid

string

无法使用容量

NotActivated

string

支持

PreSuspended

string

支持

ProvisionFailed

string

预配容量失败

Provisioning

string

正在激活容量

Suspended

string

容量的使用已暂停

UpdatingSku

string

容量 SKU 更改正在进行中

capacityUserAccessRight

用户对容量的访问权限

名称 类型 说明
Admin

string

用户对容量具有管理员权限

Assign

string

用户具有参与者权限,并且可以将工作区分配给容量

None

string

用户无权访问容量

days

执行刷新的天数

名称 类型 说明
Friday

string

Monday

string

Saturday

string

Sunday

string

Thursday

string

Tuesday

string

Wednesday

string

Refresh

Power BI 刷新历史记录条目

名称 类型 说明
endTime

string

刷新的结束日期和时间(如果正在进行刷新,可能为空)

refreshAttempts

RefreshAttempt[]

刷新尝试列表。

refreshType

RefreshType

刷新请求的类型

requestId

string

刷新请求的标识符。 在所有服务请求中提供此标识符。

serviceExceptionJson

string

JSON 格式的失败错误代码(如果没有错误,则为空)

startTime

string

刷新的开始日期和时间

status

string

  • 如果完成状态未知或刷新正在进行,则 Unknown
  • Completed 成功完成刷新。
  • Failed 刷新失败(serviceExceptionJson 将包含错误代码)。
  • 如果选择性刷新禁用了刷新,则 Disabled

Refreshable

Power BI 可刷新是至少刷新一次或有效刷新计划的数据集。 如果数据集不满足上述任一条件,则不会显示在 API 响应中。 Power BI 为每个数据集保留七天的刷新历史记录,最多保留 60 次刷新。

名称 类型 说明
averageDuration

number

刷新数据所在的时间段内刷新的平均持续时间(以秒为单位)

capacity

Capacity

可刷新项的容量

configuredBy

string[]

可刷新所有者

endTime

string

刷新数据的窗口的结束时间

group

RefreshableGroup

可刷新项的关联组

id

string

可刷新的对象 ID

kind

RefreshableKind

可刷新类型

lastRefresh

Refresh

可刷新项的最后一个 Power BI 刷新历史记录条目

medianDuration

number

刷新数据所在的时间范围内刷新的中位数持续时间(以秒为单位)

name

string

可刷新的显示名称

refreshCount

integer

刷新数据所在的时间范围内刷新次数

refreshFailures

integer

刷新数据所在的时间范围内刷新失败次数

refreshSchedule

RefreshSchedule

可刷新项的刷新计划

refreshesPerDay

integer

刷新数据所在的时间范围内每天(计划刷新和按需)的刷新次数

startTime

string

刷新数据的窗口的开始时间

RefreshableGroup

与可刷新项关联的 Power BI 组

名称 类型 说明
id

string

工作区 ID

name

string

组名称

RefreshableKind

可刷新类型

名称 类型 说明
Dataset

string

数据

Refreshables

Power BI 可刷新列表

名称 类型 说明
odata.context

string

OData 上下文

value

Refreshable[]

可刷新

RefreshAttempt

如果数据集遇到刷新失败,Power BI 会自动多次尝试刷新数据集。 此对象包含有关每次刷新尝试的信息。

名称 类型 说明
attemptId

integer

刷新尝试的索引。

endTime

string

刷新尝试的结束日期和时间。 如果刷新尝试正在进行,则该值为 void。

serviceExceptionJson

string

JSON 格式的失败错误代码。 如果没有错误,则为 Void。

startTime

string

刷新尝试的开始日期和时间。

type

RefreshAttemptType

刷新尝试的类型。

RefreshAttemptType

刷新尝试的类型。

名称 类型 说明
Data

string

刷新尝试将数据加载到数据集中。

Query

string

尝试刷新高级查询缓存和仪表板 tiles.u

RefreshSchedule

导入模型 的 Power BI 刷新计划

名称 类型 说明
NotifyOption

ScheduleNotifyOption

计划刷新终止的通知选项。 服务主体仅支持 NoNotification 值。

days

days[]

执行刷新的天数

enabled

boolean

是否启用刷新

localTimeZoneId

string

要使用的时区的 ID。 有关详细信息,请参阅 时区信息

times

string[]

执行刷新的一天中的时间

RefreshType

刷新请求的类型

名称 类型 说明
OnDemand

string

刷新是通过 Power BI 门户以交互方式触发的

OnDemandTraining

string

通过 Power BI 门户通过自动聚合训练以交互方式触发刷新

Scheduled

string

刷新是由数据集刷新计划设置触发的

ViaApi

string

刷新是由 API 调用触发的

ViaEnhancedApi

string

刷新是由增强的刷新 REST API 调用触发的

ViaXmlaEndpoint

string

刷新是通过 Power BI 公共 XMLA 终结点触发的

ScheduleNotifyOption

计划刷新终止的通知选项。 服务主体仅支持 NoNotification 值。

名称 类型 说明
MailOnFailure

string

刷新失败时将发送邮件通知

NoNotification

string

不会发送通知

TenantKey

加密密钥信息

名称 类型 说明
createdAt

string

加密密钥的创建日期和时间

id

string

加密密钥的 ID

isDefault

boolean

加密密钥是否是整个租户的默认密钥。 任何新创建的容量都继承默认密钥。

keyVaultKeyIdentifier

string

唯一指定 Azure Key Vault 中的加密密钥的 URI

name

string

加密密钥的名称

updatedAt

string

加密密钥的上次更新日期和时间